tencentcloud-sdk-nodejs 4.0.647 → 4.0.648
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +185 -0
- package/SERVICE_CHANGELOG.md +469 -332
- package/package.json +1 -1
- package/products.md +13 -13
- package/src/common/sdk_version.ts +1 -1
- package/src/services/cbs/v20170312/cbs_client.ts +20 -51
- package/src/services/cbs/v20170312/cbs_models.ts +16 -165
- package/src/services/cdb/v20170320/cdb_client.ts +4 -84
- package/src/services/cdb/v20170320/cdb_models.ts +41 -568
- package/src/services/cloudstudio/v20230508/cloudstudio_models.ts +4 -0
- package/src/services/domain/v20180808/domain_client.ts +13 -1
- package/src/services/domain/v20180808/domain_models.ts +40 -20
- package/src/services/ess/v20201111/ess_client.ts +6 -5
- package/src/services/ess/v20201111/ess_models.ts +47 -2
- package/src/services/ocr/v20181119/ocr_models.ts +8 -8
- package/src/services/tdid/v20210519/tdid_client.ts +9 -39
- package/src/services/tdid/v20210519/tdid_models.ts +24 -102
- package/src/services/teo/v20220901/teo_models.ts +1 -1
- package/src/services/tiw/v20190919/tiw_client.ts +17 -5
- package/src/services/tiw/v20190919/tiw_models.ts +105 -65
- package/src/services/trtc/v20190722/trtc_client.ts +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/cbs/v20170312/cbs_client.d.ts +10 -23
- package/tencentcloud/services/cbs/v20170312/cbs_client.js +11 -28
- package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +16 -159
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +1 -31
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +0 -40
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +41 -548
- package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_models.d.ts +4 -0
- package/tencentcloud/services/domain/v20180808/domain_client.d.ts +5 -1
- package/tencentcloud/services/domain/v20180808/domain_client.js +6 -0
- package/tencentcloud/services/domain/v20180808/domain_models.d.ts +38 -20
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +6 -5
- package/tencentcloud/services/ess/v20201111/ess_client.js +6 -5
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +47 -2
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +8 -8
- package/tencentcloud/services/tdid/v20210519/tdid_client.d.ts +4 -17
- package/tencentcloud/services/tdid/v20210519/tdid_client.js +4 -21
- package/tencentcloud/services/tdid/v20210519/tdid_models.d.ts +23 -96
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +1 -1
- package/tencentcloud/services/tiw/v20190919/tiw_client.d.ts +5 -1
- package/tencentcloud/services/tiw/v20190919/tiw_client.js +6 -0
- package/tencentcloud/services/tiw/v20190919/tiw_models.d.ts +103 -65
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +1 -1
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +1 -1
- package/test/cbs.v20170312.test.js +4 -24
- package/test/cdb.v20170320.test.js +0 -50
- package/test/domain.v20180808.test.js +10 -0
- package/test/tdid.v20210519.test.js +2 -22
- package/test/tiw.v20190919.test.js +10 -0
|
@@ -776,13 +776,60 @@ export interface DescribeRunningTasksResponse {
|
|
|
776
776
|
}
|
|
777
777
|
|
|
778
778
|
/**
|
|
779
|
-
*
|
|
779
|
+
* DescribeWhiteboardPush返回参数结构体
|
|
780
780
|
*/
|
|
781
|
-
export interface
|
|
781
|
+
export interface DescribeWhiteboardPushResponse {
|
|
782
782
|
/**
|
|
783
|
-
*
|
|
783
|
+
* 推流结束原因,
|
|
784
|
+
- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流
|
|
785
|
+
- USER_CALL: 主动调用了停止推流接口
|
|
786
|
+
- EXCEPTION: 推流异常结束
|
|
784
787
|
*/
|
|
785
|
-
|
|
788
|
+
FinishReason?: string
|
|
789
|
+
/**
|
|
790
|
+
* 需要查询结果的白板推流任务Id
|
|
791
|
+
*/
|
|
792
|
+
TaskId?: string
|
|
793
|
+
/**
|
|
794
|
+
* 推流任务状态
|
|
795
|
+
- PREPARED: 表示推流正在准备中(进房/启动推流服务等操作)
|
|
796
|
+
- PUSHING: 表示推流已开始
|
|
797
|
+
- STOPPED: 表示推流已停止
|
|
798
|
+
*/
|
|
799
|
+
Status?: string
|
|
800
|
+
/**
|
|
801
|
+
* 房间号
|
|
802
|
+
*/
|
|
803
|
+
RoomId?: number
|
|
804
|
+
/**
|
|
805
|
+
* 白板的群组 Id
|
|
806
|
+
*/
|
|
807
|
+
GroupId?: string
|
|
808
|
+
/**
|
|
809
|
+
* 推流用户Id
|
|
810
|
+
*/
|
|
811
|
+
PushUserId?: string
|
|
812
|
+
/**
|
|
813
|
+
* 实际开始推流时间,Unix 时间戳,单位秒
|
|
814
|
+
*/
|
|
815
|
+
PushStartTime?: number
|
|
816
|
+
/**
|
|
817
|
+
* 实际停止推流时间,Unix 时间戳,单位秒
|
|
818
|
+
*/
|
|
819
|
+
PushStopTime?: number
|
|
820
|
+
/**
|
|
821
|
+
* 推流过程中出现异常的次数
|
|
822
|
+
*/
|
|
823
|
+
ExceptionCnt?: number
|
|
824
|
+
/**
|
|
825
|
+
* 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
|
|
826
|
+
*/
|
|
827
|
+
IMSyncTime?: number
|
|
828
|
+
/**
|
|
829
|
+
* 备份推流任务结果信息
|
|
830
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
831
|
+
*/
|
|
832
|
+
Backup?: string
|
|
786
833
|
/**
|
|
787
834
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
788
835
|
*/
|
|
@@ -1960,13 +2007,13 @@ export interface RecordTaskSearchResult {
|
|
|
1960
2007
|
}
|
|
1961
2008
|
|
|
1962
2009
|
/**
|
|
1963
|
-
*
|
|
2010
|
+
* DescribeWarningCallback请求参数结构体
|
|
1964
2011
|
*/
|
|
1965
|
-
export interface
|
|
2012
|
+
export interface DescribeWarningCallbackRequest {
|
|
1966
2013
|
/**
|
|
1967
|
-
*
|
|
2014
|
+
* 应用的SdkAppId
|
|
1968
2015
|
*/
|
|
1969
|
-
|
|
2016
|
+
SdkAppId: number
|
|
1970
2017
|
}
|
|
1971
2018
|
|
|
1972
2019
|
/**
|
|
@@ -2040,13 +2087,29 @@ export interface ApplicationItem {
|
|
|
2040
2087
|
}
|
|
2041
2088
|
|
|
2042
2089
|
/**
|
|
2043
|
-
*
|
|
2090
|
+
* DescribeTranscodeByUrl返回参数结构体
|
|
2044
2091
|
*/
|
|
2045
|
-
export interface
|
|
2092
|
+
export interface DescribeTranscodeByUrlResponse {
|
|
2046
2093
|
/**
|
|
2047
|
-
*
|
|
2094
|
+
* 转码的当前进度,取值范围为0~100
|
|
2048
2095
|
*/
|
|
2049
|
-
|
|
2096
|
+
Progress?: number
|
|
2097
|
+
/**
|
|
2098
|
+
* 任务的当前状态
|
|
2099
|
+
- QUEUED: 正在排队等待转换
|
|
2100
|
+
- PROCESSING: 转换中
|
|
2101
|
+
- FINISHED: 转换完成
|
|
2102
|
+
- EXCEPTION: 转换异常
|
|
2103
|
+
*/
|
|
2104
|
+
Status?: string
|
|
2105
|
+
/**
|
|
2106
|
+
* 转码任务的唯一标识Id
|
|
2107
|
+
*/
|
|
2108
|
+
TaskId?: string
|
|
2109
|
+
/**
|
|
2110
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2111
|
+
*/
|
|
2112
|
+
RequestId?: string
|
|
2050
2113
|
}
|
|
2051
2114
|
|
|
2052
2115
|
/**
|
|
@@ -2243,9 +2306,9 @@ export interface PauseOnlineRecordResponse {
|
|
|
2243
2306
|
}
|
|
2244
2307
|
|
|
2245
2308
|
/**
|
|
2246
|
-
*
|
|
2309
|
+
* ModifyWhiteboardApplicationConfig返回参数结构体
|
|
2247
2310
|
*/
|
|
2248
|
-
export interface
|
|
2311
|
+
export interface ModifyWhiteboardApplicationConfigResponse {
|
|
2249
2312
|
/**
|
|
2250
2313
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2251
2314
|
*/
|
|
@@ -2626,6 +2689,20 @@ export interface StopWhiteboardPushResponse {
|
|
|
2626
2689
|
RequestId?: string
|
|
2627
2690
|
}
|
|
2628
2691
|
|
|
2692
|
+
/**
|
|
2693
|
+
* DescribeTranscodeByUrl请求参数结构体
|
|
2694
|
+
*/
|
|
2695
|
+
export interface DescribeTranscodeByUrlRequest {
|
|
2696
|
+
/**
|
|
2697
|
+
* 客户的SdkAppId
|
|
2698
|
+
*/
|
|
2699
|
+
SdkAppId: number
|
|
2700
|
+
/**
|
|
2701
|
+
* 经过URL编码后的转码文件地址。URL 编码会将字符转换为可通过因特网传输的格式,比如文档地址为http://example.com/测试.pdf,经过URL编码之后为http://example.com/%E6%B5%8B%E8%AF%95.pdf。为了提高URL解析的成功率,请对URL进行编码。
|
|
2702
|
+
*/
|
|
2703
|
+
Url: string
|
|
2704
|
+
}
|
|
2705
|
+
|
|
2629
2706
|
/**
|
|
2630
2707
|
* SetWarningCallback请求参数结构体
|
|
2631
2708
|
*/
|
|
@@ -3013,60 +3090,13 @@ export interface SetPPTCheckCallbackRequest {
|
|
|
3013
3090
|
}
|
|
3014
3091
|
|
|
3015
3092
|
/**
|
|
3016
|
-
*
|
|
3093
|
+
* DescribeApplicationUsage返回参数结构体
|
|
3017
3094
|
*/
|
|
3018
|
-
export interface
|
|
3019
|
-
/**
|
|
3020
|
-
* 推流结束原因,
|
|
3021
|
-
- AUTO: 房间内长时间没有音视频上行及白板操作导致自动停止推流
|
|
3022
|
-
- USER_CALL: 主动调用了停止推流接口
|
|
3023
|
-
- EXCEPTION: 推流异常结束
|
|
3024
|
-
*/
|
|
3025
|
-
FinishReason?: string
|
|
3026
|
-
/**
|
|
3027
|
-
* 需要查询结果的白板推流任务Id
|
|
3028
|
-
*/
|
|
3029
|
-
TaskId?: string
|
|
3030
|
-
/**
|
|
3031
|
-
* 推流任务状态
|
|
3032
|
-
- PREPARED: 表示推流正在准备中(进房/启动推流服务等操作)
|
|
3033
|
-
- PUSHING: 表示推流已开始
|
|
3034
|
-
- STOPPED: 表示推流已停止
|
|
3035
|
-
*/
|
|
3036
|
-
Status?: string
|
|
3037
|
-
/**
|
|
3038
|
-
* 房间号
|
|
3039
|
-
*/
|
|
3040
|
-
RoomId?: number
|
|
3041
|
-
/**
|
|
3042
|
-
* 白板的群组 Id
|
|
3043
|
-
*/
|
|
3044
|
-
GroupId?: string
|
|
3045
|
-
/**
|
|
3046
|
-
* 推流用户Id
|
|
3047
|
-
*/
|
|
3048
|
-
PushUserId?: string
|
|
3049
|
-
/**
|
|
3050
|
-
* 实际开始推流时间,Unix 时间戳,单位秒
|
|
3051
|
-
*/
|
|
3052
|
-
PushStartTime?: number
|
|
3053
|
-
/**
|
|
3054
|
-
* 实际停止推流时间,Unix 时间戳,单位秒
|
|
3055
|
-
*/
|
|
3056
|
-
PushStopTime?: number
|
|
3057
|
-
/**
|
|
3058
|
-
* 推流过程中出现异常的次数
|
|
3059
|
-
*/
|
|
3060
|
-
ExceptionCnt?: number
|
|
3061
|
-
/**
|
|
3062
|
-
* 白板推流首帧对应的IM时间戳,可用于录制回放时IM聊天消息与白板推流视频进行同步对时。
|
|
3063
|
-
*/
|
|
3064
|
-
IMSyncTime?: number
|
|
3095
|
+
export interface DescribeApplicationUsageResponse {
|
|
3065
3096
|
/**
|
|
3066
|
-
*
|
|
3067
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
3097
|
+
* 画图所需的用量数据
|
|
3068
3098
|
*/
|
|
3069
|
-
|
|
3099
|
+
Data: Array<DataItem>
|
|
3070
3100
|
/**
|
|
3071
3101
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3072
3102
|
*/
|
|
@@ -3156,6 +3186,16 @@ export interface CreatePPTCheckTaskResponse {
|
|
|
3156
3186
|
RequestId?: string
|
|
3157
3187
|
}
|
|
3158
3188
|
|
|
3189
|
+
/**
|
|
3190
|
+
* ModifyWhiteboardBucketConfig返回参数结构体
|
|
3191
|
+
*/
|
|
3192
|
+
export interface ModifyWhiteboardBucketConfigResponse {
|
|
3193
|
+
/**
|
|
3194
|
+
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
3195
|
+
*/
|
|
3196
|
+
RequestId?: string
|
|
3197
|
+
}
|
|
3198
|
+
|
|
3159
3199
|
/**
|
|
3160
3200
|
* CreateTranscode请求参数结构体
|
|
3161
3201
|
*/
|
|
@@ -234,7 +234,7 @@ MCU混流转码费用请参考文档:[云端混流转码计费说明](https://
|
|
|
234
234
|
转推非腾讯云CDN费用请参考文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)
|
|
235
235
|
|
|
236
236
|
参数的使用说明:
|
|
237
|
-
1、AgentParams:每个转推任务会拉起一个机器人用户进入TRTC
|
|
237
|
+
1、AgentParams:每个转推任务会拉起一个机器人用户进入TRTC房间进行拉流,您需要通过AgentParams.UserId参数进行设置,这个机器人id不能和房间中的普通用户id冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。您可以通过设置AgentParams.MaxIdleTime控制转推任务的自动结束,当设置此参数时,所有参与混流转推的主播持续离开TRTC房间超过MaxIdleTime的时长,自动停止转推任务。注意:参与混流转推的主播仅是停止音视频上行,转推任务不会自动停止。
|
|
238
238
|
2、WithTranscoding:如果需要将多路音视频流混合到一路时,WithTranscoding必须设置为1。
|
|
239
239
|
3、AudioParams:转推任务音频参数和视频参数是分开设置的,若您想要将指定的用户音频进行混音时,需要明确设置AudioParams.SubscribeAudioList。若您不设置AudioParams.SubscribeAudioList,混音引擎会自动将TRTC房间中所有用户的音频混合。若您想要混合TRTC房间除指定用户之外的所有用户的声音,可以通过AudioParams.UnSubscribeAudioList设置音频黑名单列表。
|
|
240
240
|
4、VideoParams:若您想要将用户的视频混合,可以通过VideoParams设置,若只想要混纯音频,则不用设置VideoParams参数。您可以通过VideoParams.LayoutParams.MixLayoutMode设置画面的布局模式,包括:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局)和自定义布局。动态布局模式由排版引擎按照固定的布局自动混合,不需要设置VideoParams.LayoutParams.MixLayoutList。当使用悬浮布局和屏幕分享布局时,您可以通过设置VideoParams.LayoutParams.MaxVideoUser参数指定大画面用户。自定义布局模式提供给您自主布局画面的能力,可以通过VideoParams.LayoutParams.MixLayoutList参数指定每个用户所在的布局位置。在每个布局参数中,您可以通过用户媒体流参数(UserMediaStream)指定这个布局位置为指定的用户预留,也可以不设置UserMediaStream,由排版引擎按照用户进入TRTC房间的顺序自动填充,另外您也可以设置每个布局位置的渲染方式(RenderMode)和裁剪方式(CustomCrop)。
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const sdkVersion = "4.0.
|
|
1
|
+
export declare const sdkVersion = "4.0.648";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { AbstractClient } from "../../../common/abstract_client";
|
|
2
2
|
import { ClientConfig } from "../../../common/interface";
|
|
3
|
-
import { ModifyDiskExtraPerformanceRequest, ModifyDiskAttributesResponse, DescribeDiskBackupsRequest,
|
|
3
|
+
import { ModifyDiskExtraPerformanceRequest, ModifyDiskAttributesResponse, DescribeDiskBackupsRequest, CreateDiskBackupRequest, CopySnapshotCrossRegionsResponse, ModifyAutoSnapshotPolicyAttributeResponse, ModifyDiskBackupQuotaRequest, InquiryPriceCreateDisksResponse, BindAutoSnapshotPolicyRequest, CreateSnapshotResponse, DescribeAutoSnapshotPoliciesRequest, ModifySnapshotsSharePermissionResponse, DeleteDiskBackupsRequest, InitializeDisksResponse, DescribeDiskStoragePoolRequest, DescribeDiskBackupsResponse, RenewDiskRequest, InquirePriceModifyDiskExtraPerformanceResponse, CreateDisksRequest, AttachDisksRequest, DescribeDiskAssociatedAutoSnapshotPolicyRequest, DescribeSnapshotsRequest, ModifyAutoSnapshotPolicyAttributeRequest, DescribeDiskConfigQuotaResponse, ApplyDiskBackupResponse, InquiryPriceResizeDiskResponse, ResizeDiskResponse, TerminateDisksResponse, ApplySnapshotResponse, DetachDisksRequest, ModifyDisksChargeTypeResponse, CreateSnapshotRequest, DescribeInstancesDiskNumRequest, DescribeSnapshotSharePermissionResponse, ModifyDiskBackupQuotaResponse, InquiryPriceRenewDisksRequest, DescribeSnapshotSharePermissionRequest, InquirePriceModifyDiskBackupQuotaRequest, DeleteDiskBackupsResponse, DeleteSnapshotsRequest, ModifyDisksRenewFlagResponse, DeleteAutoSnapshotPoliciesResponse, DescribeDisksResponse, DeleteSnapshotsResponse, ModifyDisksRenewFlagRequest, ModifySnapshotAttributeResponse, ModifyDiskAttributesRequest, GetSnapOverviewRequest, TerminateDisksRequest, DescribeInstancesDiskNumResponse, ResizeDiskRequest, ApplyDiskBackupRequest, ModifyDisksChargeTypeRequest, InitializeDisksRequest, CreateAutoSnapshotPolicyResponse, ModifySnapshotAttributeRequest, UnbindAutoSnapshotPolicyRequest, CreateDiskBackupResponse, InquirePriceModifyDiskBackupQuotaResponse, DeleteAutoSnapshotPoliciesRequest, InquiryPriceCreateDisksRequest, DescribeSnapshotsResponse, CreateDisksResponse, AttachDisksResponse, ModifySnapshotsSharePermissionRequest, BindAutoSnapshotPolicyResponse, DescribeDisksRequest, DetachDisksResponse, InquiryPriceRenewDisksResponse, DescribeDiskStoragePoolResponse, ModifyDiskExtraPerformanceResponse, InquirePriceModifyDiskExtraPerformanceRequest, InquiryPriceResizeDiskRequest, DescribeDiskConfigQuotaRequest, DescribeDiskAssociatedAutoSnapshotPolicyResponse, GetSnapOverviewResponse, CopySnapshotCrossRegionsRequest, RenewDiskResponse, DescribeAutoSnapshotPoliciesResponse, UnbindAutoSnapshotPolicyResponse, CreateAutoSnapshotPolicyRequest, ApplySnapshotRequest } from "./cbs_models";
|
|
4
4
|
/**
|
|
5
5
|
* cbs client
|
|
6
6
|
* @class
|
|
@@ -95,12 +95,6 @@ export declare class Client extends AbstractClient {
|
|
|
95
95
|
如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的备份点列表。
|
|
96
96
|
*/
|
|
97
97
|
DescribeDiskBackups(req: DescribeDiskBackupsRequest, cb?: (error: string, rep: DescribeDiskBackupsResponse) => void): Promise<DescribeDiskBackupsResponse>;
|
|
98
|
-
/**
|
|
99
|
-
* 接口已废弃,切换至云审计接口。见https://tapd.woa.com/pro/prong/stories/view/1010114221880719007
|
|
100
|
-
|
|
101
|
-
查询云盘操作日志功能已迁移至LookUpEvents接口(https://cloud.tencent.com/document/product/629/12359),本接口(DescribeDiskOperationLogs)即将下线,后续不再提供调用,请知悉。
|
|
102
|
-
*/
|
|
103
|
-
DescribeDiskOperationLogs(req: DescribeDiskOperationLogsRequest, cb?: (error: string, rep: DescribeDiskOperationLogsResponse) => void): Promise<DescribeDiskOperationLogsResponse>;
|
|
104
98
|
/**
|
|
105
99
|
* 本接口(DeleteAutoSnapshotPolicies)用于删除定期快照策略。
|
|
106
100
|
|
|
@@ -228,13 +222,6 @@ export declare class Client extends AbstractClient {
|
|
|
228
222
|
* 如果是弹性云盘,则云盘必须处于未挂载状态,云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询,见Attached字段解释;如果是随实例一起购买的非弹性云盘,则实例必须处于关机状态,实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
|
|
229
223
|
*/
|
|
230
224
|
ApplySnapshot(req: ApplySnapshotRequest, cb?: (error: string, rep: ApplySnapshotResponse) => void): Promise<ApplySnapshotResponse>;
|
|
231
|
-
/**
|
|
232
|
-
* 接口已废弃,切换至云审计接口。见https://tapd.woa.com/pro/prong/stories/view/1010114221880719007
|
|
233
|
-
|
|
234
|
-
查询快照操作日志功能已迁移至LookUpEvents接口(https://cloud.tencent.com/document/product/629/12359),本接口(DescribeSnapshotOperationLogs)即将下线,后续不再提供调用,请知悉。
|
|
235
|
-
|
|
236
|
-
*/
|
|
237
|
-
DescribeSnapshotOperationLogs(req: DescribeSnapshotOperationLogsRequest, cb?: (error: string, rep: DescribeSnapshotOperationLogsResponse) => void): Promise<DescribeSnapshotOperationLogsResponse>;
|
|
238
225
|
/**
|
|
239
226
|
* 本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。
|
|
240
227
|
|
|
@@ -246,12 +233,13 @@ export declare class Client extends AbstractClient {
|
|
|
246
233
|
*/
|
|
247
234
|
ModifySnapshotsSharePermission(req: ModifySnapshotsSharePermissionRequest, cb?: (error: string, rep: ModifySnapshotsSharePermissionResponse) => void): Promise<ModifySnapshotsSharePermissionResponse>;
|
|
248
235
|
/**
|
|
249
|
-
* 本接口(
|
|
236
|
+
* 本接口(CreateSnapshot)用于对指定云盘创建快照。
|
|
250
237
|
|
|
251
|
-
*
|
|
252
|
-
*
|
|
238
|
+
* 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询,见SnapshotAbility字段。
|
|
239
|
+
* 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
|
|
240
|
+
* 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。
|
|
253
241
|
*/
|
|
254
|
-
|
|
242
|
+
CreateSnapshot(req: CreateSnapshotRequest, cb?: (error: string, rep: CreateSnapshotResponse) => void): Promise<CreateSnapshotResponse>;
|
|
255
243
|
/**
|
|
256
244
|
* 获取快照概览信息
|
|
257
245
|
*/
|
|
@@ -264,13 +252,12 @@ export declare class Client extends AbstractClient {
|
|
|
264
252
|
*/
|
|
265
253
|
ResizeDisk(req: ResizeDiskRequest, cb?: (error: string, rep: ResizeDiskResponse) => void): Promise<ResizeDiskResponse>;
|
|
266
254
|
/**
|
|
267
|
-
* 本接口(
|
|
255
|
+
* 本接口(DetachDisks)用于卸载云硬盘。
|
|
268
256
|
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
* 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。
|
|
257
|
+
* 支持批量操作,卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘,则操作不执行,返回特定的错误码。
|
|
258
|
+
* 本接口为异步接口,当请求成功返回时,云盘并未立即从主机卸载,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHED”变为“UNATTACHED”,则为卸载成功。
|
|
272
259
|
*/
|
|
273
|
-
|
|
260
|
+
DetachDisks(req: DetachDisksRequest, cb?: (error: string, rep: DetachDisksResponse) => void): Promise<DetachDisksResponse>;
|
|
274
261
|
/**
|
|
275
262
|
* 本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。
|
|
276
263
|
|
|
@@ -145,14 +145,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
145
145
|
async DescribeDiskBackups(req, cb) {
|
|
146
146
|
return this.request("DescribeDiskBackups", req, cb);
|
|
147
147
|
}
|
|
148
|
-
/**
|
|
149
|
-
* 接口已废弃,切换至云审计接口。见https://tapd.woa.com/pro/prong/stories/view/1010114221880719007
|
|
150
|
-
|
|
151
|
-
查询云盘操作日志功能已迁移至LookUpEvents接口(https://cloud.tencent.com/document/product/629/12359),本接口(DescribeDiskOperationLogs)即将下线,后续不再提供调用,请知悉。
|
|
152
|
-
*/
|
|
153
|
-
async DescribeDiskOperationLogs(req, cb) {
|
|
154
|
-
return this.request("DescribeDiskOperationLogs", req, cb);
|
|
155
|
-
}
|
|
156
148
|
/**
|
|
157
149
|
* 本接口(DeleteAutoSnapshotPolicies)用于删除定期快照策略。
|
|
158
150
|
|
|
@@ -320,15 +312,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
320
312
|
async ApplySnapshot(req, cb) {
|
|
321
313
|
return this.request("ApplySnapshot", req, cb);
|
|
322
314
|
}
|
|
323
|
-
/**
|
|
324
|
-
* 接口已废弃,切换至云审计接口。见https://tapd.woa.com/pro/prong/stories/view/1010114221880719007
|
|
325
|
-
|
|
326
|
-
查询快照操作日志功能已迁移至LookUpEvents接口(https://cloud.tencent.com/document/product/629/12359),本接口(DescribeSnapshotOperationLogs)即将下线,后续不再提供调用,请知悉。
|
|
327
|
-
|
|
328
|
-
*/
|
|
329
|
-
async DescribeSnapshotOperationLogs(req, cb) {
|
|
330
|
-
return this.request("DescribeSnapshotOperationLogs", req, cb);
|
|
331
|
-
}
|
|
332
315
|
/**
|
|
333
316
|
* 本接口(ModifySnapshotsSharePermission)用于修改快照分享信息。
|
|
334
317
|
|
|
@@ -342,13 +325,14 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
342
325
|
return this.request("ModifySnapshotsSharePermission", req, cb);
|
|
343
326
|
}
|
|
344
327
|
/**
|
|
345
|
-
* 本接口(
|
|
328
|
+
* 本接口(CreateSnapshot)用于对指定云盘创建快照。
|
|
346
329
|
|
|
347
|
-
*
|
|
348
|
-
*
|
|
330
|
+
* 只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询,见SnapshotAbility字段。
|
|
331
|
+
* 可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
|
|
332
|
+
* 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。
|
|
349
333
|
*/
|
|
350
|
-
async
|
|
351
|
-
return this.request("
|
|
334
|
+
async CreateSnapshot(req, cb) {
|
|
335
|
+
return this.request("CreateSnapshot", req, cb);
|
|
352
336
|
}
|
|
353
337
|
/**
|
|
354
338
|
* 获取快照概览信息
|
|
@@ -366,14 +350,13 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
366
350
|
return this.request("ResizeDisk", req, cb);
|
|
367
351
|
}
|
|
368
352
|
/**
|
|
369
|
-
* 本接口(
|
|
353
|
+
* 本接口(DetachDisks)用于卸载云硬盘。
|
|
370
354
|
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
* 当前支持将备份点转化为普通快照,转化之后可能会收取快照使用费用,备份点不保留,其占用的备份点配额也将被释放。
|
|
355
|
+
* 支持批量操作,卸载挂载在同一主机上的多块云盘。如果多块云盘中存在不允许卸载的云盘,则操作不执行,返回特定的错误码。
|
|
356
|
+
* 本接口为异步接口,当请求成功返回时,云盘并未立即从主机卸载,可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态,如果云盘的状态由“ATTACHED”变为“UNATTACHED”,则为卸载成功。
|
|
374
357
|
*/
|
|
375
|
-
async
|
|
376
|
-
return this.request("
|
|
358
|
+
async DetachDisks(req, cb) {
|
|
359
|
+
return this.request("DetachDisks", req, cb);
|
|
377
360
|
}
|
|
378
361
|
/**
|
|
379
362
|
* 本接口(InquiryPriceRenewDisks)用于续费云硬盘询价。
|
|
@@ -1,43 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* 快照操作日志,已废弃。
|
|
3
|
-
*/
|
|
4
|
-
export interface SnapshotOperationLog {
|
|
5
|
-
/**
|
|
6
|
-
* 操作的状态。取值范围:
|
|
7
|
-
SUCCESS :表示操作成功
|
|
8
|
-
FAILED :表示操作失败
|
|
9
|
-
PROCESSING :表示操作中。
|
|
10
|
-
*/
|
|
11
|
-
OperationState: string;
|
|
12
|
-
/**
|
|
13
|
-
* 开始时间。
|
|
14
|
-
*/
|
|
15
|
-
StartTime: string;
|
|
16
|
-
/**
|
|
17
|
-
* 操作者的UIN。
|
|
18
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
19
|
-
*/
|
|
20
|
-
Operator: string;
|
|
21
|
-
/**
|
|
22
|
-
* 操作的快照ID。
|
|
23
|
-
*/
|
|
24
|
-
SnapshotId: string;
|
|
25
|
-
/**
|
|
26
|
-
* 操作类型。取值范围:
|
|
27
|
-
SNAP_OPERATION_DELETE:删除快照
|
|
28
|
-
SNAP_OPERATION_ROLLBACK:回滚快照
|
|
29
|
-
SNAP_OPERATION_MODIFY:修改快照属性
|
|
30
|
-
SNAP_OPERATION_CREATE:创建快照
|
|
31
|
-
SNAP_OPERATION_COPY:跨地域复制快照
|
|
32
|
-
ASP_OPERATION_CREATE_SNAP:由定期快照策略创建快照
|
|
33
|
-
ASP_OPERATION_DELETE_SNAP:由定期快照策略删除快照
|
|
34
|
-
*/
|
|
35
|
-
Operation: string;
|
|
36
|
-
/**
|
|
37
|
-
* 结束时间。
|
|
38
|
-
*/
|
|
39
|
-
EndTime: string;
|
|
40
|
-
}
|
|
41
1
|
/**
|
|
42
2
|
* ModifyDiskExtraPerformance请求参数结构体
|
|
43
3
|
*/
|
|
@@ -236,39 +196,17 @@ export interface DetailPrice {
|
|
|
236
196
|
UnitPriceDiscountHigh?: string;
|
|
237
197
|
}
|
|
238
198
|
/**
|
|
239
|
-
*
|
|
240
|
-
*/
|
|
241
|
-
export interface DescribeSnapshotOperationLogsRequest {
|
|
242
|
-
/**
|
|
243
|
-
* 过滤条件。支持以下条件:
|
|
244
|
-
<li>snapshot-id - Array of String - 是否必填:是 - 按快照ID过滤,每个请求最多可指定10个快照ID。
|
|
245
|
-
*/
|
|
246
|
-
Filters: Array<Filter>;
|
|
247
|
-
/**
|
|
248
|
-
* 要查询的操作日志的截止时间,例如:“2019-11-22 23:59:59"
|
|
249
|
-
*/
|
|
250
|
-
EndTime?: string;
|
|
251
|
-
/**
|
|
252
|
-
* 要查询的操作日志的起始时间,例如:“2019-11-22 00:00:00"
|
|
253
|
-
*/
|
|
254
|
-
BeginTime?: string;
|
|
255
|
-
}
|
|
256
|
-
/**
|
|
257
|
-
* ModifySnapshotsSharePermission请求参数结构体
|
|
199
|
+
* CreateDiskBackup请求参数结构体
|
|
258
200
|
*/
|
|
259
|
-
export interface
|
|
260
|
-
/**
|
|
261
|
-
* 快照ID, 可通过[DescribeSnapshots](https://cloud.tencent.com/document/api/362/15647)查询获取。
|
|
262
|
-
*/
|
|
263
|
-
SnapshotIds: Array<string>;
|
|
201
|
+
export interface CreateDiskBackupRequest {
|
|
264
202
|
/**
|
|
265
|
-
*
|
|
203
|
+
* 要创建备份点的云硬盘名称。
|
|
266
204
|
*/
|
|
267
|
-
|
|
205
|
+
DiskId: string;
|
|
268
206
|
/**
|
|
269
|
-
*
|
|
207
|
+
* 云硬盘备份点名称。长度不能超过100个字符。
|
|
270
208
|
*/
|
|
271
|
-
|
|
209
|
+
DiskBackupName?: string;
|
|
272
210
|
}
|
|
273
211
|
/**
|
|
274
212
|
* CopySnapshotCrossRegions返回参数结构体
|
|
@@ -401,15 +339,6 @@ export interface InitializeDisksResponse {
|
|
|
401
339
|
*/
|
|
402
340
|
RequestId?: string;
|
|
403
341
|
}
|
|
404
|
-
/**
|
|
405
|
-
* DeleteDiskBackups返回参数结构体
|
|
406
|
-
*/
|
|
407
|
-
export interface DeleteDiskBackupsResponse {
|
|
408
|
-
/**
|
|
409
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
410
|
-
*/
|
|
411
|
-
RequestId?: string;
|
|
412
|
-
}
|
|
413
342
|
/**
|
|
414
343
|
* DescribeDiskStoragePool请求参数结构体
|
|
415
344
|
*/
|
|
@@ -1069,13 +998,9 @@ export interface InquirePriceModifyDiskBackupQuotaRequest {
|
|
|
1069
998
|
DiskBackupQuota: number;
|
|
1070
999
|
}
|
|
1071
1000
|
/**
|
|
1072
|
-
*
|
|
1001
|
+
* DeleteDiskBackups返回参数结构体
|
|
1073
1002
|
*/
|
|
1074
|
-
export interface
|
|
1075
|
-
/**
|
|
1076
|
-
* 快照操作日志列表。
|
|
1077
|
-
*/
|
|
1078
|
-
SnapshotOperationLogSet: Array<SnapshotOperationLog>;
|
|
1003
|
+
export interface DeleteDiskBackupsResponse {
|
|
1079
1004
|
/**
|
|
1080
1005
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1081
1006
|
*/
|
|
@@ -1286,19 +1211,6 @@ export interface DescribeInstancesDiskNumResponse {
|
|
|
1286
1211
|
*/
|
|
1287
1212
|
RequestId?: string;
|
|
1288
1213
|
}
|
|
1289
|
-
/**
|
|
1290
|
-
* DescribeDiskOperationLogs返回参数结构体
|
|
1291
|
-
*/
|
|
1292
|
-
export interface DescribeDiskOperationLogsResponse {
|
|
1293
|
-
/**
|
|
1294
|
-
* 云盘的操作日志列表。
|
|
1295
|
-
*/
|
|
1296
|
-
DiskOperationLogSet: Array<DiskOperationLog>;
|
|
1297
|
-
/**
|
|
1298
|
-
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
1299
|
-
*/
|
|
1300
|
-
RequestId?: string;
|
|
1301
|
-
}
|
|
1302
1214
|
/**
|
|
1303
1215
|
* ResizeDisk请求参数结构体
|
|
1304
1216
|
*/
|
|
@@ -1688,58 +1600,21 @@ export interface AttachDisksResponse {
|
|
|
1688
1600
|
RequestId?: string;
|
|
1689
1601
|
}
|
|
1690
1602
|
/**
|
|
1691
|
-
*
|
|
1692
|
-
*/
|
|
1693
|
-
export interface CreateDiskBackupRequest {
|
|
1694
|
-
/**
|
|
1695
|
-
* 要创建备份点的云硬盘名称。
|
|
1696
|
-
*/
|
|
1697
|
-
DiskId: string;
|
|
1698
|
-
/**
|
|
1699
|
-
* 云硬盘备份点名称。长度不能超过100个字符。
|
|
1700
|
-
*/
|
|
1701
|
-
DiskBackupName?: string;
|
|
1702
|
-
}
|
|
1703
|
-
/**
|
|
1704
|
-
* 云盘操作日志。
|
|
1603
|
+
* ModifySnapshotsSharePermission请求参数结构体
|
|
1705
1604
|
*/
|
|
1706
|
-
export interface
|
|
1707
|
-
/**
|
|
1708
|
-
* 操作的状态。取值范围:
|
|
1709
|
-
SUCCESS :表示操作成功
|
|
1710
|
-
FAILED :表示操作失败
|
|
1711
|
-
PROCESSING :表示操作中。
|
|
1712
|
-
*/
|
|
1713
|
-
OperationState: string;
|
|
1714
|
-
/**
|
|
1715
|
-
* 开始时间。
|
|
1716
|
-
*/
|
|
1717
|
-
StartTime: string;
|
|
1718
|
-
/**
|
|
1719
|
-
* 操作者的UIN。
|
|
1720
|
-
*/
|
|
1721
|
-
Operator: string;
|
|
1605
|
+
export interface ModifySnapshotsSharePermissionRequest {
|
|
1722
1606
|
/**
|
|
1723
|
-
*
|
|
1724
|
-
CBS_OPERATION_ATTACH:挂载云硬盘
|
|
1725
|
-
CBS_OPERATION_DETACH:解挂云硬盘
|
|
1726
|
-
CBS_OPERATION_RENEW:续费
|
|
1727
|
-
CBS_OPERATION_EXPAND:扩容
|
|
1728
|
-
CBS_OPERATION_CREATE:创建
|
|
1729
|
-
CBS_OPERATION_ISOLATE:隔离
|
|
1730
|
-
CBS_OPERATION_MODIFY:修改云硬盘属性
|
|
1731
|
-
ASP_OPERATION_BIND:关联定期快照策略
|
|
1732
|
-
ASP_OPERATION_UNBIND:取消关联定期快照策略
|
|
1607
|
+
* 快照ID, 可通过[DescribeSnapshots](https://cloud.tencent.com/document/api/362/15647)查询获取。
|
|
1733
1608
|
*/
|
|
1734
|
-
|
|
1609
|
+
SnapshotIds: Array<string>;
|
|
1735
1610
|
/**
|
|
1736
|
-
*
|
|
1611
|
+
* 接收分享快照的账号Id列表,array型参数的格式可以参考[API简介](https://cloud.tencent.com/document/api/213/568)。帐号ID不同于QQ号,查询用户帐号ID请查看[帐号信息](https://console.cloud.tencent.com/developer)中的帐号ID栏。
|
|
1737
1612
|
*/
|
|
1738
|
-
|
|
1613
|
+
AccountIds: Array<string>;
|
|
1739
1614
|
/**
|
|
1740
|
-
*
|
|
1615
|
+
* 操作,包括 SHARE,CANCEL。其中SHARE代表分享操作,CANCEL代表取消分享操作。
|
|
1741
1616
|
*/
|
|
1742
|
-
|
|
1617
|
+
Permission: string;
|
|
1743
1618
|
}
|
|
1744
1619
|
/**
|
|
1745
1620
|
* BindAutoSnapshotPolicy返回参数结构体
|
|
@@ -1750,24 +1625,6 @@ export interface BindAutoSnapshotPolicyResponse {
|
|
|
1750
1625
|
*/
|
|
1751
1626
|
RequestId?: string;
|
|
1752
1627
|
}
|
|
1753
|
-
/**
|
|
1754
|
-
* DescribeDiskOperationLogs请求参数结构体
|
|
1755
|
-
*/
|
|
1756
|
-
export interface DescribeDiskOperationLogsRequest {
|
|
1757
|
-
/**
|
|
1758
|
-
* 过滤条件。支持以下条件:
|
|
1759
|
-
<li>disk-id - Array of String - 是否必填:是 - 按云盘ID过滤,每个请求最多可指定10个云盘ID。
|
|
1760
|
-
*/
|
|
1761
|
-
Filters: Array<Filter>;
|
|
1762
|
-
/**
|
|
1763
|
-
* 要查询的操作日志的截止时间,例如:“2019-11-22 23:59:59"
|
|
1764
|
-
*/
|
|
1765
|
-
EndTime?: string;
|
|
1766
|
-
/**
|
|
1767
|
-
* 要查询的操作日志的起始时间,例如:“2019-11-22 00:00:00"
|
|
1768
|
-
*/
|
|
1769
|
-
BeginTime?: string;
|
|
1770
|
-
}
|
|
1771
1628
|
/**
|
|
1772
1629
|
* 云硬盘备份点。
|
|
1773
1630
|
*/
|