| Modifier and Type | Method and Description |
|---|---|
ChatResponse |
AaiClient.Chat(ChatRequest req)
提供基于文本的基础聊天能力，可以让您的应用快速拥有具备深度语义理解的机器聊天功能。
|
SentenceRecognitionResponse |
AaiClient.SentenceRecognition(SentenceRecognitionRequest req)
识别60s内的短语音，当音频放在请求body中传输时整个请求大小不能超过600KB，当音频以url方式传输时，音频时长不可超过60s。所有请求参数放在post的body中采用x-www-form-urlencoded（数据转换成一个字符串（name1=value1&name2=value2…）进行urlencode后）编码传输。现暂只支持中文普通话识别，支持识别8k(16k)的16bit的mp3或者wav音频。
|
SimultaneousInterpretingResponse |
AaiClient.SimultaneousInterpreting(SimultaneousInterpretingRequest req)
该接口是实时流式识别，可同时返回语音识别文本及翻译文本，当前仅支持中文和英文。该接口可配合同传windows客户端，提供会议现场同传服务。
|
TextToVoiceResponse |
AaiClient.TextToVoice(TextToVoiceRequest req)
腾讯云语音合成技术（TTS）可以将任意文本转化为语音，实现让机器和应用张口说话。
腾讯TTS技术可以应用到很多场景，比如，移动APP语音播报新闻；智能设备语音提醒；依靠网上现有节目或少量录音，快速合成明星语音，降低邀约成本；支持车载导航语音合成的个性化语音播报。
内测期间免费使用。
|
| Modifier and Type | Method and Description |
|---|---|
AttachInstancesResponse |
AsClient.AttachInstances(AttachInstancesRequest req)
本接口（AttachInstances）用于将 CVM 实例添加到伸缩组。
|
CompleteLifecycleActionResponse |
AsClient.CompleteLifecycleAction(CompleteLifecycleActionRequest req)
本接口（CompleteLifecycleAction）用于完成生命周期动作。
用户通过调用本接口，指定一个具体的生命周期挂钩的结果（“CONITNUE”或者“ABANDON”）。如果一直不调用本接口，则生命周期挂钩会在超时后按照“DefaultResult”进行处理。
|
CreateAutoScalingGroupResponse |
AsClient.CreateAutoScalingGroup(CreateAutoScalingGroupRequest req)
本接口（CreateAutoScalingGroup）用于创建伸缩组
|
CreateLaunchConfigurationResponse |
AsClient.CreateLaunchConfiguration(CreateLaunchConfigurationRequest req)
本接口（CreateLaunchConfiguration）用于创建新的启动配置。
启动配置，可以通过 `ModifyLaunchConfigurationAttributes` 修改少量字段。如需使用新的启动配置，建议重新创建启动配置。
每个项目最多只能创建20个启动配置，详见[使用限制](https://cloud.tencent.com/document/product/377/3120)。
|
CreateLifecycleHookResponse |
AsClient.CreateLifecycleHook(CreateLifecycleHookRequest req)
本接口（CreateLifecycleHook）用于创建生命周期挂钩。
您可以为生命周期挂钩配置消息通知，弹性伸缩会通知您的CMQ消息队列，通知内容形如：
```
{
"Service": "Tencent Cloud Auto Scaling",
"Time": "2019-03-14T10:15:11Z",
"AppId": "1251783334",
"ActivityId": "asa-fznnvrja",
"AutoScalingGroupId": "asg-rrrrtttt",
"LifecycleHookId": "ash-xxxxyyyy",
"LifecycleHookName": "my-hook",
"LifecycleActionToken": "3080e1c9-0efe-4dd7-ad3b-90cd6618298f",
"InstanceId": "ins-aaaabbbb",
"LifecycleTransition": "INSTANCE_LAUNCHING",
"NotificationMetadata": ""
}
```
|
CreateNotificationConfigurationResponse |
AsClient.CreateNotificationConfiguration(CreateNotificationConfigurationRequest req)
本接口（CreateNotificationConfiguration）用于创建通知。
|
CreatePaiInstanceResponse |
AsClient.CreatePaiInstance(CreatePaiInstanceRequest req)
本接口 (CreatePaiInstance) 用于创建一个指定配置的PAI实例。
|
CreateScalingPolicyResponse |
AsClient.CreateScalingPolicy(CreateScalingPolicyRequest req)
本接口（CreateScalingPolicy）用于创建告警触发策略。
|
CreateScheduledActionResponse |
AsClient.CreateScheduledAction(CreateScheduledActionRequest req)
本接口（CreateScheduledAction）用于创建定时任务。
|
DeleteAutoScalingGroupResponse |
AsClient.DeleteAutoScalingGroup(DeleteAutoScalingGroupRequest req)
本接口（DeleteAutoScalingGroup）用于删除指定伸缩组，删除前提是伸缩组内无实例且当前未在执行伸缩活动。
|
DeleteLaunchConfigurationResponse |
AsClient.DeleteLaunchConfiguration(DeleteLaunchConfigurationRequest req)
本接口（DeleteLaunchConfiguration）用于删除启动配置。
若启动配置在伸缩组中属于生效状态，则该启动配置不允许删除。
|
DeleteLifecycleHookResponse |
AsClient.DeleteLifecycleHook(DeleteLifecycleHookRequest req)
本接口（DeleteLifecycleHook）用于删除生命周期挂钩。
|
DeleteNotificationConfigurationResponse |
AsClient.DeleteNotificationConfiguration(DeleteNotificationConfigurationRequest req)
本接口（DeleteNotificationConfiguration）用于删除特定的通知。
|
DeleteScalingPolicyResponse |
AsClient.DeleteScalingPolicy(DeleteScalingPolicyRequest req)
本接口（DeleteScalingPolicy）用于删除告警触发策略。
|
DeleteScheduledActionResponse |
AsClient.DeleteScheduledAction(DeleteScheduledActionRequest req)
本接口（DeleteScheduledAction）用于删除特定的定时任务。
|
DescribeAccountLimitsResponse |
AsClient.DescribeAccountLimits(DescribeAccountLimitsRequest req)
本接口（DescribeAccountLimits）用于查询用户账户在弹性伸缩中的资源限制。
|
DescribeAutoScalingActivitiesResponse |
AsClient.DescribeAutoScalingActivities(DescribeAutoScalingActivitiesRequest req)
本接口（DescribeAutoScalingActivities）用于查询伸缩组的伸缩活动记录。
|
DescribeAutoScalingGroupLastActivitiesResponse |
AsClient.DescribeAutoScalingGroupLastActivities(DescribeAutoScalingGroupLastActivitiesRequest req)
本接口（DescribeAutoScalingGroupLastActivities）用于查询伸缩组的最新一次伸缩活动记录。
|
DescribeAutoScalingGroupsResponse |
AsClient.DescribeAutoScalingGroups(DescribeAutoScalingGroupsRequest req)
本接口（DescribeAutoScalingGroups）用于查询伸缩组信息。
可以根据伸缩组ID、伸缩组名称或者启动配置ID等信息来查询伸缩组的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的伸缩组。
|
DescribeAutoScalingInstancesResponse |
AsClient.DescribeAutoScalingInstances(DescribeAutoScalingInstancesRequest req)
本接口（DescribeAutoScalingInstances）用于查询弹性伸缩关联实例的信息。
可以根据实例ID、伸缩组ID等信息来查询实例的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的实例。
|
DescribeLaunchConfigurationsResponse |
AsClient.DescribeLaunchConfigurations(DescribeLaunchConfigurationsRequest req)
本接口（DescribeLaunchConfigurations）用于查询启动配置的信息。
可以根据启动配置ID、启动配置名称等信息来查询启动配置的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的启动配置。
|
DescribeLifecycleHooksResponse |
AsClient.DescribeLifecycleHooks(DescribeLifecycleHooksRequest req)
本接口（DescribeLifecycleHooks）用于查询生命周期挂钩信息。
可以根据伸缩组ID、生命周期挂钩ID或者生命周期挂钩名称等信息来查询生命周期挂钩的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的生命周期挂钩。
|
DescribeNotificationConfigurationsResponse |
AsClient.DescribeNotificationConfigurations(DescribeNotificationConfigurationsRequest req)
本接口 (DescribeNotificationConfigurations) 用于查询一个或多个通知的详细信息。
可以根据通知ID、伸缩组ID等信息来查询通知的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的通知。
|
DescribePaiInstancesResponse |
AsClient.DescribePaiInstances(DescribePaiInstancesRequest req)
本接口（DescribePaiInstances）用于查询PAI实例信息。
可以根据实例ID、实例域名等信息来查询PAI实例的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的PAI实例。
|
DescribeScalingPoliciesResponse |
AsClient.DescribeScalingPolicies(DescribeScalingPoliciesRequest req)
本接口（DescribeScalingPolicies）用于查询告警触发策略。
|
DescribeScheduledActionsResponse |
AsClient.DescribeScheduledActions(DescribeScheduledActionsRequest req)
本接口 (DescribeScheduledActions) 用于查询一个或多个定时任务的详细信息。
可以根据定时任务ID、定时任务名称或者伸缩组ID等信息来查询定时任务的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的定时任务。
|
DetachInstancesResponse |
AsClient.DetachInstances(DetachInstancesRequest req)
本接口（DetachInstances）用于从伸缩组移出 CVM 实例，本接口不会销毁实例。
|
DisableAutoScalingGroupResponse |
AsClient.DisableAutoScalingGroup(DisableAutoScalingGroupRequest req)
本接口（DisableAutoScalingGroup）用于停用指定伸缩组。
|
EnableAutoScalingGroupResponse |
AsClient.EnableAutoScalingGroup(EnableAutoScalingGroupRequest req)
本接口（EnableAutoScalingGroup）用于启用指定伸缩组。
|
ExecuteScalingPolicyResponse |
AsClient.ExecuteScalingPolicy(ExecuteScalingPolicyRequest req)
本接口（ExecuteScalingPolicy）用于执行伸缩策略。
可以根据伸缩策略ID执行伸缩策略。
伸缩策略所属伸缩组处于伸缩活动时，会拒绝执行伸缩策略。
|
ModifyAutoScalingGroupResponse |
AsClient.ModifyAutoScalingGroup(ModifyAutoScalingGroupRequest req)
本接口（ModifyAutoScalingGroup）用于修改伸缩组。
|
ModifyDesiredCapacityResponse |
AsClient.ModifyDesiredCapacity(ModifyDesiredCapacityRequest req)
本接口（ModifyDesiredCapacity）用于修改指定伸缩组的期望实例数
|
ModifyLaunchConfigurationAttributesResponse |
AsClient.ModifyLaunchConfigurationAttributes(ModifyLaunchConfigurationAttributesRequest req)
本接口（ModifyLaunchConfigurationAttributes）用于修改启动配置部分属性。
修改启动配置后，已经使用该启动配置扩容的存量实例不会发生变更，此后使用该启动配置的新增实例会按照新的配置进行扩容。
本接口支持修改部分简单类型。
|
ModifyLoadBalancersResponse |
AsClient.ModifyLoadBalancers(ModifyLoadBalancersRequest req)
本接口（ModifyLoadBalancers）用于修改伸缩组的负载均衡器。
本接口用于为伸缩组指定新的负载均衡器配置，采用“完全覆盖”风格，无论之前配置如何，统一按照接口参数配置为新的负载均衡器。
如果要为伸缩组清空负载均衡器，则在调用本接口时仅指定伸缩组ID，不指定具体负载均衡器。
本接口会立即修改伸缩组的负载均衡器，并生成一个伸缩活动，异步修改存量实例的负载均衡器。
|
ModifyNotificationConfigurationResponse |
AsClient.ModifyNotificationConfiguration(ModifyNotificationConfigurationRequest req)
本接口（ModifyNotificationConfiguration）用于修改通知。
|
ModifyScalingPolicyResponse |
AsClient.ModifyScalingPolicy(ModifyScalingPolicyRequest req)
本接口（ModifyScalingPolicy）用于修改告警触发策略。
|
ModifyScheduledActionResponse |
AsClient.ModifyScheduledAction(ModifyScheduledActionRequest req)
本接口（ModifyScheduledAction）用于修改定时任务。
|
PreviewPaiDomainNameResponse |
AsClient.PreviewPaiDomainName(PreviewPaiDomainNameRequest req)
本接口（PreviewPaiDomainName）用于预览PAI实例域名。
|
RemoveInstancesResponse |
AsClient.RemoveInstances(RemoveInstancesRequest req)
本接口（RemoveInstances）用于从伸缩组删除 CVM 实例。根据当前的产品逻辑，如果实例由弹性伸缩自动创建，则实例会被销毁；如果实例系创建后加入伸缩组的，则会从伸缩组中移除，保留实例。
|
SetInstancesProtectionResponse |
AsClient.SetInstancesProtection(SetInstancesProtectionRequest req)
本接口（SetInstancesProtection）用于设置实例移除保护。
子机设置为移除保护之后，当发生不健康替换、报警策略、期望值变更等触发缩容时，将不对此子机缩容操作。
|
UpgradeLaunchConfigurationResponse |
AsClient.UpgradeLaunchConfiguration(UpgradeLaunchConfigurationRequest req)
本接口（UpgradeLaunchConfiguration）用于升级启动配置。
本接口用于升级启动配置，采用“完全覆盖”风格，无论之前参数如何，统一按照接口参数设置为新的配置。对于非必填字段，不填写则按照默认值赋值。
升级修改启动配置后，已经使用该启动配置扩容的存量实例不会发生变更，此后使用该启动配置的新增实例会按照新的配置进行扩容。
|
UpgradeLifecycleHookResponse |
AsClient.UpgradeLifecycleHook(UpgradeLifecycleHookRequest req)
本接口（UpgradeLifecycleHook）用于升级生命周期挂钩。
本接口用于升级生命周期挂钩，采用“完全覆盖”风格，无论之前参数如何，统一按照接口参数设置为新的配置。对于非必填字段，不填写则按照默认值赋值。
|
| Modifier and Type | Method and Description |
|---|---|
CreateRecTaskResponse |
AsrClient.CreateRecTask(CreateRecTaskRequest req)
本接口服务对录音时长1小时以内的录音文件进行识别，异步返回识别全部结果。
• 支持回调或轮询的方式获取结果，结果获取请参考[ 录音文件识别结果查询](https://cloud.tencent.com/document/product/1093/37822)。 • 支持语音 URL 和本地语音文件两种请求方式。 • 接口是 HTTP RESTful 形式 |
DescribeTaskStatusResponse |
AsrClient.DescribeTaskStatus(DescribeTaskStatusRequest req)
在调用录音文件识别请求接口后，有回调和轮询两种方式获取识别结果。
• 当采用回调方式时，识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL，具体请参见[ 录音识别结果回调 ](https://cloud.tencent.com/document/product/1093/37139#callback)。 • 当采用轮询方式时，需要主动提交任务ID来轮询识别结果，共有任务成功、等待、执行中和失败四种结果，具体信息请参见下文说明。 |
SentenceRecognitionResponse |
AsrClient.SentenceRecognition(SentenceRecognitionRequest req)
本接口用于对60秒之内的短音频文件进行识别。
• 支持中文普通话、英语、粤语。 • 支持本地语音文件上传和语音URL上传两种请求方式。 • 音频格式支持wav、mp3；采样率支持8000Hz或者16000Hz；采样精度支持16bits；声道支持单声道。 • 当音频文件通过请求中body内容上传时，请求大小不能超过600KB；当音频以URL方式传输时，音频时长不可超过60s。 • 所有请求参数放在POST请求的body中，编码类型采用x-www-form-urlencoded，参数进行urlencode编码后传输。 |
| Modifier and Type | Method and Description |
|---|---|
DescribeStreamPlayInfoListResponse |
BizliveClient.DescribeStreamPlayInfoList(DescribeStreamPlayInfoListRequest req)
查询播放数据，支持按流名称查询详细播放数据，也可按播放域名查询详细总数据。
|
ForbidLiveStreamResponse |
BizliveClient.ForbidLiveStream(ForbidLiveStreamRequest req)
禁止某条流的推送，可以预设某个时刻将流恢复。
|
RegisterIMResponse |
BizliveClient.RegisterIM(RegisterIMRequest req)
注册聊天室
|
| Modifier and Type | Method and Description |
|---|---|
DescribeBRIResponse |
BriClient.DescribeBRI(DescribeBRIRequest req)
输入业务名 (bri_num, bri_dev, bri_ip, bri_apk, bri_url 五种之一) 及其 相应字段, 获取业务风险分数和标签。
当业务名为bri_num时，必须填PhoneNumber字段.
|
| Modifier and Type | Method and Description |
|---|---|
DescribeCaptchaResultResponse |
CaptchaClient.DescribeCaptchaResult(DescribeCaptchaResultRequest req)
核查验证码票据结果
|
| Modifier and Type | Method and Description |
|---|---|
ApplySnapshotResponse |
CbsClient.ApplySnapshot(ApplySnapshotRequest req)
本接口（ApplySnapshot）用于回滚快照到原云硬盘。
仅支持回滚到原云硬盘上。对于数据盘快照，如果您需要复制快照数据到其它云硬盘上，请使用[CreateDisks](/document/product/362/16312)接口创建新的弹性云盘，将快照数据复制到新购云盘上。
用于回滚的快照必须处于NORMAL状态。快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。
如果是弹性云盘，则云盘必须处于未挂载状态，云硬盘挂载状态可以通过[DescribeDisks](/document/product/362/16315)接口查询，见Attached字段解释；如果是随实例一起购买的非弹性云盘，则实例必须处于关机状态，实例状态可以通过[DescribeInstancesStatus](/document/product/213/15738)接口查询。
|
AttachDisksResponse |
CbsClient.AttachDisks(AttachDisksRequest req)
本接口（AttachDisks）用于挂载云硬盘。
支持批量操作，将多块云盘挂载到同一云主机。如果多个云盘存在不允许挂载的云盘，则操作不执行，以返回特定的错误码返回。
本接口为异步接口，当挂载云盘的请求成功返回时，表示后台已发起挂载云盘的操作，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHING”变为“ATTACHED”，则为挂载成功。
|
BindAutoSnapshotPolicyResponse |
CbsClient.BindAutoSnapshotPolicy(BindAutoSnapshotPolicyRequest req)
本接口（BindAutoSnapshotPolicy）用于绑定云硬盘到指定的定期快照策略。
每个地域下的定期快照策略配额限制请参考文档[定期快照](/document/product/362/8191)。
当已绑定定期快照策略的云硬盘处于未使用状态（即弹性云盘未挂载或非弹性云盘的主机处于关机状态）将不会创建定期快照。
|
CreateAutoSnapshotPolicyResponse |
CbsClient.CreateAutoSnapshotPolicy(CreateAutoSnapshotPolicyRequest req)
本接口（CreateAutoSnapshotPolicy）用于创建定期快照策略。
每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。
每个地域可创建的快照有数量和容量的限制，具体请见腾讯云控制台快照页面提示，如果快照超配额，定期快照创建会失败。
|
CreateDisksResponse |
CbsClient.CreateDisks(CreateDisksRequest req)
本接口（CreateDisks）用于创建云硬盘。
预付费云盘的购买会预先扣除本次云盘购买所需金额，在调用本接口前请确保账户余额充足。
本接口支持传入数据盘快照来创建云盘，实现将快照数据复制到新购云盘上。
本接口为异步接口，当创建请求下发成功后会返回一个新建的云盘ID列表，此时云盘的创建并未立即完成。可以通过调用[DescribeDisks](/document/product/362/16315)接口根据DiskId查询对应云盘，如果能查到云盘，且状态为'UNATTACHED'或'ATTACHED'，则表示创建成功。
|
CreateSnapshotResponse |
CbsClient.CreateSnapshot(CreateSnapshotRequest req)
本接口（CreateSnapshot）用于对指定云盘创建快照。
只有具有快照能力的云硬盘才能创建快照。云硬盘是否具有快照能力可由[DescribeDisks](/document/product/362/16315)接口查询，见SnapshotAbility字段。
可创建快照数量限制见[产品使用限制](https://cloud.tencent.com/doc/product/362/5145)。
|
DeleteAutoSnapshotPoliciesResponse |
CbsClient.DeleteAutoSnapshotPolicies(DeleteAutoSnapshotPoliciesRequest req)
本接口（DeleteAutoSnapshotPolicies）用于删除定期快照策略。
支持批量操作。如果多个定期快照策略存在无法删除的，则操作不执行，以特定错误码返回。
|
DeleteSnapshotsResponse |
CbsClient.DeleteSnapshots(DeleteSnapshotsRequest req)
本接口（DeleteSnapshots）用于删除快照。
快照必须处于NORMAL状态，快照状态可以通过[DescribeSnapshots](/document/product/362/15647)接口查询，见输出参数中SnapshotState字段解释。
支持批量操作。如果多个快照存在无法删除的快照，则操作不执行，以返回特定的错误码返回。
|
DescribeAutoSnapshotPoliciesResponse |
CbsClient.DescribeAutoSnapshotPolicies(DescribeAutoSnapshotPoliciesRequest req)
本接口（DescribeAutoSnapshotPolicies）用于查询定期快照策略。
可以根据定期快照策略ID、名称或者状态等信息来查询定期快照策略的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的定期快照策略表。
|
DescribeDiskAssociatedAutoSnapshotPolicyResponse |
CbsClient.DescribeDiskAssociatedAutoSnapshotPolicy(DescribeDiskAssociatedAutoSnapshotPolicyRequest req)
本接口（DescribeDiskAssociatedAutoSnapshotPolicy）用于查询云盘绑定的定期快照策略。
|
DescribeDiskConfigQuotaResponse |
CbsClient.DescribeDiskConfigQuota(DescribeDiskConfigQuotaRequest req)
本接口（DescribeDiskConfigQuota）用于查询云硬盘配额。
|
DescribeDiskOperationLogsResponse |
CbsClient.DescribeDiskOperationLogs(DescribeDiskOperationLogsRequest req)
本接口（DescribeDiskOperationLogs）用于查询云盘操作日志列表。
可根据云盘ID过滤。云盘ID形如：disk-a1kmcp13。
|
DescribeDisksResponse |
CbsClient.DescribeDisks(DescribeDisksRequest req)
本接口（DescribeDisks）用于查询云硬盘列表。
可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘列表。
|
DescribeInstancesDiskNumResponse |
CbsClient.DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)
本接口（DescribeInstancesDiskNum）用于查询实例已挂载云硬盘数量。
支持批量操作，当传入多个云服务器实例ID，返回结果会分别列出每个云服务器挂载的云硬盘数量。
|
DescribeSnapshotOperationLogsResponse |
CbsClient.DescribeSnapshotOperationLogs(DescribeSnapshotOperationLogsRequest req)
本接口（DescribeSnapshotOperationLogs）用于查询快照操作日志列表。
可根据快照ID过滤。快照ID形如：snap-a1kmcp13。
|
DescribeSnapshotsResponse |
CbsClient.DescribeSnapshots(DescribeSnapshotsRequest req)
本接口（DescribeSnapshots）用于查询快照的详细信息。
根据快照ID、创建快照的云硬盘ID、创建快照的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的快照列表。
|
DescribeSnapshotSharePermissionResponse |
CbsClient.DescribeSnapshotSharePermission(DescribeSnapshotSharePermissionRequest req)
本接口（DescribeSnapshotSharePermission）用于查询快照的分享信息。
|
DetachDisksResponse |
CbsClient.DetachDisks(DetachDisksRequest req)
本接口（DetachDisks）用于解挂云硬盘。
支持批量操作，解挂挂载在同一主机上的多块云盘。如果多块云盘存在不允许解挂载的云盘，则操作不执行，以返回特定的错误码返回。
本接口为异步接口，当请求成功返回时，云盘并未立即从主机解挂载，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态由“ATTACHED”变为“UNATTACHED”，则为解挂载成功。
|
InquiryPriceCreateDisksResponse |
CbsClient.InquiryPriceCreateDisks(InquiryPriceCreateDisksRequest req)
本接口（InquiryPriceCreateDisks）用于创建云硬盘询价。
支持查询创建多块云硬盘的价格，此时返回结果为总价格。
|
InquiryPriceRenewDisksResponse |
CbsClient.InquiryPriceRenewDisks(InquiryPriceRenewDisksRequest req)
本接口（InquiryPriceRenewDisks）用于续费云硬盘询价。
只支持查询预付费模式的弹性云盘续费价格。
支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到实例续费后的到期时间来续费询价。
支持为多块云盘指定不同的续费时长，此时返回的价格为多块云盘续费的总价格。
|
InquiryPriceResizeDiskResponse |
CbsClient.InquiryPriceResizeDisk(InquiryPriceResizeDiskRequest req)
本接口（InquiryPriceResizeDisk）用于扩容云硬盘询价。
只支持预付费模式的云硬盘扩容询价。
|
ModifyAutoSnapshotPolicyAttributeResponse |
CbsClient.ModifyAutoSnapshotPolicyAttribute(ModifyAutoSnapshotPolicyAttributeRequest req)
本接口（ModifyAutoSnapshotPolicyAttribute）用于修改定期快照策略属性。
可通过该接口修改定期快照策略的执行策略、名称、是否激活等属性。
修改保留天数时必须保证不与是否永久保留属性冲突，否则整个操作失败，以特定的错误码返回。
|
ModifyDiskAttributesResponse |
CbsClient.ModifyDiskAttributes(ModifyDiskAttributesRequest req)
只支持修改弹性云盘的项目ID。随云主机创建的云硬盘项目ID与云主机联动。可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。
“云硬盘名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行云盘管理操作的依据。
支持批量操作，如果传入多个云盘ID，则所有云盘修改为同一属性。如果存在不允许操作的云盘，则操作不执行，以特定错误码返回。
|
ModifyDisksChargeTypeResponse |
CbsClient.ModifyDisksChargeType(ModifyDisksChargeTypeRequest req)
接口请求域名： cbs.tencentcloudapi.com 。
本接口 (ModifyDisksChargeType) 用于切换云盘的计费模式。
只支持从 POSTPAID_BY_HOUR 计费模式切换为PREPAID计费模式。
非弹性云盘不支持此接口，请通过修改实例计费模式接口将实例连同非弹性云盘一起转换。
默认接口请求频率限制：10次/秒。
|
ModifyDisksRenewFlagResponse |
CbsClient.ModifyDisksRenewFlag(ModifyDisksRenewFlagRequest req)
本接口（ModifyDisksRenewFlag）用于修改云硬盘续费标识，支持批量修改。
|
ModifySnapshotAttributeResponse |
CbsClient.ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)
本接口（ModifySnapshotAttribute）用于修改指定快照的属性。
当前仅支持修改快照名称及将非永久快照修改为永久快照。
“快照名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行快照管理操作的依据。
|
ModifySnapshotsSharePermissionResponse |
CbsClient.ModifySnapshotsSharePermission(ModifySnapshotsSharePermissionRequest req)
本接口（ModifySnapshotsSharePermission）用于修改快照分享信息。
分享快照后，被分享账户可以通过该快照创建云硬盘。
每个快照最多可分享给50个账户。
分享快照无法更改名称，描述，仅可用于创建云硬盘。
只支持分享到对方账户相同地域。
仅支持分享数据盘快照。
|
RenewDiskResponse |
CbsClient.RenewDisk(RenewDiskRequest req)
本接口（RenewDisk）用于续费云硬盘。
只支持预付费的云硬盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中DiskChargeType字段解释。
支持与挂载实例一起续费的场景，需要在[DiskChargePrepaid](/document/product/362/15669#DiskChargePrepaid)参数中指定CurInstanceDeadline，此时会按对齐到子机续费后的到期时间来续费。
|
ResizeDiskResponse |
CbsClient.ResizeDisk(ResizeDiskRequest req)
本接口（ResizeDisk）用于扩容云硬盘。
只支持扩容弹性云盘。云硬盘类型可以通过[DescribeDisks](/document/product/362/16315)接口查询，见输出参数中Portable字段解释。随云主机创建的云硬盘需通过[ResizeInstanceDisks](/document/product/213/15731)接口扩容。
本接口为异步接口，接口成功返回时，云盘并未立即扩容到指定大小，可通过接口[DescribeDisks](/document/product/362/16315)来查询对应云盘的状态，如果云盘的状态为“EXPANDING”，表示正在扩容中，当状态变为“UNATTACHED”，表示扩容完成。
|
TerminateDisksResponse |
CbsClient.TerminateDisks(TerminateDisksRequest req)
本接口（TerminateDisks）用于退还云硬盘。
不再使用的云盘，可通过本接口主动退还。
本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还，预付费云盘需符合退还规则。
支持批量操作，每次请求批量云硬盘的上限为50。如果批量云盘存在不允许操作的，请求会以特定错误码返回。
|
UnbindAutoSnapshotPolicyResponse |
CbsClient.UnbindAutoSnapshotPolicy(UnbindAutoSnapshotPolicyRequest req)
本接口（UnbindAutoSnapshotPolicy）用于解除云硬盘绑定的定期快照策略。
支持批量操作，可一次解除多个云盘与同一定期快照策略的绑定。
如果传入的云盘未绑定到当前定期快照策略，接口将自动跳过，仅解绑与当前定期快照策略绑定的云盘。
|
| Modifier and Type | Method and Description |
|---|---|
AddTimeWindowResponse |
CdbClient.AddTimeWindow(AddTimeWindowRequest req)
本接口(AddTimeWindow)用于添加云数据库实例的维护时间窗口，以指定实例在哪些时间段可以自动执行切换访问操作。
|
AssociateSecurityGroupsResponse |
CdbClient.AssociateSecurityGroups(AssociateSecurityGroupsRequest req)
本接口(AssociateSecurityGroups)用于安全组批量绑定实例。
|
CloseWanServiceResponse |
CdbClient.CloseWanService(CloseWanServiceRequest req)
本接口(CloseWanService)用于关闭云数据库实例的外网访问。关闭外网访问后，外网地址将不可访问。
|
CreateAccountsResponse |
CdbClient.CreateAccounts(CreateAccountsRequest req)
本接口(CreateAccounts)用于创建云数据库的账户，需要指定新的账户名和域名，以及所对应的密码，同时可以设置账号的备注信息。
|
CreateBackupResponse |
CdbClient.CreateBackup(CreateBackupRequest req)
本接口(CreateBackup)用于创建数据库备份。
|
CreateDBImportJobResponse |
CdbClient.CreateDBImportJob(CreateDBImportJobRequest req)
本接口(CreateDBImportJob)用于创建云数据库数据导入任务。
注意，用户进行数据导入任务的文件，必须提前上传到腾讯云。用户须在控制台进行文件导入。
|
CreateDBInstanceResponse |
CdbClient.CreateDBInstance(CreateDBInstanceRequest req)
本接口(CreateDBInstance)用于创建包年包月的云数据库实例（包括主实例、灾备实例和只读实例），可通过传入实例规格、MySQL 版本号、购买时长和数量等信息创建云数据库实例。
该接口为异步接口，您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为1，且 TaskStatus 为0，表示实例已经发货成功。
1.
|
CreateDBInstanceHourResponse |
CdbClient.CreateDBInstanceHour(CreateDBInstanceHourRequest req)
本接口(CreateDBInstanceHour)用于创建按量计费的实例，可通过传入实例规格、MySQL 版本号和数量等信息创建云数据库实例，支持主实例、灾备实例和只读实例的创建。
该接口为异步接口，您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为 1，且 TaskStatus 为 0，表示实例已经发货成功。
1.
|
CreateDeployGroupResponse |
CdbClient.CreateDeployGroup(CreateDeployGroupRequest req)
创建放置实例的置放群组
|
CreateParamTemplateResponse |
CdbClient.CreateParamTemplate(CreateParamTemplateRequest req)
该接口（CreateParamTemplate）用于创建参数模板。
|
DeleteAccountsResponse |
CdbClient.DeleteAccounts(DeleteAccountsRequest req)
本接口(DeleteAccounts)用于删除云数据库的账户。
|
DeleteBackupResponse |
CdbClient.DeleteBackup(DeleteBackupRequest req)
本接口(DeleteBackup)用于删除数据库备份。
|
DeleteDeployGroupsResponse |
CdbClient.DeleteDeployGroups(DeleteDeployGroupsRequest req)
根据置放群组ID删除置放群组（置放群组中有资源存在时不能删除该置放群组）
|
DeleteParamTemplateResponse |
CdbClient.DeleteParamTemplate(DeleteParamTemplateRequest req)
该接口（DeleteParamTemplate）用于删除参数模板。
|
DeleteTimeWindowResponse |
CdbClient.DeleteTimeWindow(DeleteTimeWindowRequest req)
本接口(DeleteTimeWindow)用于删除云数据库实例的维护时间窗口。删除实例维护时间窗口之后，默认的维护时间窗为 03:00-04:00，即当选择在维护时间窗口内切换访问新实例时，默认会在 03:00-04:00 点进行切换访问新实例。
|
DescribeAccountPrivilegesResponse |
CdbClient.DescribeAccountPrivileges(DescribeAccountPrivilegesRequest req)
本接口(DescribeAccountPrivileges)用于查询云数据库账户支持的权限信息。
|
DescribeAccountsResponse |
CdbClient.DescribeAccounts(DescribeAccountsRequest req)
本接口(DescribeAccounts)用于查询云数据库的所有账户信息。
|
DescribeAsyncRequestInfoResponse |
CdbClient.DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
本接口(DescribeAsyncRequestInfo)用于查询云数据库实例异步任务的执行结果。
|
DescribeBackupConfigResponse |
CdbClient.DescribeBackupConfig(DescribeBackupConfigRequest req)
本接口(DescribeBackupConfig)用于查询数据库备份配置信息。
|
DescribeBackupDatabasesResponse |
CdbClient.DescribeBackupDatabases(DescribeBackupDatabasesRequest req)
本接口(DescribeBackupDatabases)用于查询备份文件包含的库 (已废弃)。
旧版本支持全量备份后，用户如果分库表下载逻辑备份文件，需要用到此接口。
新版本支持(CreateBackup)创建逻辑备份的时候，直接发起指定库表备份，用户直接下载该备份文件即可。
|
DescribeBackupsResponse |
CdbClient.DescribeBackups(DescribeBackupsRequest req)
本接口(DescribeBackups)用于查询云数据库实例的备份数据。
|
DescribeBackupTablesResponse |
CdbClient.DescribeBackupTables(DescribeBackupTablesRequest req)
本接口(DescribeBackupTables)用于查询指定的数据库的备份数据表名 (已废弃)。
旧版本支持全量备份后，用户如果分库表下载逻辑备份文件，需要用到此接口。
新版本支持(CreateBackup)创建逻辑备份的时候，直接发起指定库表备份，用户直接下载该备份文件即可。
|
DescribeBinlogsResponse |
CdbClient.DescribeBinlogs(DescribeBinlogsRequest req)
本接口(DescribeBinlogs)用于查询云数据库实例的二进制数据。
|
DescribeDatabasesResponse |
CdbClient.DescribeDatabases(DescribeDatabasesRequest req)
本接口(DescribeDatabases)用于查询云数据库实例的数据库信息。
|
DescribeDBImportRecordsResponse |
CdbClient.DescribeDBImportRecords(DescribeDBImportRecordsRequest req)
本接口(DescribeDBImportRecords)用于查询云数据库导入任务操作日志。
|
DescribeDBInstanceCharsetResponse |
CdbClient.DescribeDBInstanceCharset(DescribeDBInstanceCharsetRequest req)
本接口(DescribeDBInstanceCharset)用于查询云数据库实例的字符集，获取字符集的名称。
|
DescribeDBInstanceConfigResponse |
CdbClient.DescribeDBInstanceConfig(DescribeDBInstanceConfigRequest req)
本接口(DescribeDBInstanceConfig)用于云数据库实例的配置信息，包括同步模式，部署模式等。
|
DescribeDBInstanceGTIDResponse |
CdbClient.DescribeDBInstanceGTID(DescribeDBInstanceGTIDRequest req)
本接口(DescribeDBInstanceGTID)用于查询云数据库实例是否开通了 GTID，不支持版本为 5.5 以及以下的实例。
|
DescribeDBInstanceRebootTimeResponse |
CdbClient.DescribeDBInstanceRebootTime(DescribeDBInstanceRebootTimeRequest req)
本接口(DescribeDBInstanceRebootTime)用于查询云数据库实例重启预计所需的时间。
|
DescribeDBInstancesResponse |
CdbClient.DescribeDBInstances(DescribeDBInstancesRequest req)
本接口(DescribeDBInstances)用于查询云数据库实例列表，支持通过项目 ID、实例 ID、访问地址、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。
|
DescribeDBPriceResponse |
CdbClient.DescribeDBPrice(DescribeDBPriceRequest req)
本接口(DescribeDBPrice)用于查询云数据库实例的价格，支持查询按量计费或者包年包月的价格。可传入实例类型、购买时长、购买数量、内存大小、硬盘大小和可用区信息等来查询实例价格。
注意：对某个地域进行询价，请使用对应地域的接入点，接入点信息请参照 服务地址 文档。例如：对广州地域进行询价，请把请求发到：cdb.ap-guangzhou.tencentcloudapi.com。同理对上海地域询价，把请求发到：cdb.ap-shanghai.tencentcloudapi.com。
|
DescribeDBSecurityGroupsResponse |
CdbClient.DescribeDBSecurityGroups(DescribeDBSecurityGroupsRequest req)
本接口(DescribeDBSecurityGroups)用于查询实例的安全组详情。
|
DescribeDBSwitchRecordsResponse |
CdbClient.DescribeDBSwitchRecords(DescribeDBSwitchRecordsRequest req)
本接口(DescribeDBSwitchRecords)用于查询云数据库实例切换记录。
|
DescribeDBZoneConfigResponse |
CdbClient.DescribeDBZoneConfig(DescribeDBZoneConfigRequest req)
本接口(DescribeDBZoneConfig)用于查询可创建的云数据库各地域可售卖的规格配置。
|
DescribeDefaultParamsResponse |
CdbClient.DescribeDefaultParams(DescribeDefaultParamsRequest req)
该接口（DescribeDefaultParams）用于查询默认的可设置参数列表。
|
DescribeDeployGroupListResponse |
CdbClient.DescribeDeployGroupList(DescribeDeployGroupListRequest req)
根据置放群组 ID 或置放群组名称查询置放群组列表
|
DescribeDeviceMonitorInfoResponse |
CdbClient.DescribeDeviceMonitorInfo(DescribeDeviceMonitorInfoRequest req)
本接口（DescribeDeviceMonitorInfo）用于查询云数据库物理机当天的监控信息，暂只支持内存488G、硬盘6T的实例查询。
|
DescribeInstanceParamRecordsResponse |
CdbClient.DescribeInstanceParamRecords(DescribeInstanceParamRecordsRequest req)
该接口（DescribeInstanceParamRecords）用于查询实例参数修改历史。
|
DescribeInstanceParamsResponse |
CdbClient.DescribeInstanceParams(DescribeInstanceParamsRequest req)
该接口（DescribeInstanceParams）用于查询实例的参数列表。
|
DescribeParamTemplateInfoResponse |
CdbClient.DescribeParamTemplateInfo(DescribeParamTemplateInfoRequest req)
该接口（DescribeParamTemplateInfo）用于查询参数模板详情。
|
DescribeParamTemplatesResponse |
CdbClient.DescribeParamTemplates(DescribeParamTemplatesRequest req)
该接口（DescribeParamTemplates）查询参数模板列表。
|
DescribeProjectSecurityGroupsResponse |
CdbClient.DescribeProjectSecurityGroups(DescribeProjectSecurityGroupsRequest req)
本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。
|
DescribeRollbackRangeTimeResponse |
CdbClient.DescribeRollbackRangeTime(DescribeRollbackRangeTimeRequest req)
本接口(DescribeRollbackRangeTime)用于查询云数据库实例可回档的时间范围。
|
DescribeSlowLogsResponse |
CdbClient.DescribeSlowLogs(DescribeSlowLogsRequest req)
本接口(DescribeSlowLogs)用于获取云数据库实例的慢查询日志。
|
DescribeSupportedPrivilegesResponse |
CdbClient.DescribeSupportedPrivileges(DescribeSupportedPrivilegesRequest req)
本接口(DescribeSupportedPrivileges)用于查询云数据库的支持的权限信息，包括全局权限，数据库权限，表权限以及列权限。
|
DescribeTablesResponse |
CdbClient.DescribeTables(DescribeTablesRequest req)
本接口(DescribeTables)用于查询云数据库实例的数据库表信息。
|
DescribeTagsOfInstanceIdsResponse |
CdbClient.DescribeTagsOfInstanceIds(DescribeTagsOfInstanceIdsRequest req)
本接口(DescribeTagsOfInstanceIds)用于获取云数据库实例的标签信息。
|
DescribeTasksResponse |
CdbClient.DescribeTasks(DescribeTasksRequest req)
本接口(DescribeTasks)用于查询云数据库实例任务列表。
|
DescribeTimeWindowResponse |
CdbClient.DescribeTimeWindow(DescribeTimeWindowRequest req)
本接口(DescribeTimeWindow)用于查询云数据库实例的维护时间窗口。
|
DescribeUploadedFilesResponse |
CdbClient.DescribeUploadedFiles(DescribeUploadedFilesRequest req)
本接口(DescribeUploadedFiles)用于查询用户导入的SQL文件列表。
|
DisassociateSecurityGroupsResponse |
CdbClient.DisassociateSecurityGroups(DisassociateSecurityGroupsRequest req)
本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。
|
InitDBInstancesResponse |
CdbClient.InitDBInstances(InitDBInstancesRequest req)
本接口(InitDBInstances)用于初始化云数据库实例，包括初始化密码、默认字符集、实例端口号等
|
InquiryPriceUpgradeInstancesResponse |
CdbClient.InquiryPriceUpgradeInstances(InquiryPriceUpgradeInstancesRequest req)
本接口(InquiryPriceUpgradeInstances)用于查询云数据库实例升级的价格，支持查询按量计费或者包年包月实例的升级价格，实例类型支持主实例、灾备实例和只读实例。
|
IsolateDBInstanceResponse |
CdbClient.IsolateDBInstance(IsolateDBInstanceRequest req)
本接口(IsolateDBInstance)用于隔离云数据库实例，隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离，请尽快进行冲正。
|
ModifyAccountDescriptionResponse |
CdbClient.ModifyAccountDescription(ModifyAccountDescriptionRequest req)
本接口(ModifyAccountDescription)用于修改云数据库账户的备注信息。
|
ModifyAccountPasswordResponse |
CdbClient.ModifyAccountPassword(ModifyAccountPasswordRequest req)
本接口(ModifyAccountPassword)用于修改云数据库账户的密码。
|
ModifyAccountPrivilegesResponse |
CdbClient.ModifyAccountPrivileges(ModifyAccountPrivilegesRequest req)
本接口(ModifyAccountPrivileges)用于修改云数据库的账户的权限信息。
|
ModifyAutoRenewFlagResponse |
CdbClient.ModifyAutoRenewFlag(ModifyAutoRenewFlagRequest req)
本接口(ModifyAutoRenewFlag)用于修改云数据库实例的自动续费标记。仅支持包年包月的实例设置自动续费标记。
|
ModifyBackupConfigResponse |
CdbClient.ModifyBackupConfig(ModifyBackupConfigRequest req)
本接口(ModifyBackupConfig)用于修改数据库备份配置信息。
|
ModifyDBInstanceNameResponse |
CdbClient.ModifyDBInstanceName(ModifyDBInstanceNameRequest req)
本接口(ModifyDBInstanceName)用于修改云数据库实例的名称。
|
ModifyDBInstanceProjectResponse |
CdbClient.ModifyDBInstanceProject(ModifyDBInstanceProjectRequest req)
本接口(ModifyDBInstanceProject)用于修改云数据库实例的所属项目。
|
ModifyDBInstanceSecurityGroupsResponse |
CdbClient.ModifyDBInstanceSecurityGroups(ModifyDBInstanceSecurityGroupsRequest req)
本接口(ModifyDBInstanceSecurityGroups)用于修改实例绑定的安全组。
|
ModifyDBInstanceVipVportResponse |
CdbClient.ModifyDBInstanceVipVport(ModifyDBInstanceVipVportRequest req)
本接口(ModifyDBInstanceVipVport)用于修改云数据库实例的IP和端口号，也可进行基础网络转 VPC 网络和 VPC 网络下的子网变更。
|
ModifyInstanceParamResponse |
CdbClient.ModifyInstanceParam(ModifyInstanceParamRequest req)
本接口(ModifyInstanceParam)用于修改云数据库实例的参数。
|
ModifyInstanceTagResponse |
CdbClient.ModifyInstanceTag(ModifyInstanceTagRequest req)
本接口(ModifyInstanceTag)用于对实例标签进行添加、修改或者删除。
|
ModifyNameOrDescByDpIdResponse |
CdbClient.ModifyNameOrDescByDpId(ModifyNameOrDescByDpIdRequest req)
修改置放群组的名称或者描述
|
ModifyParamTemplateResponse |
CdbClient.ModifyParamTemplate(ModifyParamTemplateRequest req)
该接口（ModifyParamTemplate）用于修改参数模板。
|
ModifyTimeWindowResponse |
CdbClient.ModifyTimeWindow(ModifyTimeWindowRequest req)
本接口(ModifyTimeWindow)用于更新云数据库实例的维护时间窗口。
|
OfflineIsolatedInstancesResponse |
CdbClient.OfflineIsolatedInstances(OfflineIsolatedInstancesRequest req)
本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态，即通过 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询到 Status 值为 5 的实例。
该接口为异步操作，部分资源的回收可能存在延迟。您可以通过使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口，指定实例 InstanceId 和状态 Status 为 [5,6,7] 进行查询，若返回实例为空，则实例资源已全部释放。
注意，实例下线后，相关资源和数据将无法找回，请谨慎操作。
|
OpenDBInstanceGTIDResponse |
CdbClient.OpenDBInstanceGTID(OpenDBInstanceGTIDRequest req)
本接口(OpenDBInstanceGTID)用于开启云数据库实例的 GTID，只支持版本为 5.6 以及以上的实例。
|
OpenWanServiceResponse |
CdbClient.OpenWanService(OpenWanServiceRequest req)
本接口(OpenWanService)用于开通实例外网访问。
注意，实例开通外网访问之前，需要先将实例进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作。
|
RenewDBInstanceResponse |
CdbClient.RenewDBInstance(RenewDBInstanceRequest req)
本接口(RenewDBInstance)用于续费云数据库实例，仅支持付费模式为包年包月的实例。按量计费实例不需要续费。
|
RestartDBInstancesResponse |
CdbClient.RestartDBInstances(RestartDBInstancesRequest req)
本接口(RestartDBInstances)用于重启云数据库实例。
注意：
1、本接口只支持主实例进行重启操作；
2、实例状态必须为正常，并且没有其他异步任务在执行中。
|
StartBatchRollbackResponse |
CdbClient.StartBatchRollback(StartBatchRollbackRequest req)
该接口（StartBatchRollback）用于批量回档云数据库实例的库表。
|
StopDBImportJobResponse |
CdbClient.StopDBImportJob(StopDBImportJobRequest req)
本接口(StopDBImportJob)用于终止数据导入任务。
|
SwitchForUpgradeResponse |
CdbClient.SwitchForUpgrade(SwitchForUpgradeRequest req)
本接口(SwitchForUpgrade)用于切换访问新实例，针对主升级中的实例处于待切换状态时，用户可主动发起该流程。
|
UpgradeDBInstanceResponse |
CdbClient.UpgradeDBInstance(UpgradeDBInstanceRequest req)
本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置，实例类型支持主实例、灾备实例和只读实例。
|
UpgradeDBInstanceEngineVersionResponse |
CdbClient.UpgradeDBInstanceEngineVersion(UpgradeDBInstanceEngineVersionRequest req)
本接口(UpgradeDBInstanceEngineVersion)用于升级云数据库实例版本，实例类型支持主实例、灾备实例和只读实例。
|
VerifyRootAccountResponse |
CdbClient.VerifyRootAccount(VerifyRootAccountRequest req)
本接口(VerifyRootAccount)用于校验云数据库实例的 ROOT 账号是否有足够的权限进行授权操作。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeCdnDataResponse |
CdnClient.DescribeCdnData(DescribeCdnDataRequest req)
DescribeCdnData 用于查询 CDN 实时访问监控数据，支持以下指标查询：
+ 流量（单位为 byte）
+ 带宽（单位为 bps）
+ 请求数（单位为 次）
+ 流量命中率（单位为 %，小数点后保留两位）
+ 状态码 2xx 汇总及各 2 开头状态码明细（单位为 个）
+ 状态码 3xx 汇总及各 3 开头状态码明细（单位为 个）
+ 状态码 4xx 汇总及各 4 开头状态码明细（单位为 个）
+ 状态码 5xx 汇总及各 5 开头状态码明细（单位为 个）
|
DescribeCdnIpResponse |
CdnClient.DescribeCdnIp(DescribeCdnIpRequest req)
DescribeCdnIp 用于查询 CDN IP 归属。
|
DescribeIpVisitResponse |
CdnClient.DescribeIpVisit(DescribeIpVisitRequest req)
DescribeIpVisit 用于查询 5 分钟活跃用户数，及日活跃用户数明细
+ 5 分钟活跃用户数：根据日志中客户端 IP，5 分钟粒度去重统计
+ 日活跃用户数：根据日志中客户端 IP，按天粒度去重统计
|
DescribeMapInfoResponse |
CdnClient.DescribeMapInfo(DescribeMapInfoRequest req)
DescribeMapInfo 用于查询省份对应的 ID，运营商对应的 ID 信息。
|
DescribeOriginDataResponse |
CdnClient.DescribeOriginData(DescribeOriginDataRequest req)
DescribeOriginData 用于查询 CDN 实时回源监控数据，支持以下指标查询：
+ 回源流量（单位为 byte）
+ 回源带宽（单位为 bps）
+ 回源请求数（单位为 次）
+ 回源失败请求数（单位为 次）
+ 回源失败率（单位为 %，小数点后保留两位）
+ 回源状态码 2xx 汇总及各 2 开头回源状态码明细（单位为 个）
+ 回源状态码 3xx 汇总及各 3 开头回源状态码明细（单位为 个）
+ 回源状态码 4xx 汇总及各 4 开头回源状态码明细（单位为 个）
+ 回源状态码 5xx 汇总及各 5 开头回源状态码明细（单位为 个）
|
DescribePayTypeResponse |
CdnClient.DescribePayType(DescribePayTypeRequest req)
DescribePayType 用于查询用户的计费类型，计费周期等信息。
|
DescribePurgeTasksResponse |
CdnClient.DescribePurgeTasks(DescribePurgeTasksRequest req)
DescribePurgeTasks 用于查询刷新任务提交历史记录及执行进度。
|
DescribePushTasksResponse |
CdnClient.DescribePushTasks(DescribePushTasksRequest req)
DescribePushTasks 用于查询预热任务提交历史记录及执行进度。（接口尚在批量公测中，暂未全量开放使用）
|
DisableCachesResponse |
CdnClient.DisableCaches(DisableCachesRequest req)
DisableCaches 用于禁用 CDN 上指定 URL 的访问，禁用完成后，全网访问会直接返回 403。（接口尚在内测中，暂未全量开放使用）
|
EnableCachesResponse |
CdnClient.EnableCaches(EnableCachesRequest req)
EnableCaches 用于解禁手工封禁的 URL，解禁成功后，全网生效时间约 5~10 分钟。（接口尚在内测中，暂未全量开放使用）
|
GetDisableRecordsResponse |
CdnClient.GetDisableRecords(GetDisableRecordsRequest req)
GetDisableRecords 用户查询资源禁用历史，及 URL 当前状态。（接口尚在内测中，暂未全量开放使用）
|
ListTopDataResponse |
CdnClient.ListTopData(ListTopDataRequest req)
ListTopData 通过入参 Metric 和 Filter 组合不同，可以查询以下排序数据：
+ 依据总流量、总请求数对访问 URL 排序，从大至小返回 TOP 1000 URL
+ 依据总流量、总请求数对客户端省份排序，从大至小返回省份列表
+ 依据总流量、总请求数对客户端运营商排序，从大至小返回运营商列表
+ 依据总流量、峰值带宽、总请求数、平均命中率、2XX/3XX/4XX/5XX 状态码对域名排序，从大至小返回域名列表
+ 依据总回源流量、回源峰值带宽、总回源请求数、平均回源失败率、2XX/3XX/4XX/5XX 回源状态码对域名排序，从大至小返回域名列表
|
PurgePathCacheResponse |
CdnClient.PurgePathCache(PurgePathCacheRequest req)
PurgeUrlsCache 用于批量刷新目录缓存，一次提交将返回一个刷新任务id。
|
PurgeUrlsCacheResponse |
CdnClient.PurgeUrlsCache(PurgeUrlsCacheRequest req)
PurgeUrlsCache 用于批量刷新Url，一次提交将返回一个刷新任务id。
|
PushUrlsCacheResponse |
CdnClient.PushUrlsCache(PushUrlsCacheRequest req)
PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点，默认情况下每次调用可提交 20 条 URL，每日一共可提交 1000 条。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDbauditInstancesResponse |
CdsClient.DescribeDbauditInstances(DescribeDbauditInstancesRequest req)
本接口 (DescribeDbauditInstances) 用于查询数据安全审计实例列表
|
DescribeDbauditInstanceTypeResponse |
CdsClient.DescribeDbauditInstanceType(DescribeDbauditInstanceTypeRequest req)
本接口 (DescribeDbauditInstanceType) 用于查询可售卖的产品规格列表。
|
DescribeDbauditUsedRegionsResponse |
CdsClient.DescribeDbauditUsedRegions(DescribeDbauditUsedRegionsRequest req)
本接口 (DescribeDbauditUsedRegions) 用于查询可售卖地域列表。
|
InquiryPriceDbauditInstanceResponse |
CdsClient.InquiryPriceDbauditInstance(InquiryPriceDbauditInstanceRequest req)
用于查询数据安全审计产品实例价格
|
ModifyDbauditInstancesRenewFlagResponse |
CdsClient.ModifyDbauditInstancesRenewFlag(ModifyDbauditInstancesRenewFlagRequest req)
本接口 (ModifyDbauditInstancesRenewFlag) 用于修改数据安全审计产品实例续费标识
|
| Modifier and Type | Method and Description |
|---|---|
DescribeSdkAppidResponse |
CimClient.DescribeSdkAppid(DescribeSdkAppidRequest req)
获取云通信IM中腾讯云账号对应的SDKAppID
|
| Modifier and Type | Method and Description |
|---|---|
AutoRewriteResponse |
ClbClient.AutoRewrite(AutoRewriteRequest req)
用户需要先创建出一个HTTPS:443监听器，并在其下创建转发规则。通过调用本接口，系统会自动创建出一个HTTP:80监听器（如果之前不存在），并在其下创建转发规则，与HTTPS:443监听器下的Domains（在入参中指定）对应。创建成功后可以通过HTTP:80地址自动跳转为HTTPS:443地址进行访问。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
BatchDeregisterTargetsResponse |
ClbClient.BatchDeregisterTargets(BatchDeregisterTargetsRequest req)
批量解绑四七层后端服务。
|
BatchModifyTargetWeightResponse |
ClbClient.BatchModifyTargetWeight(BatchModifyTargetWeightRequest req)
BatchModifyTargetWeight接口用于批量修改负载均衡监听器绑定的后端机器的转发权重，支持负载均衡的4层和7层监听器；不支持传统型负载均衡。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
BatchRegisterTargetsResponse |
ClbClient.BatchRegisterTargets(BatchRegisterTargetsRequest req)
批量绑定虚拟主机或弹性网卡，支持跨域绑定，只支持四层（TCP、UDP）协议绑定。
|
CreateListenerResponse |
ClbClient.CreateListener(CreateListenerRequest req)
在一个负载均衡实例下创建监听器。
本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
CreateLoadBalancerResponse |
ClbClient.CreateLoadBalancer(CreateLoadBalancerRequest req)
CreateLoadBalancer 接口用来创建负载均衡实例（本接口只支持购买按量计费的负载均衡，包年包月的负载均衡请通过控制台购买）。为了使用负载均衡服务，您必须购买一个或多个负载均衡实例。成功调用该接口后，会返回负载均衡实例的唯一 ID。负载均衡实例的类型分为：公网、内网。详情可参考产品说明中的产品类型。
注意：(1)指定可用区申请负载均衡、跨zone容灾【如需使用，请提交工单（ https://console.cloud.tencent.com/workorder/category ）申请】；(2)目前只有北京、上海、广州支持IPv6；
本接口为异步接口，接口成功返回后，可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态（如创建中、正常），以确定是否创建成功。
|
CreateRuleResponse |
ClbClient.CreateRule(CreateRuleRequest req)
CreateRule 接口用于在一个已存在的负载均衡七层监听器下创建转发规则，七层监听器中，后端服务必须绑定到规则上而非监听器上。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeleteListenerResponse |
ClbClient.DeleteListener(DeleteListenerRequest req)
本接口用来删除负载均衡实例下的监听器（四层和七层）。
本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeleteLoadBalancerResponse |
ClbClient.DeleteLoadBalancer(DeleteLoadBalancerRequest req)
DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。
本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeleteRewriteResponse |
ClbClient.DeleteRewrite(DeleteRewriteRequest req)
DeleteRewrite 接口支持删除指定转发规则之间的重定向关系。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeleteRuleResponse |
ClbClient.DeleteRule(DeleteRuleRequest req)
DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeregisterTargetsResponse |
ClbClient.DeregisterTargets(DeregisterTargetsRequest req)
DeregisterTargets 接口用来将一台或多台后端服务从负载均衡的监听器或转发规则上解绑，对于四层监听器，只需指定监听器ID即可，对于七层监听器，还需通过LocationId或Domain+Url指定转发规则。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeregisterTargetsFromClassicalLBResponse |
ClbClient.DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req)
DeregisterTargetsFromClassicalLB 接口用于解绑负载均衡后端服务。
本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DescribeClassicalLBByInstanceIdResponse |
ClbClient.DescribeClassicalLBByInstanceId(DescribeClassicalLBByInstanceIdRequest req)
DescribeClassicalLBByInstanceId用于通过后端实例ID获取传统型负载均衡ID列表
|
DescribeClassicalLBHealthStatusResponse |
ClbClient.DescribeClassicalLBHealthStatus(DescribeClassicalLBHealthStatusRequest req)
DescribeClassicalLBHealthStatus用于获取传统型负载均衡后端的健康状态
|
DescribeClassicalLBListenersResponse |
ClbClient.DescribeClassicalLBListeners(DescribeClassicalLBListenersRequest req)
DescribeClassicalLBListeners 接口用于获取传统型负载均衡的监听器信息。
|
DescribeClassicalLBTargetsResponse |
ClbClient.DescribeClassicalLBTargets(DescribeClassicalLBTargetsRequest req)
DescribeClassicalLBTargets用于获取传统型负载均衡绑定的后端服务
|
DescribeListenersResponse |
ClbClient.DescribeListeners(DescribeListenersRequest req)
DescribeListeners 接口可根据负载均衡器 ID，监听器的协议或端口作为过滤条件获取监听器列表。如果不指定任何过滤条件，默认返该负载均衡器下的默认数据长度（20 个）的监听器。
|
DescribeLoadBalancersResponse |
ClbClient.DescribeLoadBalancers(DescribeLoadBalancersRequest req)
查询负载均衡实例列表
|
DescribeRewriteResponse |
ClbClient.DescribeRewrite(DescribeRewriteRequest req)
DescribeRewrite 接口可根据负载均衡实例ID，查询一个负载均衡实例下转发规则的重定向关系。如果不指定监听器ID或转发规则ID，则返回该负载均衡实例下的所有重定向关系。
|
DescribeTargetHealthResponse |
ClbClient.DescribeTargetHealth(DescribeTargetHealthRequest req)
DescribeTargetHealth 接口用来获取负载均衡后端服务的健康检查结果，不支持传统型负载均衡。
|
DescribeTargetsResponse |
ClbClient.DescribeTargets(DescribeTargetsRequest req)
DescribeTargets 接口用来查询负载均衡实例的某些监听器绑定的后端服务列表。
|
DescribeTaskStatusResponse |
ClbClient.DescribeTaskStatus(DescribeTaskStatusRequest req)
本接口用于查询异步任务的执行状态，对于非查询类的接口（创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端服务等），在接口调用成功后，都需要使用本接口查询任务最终是否执行成功。
|
ManualRewriteResponse |
ClbClient.ManualRewrite(ManualRewriteRequest req)
用户手动配置原访问地址和重定向地址，系统自动将原访问地址的请求重定向至对应路径的目的地址。同一域名下可以配置多条路径作为重定向策略，实现http/https之间请求的自动跳转。设置重定向时，需满足如下约束条件：若A已经重定向至B，则A不能再重定向至C（除非先删除老的重定向关系，再建立新的重定向关系），B不能重定向至任何其它地址。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyDomainResponse |
ClbClient.ModifyDomain(ModifyDomainRequest req)
ModifyDomain接口用来修改负载均衡七层监听器下的域名。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyDomainAttributesResponse |
ClbClient.ModifyDomainAttributes(ModifyDomainAttributesRequest req)
ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性，如修改域名、修改DefaultServer、开启/关闭Http2、修改证书。
本接口为异步接口，本接口返回成功后，需以返回的RequestId为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyListenerResponse |
ClbClient.ModifyListener(ModifyListenerRequest req)
ModifyListener接口用来修改负载均衡监听器的属性，包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyLoadBalancerAttributesResponse |
ClbClient.ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req)
修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
|
ModifyRuleResponse |
ClbClient.ModifyRule(ModifyRuleRequest req)
ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性，包括转发路径、健康检查属性、转发策略等。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyTargetPortResponse |
ClbClient.ModifyTargetPort(ModifyTargetPortRequest req)
ModifyTargetPort接口用于修改监听器绑定的后端服务的端口。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyTargetWeightResponse |
ClbClient.ModifyTargetWeight(ModifyTargetWeightRequest req)
ModifyTargetWeight 接口用于修改负载均衡绑定的后端服务的转发权重。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
RegisterTargetsResponse |
ClbClient.RegisterTargets(RegisterTargetsRequest req)
RegisterTargets 接口用来将一台或多台后端服务绑定到负载均衡的监听器（或7层转发规则），在此之前您需要先行创建相关的4层监听器或7层转发规则。对于四层监听器（TCP、UDP），只需指定监听器ID即可，对于七层监听器（HTTP、HTTPS），还需通过LocationId或者Domain+Url指定转发规则。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
RegisterTargetsWithClassicalLBResponse |
ClbClient.RegisterTargetsWithClassicalLB(RegisterTargetsWithClassicalLBRequest req)
RegisterTargetsWithClassicalLB 接口用于绑定后端服务到传统型负载均衡。
本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
ReplaceCertForLoadBalancersResponse |
ClbClient.ReplaceCertForLoadBalancers(ReplaceCertForLoadBalancersRequest req)
ReplaceCertForLoadBalancers 接口用以替换负载均衡实例所关联的证书，对于各个地域的负载均衡，如果指定的老的证书ID与其有关联关系，则会先解除关联，再建立新证书与该负载均衡的关联关系。
此接口支持替换服务端证书或客户端证书。
需要使用的新证书，可以通过传入证书ID来指定，如果不指定证书ID，则必须传入证书内容等相关信息，用以新建证书并绑定至负载均衡。
注：本接口仅可从广州地域调用，其他地域存在域名解析问题，会报错。
|
SetLoadBalancerSecurityGroupsResponse |
ClbClient.SetLoadBalancerSecurityGroups(SetLoadBalancerSecurityGroupsRequest req)
SetLoadBalancerSecurityGroups 接口支持对一个公网负载均衡实例执行设置（绑定、解绑）安全组操作。查询一个负载均衡实例目前已绑定的安全组，可使用 DescribeLoadBalancers 接口。本接口是set语义，
绑定操作时，入参需要传入负载均衡实例要绑定的所有安全组（已绑定的+新增绑定的）。
解绑操作时，入参需要传入负载均衡实例执行解绑后所绑定的所有安全组；如果要解绑所有安全组，可不传此参数，或传入空数组。注意：内网负载均衡不支持绑定安全组。
|
SetSecurityGroupForLoadbalancersResponse |
ClbClient.SetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req)
绑定或解绑一个安全组到多个公网负载均衡实例。注意：内网负载均衡不支持绑定安全组。
|
| Modifier and Type | Method and Description |
|---|---|
AudioModerationResponse |
CmsClient.AudioModeration(AudioModerationRequest req)
音频内容检测（Audio Moderation, AM）服务使用了波形分析、声纹分析等技术，能识别涉黄、涉政、涉恐等违规音频，同时支持用户配置音频黑库，打击自定义的违规内容。
接口返回值说明：调用本接口有两个返回值，一个是同步返回值，一个是识别完成后的异步回调返回值。 音频识别结果存在于异步回调返回值中，异步回调返回值明细： 参数名 | 类型 | 描述 -|-|- SeqID | String | 请求seqId唯一标识 EvilFlag | Integer | 是否恶意：0正常，1可疑（Homology模块下：0未匹配到，1恶意，2白样本） EvilType | Integer | 恶意类型：100正常，20001政治，20002色情，20007谩骂 Duration | Integer | 音频时长（单位：毫秒） PornDetect | [AudioDetectData](#ADD) | 音频智能鉴黄 PolityDetect | [AudioDetectData](#ADD)| 音频涉政识别 CurseDetect | [AudioDetectData](#ADD) | 音频谩骂识别 CustomizedDetect | [AudioDetectData](#ADD) | 自定义识别 Homology | [AudioDetectData](#ADD) | 相似度识别 AudioDetectData 参数名 | 类型 | 描述 -|-|- HitFlag | Integer | 0正常，1可疑 Score | Integer | 判断分值 EvilType | Integer | 恶意类型：100正常，20001政治，20002色情，20007谩骂 Keywords | Array of String | 关键词明细 StartTime | Array of String | 恶意开始时间（Homology、CustomizedDetect无此字段） EndTime | Array of String | 恶意结束时间（Homology、CustomizedDetect无此字段） SeedUrl | String | 命中的种子URL |
CreateFileSampleResponse |
CmsClient.CreateFileSample(CreateFileSampleRequest req)
通过该接口可以将文件新增到样本库
|
CreateTextSampleResponse |
CmsClient.CreateTextSample(CreateTextSampleRequest req)
新增文本类型样本库
|
DeleteFileSampleResponse |
CmsClient.DeleteFileSample(DeleteFileSampleRequest req)
删除文件样本库，支持批量删除，一次提交不超过20个
|
DeleteTextSampleResponse |
CmsClient.DeleteTextSample(DeleteTextSampleRequest req)
删除文字样本库，暂时只支持单个删除
|
DescribeFileSampleResponse |
CmsClient.DescribeFileSample(DescribeFileSampleRequest req)
查询文件样本库，支持批量查询
|
DescribeModerationOverviewResponse |
CmsClient.DescribeModerationOverview(DescribeModerationOverviewRequest req)
根据日期，渠道和服务类型查询识别结果概览数据
|
DescribeTextSampleResponse |
CmsClient.DescribeTextSample(DescribeTextSampleRequest req)
支持批量查询文字样本库
|
ImageModerationResponse |
CmsClient.ImageModeration(ImageModerationRequest req)
图片内容检测服务（Image Moderation, IM）能自动扫描图片，识别涉黄、涉恐、涉政、涉毒等有害内容，同时支持用户配置图片黑名单，打击自定义的违规图片。
|
TextModerationResponse |
CmsClient.TextModeration(TextModerationRequest req)
文本内容检测（Text Moderation）服务使用了深度学习技术，识别涉黄、涉政、涉恐等有害内容，同时支持用户配置词库，打击自定义的违规文本。
|
VideoModerationResponse |
CmsClient.VideoModeration(VideoModerationRequest req)
视频内容检测（Video Moderation, VM）服务能识别涉黄、涉政、涉恐等违规视频，同时支持用户配置视频黑库，打击自定义的违规内容。
接口返回值说明：调用本接口有两个返回值，一个是同步返回值，一个是识别完成后的异步回调返回值。 视频识别结果存在于异步回调返回值中，异步回调返回值明细： 参数名 | 类型 | 描述 -|-|- SeqID | String | 请求seqId唯一标识 EvilFlag | Integer | 是否恶意：0正常，1可疑（Homology模块下：0未匹配到，1恶意，2白样本） EvilType | Integer | 恶意类型：100正常，20001政治，20002色情 Duration | Integer | 视频时长（单位：秒） PornDetect | [VideoDetectData](#VDD) | 视频智能鉴黄 PolityDetect | [VideoDetectData](#VDD) | 视频涉政识别 Homology | [VideoDetectData](#VDD) | 相似度识别 VideoDetectData 参数名 | 类型 | 描述 -|-|- HitFlag | Integer | 0正常，1可疑 Score | Integer | 判断分值 EvilType | Integer | 恶意类型：100正常，20001政治，20002色情 Keywords | Array of String | 关键词明细 SeedUrl | String | 命中的种子URL |
| Modifier and Type | Method and Description |
|---|---|
String |
AbstractClient.call(String action,
String jsonPayload)
Use post/json with tc3-hmac-sha256 signature to call any action.
|
static byte[] |
Sign.hmac256(byte[] key,
String msg) |
protected String |
AbstractClient.internalRequest(AbstractModel request,
String actionName) |
static String |
Sign.sha256Hex(byte[] b) |
static String |
Sign.sha256Hex(String s) |
static String |
Sign.sign(String secretKey,
String sigStr,
String sigMethod) |
| Modifier and Type | Method and Description |
|---|---|
com.squareup.okhttp.Response |
HttpConnection.doRequest(com.squareup.okhttp.Request request) |
com.squareup.okhttp.Response |
HttpConnection.getRequest(String url) |
com.squareup.okhttp.Response |
HttpConnection.getRequest(String url,
com.squareup.okhttp.Headers headers) |
com.squareup.okhttp.Response |
HttpConnection.postRequest(String url,
byte[] body,
com.squareup.okhttp.Headers headers) |
com.squareup.okhttp.Response |
HttpConnection.postRequest(String url,
String body) |
com.squareup.okhttp.Response |
HttpConnection.postRequest(String url,
String body,
com.squareup.okhttp.Headers headers) |
| Modifier and Type | Method and Description |
|---|---|
AllocateHostsResponse |
CvmClient.AllocateHosts(AllocateHostsRequest req)
本接口 (AllocateHosts) 用于创建一个或多个指定配置的CDH实例。
当HostChargeType为PREPAID时，必须指定HostChargePrepaid参数。
|
AssociateInstancesKeyPairsResponse |
CvmClient.AssociateInstancesKeyPairs(AssociateInstancesKeyPairsRequest req)
本接口 (AssociateInstancesKeyPairs) 用于将密钥绑定到实例上。
将密钥的公钥写入到实例的`SSH`配置当中，用户就可以通过该密钥的私钥来登录实例。
如果实例原来绑定过密钥，那么原来的密钥将失效。
如果实例原来是通过密码登录，绑定密钥后无法使用密码登录。
支持批量操作。每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。
|
AssociateSecurityGroupsResponse |
CvmClient.AssociateSecurityGroups(AssociateSecurityGroupsRequest req)
本接口 (AssociateSecurityGroups) 用于绑定安全组到指定实例。
|
CreateDisasterRecoverGroupResponse |
CvmClient.CreateDisasterRecoverGroup(CreateDisasterRecoverGroupRequest req)
本接口 (CreateDisasterRecoverGroup)用于创建[分散置放群组](https://cloud.tencent.com/document/product/213/15486)。创建好的置放群组，可在[创建实例](https://cloud.tencent.com/document/api/213/15730)时指定。
|
CreateImageResponse |
CvmClient.CreateImage(CreateImageRequest req)
本接口(CreateImage)用于将实例的系统盘制作为新镜像，创建后的镜像可以用于创建实例。
|
CreateKeyPairResponse |
CvmClient.CreateKeyPair(CreateKeyPairRequest req)
本接口 (CreateKeyPair) 用于创建一个 `OpenSSH RSA` 密钥对，可以用于登录 `Linux` 实例。
开发者只需指定密钥对名称，即可由系统自动创建密钥对，并返回所生成的密钥对的 `ID` 及其公钥、私钥的内容。
密钥对名称不能和已经存在的密钥对的名称重复。
私钥的内容可以保存到文件中作为 `SSH` 的一种认证方式。
腾讯云不会保存用户的私钥，请妥善保管。
|
DeleteDisasterRecoverGroupsResponse |
CvmClient.DeleteDisasterRecoverGroups(DeleteDisasterRecoverGroupsRequest req)
本接口 (DeleteDisasterRecoverGroups)用于删除[分散置放群组](https://cloud.tencent.com/document/product/213/15486)。只有空的置放群组才能被删除，非空的群组需要先销毁组内所有云主机，才能执行删除操作，不然会产生删除置放群组失败的错误。
|
DeleteImagesResponse |
CvmClient.DeleteImages(DeleteImagesRequest req)
本接口（DeleteImages）用于删除一个或多个镜像。
当[镜像状态](https://cloud.tencent.com/document/api/213/9452#image_state)为`创建中`和`使用中`时, 不允许删除。镜像状态可以通过[DescribeImages](https://cloud.tencent.com/document/api/213/9418)获取。
每个地域最多只支持创建10个自定义镜像，删除镜像可以释放账户的配额。
当镜像正在被其它账户分享时，不允许删除。
|
DeleteKeyPairsResponse |
CvmClient.DeleteKeyPairs(DeleteKeyPairsRequest req)
本接口 (DeleteKeyPairs) 用于删除已在腾讯云托管的密钥对。
可以同时删除多个密钥对。
不能删除已被实例或镜像引用的密钥对，所以需要独立判断是否所有密钥对都被成功删除。
|
DescribeDisasterRecoverGroupQuotaResponse |
CvmClient.DescribeDisasterRecoverGroupQuota(DescribeDisasterRecoverGroupQuotaRequest req)
本接口 (DescribeDisasterRecoverGroupQuota)用于查询[分散置放群组](https://cloud.tencent.com/document/product/213/15486)配额。
|
DescribeDisasterRecoverGroupsResponse |
CvmClient.DescribeDisasterRecoverGroups(DescribeDisasterRecoverGroupsRequest req)
本接口 (DescribeDisasterRecoverGroups)用于查询[分散置放群组](https://cloud.tencent.com/document/product/213/15486)信息。
|
DescribeHostsResponse |
CvmClient.DescribeHosts(DescribeHostsRequest req)
本接口 (DescribeHosts) 用于获取一个或多个CDH实例的详细信息。
|
DescribeImageQuotaResponse |
CvmClient.DescribeImageQuota(DescribeImageQuotaRequest req)
本接口(DescribeImageQuota)用于查询用户帐号的镜像配额。
|
DescribeImagesResponse |
CvmClient.DescribeImages(DescribeImagesRequest req)
本接口(DescribeImages) 用于查看镜像列表。
可以通过指定镜像ID来查询指定镜像的详细信息，或通过设定过滤器来查询满足过滤条件的镜像的详细信息。
指定偏移(Offset)和限制(Limit)来选择结果中的一部分，默认返回满足条件的前20个镜像信息。
|
DescribeImageSharePermissionResponse |
CvmClient.DescribeImageSharePermission(DescribeImageSharePermissionRequest req)
本接口（DescribeImageSharePermission）用于查询镜像分享信息。
|
DescribeImportImageOsResponse |
CvmClient.DescribeImportImageOs(DescribeImportImageOsRequest req)
查看可以导入的镜像操作系统信息。
|
DescribeInstanceFamilyConfigsResponse |
CvmClient.DescribeInstanceFamilyConfigs(DescribeInstanceFamilyConfigsRequest req)
本接口（DescribeInstanceFamilyConfigs）查询当前用户和地域所支持的机型族列表信息。
|
DescribeInstanceInternetBandwidthConfigsResponse |
CvmClient.DescribeInstanceInternetBandwidthConfigs(DescribeInstanceInternetBandwidthConfigsRequest req)
本接口 (DescribeInstanceInternetBandwidthConfigs) 用于查询实例带宽配置。
只支持查询`BANDWIDTH_PREPAID`计费模式的带宽配置。
接口返回实例的所有带宽配置信息（包含历史的带宽配置信息）。
|
DescribeInstancesResponse |
CvmClient.DescribeInstances(DescribeInstancesRequest req)
本接口 (DescribeInstances) 用于查询一个或多个实例的详细信息。
可以根据实例`ID`、实例名称或者实例计费模式等信息来查询实例的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的实例。
|
DescribeInstancesOperationLimitResponse |
CvmClient.DescribeInstancesOperationLimit(DescribeInstancesOperationLimitRequest req)
本接口（DescribeInstancesOperationLimit）用于查询实例操作限制。
目前支持调整配置操作限制次数查询。
|
DescribeInstancesStatusResponse |
CvmClient.DescribeInstancesStatus(DescribeInstancesStatusRequest req)
本接口 (DescribeInstancesStatus) 用于查询一个或多个实例的状态。
可以根据实例`ID`来查询实例的状态。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的实例状态。
|
DescribeInstanceTypeConfigsResponse |
CvmClient.DescribeInstanceTypeConfigs(DescribeInstanceTypeConfigsRequest req)
本接口 (DescribeInstanceTypeConfigs) 用于查询实例机型配置。
可以根据`zone`、`instance-family`来查询实例机型配置。过滤条件详见过滤器`Filter`。
如果参数为空，返回指定地域的所有实例机型配置。
|
DescribeInstanceVncUrlResponse |
CvmClient.DescribeInstanceVncUrl(DescribeInstanceVncUrlRequest req)
本接口 ( DescribeInstanceVncUrl ) 用于查询实例管理终端地址。
处于 `STOPPED` 状态的机器无法使用此功能。
管理终端地址的有效期为 15 秒，调用接口成功后如果 15 秒内不使用该链接进行访问，管理终端地址自动失效，您需要重新查询。
管理终端地址一旦被访问，将自动失效，您需要重新查询。
如果连接断开，每分钟内重新连接的次数不能超过 30 次。
获取到 `InstanceVncUrl` 后，您需要在在链接
|
DescribeInternetChargeTypeConfigsResponse |
CvmClient.DescribeInternetChargeTypeConfigs(DescribeInternetChargeTypeConfigsRequest req)
本接口（DescribeInternetChargeTypeConfigs）用于查询网络的计费类型。
|
DescribeKeyPairsResponse |
CvmClient.DescribeKeyPairs(DescribeKeyPairsRequest req)
本接口 (DescribeKeyPairs) 用于查询密钥对信息。
密钥对是通过一种算法生成的一对密钥，在生成的密钥对中，一个向外界公开，称为公钥；另一个用户自己保留，称为私钥。密钥对的公钥内容可以通过这个接口查询，但私钥内容系统不保留。
|
DescribeRegionsResponse |
CvmClient.DescribeRegions(DescribeRegionsRequest req)
本接口(DescribeRegions)用于查询地域信息。
|
DescribeReservedInstancesResponse |
CvmClient.DescribeReservedInstances(DescribeReservedInstancesRequest req)
本接口(DescribeReservedInstances)可提供列出用户已购买的预留实例
|
DescribeReservedInstancesOfferingsResponse |
CvmClient.DescribeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest req)
本接口(DescribeReservedInstancesOfferings)供用户列出可购买的预留实例配置
|
DescribeZoneInstanceConfigInfosResponse |
CvmClient.DescribeZoneInstanceConfigInfos(DescribeZoneInstanceConfigInfosRequest req)
本接口(DescribeZoneInstanceConfigInfos) 获取可用区的机型信息。
|
DescribeZonesResponse |
CvmClient.DescribeZones(DescribeZonesRequest req)
本接口(DescribeZones)用于查询可用区信息。
|
DisassociateInstancesKeyPairsResponse |
CvmClient.DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)
本接口 (DisassociateInstancesKeyPairs) 用于解除实例的密钥绑定关系。
只支持[`STOPPED`](https://cloud.tencent.com/document/api/213/9452#INSTANCE_STATE)状态的`Linux`操作系统的实例。
解绑密钥后，实例可以通过原来设置的密码登录。
如果原来没有设置密码，解绑后将无法使用 `SSH` 登录。可以调用 [ResetInstancesPassword](https://cloud.tencent.com/document/api/213/15736) 接口来设置登录密码。
支持批量操作。每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。
|
DisassociateSecurityGroupsResponse |
CvmClient.DisassociateSecurityGroups(DisassociateSecurityGroupsRequest req)
本接口 (DisassociateSecurityGroups) 用于解绑实例的指定安全组。
|
ImportImageResponse |
CvmClient.ImportImage(ImportImageRequest req)
本接口(ImportImage)用于导入镜像，导入后的镜像可用于创建实例。
|
ImportKeyPairResponse |
CvmClient.ImportKeyPair(ImportKeyPairRequest req)
本接口 (ImportKeyPair) 用于导入密钥对。
本接口的功能是将密钥对导入到用户账户，并不会自动绑定到实例。如需绑定可以使用[AssociasteInstancesKeyPair](https://cloud.tencent.com/document/api/213/9404)接口。
需指定密钥对名称以及该密钥对的公钥文本。
如果用户只有私钥，可以通过 `SSL` 工具将私钥转换成公钥后再导入。
|
InquiryPriceModifyInstancesChargeTypeResponse |
CvmClient.InquiryPriceModifyInstancesChargeType(InquiryPriceModifyInstancesChargeTypeRequest req)
本接口 (InquiryPriceModifyInstancesChargeType) 用于切换实例的计费模式询价。
只支持从 `POSTPAID_BY_HOUR` 计费模式切换为`PREPAID`计费模式。
关机不收费的实例、`BC1`和`BS1`机型族的实例、设置定时销毁的实例不支持该操作。
|
InquiryPriceRenewInstancesResponse |
CvmClient.InquiryPriceRenewInstances(InquiryPriceRenewInstancesRequest req)
本接口 (InquiryPriceRenewInstances) 用于续费包年包月实例询价。
只支持查询包年包月实例的续费价格。
|
InquiryPriceResetInstanceResponse |
CvmClient.InquiryPriceResetInstance(InquiryPriceResetInstanceRequest req)
本接口 (InquiryPriceResetInstance) 用于重装实例询价。
如果指定了`ImageId`参数，则使用指定的镜像进行重装询价；否则按照当前实例使用的镜像进行重装询价。
目前只支持[系统盘类型](/document/api/213/9452#block_device)是`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口实现`Linux`和`Windows`操作系统切换的重装询价。
目前不支持海外地域的实例使用该接口实现`Linux`和`Windows`操作系统切换的重装询价。
|
InquiryPriceResetInstancesInternetMaxBandwidthResponse |
CvmClient.InquiryPriceResetInstancesInternetMaxBandwidth(InquiryPriceResetInstancesInternetMaxBandwidthRequest req)
本接口 (InquiryPriceResetInstancesInternetMaxBandwidth) 用于调整实例公网带宽上限询价。
不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/509)。
对于`BANDWIDTH_PREPAID`计费方式的带宽，需要输入参数`StartTime`和`EndTime`，指定调整后的带宽的生效时间段。在这种场景下目前不支持调小带宽，会涉及扣费，请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/378/4397)接口查询账户余额。
对于 `TRAFFIC_POSTPAID_BY_HOUR`、 `BANDWIDTH_POSTPAID_BY_HOUR` 和 `BANDWIDTH_PACKAGE` 计费方式的带宽，使用该接口调整带宽上限是实时生效的，可以在带宽允许的范围内调大或者调小带宽，不支持输入参数 `StartTime` 和 `EndTime` 。
接口不支持调整`BANDWIDTH_POSTPAID_BY_MONTH`计费方式的带宽。
接口不支持批量调整 `BANDWIDTH_PREPAID` 和 `BANDWIDTH_POSTPAID_BY_HOUR` 计费方式的带宽。
接口不支持批量调整混合计费方式的带宽。例如不支持同时调整`TRAFFIC_POSTPAID_BY_HOUR`和`BANDWIDTH_PACKAGE`计费方式的带宽。
|
InquiryPriceResetInstancesTypeResponse |
CvmClient.InquiryPriceResetInstancesType(InquiryPriceResetInstancesTypeRequest req)
本接口 (InquiryPriceResetInstancesType) 用于调整实例的机型询价。
目前只支持[系统盘类型](https://cloud.tencent.com/document/api/213/9452#block_device)是`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口进行调整机型询价。
目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口调整机型询价。
对于包年包月实例，使用该接口会涉及扣费，请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/378/4397)接口查询账户余额。
|
InquiryPriceResizeInstanceDisksResponse |
CvmClient.InquiryPriceResizeInstanceDisks(InquiryPriceResizeInstanceDisksRequest req)
本接口 (InquiryPriceResizeInstanceDisks) 用于扩容实例的数据盘询价。
目前只支持扩容非弹性数据盘（[`DescribeDisks`](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性）询价，且[数据盘类型](/document/api/213/9452#block_device)为：`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`。
目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口扩容数据盘询价。* 仅支持包年包月实例随机器购买的数据盘。* 目前只支持扩容一块数据盘询价。
|
InquiryPriceRunInstancesResponse |
CvmClient.InquiryPriceRunInstances(InquiryPriceRunInstancesRequest req)
本接口(InquiryPriceRunInstances)用于创建实例询价。本接口仅允许针对购买限制范围内的实例配置进行询价, 详见：[创建实例](https://cloud.tencent.com/document/api/213/15730)。
|
ModifyDisasterRecoverGroupAttributeResponse |
CvmClient.ModifyDisasterRecoverGroupAttribute(ModifyDisasterRecoverGroupAttributeRequest req)
本接口 (ModifyDisasterRecoverGroupAttribute)用于修改[分散置放群组](https://cloud.tencent.com/document/product/213/15486)属性。
|
ModifyHostsAttributeResponse |
CvmClient.ModifyHostsAttribute(ModifyHostsAttributeRequest req)
本接口（ModifyHostsAttribute）用于修改CDH实例的属性，如实例名称和续费标记等。参数HostName和RenewFlag必须设置其中一个，但不能同时设置。
|
ModifyImageAttributeResponse |
CvmClient.ModifyImageAttribute(ModifyImageAttributeRequest req)
本接口（ModifyImageAttribute）用于修改镜像属性。
已分享的镜像无法修改属性。
|
ModifyImageSharePermissionResponse |
CvmClient.ModifyImageSharePermission(ModifyImageSharePermissionRequest req)
本接口（ModifyImageSharePermission）用于修改镜像分享信息。
分享镜像后，被分享账户可以通过该镜像创建实例。
每个自定义镜像最多可共享给50个账户。
分享镜像无法更改名称，描述，仅可用于创建实例。
只支持分享到对方账户相同地域。
|
ModifyInstancesAttributeResponse |
CvmClient.ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)
本接口 (ModifyInstancesAttribute) 用于修改实例的属性（目前只支持修改实例的名称和关联的安全组）。
“实例名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为提交工单或是进行实例管理操作的依据。
支持批量操作。每次请求批量实例的上限为100。
修改关联安全组时，子机原来关联的安全组会被解绑。
|
ModifyInstancesChargeTypeResponse |
CvmClient.ModifyInstancesChargeType(ModifyInstancesChargeTypeRequest req)
本接口 (ModifyInstancesChargeType) 用于切换实例的计费模式。
只支持从 `POSTPAID_BY_HOUR` 计费模式切换为`PREPAID`计费模式。
关机不收费的实例、`BC1`和`BS1`机型族的实例、设置定时销毁的实例不支持该操作。
|
ModifyInstancesProjectResponse |
CvmClient.ModifyInstancesProject(ModifyInstancesProjectRequest req)
本接口 (ModifyInstancesProject) 用于修改实例所属项目。
项目为一个虚拟概念，用户可以在一个账户下面建立多个项目，每个项目中管理不同的资源；将多个不同实例分属到不同项目中，后续使用 [`DescribeInstances`](https://cloud.tencent.com/document/api/213/9388)接口查询实例，项目ID可用于过滤结果。
绑定负载均衡的实例不支持修改实例所属项目，请先使用[`DeregisterInstancesFromLoadBalancer`](https://cloud.tencent.com/document/api/214/1258)接口解绑负载均衡。
修改实例所属项目会自动解关联实例原来关联的安全组，修改完成后可能使用[`ModifySecurityGroupsOfInstance`](https://cloud.tencent.com/document/api/213/1367)接口关联安全组。
支持批量操作。每次请求批量实例的上限为100。
|
ModifyInstancesRenewFlagResponse |
CvmClient.ModifyInstancesRenewFlag(ModifyInstancesRenewFlagRequest req)
本接口 (ModifyInstancesRenewFlag) 用于修改包年包月实例续费标识。
实例被标识为自动续费后，每次在实例到期时，会自动续费一个月。
支持批量操作。每次请求批量实例的上限为100。
|
ModifyInstancesVpcAttributeResponse |
CvmClient.ModifyInstancesVpcAttribute(ModifyInstancesVpcAttributeRequest req)
本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性，如私有网络ip。
此操作默认会关闭实例，完成后再启动。
当指定私有网络ID和子网ID（子网必须在实例所在的可用区）与指定实例所在私有网络不一致时，会将实例迁移至指定的私有网络的子网下。执行此操作前请确保指定的实例上没有绑定[弹性网卡](https://cloud.tencent.com/document/product/576)和[负载均衡](https://cloud.tencent.com/document/product/214)。
|
ModifyKeyPairAttributeResponse |
CvmClient.ModifyKeyPairAttribute(ModifyKeyPairAttributeRequest req)
本接口 (ModifyKeyPairAttribute) 用于修改密钥对属性。
修改密钥对ID所指定的密钥对的名称和描述信息。
密钥对名称不能和已经存在的密钥对的名称重复。
密钥对ID是密钥对的唯一标识，不可修改。
|
PurchaseReservedInstancesOfferingResponse |
CvmClient.PurchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest req)
本接口(PurchaseReservedInstancesOffering)用于用户购买一个或者多个指定配置的预留实例
|
RebootInstancesResponse |
CvmClient.RebootInstances(RebootInstancesRequest req)
本接口 (RebootInstances) 用于重启实例。
只有状态为`RUNNING`的实例才可以进行此操作。
接口调用成功时，实例会进入`REBOOTING`状态；重启实例成功时，实例会进入`RUNNING`状态。
支持强制重启。强制重启的效果等同于关闭物理计算机的电源开关再重新启动。强制重启可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常重启时使用。
支持批量操作，每次请求批量实例的上限为100。
|
RenewHostsResponse |
CvmClient.RenewHosts(RenewHostsRequest req)
本接口 (RenewHosts) 用于续费包年包月CDH实例。
只支持操作包年包月实例，否则操作会以特定[错误码](#4.-.E9.94.99.E8.AF.AF.E7.A0.81)返回。
续费时请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/378/4397)接口查询账户余额。
|
RenewInstancesResponse |
CvmClient.RenewInstances(RenewInstancesRequest req)
本接口 (RenewInstances) 用于续费包年包月实例。
只支持操作包年包月实例。
续费时请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/378/4397)接口查询账户余额。
|
ResetInstanceResponse |
CvmClient.ResetInstance(ResetInstanceRequest req)
本接口 (ResetInstance) 用于重装指定实例上的操作系统。
如果指定了`ImageId`参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。
系统盘将会被格式化，并重置；请确保系统盘中无重要文件。
`Linux`和`Windows`系统互相切换时，该实例系统盘`ID`将发生变化，系统盘关联快照将无法回滚、恢复数据。
密码不指定将会通过站内信下发随机密码。
目前只支持[系统盘类型](https://cloud.tencent.com/document/api/213/9452#block_device)是`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口实现`Linux`和`Windows`操作系统切换。
目前不支持海外地域的实例使用该接口实现`Linux`和`Windows`操作系统切换。
|
ResetInstancesInternetMaxBandwidthResponse |
CvmClient.ResetInstancesInternetMaxBandwidth(ResetInstancesInternetMaxBandwidthRequest req)
本接口 (ResetInstancesInternetMaxBandwidth) 用于调整实例公网带宽上限。
不同机型带宽上限范围不一致，具体限制详见[购买网络带宽](https://cloud.tencent.com/document/product/213/509)。
对于 `BANDWIDTH_PREPAID` 计费方式的带宽，需要输入参数 `StartTime` 和 `EndTime` ，指定调整后的带宽的生效时间段。在这种场景下目前不支持调小带宽，会涉及扣费，请确保账户余额充足。可通过 [`DescribeAccountBalance`](https://cloud.tencent.com/document/product/378/4397) 接口查询账户余额。
对于 `TRAFFIC_POSTPAID_BY_HOUR` 、 `BANDWIDTH_POSTPAID_BY_HOUR` 和 `BANDWIDTH_PACKAGE` 计费方式的带宽，使用该接口调整带宽上限是实时生效的，可以在带宽允许的范围内调大或者调小带宽，不支持输入参数 `StartTime` 和 `EndTime` 。
接口不支持调整 `BANDWIDTH_POSTPAID_BY_MONTH` 计费方式的带宽。
接口不支持批量调整 `BANDWIDTH_PREPAID` 和 `BANDWIDTH_POSTPAID_BY_HOUR` 计费方式的带宽。
接口不支持批量调整混合计费方式的带宽。例如不支持同时调整 `TRAFFIC_POSTPAID_BY_HOUR` 和 `BANDWIDTH_PACKAGE` 计费方式的带宽。
|
ResetInstancesPasswordResponse |
CvmClient.ResetInstancesPassword(ResetInstancesPasswordRequest req)
本接口 (ResetInstancesPassword) 用于将实例操作系统的密码重置为用户指定的密码。
只修改管理员帐号的密码。实例的操作系统不同，管理员帐号也会不一样(`Windows`为`Administrator`，`Ubuntu`为`ubuntu`，其它系统为`root`)。
重置处于运行中状态的实例，需要显式指定强制关机参数`ForceStop`。如果没有显式指定强制关机参数，则只有处于关机状态的实例才允许执行重置密码操作。
支持批量操作。将多个实例操作系统的密码重置为相同的密码。每次请求批量实例的上限为100。
|
ResetInstancesTypeResponse |
CvmClient.ResetInstancesType(ResetInstancesTypeRequest req)
本接口 (ResetInstancesType) 用于调整实例的机型。
目前只支持[系统盘类型](/document/api/213/9452#block_device)是`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口进行机型调整。
目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口调整机型。对于包年包月实例，使用该接口会涉及扣费，请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/378/4397)接口查询账户余额。
|
ResizeInstanceDisksResponse |
CvmClient.ResizeInstanceDisks(ResizeInstanceDisksRequest req)
本接口 (ResizeInstanceDisks) 用于扩容实例的数据盘。
目前只支持扩容非弹性数据盘（[`DescribeDisks`](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性），且[数据盘类型](/document/api/213/9452#block_device)为：`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`。
目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口扩容数据盘。
对于包年包月实例，使用该接口会涉及扣费，请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/378/4397)接口查询账户余额。
目前只支持扩容一块数据盘。
|
RunInstancesResponse |
CvmClient.RunInstances(RunInstancesRequest req)
本接口 (RunInstances) 用于创建一个或多个指定配置的实例。
实例创建成功后将自动开机启动，[实例状态](/document/api/213/9452#instance_state)变为“运行中”。
预付费实例的购买会预先扣除本次实例购买所需金额，按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额，在调用本接口前请确保账户余额充足。
本接口允许购买的实例数量遵循[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)，所创建的实例和官网入口创建的实例共用配额。
本接口为异步接口，当创建请求下发成功后会返回一个实例`ID`列表，此时实例的创建并立即未完成。在此期间实例的状态将会处于“准备中”，可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728) 接口查询对应实例的状态，来判断创建有没有最终成功。如果实例的状态由“准备中”变为“运行中”，则为创建成功。
|
StartInstancesResponse |
CvmClient.StartInstances(StartInstancesRequest req)
本接口 (StartInstances) 用于启动一个或多个实例。
只有状态为`STOPPED`的实例才可以进行此操作。
接口调用成功时，实例会进入`STARTING`状态；启动实例成功时，实例会进入`RUNNING`状态。
支持批量操作。每次请求批量实例的上限为100。
|
StopInstancesResponse |
CvmClient.StopInstances(StopInstancesRequest req)
本接口 (StopInstances) 用于关闭一个或多个实例。
只有状态为`RUNNING`的实例才可以进行此操作。
接口调用成功时，实例会进入`STOPPING`状态；关闭实例成功时，实例会进入`STOPPED`状态。
支持强制关闭。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。
支持批量操作。每次请求批量实例的上限为100。
|
SyncImagesResponse |
CvmClient.SyncImages(SyncImagesRequest req)
本接口（SyncImages）用于将自定义镜像同步到其它地区。
该接口每次调用只支持同步一个镜像。
该接口支持多个同步地域。
单个帐号在每个地域最多支持存在10个自定义镜像。
|
TerminateInstancesResponse |
CvmClient.TerminateInstances(TerminateInstancesRequest req)
本接口 (TerminateInstances) 用于主动退还实例。
不再使用的实例，可通过本接口主动退还。
按量计费的实例通过本接口可直接退还；包年包月实例如符合[退还规则](https://cloud.tencent.com/document/product/213/9711)，也可通过本接口主动退还。
支持批量操作，每次请求批量实例的上限为100。
|
| Modifier and Type | Method and Description |
|---|---|
CloneAccountResponse |
DcdbClient.CloneAccount(CloneAccountRequest req)
本接口（CloneAccount）用于克隆实例账户。
|
CloseDBExtranetAccessResponse |
DcdbClient.CloseDBExtranetAccess(CloseDBExtranetAccessRequest req)
本接口(CloseDBExtranetAccess)用于关闭云数据库实例的外网访问。关闭外网访问后，外网地址将不可访问，查询实例列表接口将不返回对应实例的外网域名和端口信息。
|
CopyAccountPrivilegesResponse |
DcdbClient.CopyAccountPrivileges(CopyAccountPrivilegesRequest req)
本接口（CopyAccountPrivileges）用于复制云数据库账号的权限。
注意：相同用户名，不同Host是不同的账号，Readonly属性相同的账号之间才能复制权限。
|
CreateAccountResponse |
DcdbClient.CreateAccount(CreateAccountRequest req)
本接口（CreateAccount）用于创建云数据库账号。一个实例可以创建多个不同的账号，相同的用户名+不同的host是不同的账号。
|
CreateDCDBInstanceResponse |
DcdbClient.CreateDCDBInstance(CreateDCDBInstanceRequest req)
本接口（CreateDCDBInstance）用于创建包年包月的云数据库实例，可通过传入实例规格、数据库版本号、购买时长等信息创建云数据库实例。
|
DeleteAccountResponse |
DcdbClient.DeleteAccount(DeleteAccountRequest req)
本接口（DeleteAccount）用于删除云数据库账号。用户名+host唯一确定一个账号。
|
DescribeAccountPrivilegesResponse |
DcdbClient.DescribeAccountPrivileges(DescribeAccountPrivilegesRequest req)
本接口（DescribeAccountPrivileges）用于查询云数据库账号权限。
注意：注意：相同用户名，不同Host是不同的账号。
|
DescribeAccountsResponse |
DcdbClient.DescribeAccounts(DescribeAccountsRequest req)
本接口（DescribeAccounts）用于查询指定云数据库实例的账号列表。
|
DescribeDatabaseObjectsResponse |
DcdbClient.DescribeDatabaseObjects(DescribeDatabaseObjectsRequest req)
本接口（DescribeDatabaseObjects）用于查询云数据库实例的数据库中的对象列表，包含表、存储过程、视图和函数。
|
DescribeDatabasesResponse |
DcdbClient.DescribeDatabases(DescribeDatabasesRequest req)
本接口（DescribeDatabases）用于查询云数据库实例的数据库列表。
|
DescribeDatabaseTableResponse |
DcdbClient.DescribeDatabaseTable(DescribeDatabaseTableRequest req)
本接口（DescribeDatabaseTable）用于查询云数据库实例的表信息。
|
DescribeDBLogFilesResponse |
DcdbClient.DescribeDBLogFiles(DescribeDBLogFilesRequest req)
本接口(DescribeDBLogFiles)用于获取数据库的各种日志列表，包括冷备、binlog、errlog和slowlog。
|
DescribeDBParametersResponse |
DcdbClient.DescribeDBParameters(DescribeDBParametersRequest req)
本接口(DescribeDBParameters)用于获取数据库的当前参数设置。
|
DescribeDBSyncModeResponse |
DcdbClient.DescribeDBSyncMode(DescribeDBSyncModeRequest req)
本接口（DescribeDBSyncMode）用于查询云数据库实例的同步模式。
|
DescribeDCDBInstancesResponse |
DcdbClient.DescribeDCDBInstances(DescribeDCDBInstancesRequest req)
查询云数据库实例列表，支持通过项目ID、实例ID、内网地址、实例名称等来筛选实例。
如果不指定任何筛选条件，则默认返回10条实例记录，单次请求最多支持返回100条实例记录。
|
DescribeDCDBPriceResponse |
DcdbClient.DescribeDCDBPrice(DescribeDCDBPriceRequest req)
本接口（DescribeDCDBPrice）用于在购买实例前，查询实例的价格。
|
DescribeDCDBRenewalPriceResponse |
DcdbClient.DescribeDCDBRenewalPrice(DescribeDCDBRenewalPriceRequest req)
本接口（DescribeDCDBRenewalPrice）用于在续费分布式数据库实例时，查询续费的价格。
|
DescribeDCDBSaleInfoResponse |
DcdbClient.DescribeDCDBSaleInfo(DescribeDCDBSaleInfoRequest req)
本接口(DescribeDCDBSaleInfo)用于查询分布式数据库可售卖的地域和可用区信息。
|
DescribeDCDBShardsResponse |
DcdbClient.DescribeDCDBShards(DescribeDCDBShardsRequest req)
本接口（DescribeDCDBShards）用于查询云数据库实例的分片信息。
|
DescribeDCDBUpgradePriceResponse |
DcdbClient.DescribeDCDBUpgradePrice(DescribeDCDBUpgradePriceRequest req)
本接口（DescribeDCDBUpgradePrice）用于查询升级分布式数据库实例价格。
|
DescribeOrdersResponse |
DcdbClient.DescribeOrders(DescribeOrdersRequest req)
本接口（DescribeOrders）用于查询分布式数据库订单信息。传入订单Id来查询订单关联的分布式数据库实例，和对应的任务流程ID。
|
DescribeShardSpecResponse |
DcdbClient.DescribeShardSpec(DescribeShardSpecRequest req)
查询可创建的分布式数据库可售卖的分片规格配置。
|
DescribeSqlLogsResponse |
DcdbClient.DescribeSqlLogs(DescribeSqlLogsRequest req)
本接口（DescribeSqlLogs）用于获取实例SQL日志。
|
GrantAccountPrivilegesResponse |
DcdbClient.GrantAccountPrivileges(GrantAccountPrivilegesRequest req)
本接口（GrantAccountPrivileges）用于给云数据库账号赋权。
注意：相同用户名，不同Host是不同的账号。
|
InitDCDBInstancesResponse |
DcdbClient.InitDCDBInstances(InitDCDBInstancesRequest req)
本接口(InitDCDBInstances)用于初始化云数据库实例，包括设置默认字符集、表名大小写敏感等。
|
ModifyAccountDescriptionResponse |
DcdbClient.ModifyAccountDescription(ModifyAccountDescriptionRequest req)
本接口（ModifyAccountDescription）用于修改云数据库账号备注。
注意：相同用户名，不同Host是不同的账号。
|
ModifyDBInstancesProjectResponse |
DcdbClient.ModifyDBInstancesProject(ModifyDBInstancesProjectRequest req)
本接口（ModifyDBInstancesProject）用于修改云数据库实例所属项目。
|
ModifyDBParametersResponse |
DcdbClient.ModifyDBParameters(ModifyDBParametersRequest req)
本接口(ModifyDBParameters)用于修改数据库参数。
|
ModifyDBSyncModeResponse |
DcdbClient.ModifyDBSyncMode(ModifyDBSyncModeRequest req)
本接口（ModifyDBSyncMode）用于修改云数据库实例的同步模式。
|
OpenDBExtranetAccessResponse |
DcdbClient.OpenDBExtranetAccess(OpenDBExtranetAccessRequest req)
本接口（OpenDBExtranetAccess）用于开通云数据库实例的外网访问。开通外网访问后，您可通过外网域名和端口访问实例，可使用查询实例列表接口获取外网域名和端口信息。
|
RenewDCDBInstanceResponse |
DcdbClient.RenewDCDBInstance(RenewDCDBInstanceRequest req)
本接口（RenewDCDBInstance）用于续费分布式数据库实例。
|
ResetAccountPasswordResponse |
DcdbClient.ResetAccountPassword(ResetAccountPasswordRequest req)
本接口（ResetAccountPassword）用于重置云数据库账号的密码。
注意：相同用户名，不同Host是不同的账号。
|
UpgradeDCDBInstanceResponse |
DcdbClient.UpgradeDCDBInstance(UpgradeDCDBInstanceRequest req)
本接口（UpgradeDCDBInstance）用于升级分布式数据库实例。本接口完成下单和支付两个动作，如果发生支付失败的错误，调用用户账户相关接口中的支付订单接口（PayDeals）重新支付即可。
|
| Modifier and Type | Method and Description |
|---|---|
CheckDomainResponse |
DomainClient.CheckDomain(CheckDomainRequest req)
检查域名是否可以注册
|
DescribeDomainPriceListResponse |
DomainClient.DescribeDomainPriceList(DescribeDomainPriceListRequest req)
按照域名后缀获取对应的价格列表
|
| Modifier and Type | Method and Description |
|---|---|
AddFairPlayPemResponse |
DrmClient.AddFairPlayPem(AddFairPlayPemRequest req)
本接口用来设置fairplay方案所需的私钥、私钥密钥、ask等信息。
如需使用fairplay方案，请务必先设置私钥。
|
CreateLicenseResponse |
DrmClient.CreateLicense(CreateLicenseRequest req)
本接口用来生成DRM方案对应的播放许可证，开发者需提供DRM方案类型、内容类型参数，后台将生成许可证后返回许可证数据
开发者需要转发终端设备发出的许可证请求信息。
|
DeleteFairPlayPemResponse |
DrmClient.DeleteFairPlayPem(DeleteFairPlayPemRequest req)
本接口用来删除fairplay方案的私钥、ask等信息
注：高风险操作，删除后，您将无法使用腾讯云DRM提供的fairplay服务。
由于缓存，删除操作需要约半小时生效
|
DescribeFairPlayPemResponse |
DrmClient.DescribeFairPlayPem(DescribeFairPlayPemRequest req)
该接口用来查询设置的FairPlay私钥校验信息。可用该接口校验设置的私钥与本身的私钥是否一致。
|
DescribeKeysResponse |
DrmClient.DescribeKeys(DescribeKeysRequest req)
开发者需要指定使用的DRM类型、和需要加密的Track类型，后台返回加密使用的密钥
如果加密使用的ContentID没有关联的密钥信息，后台会自动生成新的密钥返回
|
ModifyFairPlayPemResponse |
DrmClient.ModifyFairPlayPem(ModifyFairPlayPemRequest req)
本接口用来设置fairplay方案所需的私钥、私钥密钥、ask等信息。
如需使用fairplay方案，请务必先设置私钥。
|
StartEncryptionResponse |
DrmClient.StartEncryption(StartEncryptionRequest req)
开发者调用该接口，启动一次内容文件的DRM加密工作流
|
| Modifier and Type | Method and Description |
|---|---|
CheckVcodeResponse |
DsClient.CheckVcode(CheckVcodeRequest req)
检测验证码接口。此接口用于企业电子合同平台通过给用户发送短信验证码，以短信授权方式签署合同。此接口配合发送验证码接口使用。
用户在企业电子合同平台输入收到的验证码后，由企业电子合同平台调用该接口向腾讯云提交确认受托签署合同验证码命令。验证码验证正确时，本次合同签署的授权成功。
|
CreateContractByUploadResponse |
DsClient.CreateContractByUpload(CreateContractByUploadRequest req)
此接口适用于：客户平台通过上传PDF文件作为合同，以备未来进行签署。接口返回任务号，可调用DescribeTaskStatus接口查看任务执行结果。
|
CreateEnterpriseAccountResponse |
DsClient.CreateEnterpriseAccount(CreateEnterpriseAccountRequest req)
为企业电子合同平台的最终企业用户进行开户。在企业电子合同平台进行操作的企业用户，企业电子合同平台向腾讯云发送企业用户的信息，提交开户命令。腾讯云接到请求后，自动为企业电子合同平台的企业用户生成一张数字证书。
|
CreatePersonalAccountResponse |
DsClient.CreatePersonalAccount(CreatePersonalAccountRequest req)
为企业电子合同平台的最终个人用户进行开户。在企业电子合同平台进行操作的个人用户，企业电子合同平台向腾讯云发送个人用户的信息，提交开户命令。腾讯云接到请求后，自动为企业电子合同平台的个人用户生成一张数字证书。
|
CreateSealResponse |
DsClient.CreateSeal(CreateSealRequest req)
此接口用于客户电子合同平台增加某用户的印章图片。客户平台可以调用此接口增加某用户的印章图片。
|
DeleteAccountResponse |
DsClient.DeleteAccount(DeleteAccountRequest req)
删除企业电子合同平台的最终用户。调用该接口后，腾讯云将删除该用户账号。删除账号后，已经签名的合同不受影响。
|
DeleteSealResponse |
DsClient.DeleteSeal(DeleteSealRequest req)
删除印章接口，删除指定账号的某个印章
|
DescribeTaskStatusResponse |
DsClient.DescribeTaskStatus(DescribeTaskStatusRequest req)
接口使用于：客户平台可使用该接口查询任务执行状态或者执行结果
|
DownloadContractResponse |
DsClient.DownloadContract(DownloadContractRequest req)
下载合同接口。调用该接口可以下载签署中和签署完成的合同。接口返回任务号，可调用DescribeTaskStatus接口查看任务执行结果。
|
SendVcodeResponse |
DsClient.SendVcode(SendVcodeRequest req)
发送验证码接口。此接口用于：企业电子合同平台需要腾讯云发送验证码对其用户进行验证时调用，腾讯云将向其用户联系手机(企业电子合同平台为用户开户时通过接口传入)发送验证码，以验证码授权方式签署合同。用户验证工作由企业电子合同平台自身完成。
|
SignContractByCoordinateResponse |
DsClient.SignContractByCoordinate(SignContractByCoordinateRequest req)
此接口适用于：客户平台在创建好合同后，由合同签署方对创建的合同内容进行确认，无误后再进行签署。客户平台使用该接口提供详细的PDF文档签名坐标进行签署。
|
SignContractByKeywordResponse |
DsClient.SignContractByKeyword(SignContractByKeywordRequest req)
此接口适用于：客户平台在创建好合同后，由合同签署方对创建的合同内容进行确认，无误后再进行签署。客户平台使用该接口对PDF合同文档按照关键字和坐标进行签署。
|
| Modifier and Type | Method and Description |
|---|---|
CompleteMigrateJobResponse |
DtsClient.CompleteMigrateJob(CompleteMigrateJobRequest req)
本接口（CompleteMigrateJob）用于完成数据迁移任务。
选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。
通过DescribeMigrateJobs接口查询到任务的状态为准备完成（status=8）时，此时可以调用本接口完成迁移任务。
|
CreateMigrateCheckJobResponse |
DtsClient.CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)
创建校验迁移任务
在开始迁移前, 必须调用本接口创建校验, 且校验成功后才能开始迁移.
|
CreateMigrateJobResponse |
DtsClient.CreateMigrateJob(CreateMigrateJobRequest req)
本接口（CreateMigrateJob）用于创建数据迁移任务。
如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
|
CreateSyncCheckJobResponse |
DtsClient.CreateSyncCheckJob(CreateSyncCheckJobRequest req)
在调用 StartSyncJob 接口启动灾备同步前, 必须调用本接口创建校验, 且校验成功后才能开始同步数据.
|
CreateSyncJobResponse |
DtsClient.CreateSyncJob(CreateSyncJobRequest req)
本接口(CreateSyncJob)用于创建灾备同步任务。
创建同步任务后，可以通过 CreateSyncCheckJob 接口发起校验任务。校验成功后才可以通过 StartSyncJob 接口启动同步任务。
|
DeleteMigrateJobResponse |
DtsClient.DeleteMigrateJob(DeleteMigrateJobRequest req)
本接口（DeleteMigrationJob）用于删除数据迁移任务。当通过DescribeMigrateJobs接口查询到任务的状态为：检验中（status=3）、运行中（status=7）、准备完成（status=8）、撤销中（status=11）或者完成中（status=12）时，不允许删除任务。
|
DeleteSyncJobResponse |
DtsClient.DeleteSyncJob(DeleteSyncJobRequest req)
删除灾备同步任务 （运行中的同步任务不能删除）。
|
DescribeMigrateCheckJobResponse |
DtsClient.DescribeMigrateCheckJob(DescribeMigrateCheckJobRequest req)
本接口用于创建校验后,获取校验的结果.
|
DescribeMigrateJobsResponse |
DtsClient.DescribeMigrateJobs(DescribeMigrateJobsRequest req)
查询数据迁移任务.
|
DescribeSyncCheckJobResponse |
DtsClient.DescribeSyncCheckJob(DescribeSyncCheckJobRequest req)
本接口用于在通过 CreateSyncCheckJob 接口创建灾备同步校验任务后，获取校验的结果。能查询到当前校验的状态和进度。
若通过校验, 则可调用 StartSyncJob 启动同步任务。
若未通过校验, 则会返回校验失败的原因。 可通过 ModifySyncJob 修改配置，然后再次发起校验。
校验任务需要大概约30秒，当返回的 Status 不为 finished 时表示尚未校验完成，需要轮询该接口。
如果 Status=finished 且 CheckFlag=1 时表示校验成功。
如果 Status=finished 且 CheckFlag !=1 时表示校验失败。
|
DescribeSyncJobsResponse |
DtsClient.DescribeSyncJobs(DescribeSyncJobsRequest req)
查询在迁移平台发起的灾备同步任务
|
ModifyMigrateJobResponse |
DtsClient.ModifyMigrateJob(ModifyMigrateJobRequest req)
本接口（ModifyMigrateJob）用于修改数据迁移任务。
当迁移任务处于下述状态时，允许调用本接口修改迁移任务：迁移创建中（status=1）、 校验成功(status=4)、校验失败(status=5)、迁移失败(status=10)。但源实例、目标实例类型和目标实例地域不允许修改。
如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
|
ModifySyncJobResponse |
DtsClient.ModifySyncJob(ModifySyncJobRequest req)
修改灾备同步任务.
|
StartMigrateJobResponse |
DtsClient.StartMigrateJob(StartMigrateJobRequest req)
本接口（StartMigrationJob）用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移，定时任务则会开始倒计时。
调用此接口前，请务必先使用CreateMigrateCheckJob校验数据迁移任务，并通过DescribeMigrateJobs接口查询到任务状态为校验通过（status=4）时，才能启动数据迁移任务。
|
StartSyncJobResponse |
DtsClient.StartSyncJob(StartSyncJobRequest req)
创建的灾备同步任务在通过 CreateSyncCheckJob 和 DescribeSyncCheckJob 确定校验成功后，可以调用该接口启动同步
|
StopMigrateJobResponse |
DtsClient.StopMigrateJob(StopMigrateJobRequest req)
本接口（StopMigrateJob）用于撤销数据迁移任务。
在迁移过程中允许调用该接口撤销迁移, 撤销迁移的任务会失败。通过DescribeMigrateJobs接口查询到任务状态为运行中（status=7）或准备完成（status=8）时，才能撤销数据迁移任务。
|
SwitchDrToMasterResponse |
DtsClient.SwitchDrToMaster(SwitchDrToMasterRequest req)
将灾备升级为主实例，停止从原来所属主实例的同步，断开主备关系。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeTaskResponse |
EccClient.DescribeTask(DescribeTaskRequest req)
异步任务结果查询接口
|
ECCResponse |
EccClient.ECC(ECCRequest req)
接口请求域名： ecc.tencentcloudapi.com
纯文本英语作文批改
|
EHOCRResponse |
EccClient.EHOCR(EHOCRRequest req)
https://ecc.tencentcloudapi.com/?Action=EHOCR
图像识别批改接口
|
| Modifier and Type | Method and Description |
|---|---|
CreateInstanceResponse |
EsClient.CreateInstance(CreateInstanceRequest req)
创建指定规格的ES集群实例
|
DeleteInstanceResponse |
EsClient.DeleteInstance(DeleteInstanceRequest req)
销毁集群实例
|
DescribeInstanceLogsResponse |
EsClient.DescribeInstanceLogs(DescribeInstanceLogsRequest req)
查询用户该地域下符合条件的ES集群的日志
|
DescribeInstanceOperationsResponse |
EsClient.DescribeInstanceOperations(DescribeInstanceOperationsRequest req)
查询实例指定条件下的操作记录
|
DescribeInstancesResponse |
EsClient.DescribeInstances(DescribeInstancesRequest req)
查询用户该地域下符合条件的所有实例
|
RestartInstanceResponse |
EsClient.RestartInstance(RestartInstanceRequest req)
重启ES集群实例(用于系统版本更新等操作)
|
UpdateInstanceResponse |
EsClient.UpdateInstance(UpdateInstanceRequest req)
对集群进行扩缩容，修改实例名称，修改配置，重置密码， 添加Kibana黑白名单等操作。参数中InstanceId为必传参数，ForceRestart为选填参数，剩余参数传递组合及含义如下：
- InstanceName：修改实例名称(仅用于标识实例)
- NodeNum：集群数据节点横向扩缩容
- NodeType, DiskSize：集群数据节点纵向扩缩容
- MasterNodeNum: 集群专用主节点横向扩缩容
- MasterNodeType, MasterNodeDiskSize: 集群专用主节点纵向扩缩容
- EsConfig：修改集群配置
- Password：修改默认用户elastic的密码
- EsAcl：修改访问控制列表
- CosBackUp: 设置集群COS自动备份信息
以上参数组合只能传递一种，多传或少传均会导致请求失败
|
UpgradeInstanceResponse |
EsClient.UpgradeInstance(UpgradeInstanceRequest req)
升级ES集群版本
|
UpgradeLicenseResponse |
EsClient.UpgradeLicense(UpgradeLicenseRequest req)
升级ES商业特性
|
| Modifier and Type | Method and Description |
|---|---|
FaceFusionResponse |
FacefusionClient.FaceFusion(FaceFusionRequest req)
本接口用于人脸融合，用户上传人脸图片，获取与模板融合后的人脸图片。未发布的活动请求频率限制为1次/秒，已发布的活动请求频率限制50次/秒。如有需要提高活动的请求频率限制，请在控制台中申请。
>
- 公共参数中的签名方式必须指定为V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
FuseFaceResponse |
FacefusionClient.FuseFace(FuseFaceRequest req)
本接口用于单脸、多脸融合，用户上传人脸图片，获取与模板融合后的人脸图片。查看 选脸融合接入指引。
未发布的活动请求频率限制为1次/秒，已发布的活动请求频率限制50次/秒。如有需要提高活动的请求频率限制，请在控制台中申请。
>
- 公共参数中的签名方式必须指定为V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
| Modifier and Type | Method and Description |
|---|---|
CreateAppResponse |
GmeClient.CreateApp(CreateAppRequest req)
本接口(CreateApp)用于创建一个GME应用
|
DescribeAppStatisticsResponse |
GmeClient.DescribeAppStatistics(DescribeAppStatisticsRequest req)
本接口(DescribeAppStatistics)用户获取某个GME应用的用量数据。包括实时语音，离线语音，语音过滤等。最长查询周期为最近30天。
|
DescribeFilterResultResponse |
GmeClient.DescribeFilterResult(DescribeFilterResultRequest req)
根据应用ID和文件ID查询识别结果
|
DescribeFilterResultListResponse |
GmeClient.DescribeFilterResultList(DescribeFilterResultListRequest req)
根据日期查询识别结果列表
|
DescribeScanResultListResponse |
GmeClient.DescribeScanResultList(DescribeScanResultListRequest req)
本接口(DescribeScanResultList)用于查询语音检测结果，查询任务列表最多支持100个。
如果在提交语音检测任务时未设置 Callback 字段，则需要通过本接口获取检测结果 |
ModifyAppStatusResponse |
GmeClient.ModifyAppStatus(ModifyAppStatusRequest req)
本接口(ModifyAppStatus)用于修改应用总开关状态。
|
ScanVoiceResponse |
GmeClient.ScanVoice(ScanVoiceRequest req)
本接口(ScanVoice)用于提交语音检测任务，检测任务列表最多支持100个。使用前请您登录[控制台 - 服务配置](https://console.cloud.tencent.com/gamegme/conf)开启语音分析服务。
|
VoiceFilterResponse |
GmeClient.VoiceFilter(VoiceFilterRequest req)
本接口用于识别涉黄、涉政等违规音频，成功会回调配置在应用的回调地址。回调示例如下：
{"BizId":0,"FileId":"test_file_id","FileName":"test_file_name","FileUrl":"test_file_url","OpenId":"test_open_id","TimeStamp":"0000-00-00 00:00:00","Data":[{"Type":1,"Word":"xx"}]}
Type表示过滤类型，1：政治，2：色情，3：谩骂
|
| Modifier and Type | Method and Description |
|---|---|
DescribeStatusResponse |
HaboClient.DescribeStatus(DescribeStatusRequest req)
查询指定md5样本是否分析完成，并获取分析日志下载地址。
|
StartAnalyseResponse |
HaboClient.StartAnalyse(StartAnalyseRequest req)
上传样本到哈勃进行分析，异步生成分析日志。
|
| Modifier and Type | Method and Description |
|---|---|
EvaluationResponse |
HcmClient.Evaluation(EvaluationRequest req)
速算题目批改接口，根据用户上传的图片或图片的URL识别图片中的数学算式，进而给出算式的正确性评估。
|
| Modifier and Type | Method and Description |
|---|---|
AnalyzeFaceResponse |
IaiClient.AnalyzeFace(AnalyzeFaceRequest req)
对请求图片进行五官定位（也称人脸关键点定位），计算构成人脸轮廓的 90 个点，包括眉毛（左右各 8 点）、眼睛（左右各 8 点）、鼻子（13 点）、嘴巴（22 点）、脸型轮廓（21 点）、眼珠[或瞳孔]（2点）。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
CompareFaceResponse |
IaiClient.CompareFace(CompareFaceRequest req)
对两张图片中的人脸进行相似度比对，返回人脸相似度分数。
若您需要判断 “此人是否是某人”，即验证某张图片中的人是否是已知身份的某人，如常见的人脸登录场景，建议使用[人脸验证](https://cloud.tencent.com/document/product/867/32806)接口。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
CopyPersonResponse |
IaiClient.CopyPerson(CopyPersonRequest req)
将已存在于某人员库的人员复制到其他人员库，该人员的描述信息不会被复制。单个人员最多只能同时存在100个人员库中。
>
- 注：若该人员创建时算法模型版本为2.0，复制到非2.0算法模型版本的Group中时，复制操作将会失败。
|
CreateFaceResponse |
IaiClient.CreateFace(CreateFaceRequest req)
将一组人脸图片添加到一个人员中。一个人员最多允许包含 5 张图片。若该人员存在多个人员库中，所有人员库中该人员图片均会增加。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
CreateGroupResponse |
IaiClient.CreateGroup(CreateGroupRequest req)
用于创建一个空的人员库，如果人员库已存在返回错误。可根据需要创建自定义描述字段，用于辅助描述该人员库下的人员信息。1个APPID下最多创建2万个人员库（Group）、最多包含1000万张人脸（Face），单个人员库（Group）最多包含100万张人脸（Face）。
|
CreatePersonResponse |
IaiClient.CreatePerson(CreatePersonRequest req)
创建人员，添加人脸、姓名、性别及其他相关信息。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
DeleteFaceResponse |
IaiClient.DeleteFace(DeleteFaceRequest req)
删除一个人员下的人脸图片。如果该人员只有一张人脸图片，则返回错误。
|
DeleteGroupResponse |
IaiClient.DeleteGroup(DeleteGroupRequest req)
删除该人员库及包含的所有的人员。同时，人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中，该人员不会被删除，但属于该人员库中的自定义描述字段信息会被删除，属于其他人员库的自定义描述字段信息不受影响。
>
- 删除人员库的操作为异步执行，删除单张人脸时间约为10ms，即一小时内可以删除36万张。删除期间，无法向该人员库添加人员。
|
DeletePersonResponse |
IaiClient.DeletePerson(DeletePersonRequest req)
删除该人员信息，此操作会导致所有人员库均删除此人员。同时，该人员的所有人脸信息将被删除。
|
DeletePersonFromGroupResponse |
IaiClient.DeletePersonFromGroup(DeletePersonFromGroupRequest req)
从某人员库中删除人员，此操作仅影响该人员库。若该人员仅存在于指定的人员库中，该人员将被删除，其所有的人脸信息也将被删除。
|
DetectFaceResponse |
IaiClient.DetectFace(DetectFaceRequest req)
检测给定图片中的人脸（Face）的位置、相应的面部属性和人脸质量信息，位置包括 (x，y，w，h)，面部属性包括性别（gender）、年龄（age）、表情（expression）、魅力（beauty）、眼镜（glass）、发型（hair）、口罩（mask）和姿态 (pitch，roll，yaw)，人脸质量信息包括整体质量分（score）、模糊分（sharpness）、光照分（brightness）和五官遮挡分（completeness）。
其中，人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时，建议您对输入的人脸图片进行质量检测，提升后续业务处理的效果。该功能的应用场景包括：
1） 人员库[创建人员](https://cloud.tencent.com/document/product/867/32793)/[增加人脸](https://cloud.tencent.com/document/product/867/32795)：保证人员人脸信息的质量，便于后续的业务处理。
2） [人脸搜索](https://cloud.tencent.com/document/product/867/32798)：保证输入的图片质量，快速准确匹配到对应的人员。
3） [人脸验证](https://cloud.tencent.com/document/product/867/32806)：保证人脸信息的质量，避免明明是本人却认证不通过的情况。
4） [人脸融合](https://cloud.tencent.com/product/facefusion)：保证上传的人脸质量，人脸融合的效果更好。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
DetectLiveFaceResponse |
IaiClient.DetectLiveFace(DetectLiveFaceRequest req)
用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是：静态活体检测中，用户不需要通过唇语或摇头眨眼等动作来识别。
静态活体检测适用于手机自拍的场景，或对防攻击要求不高的场景。如果对活体检测有更高安全性要求，请使用[人脸核身·云智慧眼](https://cloud.tencent.com/product/faceid)产品。
>
- 图片的宽高比请接近3：4，不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景，非类手机自拍照返回的分值不具备参考意义。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
GetGroupListResponse |
IaiClient.GetGroupList(GetGroupListRequest req)
获取人员库列表。
|
GetPersonBaseInfoResponse |
IaiClient.GetPersonBaseInfo(GetPersonBaseInfoRequest req)
获取指定人员的信息，包括姓名、性别、人脸等。
|
GetPersonGroupInfoResponse |
IaiClient.GetPersonGroupInfo(GetPersonGroupInfoRequest req)
获取指定人员的信息，包括加入的人员库、描述内容等。
|
GetPersonListResponse |
IaiClient.GetPersonList(GetPersonListRequest req)
获取指定人员库中的人员列表。
|
GetPersonListNumResponse |
IaiClient.GetPersonListNum(GetPersonListNumRequest req)
获取指定人员库中人员数量。
|
ModifyGroupResponse |
IaiClient.ModifyGroup(ModifyGroupRequest req)
修改人员库名称、备注、自定义描述字段名称。
|
ModifyPersonBaseInfoResponse |
IaiClient.ModifyPersonBaseInfo(ModifyPersonBaseInfoRequest req)
修改人员信息，包括名称、性别等。人员名称和性别修改会同步到包含该人员的所有人员库。
|
ModifyPersonGroupInfoResponse |
IaiClient.ModifyPersonGroupInfo(ModifyPersonGroupInfoRequest req)
修改指定人员库人员描述内容。
|
SearchFacesResponse |
IaiClient.SearchFaces(SearchFacesRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopN 人员，识别结果按照相似度从大到小排序。单次搜索的人员库人脸总数量不得超过 100 万张。
此接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
SearchFacesReturnsByGroupResponse |
IaiClient.SearchFacesReturnsByGroup(SearchFacesReturnsByGroupRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopN 人员，按照人员库的维度以人员相似度从大到小顺序排列。
此接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。
|
SearchPersonsResponse |
IaiClient.SearchPersons(SearchPersonsRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopN 人员，按照相似度从大到小排列。
本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。
人员搜索接口和人脸搜索接口的区别是：人脸搜索会比对该 Person 下所有 Face ，而人员搜索比对的是该 Person 的 Person 特征。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
SearchPersonsReturnsByGroupResponse |
IaiClient.SearchPersonsReturnsByGroup(SearchPersonsReturnsByGroupRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopN 人员，按照人员库的维度以人员相似度从大到小顺序排列。
本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人员）更加准确。
人员搜索和人脸搜索的区别是：人脸搜索比对该 Person 下所有 Face ，而人员搜索比对的是该 Person 的 Person 特征。
|
VerifyFaceResponse |
IaiClient.VerifyFace(VerifyFaceRequest req)
给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)。 和[人脸比对](https://cloud.tencent.com/document/product/867/32802)接口不同的是，[人脸验证](https://cloud.tencent.com/document/product/867/32806)用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而[人脸比对](https://cloud.tencent.com/document/product/867/32802)用于判断两张人脸的相似度。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
VerifyPersonResponse |
IaiClient.VerifyPerson(VerifyPersonRequest req)
给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)。
本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。
和人脸比对相关接口不同的是，人脸验证相关接口用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而人脸比对相关接口用于判断两张人脸的相似度。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeAppResponse |
IcClient.DescribeApp(DescribeAppRequest req)
根据应用id查询物联卡应用详情
|
DescribeCardResponse |
IcClient.DescribeCard(DescribeCardRequest req)
查询卡片详细信息
|
DescribeCardsResponse |
IcClient.DescribeCards(DescribeCardsRequest req)
查询卡片列表信息
|
SendMultiSmsResponse |
IcClient.SendMultiSms(SendMultiSmsRequest req)
群发短信
|
SendSmsResponse |
IcClient.SendSms(SendSmsRequest req)
发送短信息接口
|
| Modifier and Type | Method and Description |
|---|---|
CancelKeyDeletionResponse |
KmsClient.CancelKeyDeletion(CancelKeyDeletionRequest req)
取消CMK的计划删除操作
|
CreateKeyResponse |
KmsClient.CreateKey(CreateKeyRequest req)
创建用户管理数据密钥的主密钥CMK（Custom Master Key）。
|
DecryptResponse |
KmsClient.Decrypt(DecryptRequest req)
本接口用于解密密文，得到明文数据。
|
DeleteImportedKeyMaterialResponse |
KmsClient.DeleteImportedKeyMaterial(DeleteImportedKeyMaterialRequest req)
用于删除导入的密钥材料，仅对EXTERNAL类型的CMK有效，该接口将CMK设置为PendingImport 状态，并不会删除CMK，在重新进行密钥导入后可继续使用。彻底删除CMK请使用 ScheduleKeyDeletion 接口。
|
DescribeKeyResponse |
KmsClient.DescribeKey(DescribeKeyRequest req)
用于获取指定KeyId的主密钥属性详情信息。
|
DescribeKeysResponse |
KmsClient.DescribeKeys(DescribeKeysRequest req)
该接口用于批量获取主密钥属性信息。
|
DisableKeyResponse |
KmsClient.DisableKey(DisableKeyRequest req)
本接口用于禁用一个主密钥，处于禁用状态的Key无法用于加密、解密操作。
|
DisableKeyRotationResponse |
KmsClient.DisableKeyRotation(DisableKeyRotationRequest req)
对指定的CMK禁止密钥轮换功能。
|
DisableKeysResponse |
KmsClient.DisableKeys(DisableKeysRequest req)
该接口用于批量禁止CMK的使用。
|
EnableKeyResponse |
KmsClient.EnableKey(EnableKeyRequest req)
用于启用一个指定的CMK。
|
EnableKeyRotationResponse |
KmsClient.EnableKeyRotation(EnableKeyRotationRequest req)
对指定的CMK开启密钥轮换功能。
|
EnableKeysResponse |
KmsClient.EnableKeys(EnableKeysRequest req)
该接口用于批量启用CMK。
|
EncryptResponse |
KmsClient.Encrypt(EncryptRequest req)
本接口用于加密最多为4KB任意数据，可用于加密数据库密码，RSA Key，或其它较小的敏感信息。对于应用的数据加密，使用GenerateDataKey生成的DataKey进行本地数据的加解密操作
|
GenerateDataKeyResponse |
KmsClient.GenerateDataKey(GenerateDataKeyRequest req)
本接口生成一个数据密钥，您可以用这个密钥进行本地数据的加密。
|
GenerateRandomResponse |
KmsClient.GenerateRandom(GenerateRandomRequest req)
随机数生成接口。
|
GetKeyRotationStatusResponse |
KmsClient.GetKeyRotationStatus(GetKeyRotationStatusRequest req)
查询指定的CMK是否开启了密钥轮换功能。
|
GetParametersForImportResponse |
KmsClient.GetParametersForImport(GetParametersForImportRequest req)
获取导入主密钥（CMK）材料的参数，返回的Token作为执行ImportKeyMaterial的参数之一，返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效，失效后如需重新导入，需要再次调用该接口获取新的Token和PublicKey。
|
GetServiceStatusResponse |
KmsClient.GetServiceStatus(GetServiceStatusRequest req)
用于查询该用户是否已开通KMS服务
|
ImportKeyMaterialResponse |
KmsClient.ImportKeyMaterial(ImportKeyMaterialRequest req)
用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入，导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料，并重新指定过期时间，但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后，指定的CMK将无法使用，需要再次导入相同的密钥材料才能正常使用。CMK是独立的，同样的密钥材料可导入不同的 CMK 中，但使用其中一个 CMK 加密的数据无法使用另一个 CMK解密。
只有Enabled 和 PendingImport状态的CMK可以导入密钥材料。
|
ListKeyDetailResponse |
KmsClient.ListKeyDetail(ListKeyDetailRequest req)
根据指定Offset和Limit获取主密钥列表详情。
|
ListKeysResponse |
KmsClient.ListKeys(ListKeysRequest req)
列出账号下面状态为Enabled， Disabled 和 PendingImport 的CMK KeyId 列表
|
ReEncryptResponse |
KmsClient.ReEncrypt(ReEncryptRequest req)
使用指定CMK对密文重新加密。
|
ScheduleKeyDeletionResponse |
KmsClient.ScheduleKeyDeletion(ScheduleKeyDeletionRequest req)
CMK计划删除接口，用于指定CMK删除的时间，可选时间区间为[7,30]天
|
UpdateAliasResponse |
KmsClient.UpdateAlias(UpdateAliasRequest req)
用于修改CMK的别名。对于处于PendingDelete状态的CMK禁止修改。
|
UpdateKeyDescriptionResponse |
KmsClient.UpdateKeyDescription(UpdateKeyDescriptionRequest req)
该接口用于对指定的cmk修改描述信息。对于处于PendingDelete状态的CMK禁止修改。
|
| Modifier and Type | Method and Description |
|---|---|
CloneAccountResponse |
MariadbClient.CloneAccount(CloneAccountRequest req)
本接口（CloneAccount）用于克隆实例账户。
|
CloseDBExtranetAccessResponse |
MariadbClient.CloseDBExtranetAccess(CloseDBExtranetAccessRequest req)
本接口(CloseDBExtranetAccess)用于关闭云数据库实例的外网访问。关闭外网访问后，外网地址将不可访问，查询实例列表接口将不返回对应实例的外网域名和端口信息。
|
CopyAccountPrivilegesResponse |
MariadbClient.CopyAccountPrivileges(CopyAccountPrivilegesRequest req)
本接口（CopyAccountPrivileges）用于复制云数据库账号的权限。
注意：相同用户名，不同Host是不同的账号，Readonly属性相同的账号之间才能复制权限。
|
CreateAccountResponse |
MariadbClient.CreateAccount(CreateAccountRequest req)
本接口（CreateAccount）用于创建云数据库账号。一个实例可以创建多个不同的账号，相同的用户名+不同的host是不同的账号。
|
CreateDBInstanceResponse |
MariadbClient.CreateDBInstance(CreateDBInstanceRequest req)
本接口（CreateDBInstance）用于创建包年包月的云数据库实例，可通过传入实例规格、数据库版本号、购买时长和数量等信息创建云数据库实例。
|
DeleteAccountResponse |
MariadbClient.DeleteAccount(DeleteAccountRequest req)
本接口（DeleteAccount）用于删除云数据库账号。用户名+host唯一确定一个账号。
|
DescribeAccountPrivilegesResponse |
MariadbClient.DescribeAccountPrivileges(DescribeAccountPrivilegesRequest req)
本接口（DescribeAccountPrivileges）用于查询云数据库账号权限。
注意：注意：相同用户名，不同Host是不同的账号。
|
DescribeAccountsResponse |
MariadbClient.DescribeAccounts(DescribeAccountsRequest req)
本接口（DescribeAccounts）用于查询指定云数据库实例的账号列表。
|
DescribeBackupTimeResponse |
MariadbClient.DescribeBackupTime(DescribeBackupTimeRequest req)
本接口（DescribeBackupTime）用于获取云数据库的备份时间。后台系统将根据此配置定期进行实例备份。
|
DescribeDBInstancesResponse |
MariadbClient.DescribeDBInstances(DescribeDBInstancesRequest req)
本接口（DescribeDBInstances）用于查询云数据库实例列表，支持通过项目ID、实例ID、内网地址、实例名称等来筛选实例。
如果不指定任何筛选条件，则默认返回20条实例记录，单次请求最多支持返回100条实例记录。
|
DescribeDBInstanceSpecsResponse |
MariadbClient.DescribeDBInstanceSpecs(DescribeDBInstanceSpecsRequest req)
本接口(DescribeDBInstanceSpecs)用于查询可创建的云数据库可售卖的规格配置。
|
DescribeDBLogFilesResponse |
MariadbClient.DescribeDBLogFiles(DescribeDBLogFilesRequest req)
本接口(DescribeDBLogFiles)用于获取数据库的各种日志列表，包括冷备、binlog、errlog和slowlog。
|
DescribeDBParametersResponse |
MariadbClient.DescribeDBParameters(DescribeDBParametersRequest req)
本接口(DescribeDBParameters)用于获取数据库的当前参数设置。
|
DescribeDBPerformanceResponse |
MariadbClient.DescribeDBPerformance(DescribeDBPerformanceRequest req)
本接口(DescribeDBPerformance)用于查看数据库实例当前性能数据。
|
DescribeDBPerformanceDetailsResponse |
MariadbClient.DescribeDBPerformanceDetails(DescribeDBPerformanceDetailsRequest req)
本接口(DescribeDBPerformanceDetails)用于查看实例性能数据详情。
|
DescribeDBResourceUsageResponse |
MariadbClient.DescribeDBResourceUsage(DescribeDBResourceUsageRequest req)
本接口(DescribeDBResourceUsage)用于查看数据库实例资源的使用情况。
|
DescribeDBResourceUsageDetailsResponse |
MariadbClient.DescribeDBResourceUsageDetails(DescribeDBResourceUsageDetailsRequest req)
本接口(DescribeDBResourceUsageDetails)用于查看数据库实例当前性能数据。
|
DescribeDBSlowLogsResponse |
MariadbClient.DescribeDBSlowLogs(DescribeDBSlowLogsRequest req)
本接口(DescribeDBSlowLogs)用于查询慢查询日志列表。
|
DescribeFlowResponse |
MariadbClient.DescribeFlow(DescribeFlowRequest req)
本接口（DescribeFlow）用于查询流程状态。
|
DescribeLogFileRetentionPeriodResponse |
MariadbClient.DescribeLogFileRetentionPeriod(DescribeLogFileRetentionPeriodRequest req)
本接口(DescribeLogFileRetentionPeriod)用于查看数据库备份日志的备份天数的设置情况。
|
DescribeOrdersResponse |
MariadbClient.DescribeOrders(DescribeOrdersRequest req)
本接口（DescribeOrders）用于查询云数据库订单信息。传入订单Id来查询订单关联的云数据库实例，和对应的任务流程ID。
|
DescribePriceResponse |
MariadbClient.DescribePrice(DescribePriceRequest req)
本接口（DescribePrice）用于在购买实例前，查询实例的价格。
|
DescribeRenewalPriceResponse |
MariadbClient.DescribeRenewalPrice(DescribeRenewalPriceRequest req)
本接口（DescribeRenewalPrice）用于在续费云数据库实例时，查询续费的价格。
|
DescribeSaleInfoResponse |
MariadbClient.DescribeSaleInfo(DescribeSaleInfoRequest req)
本接口(DescribeSaleInfo)用于查询云数据库可售卖的地域和可用区信息。
|
DescribeSqlLogsResponse |
MariadbClient.DescribeSqlLogs(DescribeSqlLogsRequest req)
本接口（DescribeSqlLogs）用于获取实例SQL日志。
|
DescribeUpgradePriceResponse |
MariadbClient.DescribeUpgradePrice(DescribeUpgradePriceRequest req)
本接口（DescribeUpgradePrice）用于在扩容云数据库实例时，查询扩容的价格。
|
GrantAccountPrivilegesResponse |
MariadbClient.GrantAccountPrivileges(GrantAccountPrivilegesRequest req)
本接口（GrantAccountPrivileges）用于给云数据库账号赋权。
注意：相同用户名，不同Host是不同的账号。
|
InitDBInstancesResponse |
MariadbClient.InitDBInstances(InitDBInstancesRequest req)
本接口(InitDBInstances)用于初始化云数据库实例，包括设置默认字符集、表名大小写敏感等。
|
ModifyAccountDescriptionResponse |
MariadbClient.ModifyAccountDescription(ModifyAccountDescriptionRequest req)
本接口（ModifyAccountDescription）用于修改云数据库账号备注。
注意：相同用户名，不同Host是不同的账号。
|
ModifyBackupTimeResponse |
MariadbClient.ModifyBackupTime(ModifyBackupTimeRequest req)
本接口（ModifyBackupTime）用于设置云数据库实例的备份时间。后台系统将根据此配置定期进行实例备份。
|
ModifyDBInstanceNameResponse |
MariadbClient.ModifyDBInstanceName(ModifyDBInstanceNameRequest req)
本接口（ModifyDBInstanceName）用于修改云数据库实例的名称。
|
ModifyDBInstancesProjectResponse |
MariadbClient.ModifyDBInstancesProject(ModifyDBInstancesProjectRequest req)
本接口（ModifyDBInstancesProject）用于修改云数据库实例所属项目。
|
ModifyDBParametersResponse |
MariadbClient.ModifyDBParameters(ModifyDBParametersRequest req)
本接口(ModifyDBParameters)用于修改数据库参数。
|
ModifyLogFileRetentionPeriodResponse |
MariadbClient.ModifyLogFileRetentionPeriod(ModifyLogFileRetentionPeriodRequest req)
本接口(ModifyLogFileRetentionPeriod)用于修改数据库备份日志保存天数。
|
OpenDBExtranetAccessResponse |
MariadbClient.OpenDBExtranetAccess(OpenDBExtranetAccessRequest req)
本接口（OpenDBExtranetAccess）用于开通云数据库实例的外网访问。开通外网访问后，您可通过外网域名和端口访问实例，可使用查询实例列表接口获取外网域名和端口信息。
|
RenewDBInstanceResponse |
MariadbClient.RenewDBInstance(RenewDBInstanceRequest req)
本接口（RenewDBInstance）用于续费云数据库实例。
|
ResetAccountPasswordResponse |
MariadbClient.ResetAccountPassword(ResetAccountPasswordRequest req)
本接口（ResetAccountPassword）用于重置云数据库账号的密码。
注意：相同用户名，不同Host是不同的账号。
|
UpgradeDBInstanceResponse |
MariadbClient.UpgradeDBInstance(UpgradeDBInstanceRequest req)
本接口(UpgradeDBInstance)用于扩容云数据库实例。本接口完成下单和支付两个动作，如果发生支付失败的错误，调用用户账户相关接口中的支付订单接口（PayDeals）重新支付即可。
|
| Modifier and Type | Method and Description |
|---|---|
AssignProjectResponse |
MongodbClient.AssignProject(AssignProjectRequest req)
本接口(AssignProject)用于指定云数据库实例的所属项目。
|
CreateDBInstanceResponse |
MongodbClient.CreateDBInstance(CreateDBInstanceRequest req)
本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。
|
CreateDBInstanceHourResponse |
MongodbClient.CreateDBInstanceHour(CreateDBInstanceHourRequest req)
本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例（包括主实例、灾备实例和只读实例），可通过传入实例规格、实例类型、MongoDB版本、购买时长和数量等信息创建云数据库实例。
|
DescribeClientConnectionsResponse |
MongodbClient.DescribeClientConnections(DescribeClientConnectionsRequest req)
本接口(DescribeClientConnections)用于查询实例客户端连接信息，包括连接IP和连接数量。目前只支持3.2版本的MongoDB实例。
|
DescribeDBInstancesResponse |
MongodbClient.DescribeDBInstances(DescribeDBInstancesRequest req)
本接口(DescribeDBInstances)用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。
|
DescribeSlowLogResponse |
MongodbClient.DescribeSlowLog(DescribeSlowLogRequest req)
本接口(DescribeSlowLogs)用于获取云数据库实例的慢查询日志。
|
DescribeSpecInfoResponse |
MongodbClient.DescribeSpecInfo(DescribeSpecInfoRequest req)
本接口(DescribeSpecInfo)用于查询实例的售卖规格。
|
RenameInstanceResponse |
MongodbClient.RenameInstance(RenameInstanceRequest req)
本接口(RenameInstance)用于修改云数据库实例的名称。
|
SetAutoRenewResponse |
MongodbClient.SetAutoRenew(SetAutoRenewRequest req)
本接口(SetAutoRenew)用于设置包年包月云数据库实例的续费选项。
|
SetPasswordResponse |
MongodbClient.SetPassword(SetPasswordRequest req)
本接口(SetPassword)用于设置云数据库账户的密码。
|
TerminateDBInstanceResponse |
MongodbClient.TerminateDBInstance(TerminateDBInstanceRequest req)
本接口(TerminateDBInstance)用于销毁按量计费的MongoDB云数据库实例
|
UpgradeDBInstanceResponse |
MongodbClient.UpgradeDBInstance(UpgradeDBInstanceRequest req)
本接口(UpgradeDBInstance)用于升级包年包月的MongoDB云数据库实例，可以扩容内存、存储以及Oplog
|
UpgradeDBInstanceHourResponse |
MongodbClient.UpgradeDBInstanceHour(UpgradeDBInstanceHourRequest req)
本接口(UpgradeDBInstanceHour)用于升级按量计费的MongoDB云数据库实例，可以扩容内存、存储以及oplog
|
| Modifier and Type | Method and Description |
|---|---|
AssignProjectResponse |
MongodbClient.AssignProject(AssignProjectRequest req)
本接口(AssignProject)用于指定云数据库实例的所属项目。
|
CreateDBInstanceResponse |
MongodbClient.CreateDBInstance(CreateDBInstanceRequest req)
本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
|
CreateDBInstanceHourResponse |
MongodbClient.CreateDBInstanceHour(CreateDBInstanceHourRequest req)
本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。
|
DescribeBackupAccessResponse |
MongodbClient.DescribeBackupAccess(DescribeBackupAccessRequest req)
本接口（DescribeBackupAccess）用于获取备份文件的下载授权，具体的备份文件信息可通过查询实例备份列表（DescribeDBBackups）接口获取
|
DescribeClientConnectionsResponse |
MongodbClient.DescribeClientConnections(DescribeClientConnectionsRequest req)
本接口(DescribeClientConnections)用于查询实例客户端连接信息，包括连接IP和连接数量。目前只支持3.2版本的MongoDB实例。
|
DescribeDBBackupsResponse |
MongodbClient.DescribeDBBackups(DescribeDBBackupsRequest req)
本接口（DescribeDBBackups）用于查询实例备份列表，目前只支持7天内的备份查询。
|
DescribeDBInstancesResponse |
MongodbClient.DescribeDBInstances(DescribeDBInstancesRequest req)
本接口(DescribeDBInstances)用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。
|
DescribeSpecInfoResponse |
MongodbClient.DescribeSpecInfo(DescribeSpecInfoRequest req)
本接口(DescribeSpecInfo)用于查询实例的售卖规格。
|
IsolateDBInstanceResponse |
MongodbClient.IsolateDBInstance(IsolateDBInstanceRequest req)
本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中，不能再写入数据。隔离一定时间后，实例会彻底删除，回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复，请谨慎操作。
|
ModifyDBInstanceSpecResponse |
MongodbClient.ModifyDBInstanceSpec(ModifyDBInstanceSpecRequest req)
本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
|
OfflineIsolatedDBInstanceResponse |
MongodbClient.OfflineIsolatedDBInstance(OfflineIsolatedDBInstanceRequest req)
本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态。
|
RenameInstanceResponse |
MongodbClient.RenameInstance(RenameInstanceRequest req)
本接口(RenameInstance)用于修改云数据库实例的名称。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeBaseMetricsResponse |
MonitorClient.DescribeBaseMetrics(DescribeBaseMetricsRequest req)
获取基础指标详情
|
GetMonitorDataResponse |
MonitorClient.GetMonitorData(GetMonitorDataRequest req)
获取云产品的监控数据。传入产品的命名空间、对象维度描述和监控指标即可获得相应的监控数据。
接口调用频率限制为：20次/秒，1200次/分钟。
若您需要调用的指标、对象较多，可能存在因限频出现拉取失败的情况，建议尽量将请求按时间维度均摊。
|
| Modifier and Type | Method and Description |
|---|---|
DeregisterMigrationTaskResponse |
MspClient.DeregisterMigrationTask(DeregisterMigrationTaskRequest req)
取消注册迁移任务
|
DescribeMigrationTaskResponse |
MspClient.DescribeMigrationTask(DescribeMigrationTaskRequest req)
获取指定迁移任务详情
|
ListMigrationProjectResponse |
MspClient.ListMigrationProject(ListMigrationProjectRequest req)
获取迁移项目名称列表
|
ListMigrationTaskResponse |
MspClient.ListMigrationTask(ListMigrationTaskRequest req)
获取迁移任务列表
|
ModifyMigrationTaskBelongToProjectResponse |
MspClient.ModifyMigrationTaskBelongToProject(ModifyMigrationTaskBelongToProjectRequest req)
更改迁移任务所属项目
|
ModifyMigrationTaskStatusResponse |
MspClient.ModifyMigrationTaskStatus(ModifyMigrationTaskStatusRequest req)
更新迁移任务状态
|
RegisterMigrationTaskResponse |
MspClient.RegisterMigrationTask(RegisterMigrationTaskRequest req)
注册迁移任务
|
| Modifier and Type | Method and Description |
|---|---|
AutoSummarizationResponse |
NlpClient.AutoSummarization(AutoSummarizationRequest req)
利用人工智能算法，自动抽取文本中的关键信息并生成指定长度的文本摘要。可用于新闻标题生成、科技文献摘要生成和商品评论摘要等。
|
ContentApprovalResponse |
NlpClient.ContentApproval(ContentApprovalRequest req)
（该接口即将下线，请使用升级接口：文本审核）
文本审核接口能够识别文本信息中的色情、政治等有害内容，帮助用户及时、精准地防范违规风险，可用于内容审核、敏感信息过滤、舆情监控等场景。
该功能基于10万级大规模敏感词库，结合多种文本对抗方法、政策权威指令等，并运用了深度学习技术，高效识别高危有害内容。同时我们会根据大规模语料和实时反误杀系统，不断更新迭代，确保效果持续提升。
文本审核接口目前提供以下三个功能：
1、文本恶意级别：将文本分为3个级别，包括正常、恶意、可疑送审；
2、文本恶意类型：把文本分为9个类别，包括正常、政治、色情、辱骂/低俗、暴恐/毒品、广告/灌水、迷信/邪教、其他违法、综合；
3、恶意关键词：文本中所有涉嫌恶意的关键词。
|
DependencyParsingResponse |
NlpClient.DependencyParsing(DependencyParsingRequest req)
句法依存分析接口能够分析出句子中词与词之间的相互依存关系，并揭示其句法结构，包括主谓关系、动宾关系、核心关系等等，可用于提取句子主干、提取句子核心词等，在机器翻译、自动问答、知识抽取等领域都有很好的应用。
|
KeywordsExtractionResponse |
NlpClient.KeywordsExtraction(KeywordsExtractionRequest req)
基于关键词提取平台，通过对文本内容进行深度分析，提取出文本内容中的关键信息，为用户实现诸如新闻内容关键词自动提取、评论关键词提取等提供基础服务。
|
LexicalAnalysisResponse |
NlpClient.LexicalAnalysis(LexicalAnalysisRequest req)
词法分析接口提供以下三个功能：
1、智能分词：将连续的自然语言文本，切分成具有语义合理性和完整性的词汇序列；
2、词性标注：为每一个词附上对应的词性，例如名词、代词、形容词、动词等；
3、命名实体识别：快速识别文本中的实体，例如人名、地名、机构名、时间日期等。
所有的功能均基于千亿级大规模互联网语料进行持续迭代更新，以保证效果不断提升，用户无需担心新词发现、歧义消除、调用性能等问题。目前词法分析已经在泛互联网、金融、政务等不同垂直领域提供业务支持，并取得良好的效果。
|
SensitiveWordsRecognitionResponse |
NlpClient.SensitiveWordsRecognition(SensitiveWordsRecognitionRequest req)
敏感词识别接口能够识别出文本中的所有敏感词，帮助用户及时、精准地防范违规风险，广泛用于各种高危涉敏场景（如资讯、评论、聊天室）的敏感信息过滤。
该功能基于10万级大规模敏感词库，结合多种文本对抗方法、政策权威指令等，高效识别敏感词及其各类变种。同时我们会根据大规模语料和实时反误杀系统，不断更新迭代，确保效果持续提升。
目前能够支持对政治、色情、辱骂/低俗、暴恐/毒品、广告/灌水、迷信/邪教、其他违法、综合等8大类敏感信息的识别。
|
SentenceEmbeddingResponse |
NlpClient.SentenceEmbedding(SentenceEmbeddingRequest req)
句向量接口能够将输入的句子映射成一个固定维度的向量，用来表示这个句子的语义特征，可用于文本聚类、文本相似度、文本分类等任务，能够显著提高它们的效果。
该句向量服务由腾讯知文自然语言处理团队联合腾讯AI Lab共同打造，基于千亿级大规模互联网语料并采用AI Lab自研的DSG算法训练而成，在腾讯内部诸多业务的NLP任务上实测效果显著。
|
SentenceSimilarityResponse |
NlpClient.SentenceSimilarity(SentenceSimilarityRequest req)
文本相似度接口能够基于深度学习技术来计算两个输入文本的相似度，相似度数值越大的两个文本在语义上越相似。目前仅支持短文本的相似度计算，长文本的相似度计算也即将推出。
鉴于文本相似度是一个应用非常广泛的功能，腾讯知文自然语言处理团队在深度神经网络模型的基础上，专门针对文本相似任务进行了优化，并持续迭代更新。基于文本相似度，可以轻松实现诸如文本去重、相似推荐等功能。
|
SentimentAnalysisResponse |
NlpClient.SentimentAnalysis(SentimentAnalysisRequest req)
情感分析接口能够对带有情感色彩的主观性文本进行分析、处理、归纳和推理，识别出用户的情感倾向，是积极还是消极，并且提供各自概率。
该功能基于基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升。
|
SimilarWordsResponse |
NlpClient.SimilarWords(SimilarWordsRequest req)
相似词接口能够基于同义词库及词向量技术，检索出与输入词语在语义上最相似的若干个词语，可广泛用于检索系统、问答系统、文档归档等场景。
|
TextApprovalResponse |
NlpClient.TextApproval(TextApprovalRequest req)
文本审核接口能够识别文本信息中的色情、政治等有害内容，帮助用户及时、精准地防范违规风险，可用于内容审核、敏感信息过滤、舆情监控等场景。
该功能基于10万级大规模敏感词库，结合多种文本对抗方法、政策权威指令等，并运用了深度学习技术，高效识别高危有害内容。同时我们会根据大规模语料和实时反误杀系统，不断更新迭代，确保效果持续提升。
文本审核接口目前提供以下三个功能：
1、文本恶意级别：将文本分为3个级别，包括正常、恶意、可疑送审；
2、文本恶意类型：把文本分为9个类别，包括正常、政治、色情、辱骂/低俗、暴恐/毒品、广告/灌水、迷信/邪教、其他违法、综合；
3、恶意关键词：文本中所有涉嫌恶意的关键词。
|
TextClassificationResponse |
NlpClient.TextClassification(TextClassificationRequest req)
文本分类接口能够对用户输入的文本进行自动分类，将其映射到具体的类目上，用户只需要提供待分类的文本，而无需关注具体实现。
该功能基于基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升。
目前已提供：
- 通用领域分类体系，包括15个分类类目，分别是汽车、科技、健康、体育、旅行、教育、职业、文化、军事、房产、娱乐、女性、奥运、财经以及其他，适用于通用的场景。
- 新闻领域分类体系，包括37个一级分类类目，285个二级分类，已应用于腾讯新闻的文章分类。
更多垂直领域的分类体系即将推出，敬请期待。
|
TextCorrectionResponse |
NlpClient.TextCorrection(TextCorrectionRequest req)
提供对中文文本的自动纠错功能，能够识别输入文本中的错误片段，定位错误并给出正确的文本结果；支持长度不超过2000字的长文本纠错。
此功能是基于千亿级大规模互联网语料和LSTM、BERT等深度神经网络模型进行训练，并持续迭代更新，以保证效果不断提升，是搜索引擎、语音识别、内容审核等功能更好运行的基础之一。
|
WordEmbeddingResponse |
NlpClient.WordEmbedding(WordEmbeddingRequest req)
词向量接口能够将输入的词语映射成一个固定维度的词向量，用来表示这个词语的语义特征。词向量是很多自然语言处理技术的基础，能够显著提高它们的效果。
该词向量服务由腾讯知文自然语言处理团队联合腾讯AI Lab共同打造。使用的词向量基于千亿级大规模互联网语料并采用AI Lab自研的DSG算法训练而成，开源的词向量包含800多万中文词汇，在覆盖率、新鲜度及准确性等三方面性能突出。
腾讯AI Lab词向量相关资料：
https://ai.tencent.com/ailab/zh/news/detial?id=22
https://ai.tencent.com/ailab/nlp/embedding.html
|
WordSimilarityResponse |
NlpClient.WordSimilarity(WordSimilarityRequest req)
词相似度接口能够基于词向量技术来计算两个输入词语的余弦相似度，相似度数值越大的两个词语在语义上越相似。
|
| Modifier and Type | Method and Description |
|---|---|
ArithmeticOCRResponse |
OcrClient.ArithmeticOCR(ArithmeticOCRRequest req)
本接口支持作业算式题目的自动识别，目前覆盖 K12 学力范围内的 14 种题型，包括加减乘除四则运算、分数四则运算、竖式四则运算、脱式计算等。
|
BankCardOCRResponse |
OcrClient.BankCardOCR(BankCardOCRRequest req)
本接口支持对中国大陆主流银行卡的卡号、银行信息、有效期等关键字段的检测与识别。
|
BizLicenseOCRResponse |
OcrClient.BizLicenseOCR(BizLicenseOCRRequest req)
本接口支持快速精准识别营业执照上的字段，包括注册号、公司名称、经营场所、主体类型、法定代表人、注册资金、组成形式、成立日期、营业期限和经营范围等字段。
|
BusinessCardOCRResponse |
OcrClient.BusinessCardOCR(BusinessCardOCRRequest req)
本接口支持名片各字段的自动定位与识别，包含姓名、电话、手机号、邮箱、公司、部门、职位、网址、地址、QQ、微信、MSN等。
|
BusInvoiceOCRResponse |
OcrClient.BusInvoiceOCR(BusInvoiceOCRRequest req)
本接口支持识别公路汽车客票的发票代码、发票号码、日期、姓名、票价等字段。
|
CarInvoiceOCRResponse |
OcrClient.CarInvoiceOCR(CarInvoiceOCRRequest req)
本接口支持机动车销售统一发票和二手车销售统一发票的识别，包括发票号码、发票代码、合计金额、合计税额等二十多个字段。
|
DriverLicenseOCRResponse |
OcrClient.DriverLicenseOCR(DriverLicenseOCRRequest req)
本接口支持对驾驶证主页所有字段的自动定位与识别，包含证号、姓名、性别、国籍、住址、出生日期、初次领证日期、准驾车型、有效期限等。
|
DutyPaidProofOCRResponse |
OcrClient.DutyPaidProofOCR(DutyPaidProofOCRRequest req)
本接口支持对完税证明的税号、纳税人识别号、纳税人名称、金额合计大写、金额合计小写、填发日期、税务机关、填票人等关键字段的识别。
|
EduPaperOCRResponse |
OcrClient.EduPaperOCR(EduPaperOCRRequest req)
本接口支持数学试题内容的识别和结构化输出，包括通用文本解析和小学/初中/高中数学公式解析能力（包括91种题型，180种符号）。
|
EnglishOCRResponse |
OcrClient.EnglishOCR(EnglishOCRRequest req)
本接口支持图像英文文字的检测和识别，返回文字框位置与文字内容。支持多场景、任意版面下的英文、字母、数字和常见字符的识别，同时覆盖英文印刷体和英文手写体识别。
|
EnterpriseLicenseOCRResponse |
OcrClient.EnterpriseLicenseOCR(EnterpriseLicenseOCRRequest req)
本接口支持智能化识别各类企业登记证书、许可证书、企业执照、三证合一类证书，结构化输出统一社会信用代码、公司名称、法定代表人、公司地址、注册资金、企业类型、经营范围等关键字段。
|
EstateCertOCRResponse |
OcrClient.EstateCertOCR(EstateCertOCRRequest req)
本接口支持不动产权证关键字段的识别，包括使用期限、面积、用途、权利性质、权利类型、坐落、共有情况、权利人、权利其他状况等。
|
FinanBillOCRResponse |
OcrClient.FinanBillOCR(FinanBillOCRRequest req)
本接口支持常见银行票据的自动分类和识别。整单识别包括支票（含现金支票、普通支票、转账支票），承兑汇票（含银行承兑汇票、商业承兑汇票）以及进账单等，适用于中国人民银行印发的 2010 版银行票据凭证版式（银发[2010]299 号）。
|
FinanBillSliceOCRResponse |
OcrClient.FinanBillSliceOCR(FinanBillSliceOCRRequest req)
本接口支持常见银行票据的自动分类和识别。切片识别包括金融行业常见票据的重要切片字段识别，包括金额、账号、日期、凭证号码等。（金融票据切片：金融票据中待识别字段及其周围局部区域的裁剪图像。）
|
FlightInvoiceOCRResponse |
OcrClient.FlightInvoiceOCR(FlightInvoiceOCRRequest req)
本接口支持机票行程单关键字段的识别，包括姓名、身份证件号码、航班号、票价 、合计、电子客票号码、填开日期等。
|
FormulaOCRResponse |
OcrClient.FormulaOCR(FormulaOCRRequest req)
本接口支持识别主流初高中数学符号和公式，返回公式的 Latex 格式文本。
|
GeneralAccurateOCRResponse |
OcrClient.GeneralAccurateOCR(GeneralAccurateOCRRequest req)
本接口支持图像整体文字的检测和识别，返回文字框位置与文字内容。相比通用印刷体识别接口，准确率和召回率更高。
|
GeneralBasicOCRResponse |
OcrClient.GeneralBasicOCR(GeneralBasicOCRRequest req)
本接口支持多场景、任意版面下整图文字的识别。支持自动识别语言类型，同时支持自选语言种类（推荐），除中英文外，支持日语、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语等多种语言。应用场景包括：印刷文档识别、网络图片识别、广告图文字识别、街景店招识别、菜单识别、视频标题识别、头像文字识别等。
|
GeneralEfficientOCRResponse |
OcrClient.GeneralEfficientOCR(GeneralEfficientOCRRequest req)
本接口支持多场景、任意版面下整图文字的识别。相较于“通用印刷体识别”接口，精简版接口在准召率有一定损失的情况下，耗时更短。适用于对接口耗时较为敏感的客户。
|
GeneralFastOCRResponse |
OcrClient.GeneralFastOCR(GeneralFastOCRRequest req)
本接口支持图片中整体文字的检测和识别，返回文字框位置与文字内容。相比通用印刷体识别接口，识别速度更快、支持的 QPS 更高。
|
GeneralHandwritingOCRResponse |
OcrClient.GeneralHandwritingOCR(GeneralHandwritingOCRRequest req)
本接口支持图片内手写体文字的检测和识别，针对手写字体无规则、字迹潦草、模糊等特点进行了识别能力的增强。
|
IDCardOCRResponse |
OcrClient.IDCardOCR(IDCardOCRRequest req)
本接口支持中国大陆居民二代身份证正反面所有字段的识别，包括姓名、性别、民族、出生日期、住址、公民身份证号、签发机关、有效期限；具备身份证照片、人像照片的裁剪功能和翻拍、PS、复印件告警功能，以及边框和框内遮挡告警、临时身份证告警和身份证有效期不合法告警等扩展功能。
|
InstitutionOCRResponse |
OcrClient.InstitutionOCR(InstitutionOCRRequest req)
本接口支持事业单位法人证书关键字段识别，包括注册号、有效期、住所、名称、法定代表人等。
|
InsuranceBillOCRResponse |
OcrClient.InsuranceBillOCR(InsuranceBillOCRRequest req)
本接口支持病案首页、费用清单、结算单、医疗发票四种保险理赔单据的文本识别和结构化输出。
|
InvoiceGeneralOCRResponse |
OcrClient.InvoiceGeneralOCR(InvoiceGeneralOCRRequest req)
本接口支持对通用机打发票的发票代码、发票号码、日期、购买方识别号、销售方识别号、校验码、小写金额等关键字段的识别。
|
LicensePlateOCRResponse |
OcrClient.LicensePlateOCR(LicensePlateOCRRequest req)
本接口支持对中国大陆机动车车牌的自动定位和识别，返回地域编号和车牌号信息。
|
MixedInvoiceDetectResponse |
OcrClient.MixedInvoiceDetect(MixedInvoiceDetectRequest req)
本接口支持多张、多类型票据的混合检测和自动分类，返回对应票据类型。目前已支持增值税发票、增值税发票（卷票）、定额发票、通用机打发票、购车发票、火车票、出租车发票、机票行程单、汽车票、轮船票、过路过桥费发票、酒店账单、客运限额发票、购物小票、完税证明共15种票据。
|
MixedInvoiceOCRResponse |
OcrClient.MixedInvoiceOCR(MixedInvoiceOCRRequest req)
本接口支持多张、多类型票据的混合识别，系统自动实现分割、分类和识别。目前已支持增值税发票、增值税发票（卷票）、定额发票、通用机打发票、购车发票、火车票、出租车发票、机票行程单、汽车票、轮船票、过路过桥费发票共11种票据。
|
MLIDCardOCRResponse |
OcrClient.MLIDCardOCR(MLIDCardOCRRequest req)
本接口支持马来西亚身份证识别，识别字段包括身份证号、姓名、性别、地址；具备身份证人像照片的裁剪功能和翻拍、复印件告警功能。
本接口暂未完全对外开放，如需咨询，请[联系商务](https://cloud.tencent.com/about/connect)
|
MLIDPassportOCRResponse |
OcrClient.MLIDPassportOCR(MLIDPassportOCRRequest req)
本接口支持马来西亚身护照识别，识别字段包括护照ID、姓名、出生日期、性别、有效期、发行国、国籍；具备护照人像照片的裁剪功能和翻拍、复印件告警功能。
本接口暂未完全对外开放，如需咨询，请[联系商务](https://cloud.tencent.com/about/connect)
|
OrgCodeCertOCRResponse |
OcrClient.OrgCodeCertOCR(OrgCodeCertOCRRequest req)
本接口支持组织机构代码证关键字段的识别，包括代码、有效期、地址、机构名称等。
|
PassportOCRResponse |
OcrClient.PassportOCR(PassportOCRRequest req)
本接口支持中国大陆护照、中国香港护照、泰国护照及其他国外护照个人资料页多个字段的检测与识别。其中中国大陆居民护照识别，已支持字段包括英文姓名、中文姓名、国家码、护照号、出生地、出生日期、国籍英文、性别英文、有效期、签发地点英文、签发日期、持证人签名、护照机读码（MRZ码）等。中国香港护照、泰国护照及其他国外护照识别，已支持字段包括英文姓名、国籍、签发日期、性别、护照号码等。
|
PermitOCRResponse |
OcrClient.PermitOCR(PermitOCRRequest req)
本接口支持对卡式港澳台通行证的识别，包括签发地点、签发机关、有效期限、性别、出生日期、英文姓名、姓名、证件号等字段。
|
QrcodeOCRResponse |
OcrClient.QrcodeOCR(QrcodeOCRRequest req)
本接口支持条形码和二维码的识别（包括 DataMatrix 和 PDF417）。
本接口暂未完全对外开放，如需咨询，请[联系商务](https://cloud.tencent.com/about/connect)
|
QuotaInvoiceOCRResponse |
OcrClient.QuotaInvoiceOCR(QuotaInvoiceOCRRequest req)
本接口支持定额发票的发票号码、发票代码及金额等关键字段的识别。
|
ShipInvoiceOCRResponse |
OcrClient.ShipInvoiceOCR(ShipInvoiceOCRRequest req)
本接口支持识别轮船票的发票代码、发票号码、日期、姓名、票价等字段。
|
TableOCRResponse |
OcrClient.TableOCR(TableOCRRequest req)
本接口支持图片内表格文档的检测和识别，返回每个单元格的文字内容，支持将识别结果保存为 Excel 格式。
|
TaxiInvoiceOCRResponse |
OcrClient.TaxiInvoiceOCR(TaxiInvoiceOCRRequest req)
本接口支持出租车发票关键字段的识别，包括发票号码、发票代码、金额、日期等字段。
|
TextDetectResponse |
OcrClient.TextDetect(TextDetectRequest req)
本接口通过检测图片中的文字信息特征，快速判断图片中有无文字并返回判断结果，帮助用户过滤无文字的图片。
|
TollInvoiceOCRResponse |
OcrClient.TollInvoiceOCR(TollInvoiceOCRRequest req)
本接口支持对过路过桥费发票的发票代码、发票号码、日期、小写金额等关键字段的识别。
|
TrainTicketOCRResponse |
OcrClient.TrainTicketOCR(TrainTicketOCRRequest req)
本接口支持火车票全字段的识别，包括编号、票价、姓名、座位号、出发时间、出发站、到达站、车次、席别等。
|
VatInvoiceOCRResponse |
OcrClient.VatInvoiceOCR(VatInvoiceOCRRequest req)
本接口支持增值税专用发票、增值税普通发票、增值税电子发票全字段的内容检测和识别，包括发票代码、发票号码、开票日期、合计金额、校验码、税率、合计税额、价税合计、购买方识别号、复核、销售方识别号、开票人、密码区1、密码区2、密码区3、密码区4、发票名称、购买方名称、销售方名称、服务名称、备注、规格型号、数量、单价、金额、税额、收款人等字段。
|
VatRollInvoiceOCRResponse |
OcrClient.VatRollInvoiceOCR(VatRollInvoiceOCRRequest req)
本接口支持对增值税发票（卷票）的发票代码、发票号码、日期、校验码、合计金额（小写）等关键字段的识别。
|
VehicleLicenseOCRResponse |
OcrClient.VehicleLicenseOCR(VehicleLicenseOCRRequest req)
本接口支持行驶证主页和副页所有字段的自动定位与识别，包含车牌号码、车辆类型、所有人、住址、使用性质、品牌型号、车辆识别代码、发动机号、注册日期、发证日期等。
|
VehicleRegCertOCRResponse |
OcrClient.VehicleRegCertOCR(VehicleRegCertOCRRequest req)
本接口支持国内机动车登记证书主要字段的结构化识别，包括机动车所有人、身份证明名称、号码、车辆型号、车辆识别代号、发动机号、制造厂名称等。
|
VinOCRResponse |
OcrClient.VinOCR(VinOCRRequest req)
本接口支持图片内车辆识别代号（VIN）的检测和识别。
|
WaybillOCRResponse |
OcrClient.WaybillOCR(WaybillOCRRequest req)
本接口支持市面上主流版式电子运单的识别，包括收件人和寄件人的姓名、电话、地址以及运单号等字段。
|
| Modifier and Type | Method and Description |
|---|---|
PullSmsReplyStatusResponse |
SmsClient.PullSmsReplyStatus(PullSmsReplyStatusRequest req)
拉取短信回复状态
|
PullSmsReplyStatusByPhoneNumberResponse |
SmsClient.PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)
拉取单个号码短信回复状态
|
PullSmsSendStatusResponse |
SmsClient.PullSmsSendStatus(PullSmsSendStatusRequest req)
拉取短信下发状态
|
PullSmsSendStatusByPhoneNumberResponse |
SmsClient.PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)
拉取单个号码短信下发状态
|
SendSmsResponse |
SmsClient.SendSms(SendSmsRequest req)
短信发送接口，用户给用户发短信验证码、通知类短信或营销短信。
|
| Modifier and Type | Method and Description |
|---|---|
InitOralProcessResponse |
SoeClient.InitOralProcess(InitOralProcessRequest req)
初始化发音评估过程，每一轮评估前进行调用。语音输入模式分为流式模式和非流式模式，流式模式支持数据分片传输，可以加快评估响应速度。评估模式分为词模式和句子模式，词模式会标注每个音节的详细信息；句子模式会有完整度和流利度的评估。
|
KeywordEvaluateResponse |
SoeClient.KeywordEvaluate(KeywordEvaluateRequest req)
指定主题关键词词汇评估，分析语音与关键词的切合程度，可指定多个关键词，支持中文英文同时评测。分片传输时，尽量保证纯异步调用，即不等待上一个分片的传输结果边录边传，这样可以尽可能早的提供音频数据。音频源目前仅支持16k采样率16bit单声道编码方式，如有不一致可能导致评估不准确或失败。
|
TransmitOralProcessResponse |
SoeClient.TransmitOralProcess(TransmitOralProcessRequest req)
传输音频数据，必须在完成发音评估初始化接口之后调用，且SessonId要与初始化接口保持一致。分片传输时，尽量保证SeqId顺序传输。音频源目前仅支持16k采样率16bit单声道编码方式，如有不一致可能导致评估不准确或失败。
|
TransmitOralProcessWithInitResponse |
SoeClient.TransmitOralProcessWithInit(TransmitOralProcessWithInitRequest req)
初始化并传输音频数据，分片传输时，尽量保证SeqId顺序传输。音频源目前仅支持16k采样率16bit单声道编码方式，如有不一致可能导致评估不准确或失败。
|
| Modifier and Type | Method and Description |
|---|---|
AssumeRoleResponse |
StsClient.AssumeRole(AssumeRoleRequest req)
申请扮演角色
|
AssumeRoleWithSAMLResponse |
StsClient.AssumeRoleWithSAML(AssumeRoleWithSAMLRequest req)
本接口（AssumeRoleWithSAML）用于根据 SAML 断言申请角色临时凭证。
|
GetFederationTokenResponse |
StsClient.GetFederationToken(GetFederationTokenRequest req)
获取联合身份临时访问凭证
|
| Modifier and Type | Method and Description |
|---|---|
GetLocalEngineResponse |
TavClient.GetLocalEngine(GetLocalEngineRequest req)
获取TAV本地引擎
|
GetScanResultResponse |
TavClient.GetScanResult(GetScanResultRequest req)
tav文件上传扫描结果查询
|
ScanFileResponse |
TavClient.ScanFile(ScanFileRequest req)
tav文件上传扫描
|
ScanFileHashResponse |
TavClient.ScanFileHash(ScanFileHashRequest req)
通过文件哈希值获取文件黑白属性
|
| Modifier and Type | Method and Description |
|---|---|
ResetResponse |
TbpClient.Reset(ResetRequest req)
对当前机器人的会话状态进行复位
|
TextProcessResponse |
TbpClient.TextProcess(TextProcessRequest req)
接收调用侧的文本输入，返回应答文本。已废弃，推荐使用最新版TextProcess接口。
|
TextResetResponse |
TbpClient.TextReset(TextResetRequest req)
会话重置接口。已废弃，推荐使用最新版TextReset接口。
|
| Modifier and Type | Method and Description |
|---|---|
TextProcessResponse |
TbpClient.TextProcess(TextProcessRequest req)
接收调用侧的文本输入，返回应答文本。
|
TextResetResponse |
TbpClient.TextReset(TextResetRequest req)
会话重置接口。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDatabaseACLResponse |
TcbClient.DescribeDatabaseACL(DescribeDatabaseACLRequest req)
获取数据库权限
|
DescribeEnvsResponse |
TcbClient.DescribeEnvs(DescribeEnvsRequest req)
获取环境列表，含环境下的各个资源信息。尤其是各资源的唯一标识，是请求各资源的关键参数
|
ModifyDatabaseACLResponse |
TcbClient.ModifyDatabaseACL(ModifyDatabaseACLRequest req)
修改数据库权限
|
ModifyEnvResponse |
TcbClient.ModifyEnv(ModifyEnvRequest req)
更新环境信息
|
| Modifier and Type | Method and Description |
|---|---|
AIAssistantResponse |
TciClient.AIAssistant(AIAssistantRequest req)
提供 AI 助教基础版本功能接口
|
CancelTaskResponse |
TciClient.CancelTask(CancelTaskRequest req)
用于取消已经提交的任务，目前只支持图像任务。
|
CheckFacePhotoResponse |
TciClient.CheckFacePhoto(CheckFacePhotoRequest req)
检查人脸图片是否合法
|
CreateFaceResponse |
TciClient.CreateFace(CreateFaceRequest req)
创建人脸
|
CreateLibraryResponse |
TciClient.CreateLibrary(CreateLibraryRequest req)
创建人员库
|
CreatePersonResponse |
TciClient.CreatePerson(CreatePersonRequest req)
创建人员
|
CreateVocabResponse |
TciClient.CreateVocab(CreateVocabRequest req)
创建词汇
|
CreateVocabLibResponse |
TciClient.CreateVocabLib(CreateVocabLibRequest req)
建立词汇库
|
DeleteFaceResponse |
TciClient.DeleteFace(DeleteFaceRequest req)
删除人脸
|
DeleteLibraryResponse |
TciClient.DeleteLibrary(DeleteLibraryRequest req)
删除人员库
|
DeletePersonResponse |
TciClient.DeletePerson(DeletePersonRequest req)
删除人员
|
DeleteVocabResponse |
TciClient.DeleteVocab(DeleteVocabRequest req)
删除词汇
|
DeleteVocabLibResponse |
TciClient.DeleteVocabLib(DeleteVocabLibRequest req)
删除词汇库
|
DescribeAITaskResultResponse |
TciClient.DescribeAITaskResult(DescribeAITaskResultRequest req)
获取标准化接口任务结果
|
DescribeAttendanceResultResponse |
TciClient.DescribeAttendanceResult(DescribeAttendanceResultRequest req)
人脸考勤查询结果
|
DescribeAudioTaskResponse |
TciClient.DescribeAudioTask(DescribeAudioTaskRequest req)
音频评估任务信息查询接口，异步查询客户提交的请求的结果。
|
DescribeConversationTaskResponse |
TciClient.DescribeConversationTask(DescribeConversationTaskRequest req)
音频对话任务评估任务信息查询接口，异步查询客户提交的请求的结果。
|
DescribeHighlightResultResponse |
TciClient.DescribeHighlightResult(DescribeHighlightResultRequest req)
视频精彩集锦结果查询接口，异步查询客户提交的请求的结果。
|
DescribeImageTaskResponse |
TciClient.DescribeImageTask(DescribeImageTaskRequest req)
拉取任务详情
|
DescribeImageTaskStatisticResponse |
TciClient.DescribeImageTaskStatistic(DescribeImageTaskStatisticRequest req)
获取图像任务统计信息
|
DescribeLibrariesResponse |
TciClient.DescribeLibraries(DescribeLibrariesRequest req)
获取人员库列表
|
DescribePersonResponse |
TciClient.DescribePerson(DescribePersonRequest req)
获取人员详情
|
DescribePersonsResponse |
TciClient.DescribePersons(DescribePersonsRequest req)
拉取人员列表
|
DescribeVocabResponse |
TciClient.DescribeVocab(DescribeVocabRequest req)
查询词汇
|
DescribeVocabLibResponse |
TciClient.DescribeVocabLib(DescribeVocabLibRequest req)
查询词汇库
|
ModifyLibraryResponse |
TciClient.ModifyLibrary(ModifyLibraryRequest req)
修改人员库信息
|
ModifyPersonResponse |
TciClient.ModifyPerson(ModifyPersonRequest req)
修改人员信息
|
SubmitAudioTaskResponse |
TciClient.SubmitAudioTask(SubmitAudioTaskRequest req)
音频任务提交接口
|
SubmitCheckAttendanceTaskResponse |
TciClient.SubmitCheckAttendanceTask(SubmitCheckAttendanceTaskRequest req)
提交人员考勤任务，支持包括点播和直播资源；支持通过DescribeAttendanceResult查询结果，也支持通过NoticeUrl设置考勤回调结果，回调结果结构如下：
##### 回调事件结构
| 参数名称 | 类型 | 描述 |
| ---- | --- | ------ |
| jobid | Integer | 任务ID |
| person_info | array of PersonInfo | 识别到的人员列表 |
#####子结构PersonInfo
| 参数名称 | 类型 | 描述 |
| ---- | --- | ------ |
| traceid | String | 可用于区分同一路视频流下的不同陌生人 |
| personid | String | 识别到的人员ID，如果是陌生人则返回空串 |
| libid | String | 识别到的人员所在的库ID，如果是陌生人则返回空串 |
| timestamp | uint64 | 识别到人脸的绝对时间戳，单位ms |
| image_url | string | 识别到人脸的事件抓图的下载地址，不长期保存，需要请及时下载 |
|
SubmitCheckAttendanceTaskPlusResponse |
TciClient.SubmitCheckAttendanceTaskPlus(SubmitCheckAttendanceTaskPlusRequest req)
支持多路视频流，提交高级人员考勤任务
|
SubmitConversationTaskResponse |
TciClient.SubmitConversationTask(SubmitConversationTaskRequest req)
对话任务分析接口
|
SubmitDoubleVideoHighlightsResponse |
TciClient.SubmitDoubleVideoHighlights(SubmitDoubleVideoHighlightsRequest req)
发起双路视频生成精彩集锦接口。该接口可以通过客户传入的学生音视频及老师视频两路Url，自动生成一堂课程的精彩集锦。需要通过DescribeHighlightResult
接口获取生成结果。
|
SubmitFullBodyClassTaskResponse |
TciClient.SubmitFullBodyClassTask(SubmitFullBodyClassTaskRequest req)
传统课堂授课任务**：在此场景中，老师为站立授课，有白板或投影供老师展示课程内容，摄像头可以拍摄到老师的半身或者全身。拍摄视频为一路全局画面，且背景不动，要求画面稳定清晰。通过此接口可分析老师授课的行为及语音，以支持AI评教。
提供的功能接口有：**老师人脸识别、老师表情识别、老师肢体动作识别、语音识别。 可分析的指标维度包括：身份识别、正脸、侧脸、人脸坐标、人脸尺寸、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、正面讲解、写板书、指黑板、语音转文字、发音时长、非发音时长、音量、语速、指定关键词的使用等
对场景的要求为：**真实场景老师1人出现在画面中，全局画面且背景不动；人脸上下角度在20度以内，左右角度在15度以内，歪头角度在15度以内；光照均匀，无遮挡，人脸清晰可见；像素最好在 100X100 像素以上，但是图像整体质量不能超过1080p。
结果查询方式：**图像任务直接返回结果，点播及直播任务通过DescribeAITaskResult查询结果。
|
SubmitHighlightsResponse |
TciClient.SubmitHighlights(SubmitHighlightsRequest req)
发起视频生成精彩集锦接口。该接口可以通过客户传入的课程音频数据及相关策略（如微笑抽取，专注抽取等），自动生成一堂课程的精彩集锦。需要通过QueryHighlightResult接口获取生成结果。
|
SubmitImageTaskResponse |
TciClient.SubmitImageTask(SubmitImageTaskRequest req)
提交图像分析任务
|
SubmitImageTaskPlusResponse |
TciClient.SubmitImageTaskPlus(SubmitImageTaskPlusRequest req)
高级图像分析任务，开放了图像任务里的所有开关，可以根据场景深度定制图像分析任务。支持的图像类别有，图片链接、图片二进制数据、点播链接和直播链接。
|
SubmitOneByOneClassTaskResponse |
TciClient.SubmitOneByOneClassTask(SubmitOneByOneClassTaskRequest req)
提交在线1对1课堂任务**
对于在线1对1课堂，老师通过视频向学生授课，并且学生人数为1人。通过上传学生端的图像信息，可以获取学生的听课情况分析。 具体指一路全局画面且背景不动，有1位学生的头像或上半身的画面，要求画面稳定清晰。
提供的功能接口有：**学生人脸识别、学生表情识别、语音识别。可分析的指标维度包括：学生身份识别、正脸、侧脸、抬头、低头、人脸坐标、人脸尺寸、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、语音转文字、发音时长、非发音时长、音量、语速等。
对场景的要求为：**真实常规1v1授课场景，学生2人以下，全局画面且背景不动；人脸上下角度在20度以内，左右角度在15度以内，歪头角度在15度以内；光照均匀，无遮挡，人脸清晰可见；像素最好在 100X100 像素以上，但是图像整体质量不能超过1080p。
结果查询方式：**图像任务直接返回结果，点播及直播任务通过DescribeAITaskResult查询结果。
|
SubmitOpenClassTaskResponse |
TciClient.SubmitOpenClassTask(SubmitOpenClassTaskRequest req)
提交线下小班（无课桌）课任务**
线下小班课是指有学生无课桌的课堂，满座15人以下，全局画面且背景不动，能清晰看到。
提供的功能接口有：**学生人脸识别、学生表情识别、学生肢体动作识别。 可分析的指标维度包括：身份识别、正脸、侧脸、抬头、低头、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、站立、举手、坐着等。
对场景的要求为：**真实常规教室，满座15人以下，全局画面且背景不动；人脸上下角度在20度以内，左右角度在15度以内，歪头角度在15度以内；光照均匀，无遮挡，人脸清晰可见；像素最好在 100X100 像素以上但是图像整体质量不能超过1080p。
结果查询方式：**图像任务直接返回结果，点播及直播任务通过DescribeAITaskResult查询结果。
|
SubmitPartialBodyClassTaskResponse |
TciClient.SubmitPartialBodyClassTask(SubmitPartialBodyClassTaskRequest req)
在线小班课任务**：此场景是在线授课场景，老师一般为坐着授课，摄像头可以拍摄到老师的头部及上半身。拍摄视频为一路全局画面，且背景不动，要求画面稳定清晰。通过此接口可分析老师授课的行为及语音，以支持AI评教。
提供的功能接口有：**老师人脸识别、老师表情识别、老师手势识别、光线识别、语音识别。 可分析的指标维度包括：身份识别、正脸、侧脸、人脸坐标、人脸尺寸、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、点赞手势、听你说手势、听我说手势、拿教具行为、语音转文字、发音时长、非发音时长、音量、语速、指定关键词的使用等
对场景的要求为：**在线常规授课场景，全局画面且背景不动；人脸上下角度在20度以内，左右角度在15度以内，歪头角度在15度以内；光照均匀，无遮挡，人脸清晰可见；像素最好在 100X100 像素以上，但是图像整体质量不能超过1080p。
结果查询方式：**图像任务直接返回结果，点播及直播任务通过DescribeAITaskResult查询结果。
|
SubmitTraditionalClassTaskResponse |
TciClient.SubmitTraditionalClassTask(SubmitTraditionalClassTaskRequest req)
提交线下传统面授大班课（含课桌）任务。**
传统教室课堂是指有学生课堂有课桌的课堂，满座20-50人，全局画面且背景不动。
提供的功能接口有：**学生人脸识别、学生表情识别、学生肢体动作识别。可分析的指标维度包括：学生身份识别、正脸、侧脸、抬头、低头、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、举手、站立、坐着、趴桌子、玩手机等
对场景的要求为：**传统的学生上课教室，满座20-50人，全局画面且背景不动；人脸上下角度在20度以内，左右角度在15度以内，歪头角度在15度以内；光照均匀，无遮挡，人脸清晰可见；像素最好在 100X100 像素以上，但是图像整体质量不能超过1080p。
结果查询方式：**图像任务直接返回结果，点播及直播任务通过DescribeAITaskResult查询结果。
|
TransmitAudioStreamResponse |
TciClient.TransmitAudioStream(TransmitAudioStreamRequest req)
分析音频信息
|
| Modifier and Type | Method and Description |
|---|---|
CreateJobResponse |
TiaClient.CreateJob(CreateJobRequest req)
创建训练任务
|
CreateModelResponse |
TiaClient.CreateModel(CreateModelRequest req)
部署模型，用以对外提供服务。有两种部署模式：`无服务器模式` 和 `集群模式`。`无服务器模式` 下，模型文件被部署到无服务器云函数，即 [SCF](https://cloud.tencent.com/product/scf)，用户可以在其控制台上进一步操作。`集群模式` 下，模型文件被部署到 TI-A 的计算集群中。
|
DeleteJobResponse |
TiaClient.DeleteJob(DeleteJobRequest req)
删除训练任务
|
DeleteModelResponse |
TiaClient.DeleteModel(DeleteModelRequest req)
删除指定的部署模型。模型有两种部署模式：`无服务器模式` 和 `集群模式`。`无服务器模式` 下，模型文件被部署到无服务器云函数，即 [SCF](https://cloud.tencent.com/product/scf)，用户可以在其控制台上进一步操作。`集群模式` 下，模型文件被部署到 TI-A 的计算集群中。
|
DescribeJobResponse |
TiaClient.DescribeJob(DescribeJobRequest req)
获取训练任务详情
|
DescribeModelResponse |
TiaClient.DescribeModel(DescribeModelRequest req)
描述已经部署的某个模型。而模型部署有两种模式：`无服务器模式` 和 `集群模式`。`无服务器模式` 下，模型文件被部署到无服务器云函数，即 [SCF](https://cloud.tencent.com/product/scf)，用户可以在其控制台上进一步操作。`集群模式` 下，模型文件被部署到 TI-A 的计算集群中。
|
InstallAgentResponse |
TiaClient.InstallAgent(InstallAgentRequest req)
安装agent
|
ListJobsResponse |
TiaClient.ListJobs(ListJobsRequest req)
列举训练任务
|
ListModelsResponse |
TiaClient.ListModels(ListModelsRequest req)
用以列举已经部署的模型。而部署有两种模式：`无服务器模式` 和 `集群模式`。`无服务器模式` 下，模型文件被部署到无服务器云函数，即 [SCF](https://cloud.tencent.com/product/scf)，用户可以在其控制台上进一步操作。`集群模式` 下，模型文件被部署到 TI-A 的计算集群中。不同部署模式下的模型分开列出。
|
QueryLogsResponse |
TiaClient.QueryLogs(QueryLogsRequest req)
查询 TI-A 训练任务的日志
|
| Modifier and Type | Method and Description |
|---|---|
ImageModerationResponse |
TicmClient.ImageModeration(ImageModerationRequest req)
本接口提供多种维度的图像审核能力，支持色情和性感内容识别，政治人物和涉政敏感场景识别，以及暴恐人物、场景、旗帜标识等违禁内容的识别。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDomainInfoResponse |
TicsClient.DescribeDomainInfo(DescribeDomainInfoRequest req)
提供域名相关的基础信息以及与攻击事件（团伙、家族）、恶意文件等相关联信息。
|
DescribeFileInfoResponse |
TicsClient.DescribeFileInfo(DescribeFileInfoRequest req)
提供文件相关的基础信息以及与攻击事件（团伙、家族）、恶意文件等相关联信息。
|
DescribeIpInfoResponse |
TicsClient.DescribeIpInfo(DescribeIpInfoRequest req)
提供IP相关的基础信息以及与攻击事件（团伙、家族）、恶意文件等相关联信息。
|
DescribeThreatInfoResponse |
TicsClient.DescribeThreatInfo(DescribeThreatInfoRequest req)
提供IP和域名相关威胁情报信息查询，这些信息可以辅助检测失陷主机、帮助SIEM/SOC等系统做研判决策、帮助运营团队对设备报警的编排处理。
|
| Modifier and Type | Method and Description |
|---|---|
CreateServiceResponse |
TiemsClient.CreateService(CreateServiceRequest req)
创建服务
|
CreateServiceConfigResponse |
TiemsClient.CreateServiceConfig(CreateServiceConfigRequest req)
创建服务配置
|
DeleteServiceResponse |
TiemsClient.DeleteService(DeleteServiceRequest req)
删除服务
|
DeleteServiceConfigResponse |
TiemsClient.DeleteServiceConfig(DeleteServiceConfigRequest req)
删除服务配置
|
DescribeRuntimesResponse |
TiemsClient.DescribeRuntimes(DescribeRuntimesRequest req)
描述服务运行环境
|
DescribeServiceConfigsResponse |
TiemsClient.DescribeServiceConfigs(DescribeServiceConfigsRequest req)
描述服务配置
|
DescribeServicesResponse |
TiemsClient.DescribeServices(DescribeServicesRequest req)
描述服务
|
UpdateServiceResponse |
TiemsClient.UpdateService(UpdateServiceRequest req)
更新服务
|
| Modifier and Type | Method and Description |
|---|---|
AssessQualityResponse |
TiiaClient.AssessQuality(AssessQualityRequest req)
评估输入图片在视觉上的质量，从多个方面评估，并同时给出综合的、客观的清晰度评分，和主观的美观度评分。
|
CropImageResponse |
TiiaClient.CropImage(CropImageRequest req)
根据输入的裁剪比例，智能判断一张图片的最佳裁剪区域，确保原图的主体区域不受影响。
可以自动裁剪图片，适应不同平台、设备的展示要求，避免简单拉伸带来的变形。
|
DetectCelebrityResponse |
TiiaClient.DetectCelebrity(DetectCelebrityRequest req)
传入一张图片，可以识别图片中包含的人物是否为公众人物，如果是，输出人物的姓名、基本信息、脸部坐标。
支持识别一张图片中存在的多个人脸，针对每个人脸，会给出与之最相似的公众人物。
|
DetectDisgustResponse |
TiiaClient.DetectDisgust(DetectDisgustRequest req)
输入一张图片，返回AI针对一张图片是否是恶心的一系列判断值。
通过恶心图片识别, 可以判断一张图片是否令人恶心, 同时给出它属于的潜在类别, 让您能够过滤掉使人不愉快的图片.
|
DetectLabelResponse |
TiiaClient.DetectLabel(DetectLabelRequest req)
传入一张图片，识别出图片中存在的物体，并返回物体的名称（分类）、置信度，一张图片会给出多个可能的标签。
|
DetectMisbehaviorResponse |
TiiaClient.DetectMisbehavior(DetectMisbehaviorRequest req)
可以识别输入的图片中是否包含不良行为，例如打架斗殴、赌博、抽烟等，可以应用于广告图、直播截图、短视频截图等审核，减少不良行为对平台内容质量的影响，维护健康向上的互联网环境。
|
DetectProductResponse |
TiiaClient.DetectProduct(DetectProductRequest req)
本接口支持识别图片中包含的商品，能够输出商品的品类名称、类别，还可以输出商品在图片中的位置。支持一张图片多个商品的识别。
|
EnhanceImageResponse |
TiiaClient.EnhanceImage(EnhanceImageRequest req)
传入一张图片，输出清晰度提升后的图片。
可以消除图片有损压缩导致的噪声，和使用滤镜、拍摄失焦导致的模糊。让图片的边缘和细节更加清晰自然。
|
ImageModerationResponse |
TiiaClient.ImageModeration(ImageModerationRequest req)
本接口提供多种维度的图像审核能力，支持色情和性感内容识别，政治人物和涉政敏感场景识别，暴恐人物、场景、旗帜标识等违禁内容的识别，以及图片中文字内容的识别。
|
RecognizeCarResponse |
TiiaClient.RecognizeCar(RecognizeCarRequest req)
腾讯云车辆属性识别可对汽车车身及车辆属性进行检测与识别，目前支持11种车身颜色、20多种车型、300多种品牌、4000多种车系+年款的识别，同时支持对车标的位置进行检测。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeEntityResponse |
TkgdqClient.DescribeEntity(DescribeEntityRequest req)
输入实体名称，返回实体相关的信息如实体别名、实体英文名、实体详细信息、相关实体等
|
DescribeRelationResponse |
TkgdqClient.DescribeRelation(DescribeRelationRequest req)
输入两个实体，返回两个实体间的关系，例如马化腾与腾讯公司不仅是相关实体，二者还存在隶属关系（马化腾属于腾讯公司）。
|
DescribeTripleResponse |
TkgdqClient.DescribeTriple(DescribeTripleRequest req)
三元组查询，主要分为两类，SP查询和PO查询。SP查询表示已知主语和谓语查询宾语，PO查询表示已知宾语和谓语查询主语。每一个SP或PO查询都是一个可独立执行的查询，TQL支持SP查询的嵌套查询，即主语可以是一个嵌套的子查询。其他复杂的三元组查询方法，请参考官网API文档示例。
|
| Modifier and Type | Method and Description |
|---|---|
ImageTranslateResponse |
TmtClient.ImageTranslate(ImageTranslateRequest req)
提供中文到英文、英文到中文两种语言的图片翻译服务，可自动识别图片中的文本内容并翻译成目标语言，识别后的文本按行翻译，后续会提供可按段落翻译的版本。
提示：对于一般开发者，我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5. |
LanguageDetectResponse |
TmtClient.LanguageDetect(LanguageDetectRequest req)
可自动识别文本内容的语言种类，轻量高效，无需额外实现判断方式，使面向客户的服务体验更佳。
提示：对于一般开发者，我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5. |
SpeechTranslateResponse |
TmtClient.SpeechTranslate(SpeechTranslateRequest req)
本接口提供音频内文字识别 + 翻译功能，目前开放中到英的语音翻译服务。
待识别和翻译的音频文件可以是 pcm、mp3、amr和speex 格式，音频内语音清晰，采用流式传输和翻译的方式。
提示：对于一般开发者，我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5. |
TextTranslateResponse |
TmtClient.TextTranslate(TextTranslateRequest req)
提供中文到英文、英文到中文的等多种语言的文本内容翻译服务， 经过大数据语料库、多种解码算法、翻译引擎深度优化，在新闻文章、生活口语等不同语言场景中都有深厚积累，翻译结果专业评价处于行业领先水平。
提示：对于一般开发者，我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5. |
| Modifier and Type | Method and Description |
|---|---|
DissolveRoomResponse |
TrtcClient.DissolveRoom(DissolveRoomRequest req)
接口说明：把房间所有用户从房间踢出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
KickOutUserResponse |
TrtcClient.KickOutUser(KickOutUserRequest req)
接口说明：将用户从房间踢出。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
|
| Modifier and Type | Method and Description |
|---|---|
TextToVoiceResponse |
TtsClient.TextToVoice(TextToVoiceRequest req)
腾讯云语音合成技术（TTS）可以将任意文本转化为语音，实现让机器和应用张口说话。
腾讯TTS技术可以应用到很多场景，比如，移动APP语音播报新闻；智能设备语音提醒；依靠网上现有节目或少量录音，快速合成明星语音，降低邀约成本；支持车载导航语音合成的个性化语音播报。
内测期间免费使用。
|
| Modifier and Type | Method and Description |
|---|---|
ApplyUploadResponse |
VodClient.ApplyUpload(ApplyUploadRequest req)
该接口用于申请媒体文件（和封面文件）的上传，获取文件上传到云点播的元信息（包括上传路径、上传签名等），用于后续上传接口。
上传流程请参考 [服务端上传综述](/document/product/266/9759)。
|
CommitUploadResponse |
VodClient.CommitUpload(CommitUploadRequest req)
该接口用于确认媒体文件（和封面文件）上传到腾讯云点播的结果，并存储媒体信息，返回文件的播放地址和文件 ID。
|
ComposeMediaResponse |
VodClient.ComposeMedia(ComposeMediaRequest req)
该接口用于制作媒体文件，可以
1.
|
ConfirmEventsResponse |
VodClient.ConfirmEvents(ConfirmEventsRequest req)
开发者调用拉取事件通知，获取到事件后，必须调用该接口来确认消息已经收到；
开发者获取到事件句柄后，等待确认的有效时间为 30 秒，超出 30 秒会报参数错误（4000）；
更多参考事件通知的[可靠回调](https://cloud.tencent.com/document/product/266/33779#.E5.8F.AF.E9.9D.A0.E5.9B.9E.E8.B0.83)。
|
CreateAIAnalysisTemplateResponse |
VodClient.CreateAIAnalysisTemplate(CreateAIAnalysisTemplateRequest req)
创建用户自定义视频内容分析模板，数量上限：50。
|
CreateAIRecognitionTemplateResponse |
VodClient.CreateAIRecognitionTemplate(CreateAIRecognitionTemplateRequest req)
创建用户自定义视频内容识别模板，数量上限：50。
|
CreateAnimatedGraphicsTemplateResponse |
VodClient.CreateAnimatedGraphicsTemplate(CreateAnimatedGraphicsTemplateRequest req)
创建用户自定义转动图模板，数量上限：16。
|
CreateClassResponse |
VodClient.CreateClass(CreateClassRequest req)
用于对媒体进行分类管理；
该接口不影响既有媒体的分类，如需修改媒体分类，请调用[修改媒体文件属性](/document/product/266/31762)接口。
分类层次不可超过 4 层。
每个分类的子类数量不可超过 500 个。
|
CreateContentReviewTemplateResponse |
VodClient.CreateContentReviewTemplate(CreateContentReviewTemplateRequest req)
创建用户自定义视频内容审核模板，数量上限：50。
|
CreateImageSpriteTemplateResponse |
VodClient.CreateImageSpriteTemplate(CreateImageSpriteTemplateRequest req)
创建用户自定义雪碧图模板，数量上限：16。
|
CreatePersonSampleResponse |
VodClient.CreatePersonSample(CreatePersonSampleRequest req)
该接口用于创建人物样本，用于通过人脸识别等技术，进行内容识别、内容审核等视频处理。
|
CreateProcedureTemplateResponse |
VodClient.CreateProcedureTemplate(CreateProcedureTemplateRequest req)
创建用户自定义的任务流模板，模板上限：50。
|
CreateSampleSnapshotTemplateResponse |
VodClient.CreateSampleSnapshotTemplate(CreateSampleSnapshotTemplateRequest req)
创建用户自定义采样截图模板，数量上限：16。
|
CreateSnapshotByTimeOffsetTemplateResponse |
VodClient.CreateSnapshotByTimeOffsetTemplate(CreateSnapshotByTimeOffsetTemplateRequest req)
创建用户自定义指定时间点截图模板，数量上限：16。
|
CreateTranscodeTemplateResponse |
VodClient.CreateTranscodeTemplate(CreateTranscodeTemplateRequest req)
创建用户自定义转码模板，数量上限：1000。
|
CreateWatermarkTemplateResponse |
VodClient.CreateWatermarkTemplate(CreateWatermarkTemplateRequest req)
创建用户自定义水印模板，数量上限：1000。
|
CreateWordSamplesResponse |
VodClient.CreateWordSamples(CreateWordSamplesRequest req)
该接口用于批量创建关键词样本，样本用于通过OCR、ASR技术，进行内容审核、内容识别等视频处理。
|
DeleteAIAnalysisTemplateResponse |
VodClient.DeleteAIAnalysisTemplate(DeleteAIAnalysisTemplateRequest req)
删除用户自定义视频内容分析模板。
注意：模板 ID 为 10000 以下的为系统预置模板，不允许删除。
|
DeleteAIRecognitionTemplateResponse |
VodClient.DeleteAIRecognitionTemplate(DeleteAIRecognitionTemplateRequest req)
删除用户自定义视频内容识别模板。
|
DeleteAnimatedGraphicsTemplateResponse |
VodClient.DeleteAnimatedGraphicsTemplate(DeleteAnimatedGraphicsTemplateRequest req)
删除用户自定义转动图模板。
|
DeleteClassResponse |
VodClient.DeleteClass(DeleteClassRequest req)
仅当待删分类无子分类且无媒体关联情况下，可删除分类；
否则，请先执行[删除媒体](/document/product/266/31764)及子分类，再删除该分类；
|
DeleteContentReviewTemplateResponse |
VodClient.DeleteContentReviewTemplate(DeleteContentReviewTemplateRequest req)
删除用户自定义视频内容审核模板。
|
DeleteImageSpriteTemplateResponse |
VodClient.DeleteImageSpriteTemplate(DeleteImageSpriteTemplateRequest req)
删除雪碧图模板。
|
DeleteMediaResponse |
VodClient.DeleteMedia(DeleteMediaRequest req)
删除媒体及其对应的视频处理文件（如转码视频、雪碧图、截图、微信发布视频等）；
可单独删除指定 ID 的视频文件下的转码，或者微信发布文件；
|
DeletePersonSampleResponse |
VodClient.DeletePersonSample(DeletePersonSampleRequest req)
该接口用于根据人物 ID，删除人物样本。
|
DeleteProcedureTemplateResponse |
VodClient.DeleteProcedureTemplate(DeleteProcedureTemplateRequest req)
删除指定名字的任务流模板
|
DeleteSampleSnapshotTemplateResponse |
VodClient.DeleteSampleSnapshotTemplate(DeleteSampleSnapshotTemplateRequest req)
删除用户自定义采样截图模板。
|
DeleteSnapshotByTimeOffsetTemplateResponse |
VodClient.DeleteSnapshotByTimeOffsetTemplate(DeleteSnapshotByTimeOffsetTemplateRequest req)
删除用户自定义指定时间点截图模板。
|
DeleteTranscodeTemplateResponse |
VodClient.DeleteTranscodeTemplate(DeleteTranscodeTemplateRequest req)
删除用户自定义转码模板。
|
DeleteWatermarkTemplateResponse |
VodClient.DeleteWatermarkTemplate(DeleteWatermarkTemplateRequest req)
删除用户自定义水印模板。
|
DeleteWordSamplesResponse |
VodClient.DeleteWordSamples(DeleteWordSamplesRequest req)
该接口用于批量删除关键词样本。
|
DescribeAdaptiveDynamicStreamingTemplatesResponse |
VodClient.DescribeAdaptiveDynamicStreamingTemplates(DescribeAdaptiveDynamicStreamingTemplatesRequest req)
查询转自适应码流模板，支持根据条件，分页查询。
|
DescribeAIAnalysisTemplatesResponse |
VodClient.DescribeAIAnalysisTemplates(DescribeAIAnalysisTemplatesRequest req)
根据视频内容分析模板唯一标识，获取视频内容分析模板详情列表。返回结果包含符合条件的所有用户自定义视频内容分析模板及[系统预置视频内容分析模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.A7.86.E9.A2.91.E5.86.85.E5.AE.B9.E5.88.86.E6.9E.90.E6.A8.A1.E6.9D.BF)。
|
DescribeAIRecognitionTemplatesResponse |
VodClient.DescribeAIRecognitionTemplates(DescribeAIRecognitionTemplatesRequest req)
根据视频内容识别模板唯一标识，获取视频内容识别模板详情列表。返回结果包含符合条件的所有用户自定义视频内容识别模板及[系统预置视频内容识别模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.A7.86.E9.A2.91.E5.86.85.E5.AE.B9.E8.AF.86.E5.88.AB.E6.A8.A1.E6.9D.BF)。
|
DescribeAllClassResponse |
VodClient.DescribeAllClass(DescribeAllClassRequest req)
获得用户的所有分类信息。
|
DescribeAnimatedGraphicsTemplatesResponse |
VodClient.DescribeAnimatedGraphicsTemplates(DescribeAnimatedGraphicsTemplatesRequest req)
查询转动图模板列表，支持根据条件，分页查询。
|
DescribeAudioTrackTemplatesResponse |
VodClient.DescribeAudioTrackTemplates(DescribeAudioTrackTemplatesRequest req)
获取转自适应码流音频轨模板列表，支持根据条件，分页查询。
|
DescribeCDNUsageDataResponse |
VodClient.DescribeCDNUsageData(DescribeCDNUsageDataRequest req)
该接口用于查询点播 CDN 的流量、带宽等统计数据。
1.
|
DescribeContentReviewTemplatesResponse |
VodClient.DescribeContentReviewTemplates(DescribeContentReviewTemplatesRequest req)
根据视频内容审核模板唯一标识，获取视频内容审核模板详情列表。返回结果包含符合条件的所有用户自定义模板及[系统预置内容审核模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.A7.86.E9.A2.91.E5.86.85.E5.AE.B9.E5.AE.A1.E6.A0.B8.E6.A8.A1.E6.9D.BF)。
|
DescribeImageSpriteTemplatesResponse |
VodClient.DescribeImageSpriteTemplates(DescribeImageSpriteTemplatesRequest req)
查询雪碧图模板，支持根据条件，分页查询。
|
DescribeMediaInfosResponse |
VodClient.DescribeMediaInfos(DescribeMediaInfosRequest req)
1.
|
DescribePersonSamplesResponse |
VodClient.DescribePersonSamples(DescribePersonSamplesRequest req)
该接口用于查询人物样本信息，支持根据人物 ID、名称、标签，分页查询。
|
DescribeProcedureTemplatesResponse |
VodClient.DescribeProcedureTemplates(DescribeProcedureTemplatesRequest req)
根据任务流模板名字，获取任务流模板详情列表。
|
DescribeReviewDetailsResponse |
VodClient.DescribeReviewDetails(DescribeReviewDetailsRequest req)
该接口返回查询时间范围内每天使用的视频内容审核时长数据，单位： 秒。
1.
|
DescribeSampleSnapshotTemplatesResponse |
VodClient.DescribeSampleSnapshotTemplates(DescribeSampleSnapshotTemplatesRequest req)
查询采样截图模板，支持根据条件，分页查询。
|
DescribeSnapshotByTimeOffsetTemplatesResponse |
VodClient.DescribeSnapshotByTimeOffsetTemplates(DescribeSnapshotByTimeOffsetTemplatesRequest req)
查询指定时间点截图模板，支持根据条件，分页查询。
|
DescribeSubAppIdsResponse |
VodClient.DescribeSubAppIds(DescribeSubAppIdsRequest req)
该接口用于获取当前账号有权限的子应用列表，包含主应用。若尚未开通子应用功能，接口将返回
FailedOperation。
|
DescribeTaskDetailResponse |
VodClient.DescribeTaskDetail(DescribeTaskDetailRequest req)
通过任务 ID 查询任务的执行状态和结果的详细信息（最多可以查询3天之内提交的任务）。
|
DescribeTasksResponse |
VodClient.DescribeTasks(DescribeTasksRequest req)
该接口用于查询任务列表；
当列表数据比较多时，单次接口调用无法拉取整个列表，可通过 ScrollToken 参数，分批拉取；
只能查询到最近三天（72 小时）内的任务。
|
DescribeTranscodeTemplatesResponse |
VodClient.DescribeTranscodeTemplates(DescribeTranscodeTemplatesRequest req)
根据转码模板唯一标识，获取转码模板详情列表。返回结果包含符合条件的所有用户自定义模板及[系统预置转码模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.BD.AC.E7.A0.81.E6.A8.A1.E6.9D.BF)。
|
DescribeVideoTrackTemplatesResponse |
VodClient.DescribeVideoTrackTemplates(DescribeVideoTrackTemplatesRequest req)
获取转自适应码流视频轨模板列表，支持根据条件，分页查询。
|
DescribeWatermarkTemplatesResponse |
VodClient.DescribeWatermarkTemplates(DescribeWatermarkTemplatesRequest req)
查询用户自定义水印模板，支持根据条件，分页查询。
|
DescribeWordSamplesResponse |
VodClient.DescribeWordSamples(DescribeWordSamplesRequest req)
该接口用于根据应用场景、关键词、标签，分页查询关键词样本信息。
|
EditMediaResponse |
VodClient.EditMedia(EditMediaRequest req)
对视频进行编辑（剪辑、拼接等），生成一个新的点播视频。编辑的功能包括：
1.
|
ExecuteFunctionResponse |
VodClient.ExecuteFunction(ExecuteFunctionRequest req)
本接口仅用于定制开发的特殊场景，除非云点播客服人员主动告知您需要使用本接口，其它情况请勿调用。
|
LiveRealTimeClipResponse |
VodClient.LiveRealTimeClip(LiveRealTimeClipRequest req)
直播即时剪辑，是指在直播过程中（即直播尚未结束时），客户可以在过往直播内容中选择一段，实时生成一个新的视频（HLS 格式），开发者可以将其立即分享出去，或者长久保存起来。
腾讯云点播支持两种即时剪辑模式：
- 剪辑固化：将剪辑出来的视频保存成独立的视频，拥有独立 FileId；适用于将精彩片段**长久保存**的场景；
- 剪辑不固化：剪辑得到的视频附属于直播录制文件，没有独立 FileId；适用于将精彩片段**临时分享**的场景。
注意：
- 使用直播即时剪辑功能的前提是：目标直播流开启了[时移回看](https://cloud.tencent.com/document/product/267/32742)功能。
- 直播即时剪辑是基于直播录制生成的 m3u8 文件进行的，故而其最小剪辑精度为一个 ts 切片，无法实现秒级或者更为精确的剪辑精度。
### 剪辑固化
所谓剪辑固化，是指将剪辑出来的视频是保存成一个独立的视频（拥有独立的 FileId）。其生命周期不受原始直播录制视频影响（即使原始录制视频被删除，剪辑结果也不会受到任何影响）；也可以对其进行转码、微信发布等二次处理。
举例如下：一场完整的足球比赛，直播录制出来的原始视频可能长达 2 个小时，客户出于节省成本的目的可以对这个视频存储 2 个月，但对于直播即时剪辑的「精彩时刻」视频却可以指定存储更长时间，同时可以单独对「精彩时刻」视频进行转码、微信发布等额外的点播操作，这时候可以选择直播即时剪辑并且固化的方案。
剪辑固化的优势在于其生命周期与原始录制视频相互独立，可以独立管理、长久保存。
### 剪辑不固化
所谓剪辑不固化，是指剪辑所得到的结果（m3u8 文件）与直播录制视频共享相同的 ts 分片，新生成的视频不是一个独立完整的视频（没有独立 FileId，只有播放 URL），其有效期与直播录制的完整视频有效期是一致的。一旦直播录制出来的视频被删除，也会导致该片段无法播放。
剪辑不固化，由于其剪辑结果不是一个独立的视频，因而也不会纳入点播媒资视频管理（比如控制台的视频总数不会统计这一片段）中，也无法单独针对这个片段做转码、微信发布等任何视频处理操作。
剪辑不固化的优势在于其剪辑操作十分“轻量化”，不会产生额外的存储开销。但其不足之处在于生命周期与原始录制视频相同，且无法进一步进行转码等视频处理。
|
ModifyAIAnalysisTemplateResponse |
VodClient.ModifyAIAnalysisTemplate(ModifyAIAnalysisTemplateRequest req)
修改用户自定义视频内容分析模板。
注意：模板 ID 10000 以下的为系统预置模板，不允许修改。
|
ModifyAIRecognitionTemplateResponse |
VodClient.ModifyAIRecognitionTemplate(ModifyAIRecognitionTemplateRequest req)
修改用户自定义视频内容识别模板。
|
ModifyAnimatedGraphicsTemplateResponse |
VodClient.ModifyAnimatedGraphicsTemplate(ModifyAnimatedGraphicsTemplateRequest req)
修改用户自定义转动图模板。
|
ModifyClassResponse |
VodClient.ModifyClass(ModifyClassRequest req)
修改媒体分类属性。
|
ModifyContentReviewTemplateResponse |
VodClient.ModifyContentReviewTemplate(ModifyContentReviewTemplateRequest req)
修改用户自定义视频内容审核模板。
|
ModifyImageSpriteTemplateResponse |
VodClient.ModifyImageSpriteTemplate(ModifyImageSpriteTemplateRequest req)
修改用户自定义雪碧图模板。
|
ModifyMediaInfoResponse |
VodClient.ModifyMediaInfo(ModifyMediaInfoRequest req)
修改媒体文件的属性，包括分类、名称、描述、标签、过期时间、打点信息、视频封面等。
|
ModifyPersonSampleResponse |
VodClient.ModifyPersonSample(ModifyPersonSampleRequest req)
该接口用于根据人物 ID，修改人物样本信息，包括名称、描述的修改，以及人脸、标签的添加、删除、重置操作。人脸删除操作需保证至少剩余 1 张图片，否则，请使用重置操作。
|
ModifySampleSnapshotTemplateResponse |
VodClient.ModifySampleSnapshotTemplate(ModifySampleSnapshotTemplateRequest req)
修改用户自定义采样截图模板。
|
ModifySnapshotByTimeOffsetTemplateResponse |
VodClient.ModifySnapshotByTimeOffsetTemplate(ModifySnapshotByTimeOffsetTemplateRequest req)
修改用户自定义指定时间点截图模板。
|
ModifySubAppIdInfoResponse |
VodClient.ModifySubAppIdInfo(ModifySubAppIdInfoRequest req)
该接口用于修改子应用信息，但不允许修改主应用信息。
|
ModifySubAppIdStatusResponse |
VodClient.ModifySubAppIdStatus(ModifySubAppIdStatusRequest req)
该接口用于启用、停用子应用。被停用的子应用将封停对应域名，并限制控制台访问。
|
ModifyTranscodeTemplateResponse |
VodClient.ModifyTranscodeTemplate(ModifyTranscodeTemplateRequest req)
修改用户自定义转码模板信息。
|
ModifyWatermarkTemplateResponse |
VodClient.ModifyWatermarkTemplate(ModifyWatermarkTemplateRequest req)
修改用户自定义水印模板，水印类型不允许修改。
|
ModifyWordSampleResponse |
VodClient.ModifyWordSample(ModifyWordSampleRequest req)
该接口用于修改关键词的应用场景、标签，关键词本身不可修改，如需修改，可删除重建。
|
ProcessMediaResponse |
VodClient.ProcessMedia(ProcessMediaRequest req)
对点播中的音视频媒体发起处理任务，功能包括：
1.
|
ProcessMediaByProcedureResponse |
VodClient.ProcessMediaByProcedure(ProcessMediaByProcedureRequest req)
使用任务流模板，对点播中的视频发起处理任务。
有两种方式创建任务流模板：
1.
|
ProcessMediaByUrlResponse |
VodClient.ProcessMediaByUrl(ProcessMediaByUrlRequest req)
对来源为 URL 的音视频媒体发起处理任务，功能包括：
1.
|
PullEventsResponse |
VodClient.PullEvents(PullEventsRequest req)
该接口用于业务服务器以 [可靠回调](https://cloud.tencent.com/document/product/266/33779#.E5.8F.AF.E9.9D.A0.E5.9B.9E.E8.B0.83) 的方式获取事件通知；
接口为长轮询模式，即：如果服务端存在未消费事件，则立即返回给请求方；如果服务端没有未消费事件，则后台会将请求挂起，直到有新的事件产生为止；
请求最多挂起5秒，建议请求方将超时时间设置为10秒；
若该接口有事件返回，调用方必须在30秒内调用 [确认事件通知](https://cloud.tencent.com/document/product/266/33434) 接口，确认事件通知已经处理，否则该事件通知在30秒后会再次被拉取到。
|
PullUploadResponse |
VodClient.PullUpload(PullUploadRequest req)
该接口用于将一个网络上的视频拉取到云点播平台。
|
PushUrlCacheResponse |
VodClient.PushUrlCache(PushUrlCacheRequest req)
1.
|
ResetProcedureTemplateResponse |
VodClient.ResetProcedureTemplate(ResetProcedureTemplateRequest req)
重新设置已存在的任务流模板的任务内容
|
SearchMediaResponse |
VodClient.SearchMedia(SearchMediaRequest req)
搜索媒体信息，支持各种条件筛选，以及对返回结果进行排序、过滤等功能，具体包括：
- 根据媒体文件名或描述信息进行文本模糊搜索。
- 根据媒体分类、标签进行检索。
- 指定分类集合 ClassIds（见输入参数），返回满足集合中任意分类的媒体。例如：假设媒体分类有电影、电视剧、综艺，其中电影又有子分类历史片、动作片、言情片。如果 ClassIds 指定了电影、电视剧，那么电影和电视剧下的所有子分类
都会返回；而如果 ClassIds 指定的是历史片、动作片，那么只有这 2 个子分类下的媒体才会返回。
- 指定标签集合 Tags（见输入参数），返回满足集合中任意标签的媒体。例如：假设媒体标签有二次元、宫斗、鬼畜，如果 Tags 指定了二次元、鬼畜 2 个标签，那么只要符合这 2 个标签中任意一个的媒体都会被检索出来。
- 允许指定筛选某一来源 Source（见输入参数）的媒体。
- 允许根据直播推流码、Vid（见输入参数）筛选直播录制的媒体。
- 允许根据媒体的创建范围筛选媒体。
- 允许对上述条件进行任意组合，检索同时满足以上条件的媒体。例如可以筛选从 2018 年 12 月 1 日到 2018 年 12 月 8 日创建的电影、电视剧分类下带有宫斗、鬼畜标签的媒体。
- 允许对结果进行排序，允许通过 Offset 和 Limit 实现只返回部分结果。
接口搜索限制：
- 搜索结果超过 5000条，不再支持分页查询超过 5000 部分的数据。
|
SimpleHlsClipResponse |
VodClient.SimpleHlsClip(SimpleHlsClipRequest req)
对 HLS 视频进行按时间段裁剪。
注意：裁剪出来的视频与原始视频共用 ts，仅生成新的 m3u8。原始视频删除后，该裁剪视频也会被删除。
|
WeChatMiniProgramPublishResponse |
VodClient.WeChatMiniProgramPublish(WeChatMiniProgramPublishRequest req)
将点播视频发布到微信小程序，供微信小程序播放器播放。
|
| Modifier and Type | Method and Description |
|---|---|
AcceptAttachCcnInstancesResponse |
VpcClient.AcceptAttachCcnInstances(AcceptAttachCcnInstancesRequest req)
本接口（AcceptAttachCcnInstances）用于跨账号关联实例时，云联网所有者接受并同意关联操作。
|
AddBandwidthPackageResourcesResponse |
VpcClient.AddBandwidthPackageResources(AddBandwidthPackageResourcesRequest req)
接口用于添加带宽包资源，包括[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)和[负载均衡](https://cloud.tencent.com/document/product/214/517)等
|
AddIp6RulesResponse |
VpcClient.AddIp6Rules(AddIp6RulesRequest req)
1.
|
AllocateAddressesResponse |
VpcClient.AllocateAddresses(AllocateAddressesRequest req)
本接口 (AllocateAddresses) 用于申请一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）。
EIP 是专为动态云计算设计的静态 IP 地址。借助 EIP，您可以快速将 EIP 重新映射到您的另一个实例上，从而屏蔽实例故障。
您的 EIP 与腾讯云账户相关联，而不是与某个实例相关联。在您选择显式释放该地址，或欠费超过24小时之前，它会一直与您的腾讯云账户保持关联。
一个腾讯云账户在每个地域能申请的 EIP 最大配额有所限制，可参见 [EIP 产品简介](https://cloud.tencent.com/document/product/213/5733)，上述配额可通过 DescribeAddressQuota 接口获取。
|
AssignIpv6AddressesResponse |
VpcClient.AssignIpv6Addresses(AssignIpv6AddressesRequest req)
本接口（AssignIpv6Addresses）用于弹性网卡申请`IPv6`地址。
本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`QueryTask`接口。 一个弹性网卡支持绑定的IP地址是有限制的，更多资源限制信息详见弹性网卡使用限制。 可以指定`IPv6`地址申请，地址类型不能为主`IP`，`IPv6`地址暂时只支持作为辅助`IP`。 地址必须要在弹性网卡所在子网内，而且不能被占用。 在弹性网卡上申请一个到多个辅助`IPv6`地址，接口会在弹性网卡所在子网段内返回指定数量的辅助`IPv6`地址。 |
AssignIpv6CidrBlockResponse |
VpcClient.AssignIpv6CidrBlock(AssignIpv6CidrBlockRequest req)
本接口（AssignIpv6CidrBlock）用于分配IPv6网段。
使用本接口前，你需要已有VPC实例，如果没有可通过接口CreateVpc创建。
每个VPC只能申请一个IPv6网段
|
AssignIpv6SubnetCidrBlockResponse |
VpcClient.AssignIpv6SubnetCidrBlock(AssignIpv6SubnetCidrBlockRequest req)
本接口（AssignIpv6SubnetCidrBlock）用于分配IPv6子网段。
给子网分配 `IPv6` 网段，要求子网所属 `VPC` 已获得 `IPv6` 网段。如果尚未分配，请先通过接口 `AssignIpv6CidrBlock` 给子网所属 `VPC` 分配一个 `IPv6` 网段。否则无法分配 `IPv6` 子网段。
每个子网只能分配一个IPv6网段。
|
AssignPrivateIpAddressesResponse |
VpcClient.AssignPrivateIpAddresses(AssignPrivateIpAddressesRequest req)
本接口（AssignPrivateIpAddresses）用于弹性网卡申请内网 IP。
一个弹性网卡支持绑定的IP地址是有限制的，更多资源限制信息详见弹性网卡使用限制。
可以指定内网IP地址申请，内网IP地址类型不能为主IP，主IP已存在，不能修改，内网IP必须要弹性网卡所在子网内，而且不能被占用。
在弹性网卡上申请一个到多个辅助内网IP，接口会在弹性网卡所在子网网段内返回指定数量的辅助内网IP。
|
AssociateAddressResponse |
VpcClient.AssociateAddress(AssociateAddressRequest req)
本接口 (AssociateAddress) 用于将[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）绑定到实例或弹性网卡的指定内网 IP 上。
将 EIP 绑定到实例（CVM）上，其本质是将 EIP 绑定到实例上主网卡的主内网 IP 上。
将 EIP 绑定到主网卡的主内网IP上，绑定过程会把其上绑定的普通公网 IP 自动解绑并释放。
将 EIP 绑定到指定网卡的内网 IP上（非主网卡的主内网IP），则必须先解绑该 EIP，才能再绑定新的。
将 EIP 绑定到NAT网关，请使用接口[EipBindNatGateway](https://cloud.tencent.com/document/product/215/4093)
EIP 如果欠费或被封堵，则不能被绑定。
只有状态为 UNBIND 的 EIP 才能够被绑定。
|
AssociateNatGatewayAddressResponse |
VpcClient.AssociateNatGatewayAddress(AssociateNatGatewayAddressRequest req)
本接口(AssociateNatGatewayAddress)用于NAT网关绑定弹性IP（EIP）。
|
AttachCcnInstancesResponse |
VpcClient.AttachCcnInstances(AttachCcnInstancesRequest req)
本接口（AttachCcnInstances）用于将网络实例加载到云联网实例中，网络实例包括VPC和专线网关。
每个云联网能够关联的网络实例个数是有限的，详请参考产品文档。如果需要扩充请联系在线客服。 |
AttachClassicLinkVpcResponse |
VpcClient.AttachClassicLinkVpc(AttachClassicLinkVpcRequest req)
本接口(AttachClassicLinkVpc)用于创建私有网络和基础网络设备互通。
私有网络和基础网络设备必须在同一个地域。
私有网络和基础网络的区别详见vpc产品文档-私有网络与基础网络。
|
AttachNetworkInterfaceResponse |
VpcClient.AttachNetworkInterface(AttachNetworkInterfaceRequest req)
|
CheckNetDetectStateResponse |
VpcClient.CheckNetDetectState(CheckNetDetectStateRequest req)
本接口(CheckNetDetectState)用于验证网络探测。
|
CreateAddressTemplateResponse |
VpcClient.CreateAddressTemplate(CreateAddressTemplateRequest req)
本接口（CreateAddressTemplate）用于创建IP地址模版
|
CreateAddressTemplateGroupResponse |
VpcClient.CreateAddressTemplateGroup(CreateAddressTemplateGroupRequest req)
本接口（CreateAddressTemplateGroup）用于创建IP地址模版集合
|
CreateBandwidthPackageResponse |
VpcClient.CreateBandwidthPackage(CreateBandwidthPackageRequest req)
接口支持创建[设备带宽包](https://cloud.tencent.com/document/product/684/15246#.E8.AE.BE.E5.A4.87.E5.B8.A6.E5.AE.BD.E5.8C.85)和[ip带宽包](https://cloud.tencent.com/document/product/684/15246#ip-.E5.B8.A6.E5.AE.BD.E5.8C.85)
|
CreateCcnResponse |
VpcClient.CreateCcn(CreateCcnRequest req)
本接口（CreateCcn）用于创建云联网（CCN）。
每个账号能创建的云联网实例个数是有限的，详请参考产品文档。如果需要扩充请联系在线客服。 |
CreateCustomerGatewayResponse |
VpcClient.CreateCustomerGateway(CreateCustomerGatewayRequest req)
本接口（CreateCustomerGateway）用于创建对端网关。
|
CreateDefaultVpcResponse |
VpcClient.CreateDefaultVpc(CreateDefaultVpcRequest req)
本接口（CreateDefaultVpc）用于创建默认私有网络(VPC）。
默认VPC适用于快速入门和启动公共实例，您可以像使用任何其他VPC一样使用默认VPC。如果你想创建标准VPC，即指定VPC名称、VPC网段、子网网段、子网可用区，请使用常规创建VPC接口（CreateVpc）
正常情况，本接口并不一定生产默认VPC，而是根据用户账号的网络属性（DescribeAccountAttributes）来决定的
支持基础网络、VPC，返回VpcId为0
只支持VPC，返回默认VPC信息
你也可以通过 Force 参数，强制返回默认VPC
|
CreateDirectConnectGatewayResponse |
VpcClient.CreateDirectConnectGateway(CreateDirectConnectGatewayRequest req)
本接口（CreateDirectConnectGateway）用于创建专线网关。
|
CreateDirectConnectGatewayCcnRoutesResponse |
VpcClient.CreateDirectConnectGatewayCcnRoutes(CreateDirectConnectGatewayCcnRoutesRequest req)
本接口（CreateDirectConnectGatewayCcnRoutes）用于创建专线网关的云联网路由（IDC网段）
|
CreateFlowLogResponse |
VpcClient.CreateFlowLog(CreateFlowLogRequest req)
本接口（CreateFlowLog）用于创建流日志
|
CreateHaVipResponse |
VpcClient.CreateHaVip(CreateHaVipRequest req)
本接口（CreateHaVip）用于创建高可用虚拟IP（HAVIP）
|
CreateIp6TranslatorsResponse |
VpcClient.CreateIp6Translators(CreateIp6TranslatorsRequest req)
1.
|
CreateNatGatewayResponse |
VpcClient.CreateNatGateway(CreateNatGatewayRequest req)
本接口(CreateNatGateway)用于创建NAT网关。
|
CreateNatGatewayDestinationIpPortTranslationNatRuleResponse |
VpcClient.CreateNatGatewayDestinationIpPortTranslationNatRule(CreateNatGatewayDestinationIpPortTranslationNatRuleRequest req)
本接口(CreateNatGatewayDestinationIpPortTranslationNatRule)用于创建NAT网关端口转发规则。
|
CreateNetDetectResponse |
VpcClient.CreateNetDetect(CreateNetDetectRequest req)
本接口(CreateNetDetect)用于创建网络探测。
|
CreateNetworkInterfaceResponse |
VpcClient.CreateNetworkInterface(CreateNetworkInterfaceRequest req)
本接口（CreateNetworkInterface）用于创建弹性网卡。
创建弹性网卡时可以指定内网IP，并且可以指定一个主IP，指定的内网IP必须在弹性网卡所在子网内，而且不能被占用。
创建弹性网卡时可以指定需要申请的内网IP数量，系统会随机生成内网IP地址。
一个弹性网卡支持绑定的IP地址是有限制的，更多资源限制信息详见弹性网卡使用限制。
创建弹性网卡同时可以绑定已有安全组。
|
CreateRoutesResponse |
VpcClient.CreateRoutes(CreateRoutesRequest req)
本接口(CreateRoutes)用于创建路由策略。
向指定路由表批量新增路由策略。
|
CreateRouteTableResponse |
VpcClient.CreateRouteTable(CreateRouteTableRequest req)
本接口(CreateRouteTable)用于创建路由表。
创建了VPC后，系统会创建一个默认路由表，所有新建的子网都会关联到默认路由表。默认情况下您可以直接使用默认路由表来管理您的路由策略。当您的路由策略较多时，您可以调用创建路由表接口创建更多路由表管理您的路由策略。
|
CreateSecurityGroupResponse |
VpcClient.CreateSecurityGroup(CreateSecurityGroupRequest req)
本接口（CreateSecurityGroup）用于创建新的安全组（SecurityGroup）。
每个账户下每个地域的每个项目的安全组数量限制。
新建的安全组的入站和出站规则默认都是全部拒绝，在创建后通常您需要再调用CreateSecurityGroupPolicies将安全组的规则设置为需要的规则。
|
CreateSecurityGroupPoliciesResponse |
VpcClient.CreateSecurityGroupPolicies(CreateSecurityGroupPoliciesRequest req)
本接口（CreateSecurityGroupPolicies）用于创建安全组规则（SecurityGroupPolicy）。
Version安全组规则版本号，用户每次更新安全规则版本会自动加1，防止你更新的路由规则已过期，不填不考虑冲突。
Protocol字段支持输入TCP, UDP, ICMP, GRE, ALL。
CidrBlock字段允许输入符合cidr格式标准的任意字符串。(展开)在基础网络中，如果CidrBlock包含您的账户内的云服务器之外的设备在腾讯云的内网IP，并不代表此规则允许您访问这些设备，租户之间网络隔离规则优先于安全组中的内网规则。
SecurityGroupId字段允许输入与待修改的安全组位于相同项目中的安全组ID，包括这个安全组ID本身，代表安全组下所有云服务器的内网IP。使用这个字段时，这条规则用来匹配网络报文的过程中会随着被使用的这个ID所关联的云服务器变化而变化，不需要重新修改。
Port字段允许输入一个单独端口号，或者用减号分隔的两个端口号代表端口范围，例如80或8000-8010。只有当Protocol字段是TCP或UDP时，Port字段才被接受，即Protocol字段不是TCP或UDP时，Protocol和Port排他关系，不允许同时输入，否则会接口报错。
Action字段只允许输入ACCEPT或DROP。
CidrBlock, SecurityGroupId, AddressTemplate三者是排他关系，不允许同时输入，Protocol + Port和ServiceTemplate二者是排他关系，不允许同时输入。
一次请求中只能创建单个方向的规则, 如果需要指定索引（PolicyIndex）参数, 多条规则的索引必须一致。
|
CreateServiceTemplateResponse |
VpcClient.CreateServiceTemplate(CreateServiceTemplateRequest req)
本接口（CreateServiceTemplate）用于创建协议端口模板
|
CreateServiceTemplateGroupResponse |
VpcClient.CreateServiceTemplateGroup(CreateServiceTemplateGroupRequest req)
本接口（CreateServiceTemplateGroup）用于创建协议端口模板集合
|
CreateSubnetResponse |
VpcClient.CreateSubnet(CreateSubnetRequest req)
本接口(CreateSubnet)用于创建子网。
创建子网前必须创建好 VPC。
子网创建成功后，子网网段不能修改。子网网段必须在VPC网段内，可以和VPC网段相同（VPC有且只有一个子网时），建议子网网段在VPC网段内，预留网段给其他子网使用。
你可以创建的最小网段子网掩码为28（有16个IP地址），最大网段子网掩码为16（65,536个IP地址）。
同一个VPC内，多个子网的网段不能重叠。
子网创建后会自动关联到默认路由表。
|
CreateSubnetsResponse |
VpcClient.CreateSubnets(CreateSubnetsRequest req)
本接口(CreateSubnets)用于批量创建子网。
创建子网前必须创建好 VPC。
子网创建成功后，子网网段不能修改。子网网段必须在VPC网段内，可以和VPC网段相同（VPC有且只有一个子网时），建议子网网段在VPC网段内，预留网段给其他子网使用。
你可以创建的最小网段子网掩码为28（有16个IP地址），最大网段子网掩码为16（65,536个IP地址）。
同一个VPC内，多个子网的网段不能重叠。
子网创建后会自动关联到默认路由表。
|
CreateVpcResponse |
VpcClient.CreateVpc(CreateVpcRequest req)
本接口(CreateVpc)用于创建私有网络(VPC)。
用户可以创建的最小网段子网掩码为28（有16个IP地址），最大网段子网掩码为16（65,536个IP地址）,如果规划VPC网段请参见VPC网段规划说明。
同一个地域能创建的VPC资源个数也是有限制的，详见 VPC使用限制,如果需要扩充请联系在线客服。
|
CreateVpnConnectionResponse |
VpcClient.CreateVpnConnection(CreateVpnConnectionRequest req)
本接口（CreateVpnConnection）用于创建VPN通道。
|
CreateVpnGatewayResponse |
VpcClient.CreateVpnGateway(CreateVpnGatewayRequest req)
本接口（CreateVpnGateway）用于创建VPN网关。
|
DeleteAddressTemplateResponse |
VpcClient.DeleteAddressTemplate(DeleteAddressTemplateRequest req)
本接口（DeleteAddressTemplate）用于删除IP地址模板
|
DeleteAddressTemplateGroupResponse |
VpcClient.DeleteAddressTemplateGroup(DeleteAddressTemplateGroupRequest req)
本接口（DeleteAddressTemplateGroup）用于删除IP地址模板集合
|
DeleteBandwidthPackageResponse |
VpcClient.DeleteBandwidthPackage(DeleteBandwidthPackageRequest req)
接口支持删除共享带宽包，包括[设备带宽包](https://cloud.tencent.com/document/product/684/15246#.E8.AE.BE.E5.A4.87.E5.B8.A6.E5.AE.BD.E5.8C.85)和[ip带宽包](https://cloud.tencent.com/document/product/684/15246#ip-.E5.B8.A6.E5.AE.BD.E5.8C.85)
|
DeleteCcnResponse |
VpcClient.DeleteCcn(DeleteCcnRequest req)
本接口（DeleteCcn）用于删除云联网。
删除后，云联网关联的所有实例间路由将被删除，网络将会中断，请务必确认
删除云联网是不可逆的操作，请谨慎处理。
|
DeleteCustomerGatewayResponse |
VpcClient.DeleteCustomerGateway(DeleteCustomerGatewayRequest req)
本接口（DeleteCustomerGateway）用于删除对端网关。
|
DeleteDirectConnectGatewayResponse |
VpcClient.DeleteDirectConnectGateway(DeleteDirectConnectGatewayRequest req)
本接口（DeleteDirectConnectGateway）用于删除专线网关。
如果是 NAT 网关，删除专线网关后，NAT 规则以及 ACL 策略都被清理了。
删除专线网关后，系统会删除路由表中跟该专线网关相关的路由策略。
本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`QueryTask`接口
|
DeleteDirectConnectGatewayCcnRoutesResponse |
VpcClient.DeleteDirectConnectGatewayCcnRoutes(DeleteDirectConnectGatewayCcnRoutesRequest req)
本接口（DeleteDirectConnectGatewayCcnRoutes）用于删除专线网关的云联网路由（IDC网段）
|
DeleteFlowLogResponse |
VpcClient.DeleteFlowLog(DeleteFlowLogRequest req)
本接口（DeleteFlowLog）用于删除流日志
|
DeleteHaVipResponse |
VpcClient.DeleteHaVip(DeleteHaVipRequest req)
本接口（DeleteHaVip）用于删除高可用虚拟IP（HAVIP）
本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`QueryTask`接口 |
DeleteIp6TranslatorsResponse |
VpcClient.DeleteIp6Translators(DeleteIp6TranslatorsRequest req)
1.
|
DeleteNatGatewayResponse |
VpcClient.DeleteNatGateway(DeleteNatGatewayRequest req)
本接口（DeleteNatGateway）用于删除NAT网关。
删除 NAT 网关后，系统会自动删除路由表中包含此 NAT 网关的路由项，同时也会解绑弹性公网IP（EIP）。
|
DeleteNatGatewayDestinationIpPortTranslationNatRuleResponse |
VpcClient.DeleteNatGatewayDestinationIpPortTranslationNatRule(DeleteNatGatewayDestinationIpPortTranslationNatRuleRequest req)
本接口（DeleteNatGatewayDestinationIpPortTranslationNatRule）用于删除NAT网关端口转发规则。
|
DeleteNetDetectResponse |
VpcClient.DeleteNetDetect(DeleteNetDetectRequest req)
本接口(DeleteNetDetect)用于删除网络探测实例。
|
DeleteNetworkInterfaceResponse |
VpcClient.DeleteNetworkInterface(DeleteNetworkInterfaceRequest req)
本接口（DeleteNetworkInterface）用于删除弹性网卡。
弹性网卡上绑定了云主机时，不能被删除。
删除指定弹性网卡，弹性网卡必须先和子机解绑才能删除。删除之后弹性网卡上所有内网IP都将被退还。
|
DeleteRoutesResponse |
VpcClient.DeleteRoutes(DeleteRoutesRequest req)
本接口(DeleteRoutes)用于对某个路由表批量删除路由策略（Route）。
|
DeleteRouteTableResponse |
VpcClient.DeleteRouteTable(DeleteRouteTableRequest req)
删除路由表
|
DeleteSecurityGroupResponse |
VpcClient.DeleteSecurityGroup(DeleteSecurityGroupRequest req)
本接口（DeleteSecurityGroup）用于删除安全组（SecurityGroup）。
只有当前账号下的安全组允许被删除。
安全组实例ID如果在其他安全组的规则中被引用，则无法直接删除。这种情况下，需要先进行规则修改，再删除安全组。
删除的安全组无法再找回，请谨慎调用。
|
DeleteSecurityGroupPoliciesResponse |
VpcClient.DeleteSecurityGroupPolicies(DeleteSecurityGroupPoliciesRequest req)
本接口（DeleteSecurityGroupPolicies）用于用于删除安全组规则（SecurityGroupPolicy）。
SecurityGroupPolicySet.Version 用于指定要操作的安全组的版本。传入 Version 版本号若不等于当前安全组的最新版本，将返回失败；若不传 Version 则直接删除指定PolicyIndex的规则。
|
DeleteServiceTemplateResponse |
VpcClient.DeleteServiceTemplate(DeleteServiceTemplateRequest req)
本接口（DeleteServiceTemplate）用于删除协议端口模板
|
DeleteServiceTemplateGroupResponse |
VpcClient.DeleteServiceTemplateGroup(DeleteServiceTemplateGroupRequest req)
本接口（DeleteServiceTemplateGroup）用于删除协议端口模板集合
|
DeleteSubnetResponse |
VpcClient.DeleteSubnet(DeleteSubnetRequest req)
本接口（DeleteSubnet）用于用于删除子网(Subnet)。
删除子网前，请清理该子网下所有资源，包括云主机、负载均衡、云数据、noSql、弹性网卡等资源。
|
DeleteVpcResponse |
VpcClient.DeleteVpc(DeleteVpcRequest req)
本接口（DeleteVpc）用于删除私有网络。
删除前请确保 VPC 内已经没有相关资源，例如云主机、云数据库、NoSQL、VPN网关、专线网关、负载均衡、对等连接、与之互通的基础网络设备等。
删除私有网络是不可逆的操作，请谨慎处理。
|
DeleteVpnConnectionResponse |
VpcClient.DeleteVpnConnection(DeleteVpnConnectionRequest req)
本接口(DeleteVpnConnection)用于删除VPN通道。
|
DeleteVpnGatewayResponse |
VpcClient.DeleteVpnGateway(DeleteVpnGatewayRequest req)
本接口（DeleteVpnGateway）用于删除VPN网关。目前只支持删除运行中的按量计费的IPSEC网关实例。
|
DescribeAccountAttributesResponse |
VpcClient.DescribeAccountAttributes(DescribeAccountAttributesRequest req)
本接口（DescribeAccountAttributes）用于查询用户账号私有属性。
|
DescribeAddressesResponse |
VpcClient.DescribeAddresses(DescribeAddressesRequest req)
本接口 (DescribeAddresses) 用于查询一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）的详细信息。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的 EIP。
|
DescribeAddressQuotaResponse |
VpcClient.DescribeAddressQuota(DescribeAddressQuotaRequest req)
本接口 (DescribeAddressQuota) 用于查询您账户的[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）在当前地域的配额信息。配额详情可参见 [EIP 产品简介](https://cloud.tencent.com/document/product/213/5733)。
|
DescribeAddressTemplateGroupsResponse |
VpcClient.DescribeAddressTemplateGroups(DescribeAddressTemplateGroupsRequest req)
本接口（DescribeAddressTemplateGroups）用于查询IP地址模板集合
|
DescribeAddressTemplatesResponse |
VpcClient.DescribeAddressTemplates(DescribeAddressTemplatesRequest req)
本接口（DescribeAddressTemplates）用于查询IP地址模板
|
DescribeBandwidthPackageQuotaResponse |
VpcClient.DescribeBandwidthPackageQuota(DescribeBandwidthPackageQuotaRequest req)
接口用于查询账户在当前地域的带宽包上限数量以及使用数量
|
DescribeBandwidthPackagesResponse |
VpcClient.DescribeBandwidthPackages(DescribeBandwidthPackagesRequest req)
接口用于查询带宽包详细信息，包括带宽包唯一标识ID，类型，计费模式，名称，资源信息等
|
DescribeCcnAttachedInstancesResponse |
VpcClient.DescribeCcnAttachedInstances(DescribeCcnAttachedInstancesRequest req)
本接口（DescribeCcnAttachedInstances）用于查询云联网实例下已关联的网络实例。
|
DescribeCcnRegionBandwidthLimitsResponse |
VpcClient.DescribeCcnRegionBandwidthLimits(DescribeCcnRegionBandwidthLimitsRequest req)
本接口（DescribeCcnRegionBandwidthLimits）用于查询云联网各地域出带宽上限，该接口只返回已关联网络实例包含的地域
|
DescribeCcnRoutesResponse |
VpcClient.DescribeCcnRoutes(DescribeCcnRoutesRequest req)
本接口（DescribeCcnRoutes）用于查询已加入云联网（CCN）的路由
|
DescribeCcnsResponse |
VpcClient.DescribeCcns(DescribeCcnsRequest req)
本接口（DescribeCcns）用于查询云联网（CCN）列表。
|
DescribeClassicLinkInstancesResponse |
VpcClient.DescribeClassicLinkInstances(DescribeClassicLinkInstancesRequest req)
本接口(DescribeClassicLinkInstances)用于查询私有网络和基础网络设备互通列表。
|
DescribeCustomerGatewaysResponse |
VpcClient.DescribeCustomerGateways(DescribeCustomerGatewaysRequest req)
本接口（DescribeCustomerGateways）用于查询对端网关列表。
|
DescribeCustomerGatewayVendorsResponse |
VpcClient.DescribeCustomerGatewayVendors(DescribeCustomerGatewayVendorsRequest req)
本接口（DescribeCustomerGatewayVendors）用于查询可支持的对端网关厂商信息。
|
DescribeDirectConnectGatewayCcnRoutesResponse |
VpcClient.DescribeDirectConnectGatewayCcnRoutes(DescribeDirectConnectGatewayCcnRoutesRequest req)
本接口（DescribeDirectConnectGatewayCcnRoutes）用于查询专线网关的云联网路由（IDC网段）
|
DescribeDirectConnectGatewaysResponse |
VpcClient.DescribeDirectConnectGateways(DescribeDirectConnectGatewaysRequest req)
本接口（DescribeDirectConnectGateways）用于查询专线网关。
|
DescribeFlowLogResponse |
VpcClient.DescribeFlowLog(DescribeFlowLogRequest req)
本接口（DescribeFlowLog）用于查询流日志实例信息
|
DescribeFlowLogsResponse |
VpcClient.DescribeFlowLogs(DescribeFlowLogsRequest req)
本接口（DescribeFlowLogs）用于查询获取流日志集合
|
DescribeGatewayFlowMonitorDetailResponse |
VpcClient.DescribeGatewayFlowMonitorDetail(DescribeGatewayFlowMonitorDetailRequest req)
本接口（DescribeGatewayFlowMonitorDetail）用于查询网关流量监控明细。
只支持单个网关实例查询。即入参 `VpnId` `DirectConnectGatewayId` `PeeringConnectionId` `NatId` 最多只支持传一个，且必须传一个。
如果网关有流量，但调用本接口没有返回数据，请在控制台对应网关详情页确认是否开启网关流量监控。
|
DescribeHaVipsResponse |
VpcClient.DescribeHaVips(DescribeHaVipsRequest req)
本接口（DescribeHaVips）用于查询高可用虚拟IP（HAVIP）列表。
|
DescribeIp6TranslatorQuotaResponse |
VpcClient.DescribeIp6TranslatorQuota(DescribeIp6TranslatorQuotaRequest req)
查询账户在指定地域IPV6转换实例和规则的配额
|
DescribeIp6TranslatorsResponse |
VpcClient.DescribeIp6Translators(DescribeIp6TranslatorsRequest req)
1.
|
DescribeNatGatewayDestinationIpPortTranslationNatRulesResponse |
VpcClient.DescribeNatGatewayDestinationIpPortTranslationNatRules(DescribeNatGatewayDestinationIpPortTranslationNatRulesRequest req)
本接口（DescribeNatGatewayDestinationIpPortTranslationNatRules）用于查询NAT网关端口转发规则对象数组。
|
DescribeNatGatewaysResponse |
VpcClient.DescribeNatGateways(DescribeNatGatewaysRequest req)
本接口（DescribeNatGateways）用于查询 NAT 网关。
|
DescribeNetDetectsResponse |
VpcClient.DescribeNetDetects(DescribeNetDetectsRequest req)
本接口（DescribeNetDetects）用于查询网络探测列表。
|
DescribeNetDetectStatesResponse |
VpcClient.DescribeNetDetectStates(DescribeNetDetectStatesRequest req)
本接口(DescribeNetDetectStates)用于查询网络探测验证结果列表。
|
DescribeNetworkInterfaceLimitResponse |
VpcClient.DescribeNetworkInterfaceLimit(DescribeNetworkInterfaceLimitRequest req)
本接口（DescribeNetworkInterfaceLimit）根据CVM实例ID查询弹性网卡配额，返回该CVM实例能绑定的弹性网卡配额，以及每个弹性网卡可以分配的ip配额
|
DescribeNetworkInterfacesResponse |
VpcClient.DescribeNetworkInterfaces(DescribeNetworkInterfacesRequest req)
本接口（DescribeNetworkInterfaces）用于查询弹性网卡列表。
|
DescribeRouteConflictsResponse |
VpcClient.DescribeRouteConflicts(DescribeRouteConflictsRequest req)
本接口（DescribeRouteConflicts）用于查询自定义路由策略与云联网路由策略冲突列表
|
DescribeRouteTablesResponse |
VpcClient.DescribeRouteTables(DescribeRouteTablesRequest req)
本接口（DescribeRouteTables）用于查询路由表。
|
DescribeSecurityGroupAssociationStatisticsResponse |
VpcClient.DescribeSecurityGroupAssociationStatistics(DescribeSecurityGroupAssociationStatisticsRequest req)
本接口（DescribeSecurityGroupAssociationStatistics）用于查询安全组关联的实例统计。
|
DescribeSecurityGroupPoliciesResponse |
VpcClient.DescribeSecurityGroupPolicies(DescribeSecurityGroupPoliciesRequest req)
本接口（DescribeSecurityGroupPolicies）用于查询安全组规则。
|
DescribeSecurityGroupsResponse |
VpcClient.DescribeSecurityGroups(DescribeSecurityGroupsRequest req)
本接口（DescribeSecurityGroups）用于查询安全组。
|
DescribeServiceTemplateGroupsResponse |
VpcClient.DescribeServiceTemplateGroups(DescribeServiceTemplateGroupsRequest req)
本接口（DescribeServiceTemplateGroups）用于查询协议端口模板集合
|
DescribeServiceTemplatesResponse |
VpcClient.DescribeServiceTemplates(DescribeServiceTemplatesRequest req)
本接口（DescribeServiceTemplates）用于查询协议端口模板
|
DescribeSubnetsResponse |
VpcClient.DescribeSubnets(DescribeSubnetsRequest req)
本接口（DescribeSubnets）用于查询子网列表。
|
DescribeTaskResultResponse |
VpcClient.DescribeTaskResult(DescribeTaskResultRequest req)
查询EIP异步任务执行结果
|
DescribeVpcIpv6AddressesResponse |
VpcClient.DescribeVpcIpv6Addresses(DescribeVpcIpv6AddressesRequest req)
本接口（DescribeVpcIpv6Addresses）用于查询 `VPC` `IPv6` 信息。
只能查询已使用的`IPv6`信息，当查询未使用的IP时，本接口不会报错，但不会出现在返回结果里。
|
DescribeVpcPrivateIpAddressesResponse |
VpcClient.DescribeVpcPrivateIpAddresses(DescribeVpcPrivateIpAddressesRequest req)
本接口（DescribeVpcPrivateIpAddresses）用于查询VPC内网IP信息。
只能查询已使用的IP信息，当查询未使用的IP时，本接口不会报错，但不会出现在返回结果里。 |
DescribeVpcsResponse |
VpcClient.DescribeVpcs(DescribeVpcsRequest req)
本接口（DescribeVpcs）用于查询私有网络列表。
|
DescribeVpnConnectionsResponse |
VpcClient.DescribeVpnConnections(DescribeVpnConnectionsRequest req)
本接口（DescribeVpnConnections）查询VPN通道列表。
|
DescribeVpnGatewaysResponse |
VpcClient.DescribeVpnGateways(DescribeVpnGatewaysRequest req)
本接口（DescribeVpnGateways）用于查询VPN网关列表。
|
DetachCcnInstancesResponse |
VpcClient.DetachCcnInstances(DetachCcnInstancesRequest req)
本接口（DetachCcnInstances）用于从云联网实例中解关联指定的网络实例。
解关联网络实例后，相应的路由策略会一并删除。 |
DetachClassicLinkVpcResponse |
VpcClient.DetachClassicLinkVpc(DetachClassicLinkVpcRequest req)
本接口(DetachClassicLinkVpc)用于删除私有网络和基础网络设备互通。
|
DetachNetworkInterfaceResponse |
VpcClient.DetachNetworkInterface(DetachNetworkInterfaceRequest req)
本接口（DetachNetworkInterface）用于弹性网卡解绑云主机。
|
DisableCcnRoutesResponse |
VpcClient.DisableCcnRoutes(DisableCcnRoutesRequest req)
本接口（DisableCcnRoutes）用于禁用已经启用的云联网（CCN）路由
|
DisableRoutesResponse |
VpcClient.DisableRoutes(DisableRoutesRequest req)
本接口（DisableRoutes）用于禁用已启用的子网路由
|
DisassociateAddressResponse |
VpcClient.DisassociateAddress(DisassociateAddressRequest req)
本接口 (DisassociateAddress) 用于解绑[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）。
支持CVM实例，弹性网卡上的EIP解绑
不支持NAT上的EIP解绑。NAT上的EIP解绑请参考[EipUnBindNatGateway](https://cloud.tencent.com/document/product/215/4092)
只有状态为 BIND 和 BIND_ENI 的 EIP 才能进行解绑定操作。
EIP 如果被封堵，则不能进行解绑定操作。
|
DisassociateNatGatewayAddressResponse |
VpcClient.DisassociateNatGatewayAddress(DisassociateNatGatewayAddressRequest req)
本接口（DisassociateNatGatewayAddress）用于NAT网关解绑弹性IP。
|
DownloadCustomerGatewayConfigurationResponse |
VpcClient.DownloadCustomerGatewayConfiguration(DownloadCustomerGatewayConfigurationRequest req)
本接口(DownloadCustomerGatewayConfiguration)用于下载VPN通道配置。
|
EnableCcnRoutesResponse |
VpcClient.EnableCcnRoutes(EnableCcnRoutesRequest req)
本接口（EnableCcnRoutes）用于启用已经加入云联网（CCN）的路由。
本接口会校验启用后，是否与已有路由冲突，如果冲突，则无法启用，失败处理。路由冲突时，需要先禁用与之冲突的路由，才能启用该路由。 |
EnableRoutesResponse |
VpcClient.EnableRoutes(EnableRoutesRequest req)
本接口（EnableRoutes）用于启用已禁用的子网路由。
本接口会校验启用后，是否与已有路由冲突，如果冲突，则无法启用，失败处理。路由冲突时，需要先禁用与之冲突的路由，才能启用该路由。 |
HaVipAssociateAddressIpResponse |
VpcClient.HaVipAssociateAddressIp(HaVipAssociateAddressIpRequest req)
本接口（HaVipAssociateAddressIp）用于高可用虚拟IP（HAVIP）绑定弹性公网IP（EIP）
本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`QueryTask`接口 |
HaVipDisassociateAddressIpResponse |
VpcClient.HaVipDisassociateAddressIp(HaVipDisassociateAddressIpRequest req)
本接口（HaVipDisassociateAddressIp）用于将高可用虚拟IP（HAVIP）已绑定的弹性公网IP（EIP）解除绑定
本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`QueryTask`接口 |
InquiryPriceCreateVpnGatewayResponse |
VpcClient.InquiryPriceCreateVpnGateway(InquiryPriceCreateVpnGatewayRequest req)
本接口（InquiryPriceCreateVpnGateway）用于创建VPN网关询价。
|
InquiryPriceRenewVpnGatewayResponse |
VpcClient.InquiryPriceRenewVpnGateway(InquiryPriceRenewVpnGatewayRequest req)
本接口（InquiryPriceRenewVpnGateway）用于续费VPN网关询价。目前仅支持IPSEC类型网关的询价。
|
InquiryPriceResetVpnGatewayInternetMaxBandwidthResponse |
VpcClient.InquiryPriceResetVpnGatewayInternetMaxBandwidth(InquiryPriceResetVpnGatewayInternetMaxBandwidthRequest req)
本接口（InquiryPriceResetVpnGatewayInternetMaxBandwidth）调整VPN网关带宽上限询价。
|
MigrateNetworkInterfaceResponse |
VpcClient.MigrateNetworkInterface(MigrateNetworkInterfaceRequest req)
本接口（MigrateNetworkInterface）用于弹性网卡迁移。
|
MigratePrivateIpAddressResponse |
VpcClient.MigratePrivateIpAddress(MigratePrivateIpAddressRequest req)
本接口（MigratePrivateIpAddress）用于弹性网卡内网IP迁移。
该接口用于将一个内网IP从一个弹性网卡上迁移到另外一个弹性网卡，主IP地址不支持迁移。
迁移前后的弹性网卡必须在同一个子网内。
|
ModifyAddressAttributeResponse |
VpcClient.ModifyAddressAttribute(ModifyAddressAttributeRequest req)
本接口 (ModifyAddressAttribute) 用于修改[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）的名称。
|
ModifyAddressesBandwidthResponse |
VpcClient.ModifyAddressesBandwidth(ModifyAddressesBandwidthRequest req)
本接口（ModifyAddressesBandwidth）用于调整[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称EIP)带宽，包括后付费EIP, 预付费EIP和带宽包EIP
|
ModifyAddressTemplateAttributeResponse |
VpcClient.ModifyAddressTemplateAttribute(ModifyAddressTemplateAttributeRequest req)
本接口（ModifyAddressTemplateAttribute）用于修改IP地址模板
|
ModifyAddressTemplateGroupAttributeResponse |
VpcClient.ModifyAddressTemplateGroupAttribute(ModifyAddressTemplateGroupAttributeRequest req)
本接口（ModifyAddressTemplateGroupAttribute）用于修改IP地址模板集合
|
ModifyBandwidthPackageAttributeResponse |
VpcClient.ModifyBandwidthPackageAttribute(ModifyBandwidthPackageAttributeRequest req)
接口用于修改带宽包属性，包括带宽包名字等
|
ModifyCcnAttributeResponse |
VpcClient.ModifyCcnAttribute(ModifyCcnAttributeRequest req)
本接口（ModifyCcnAttribute）用于修改云联网（CCN）的相关属性。
|
ModifyCustomerGatewayAttributeResponse |
VpcClient.ModifyCustomerGatewayAttribute(ModifyCustomerGatewayAttributeRequest req)
本接口（ModifyCustomerGatewayAttribute）用于修改对端网关信息。
|
ModifyDirectConnectGatewayAttributeResponse |
VpcClient.ModifyDirectConnectGatewayAttribute(ModifyDirectConnectGatewayAttributeRequest req)
本接口（ModifyDirectConnectGatewayAttribute）用于修改专线网关属性
|
ModifyFlowLogAttributeResponse |
VpcClient.ModifyFlowLogAttribute(ModifyFlowLogAttributeRequest req)
本接口（ModifyFlowLogAttribute）用于修改流日志属性
|
ModifyHaVipAttributeResponse |
VpcClient.ModifyHaVipAttribute(ModifyHaVipAttributeRequest req)
本接口（ModifyHaVipAttribute）用于修改高可用虚拟IP（HAVIP）属性
|
ModifyIp6RuleResponse |
VpcClient.ModifyIp6Rule(ModifyIp6RuleRequest req)
该接口用于修改IPV6转换规则，当前仅支持修改转换规则名称，IPV4地址和IPV4端口号
|
ModifyIp6TranslatorResponse |
VpcClient.ModifyIp6Translator(ModifyIp6TranslatorRequest req)
该接口用于修改IP6转换实例属性，当前仅支持修改实例名称。
|
ModifyIpv6AddressesAttributeResponse |
VpcClient.ModifyIpv6AddressesAttribute(ModifyIpv6AddressesAttributeRequest req)
本接口（ModifyIpv6AddressesAttribute）用于修改弹性网卡内网IPv6地址属性。
|
ModifyNatGatewayAttributeResponse |
VpcClient.ModifyNatGatewayAttribute(ModifyNatGatewayAttributeRequest req)
本接口（ModifyNatGatewayAttribute）用于修改NAT网关的属性。
|
ModifyNatGatewayDestinationIpPortTranslationNatRuleResponse |
VpcClient.ModifyNatGatewayDestinationIpPortTranslationNatRule(ModifyNatGatewayDestinationIpPortTranslationNatRuleRequest req)
本接口（ModifyNatGatewayDestinationIpPortTranslationNatRule）用于修改NAT网关端口转发规则。
|
ModifyNetDetectResponse |
VpcClient.ModifyNetDetect(ModifyNetDetectRequest req)
本接口(ModifyNetDetect)用于修改网络探测参数。
|
ModifyNetworkInterfaceAttributeResponse |
VpcClient.ModifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest req)
本接口（ModifyNetworkInterfaceAttribute）用于修改弹性网卡属性。
|
ModifyPrivateIpAddressesAttributeResponse |
VpcClient.ModifyPrivateIpAddressesAttribute(ModifyPrivateIpAddressesAttributeRequest req)
本接口（ModifyPrivateIpAddressesAttribute）用于修改弹性网卡内网IP属性。
|
ModifyRouteTableAttributeResponse |
VpcClient.ModifyRouteTableAttribute(ModifyRouteTableAttributeRequest req)
本接口（ModifyRouteTableAttribute）用于修改路由表（RouteTable）属性。
|
ModifySecurityGroupAttributeResponse |
VpcClient.ModifySecurityGroupAttribute(ModifySecurityGroupAttributeRequest req)
本接口（ModifySecurityGroupAttribute）用于修改安全组（SecurityGroupPolicy）属性。
|
ModifySecurityGroupPoliciesResponse |
VpcClient.ModifySecurityGroupPolicies(ModifySecurityGroupPoliciesRequest req)
本接口（ModifySecurityGroupPolicies）用于重置安全组出站和入站规则（SecurityGroupPolicy）。
接口是先删除当前所有的出入站规则，然后再添加 Egress 和 Ingress 规则，不支持自定义索引 PolicyIndex 。
如果指定 SecurityGroupPolicySet.Version 为0, 表示清空所有规则，并忽略Egress和Ingress。
Protocol字段支持输入TCP, UDP, ICMP, GRE, ALL。
CidrBlock字段允许输入符合cidr格式标准的任意字符串。(展开)在基础网络中，如果CidrBlock包含您的账户内的云服务器之外的设备在腾讯云的内网IP，并不代表此规则允许您访问这些设备，租户之间网络隔离规则优先于安全组中的内网规则。
SecurityGroupId字段允许输入与待修改的安全组位于相同项目中的安全组ID，包括这个安全组ID本身，代表安全组下所有云服务器的内网IP。使用这个字段时，这条规则用来匹配网络报文的过程中会随着被使用的这个ID所关联的云服务器变化而变化，不需要重新修改。
Port字段允许输入一个单独端口号，或者用减号分隔的两个端口号代表端口范围，例如80或8000-8010。只有当Protocol字段是TCP或UDP时，Port字段才被接受。
Action字段只允许输入ACCEPT或DROP。
CidrBlock, SecurityGroupId, AddressTemplate三者是排他关系，不允许同时输入，Protocol + Port和ServiceTemplate二者是排他关系，不允许同时输入。
|
ModifyServiceTemplateAttributeResponse |
VpcClient.ModifyServiceTemplateAttribute(ModifyServiceTemplateAttributeRequest req)
本接口（ModifyServiceTemplateAttribute）用于修改协议端口模板
|
ModifyServiceTemplateGroupAttributeResponse |
VpcClient.ModifyServiceTemplateGroupAttribute(ModifyServiceTemplateGroupAttributeRequest req)
本接口（ModifyServiceTemplateGroupAttribute）用于修改协议端口模板集合。
|
ModifySubnetAttributeResponse |
VpcClient.ModifySubnetAttribute(ModifySubnetAttributeRequest req)
本接口（ModifySubnetAttribute）用于修改子网属性。
|
ModifyVpcAttributeResponse |
VpcClient.ModifyVpcAttribute(ModifyVpcAttributeRequest req)
本接口（ModifyVpcAttribute）用于修改私有网络（VPC）的相关属性。
|
ModifyVpnConnectionAttributeResponse |
VpcClient.ModifyVpnConnectionAttribute(ModifyVpnConnectionAttributeRequest req)
本接口（ModifyVpnConnectionAttribute）用于修改VPN通道。
|
ModifyVpnGatewayAttributeResponse |
VpcClient.ModifyVpnGatewayAttribute(ModifyVpnGatewayAttributeRequest req)
本接口（ModifyVpnGatewayAttribute）用于修改VPN网关属性。
|
RejectAttachCcnInstancesResponse |
VpcClient.RejectAttachCcnInstances(RejectAttachCcnInstancesRequest req)
本接口（RejectAttachCcnInstances）用于跨账号关联实例时，云联网所有者拒绝关联操作。
|
ReleaseAddressesResponse |
VpcClient.ReleaseAddresses(ReleaseAddressesRequest req)
本接口 (ReleaseAddresses) 用于释放一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）。
该操作不可逆，释放后 EIP 关联的 IP 地址将不再属于您的名下。
只有状态为 UNBIND 的 EIP 才能进行释放操作。
|
RemoveBandwidthPackageResourcesResponse |
VpcClient.RemoveBandwidthPackageResources(RemoveBandwidthPackageResourcesRequest req)
接口用于删除带宽包资源，包括[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)和[负载均衡](https://cloud.tencent.com/document/product/214/517)等
|
RemoveIp6RulesResponse |
VpcClient.RemoveIp6Rules(RemoveIp6RulesRequest req)
1.
|
RenewVpnGatewayResponse |
VpcClient.RenewVpnGateway(RenewVpnGatewayRequest req)
本接口（RenewVpnGateway）用于预付费（包年包月）VPN网关续费。目前只支持IPSEC网关。
|
ReplaceDirectConnectGatewayCcnRoutesResponse |
VpcClient.ReplaceDirectConnectGatewayCcnRoutes(ReplaceDirectConnectGatewayCcnRoutesRequest req)
本接口（ReplaceDirectConnectGatewayCcnRoutes）根据路由ID（RouteId）修改指定的路由（Route），支持批量修改。
|
ReplaceRoutesResponse |
VpcClient.ReplaceRoutes(ReplaceRoutesRequest req)
本接口（ReplaceRoutes）根据路由策略ID（RouteId）修改指定的路由策略（Route），支持批量修改。
|
ReplaceRouteTableAssociationResponse |
VpcClient.ReplaceRouteTableAssociation(ReplaceRouteTableAssociationRequest req)
本接口（ReplaceRouteTableAssociation)用于修改子网（Subnet）关联的路由表（RouteTable）。
一个子网只能关联一个路由表。
|
ReplaceSecurityGroupPolicyResponse |
VpcClient.ReplaceSecurityGroupPolicy(ReplaceSecurityGroupPolicyRequest req)
本接口（ReplaceSecurityGroupPolicy）用于替换单条安全组规则（SecurityGroupPolicy）。
单个请求中只能替换单个方向的一条规则, 必须要指定索引（PolicyIndex）。
|
ResetAttachCcnInstancesResponse |
VpcClient.ResetAttachCcnInstances(ResetAttachCcnInstancesRequest req)
本接口（ResetAttachCcnInstances）用于跨账号关联实例申请过期时，重新申请关联操作。
|
ResetNatGatewayConnectionResponse |
VpcClient.ResetNatGatewayConnection(ResetNatGatewayConnectionRequest req)
本接口（ResetNatGatewayConnection）用来NAT网关并发连接上限。
|
ResetRoutesResponse |
VpcClient.ResetRoutes(ResetRoutesRequest req)
本接口（ResetRoutes）用于对某个路由表名称和所有路由策略（Route）进行重新设置。
注意: 调用本接口是先删除当前路由表中所有路由策略, 再保存新提交的路由策略内容, 会引起网络中断。 |
ResetVpnConnectionResponse |
VpcClient.ResetVpnConnection(ResetVpnConnectionRequest req)
本接口(ResetVpnConnection)用于重置VPN通道。
|
ResetVpnGatewayInternetMaxBandwidthResponse |
VpcClient.ResetVpnGatewayInternetMaxBandwidth(ResetVpnGatewayInternetMaxBandwidthRequest req)
本接口（ResetVpnGatewayInternetMaxBandwidth）调整VPN网关带宽上限。目前支持升级配置，如果是包年包月VPN网关需要在有效期内。
|
SetCcnRegionBandwidthLimitsResponse |
VpcClient.SetCcnRegionBandwidthLimits(SetCcnRegionBandwidthLimitsRequest req)
本接口（SetCcnRegionBandwidthLimits）用于设置云联网（CCN）各地域出带宽上限，该接口只能设置已关联网络实例包含的地域的出带宽上限
|
TransformAddressResponse |
VpcClient.TransformAddress(TransformAddressRequest req)
本接口 (TransformAddress) 用于将实例的普通公网 IP 转换为[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)（简称 EIP）。
平台对用户每地域每日解绑 EIP 重新分配普通公网 IP 次数有所限制（可参见 [EIP 产品简介](/document/product/213/1941)）。上述配额可通过 [DescribeAddressQuota](https://cloud.tencent.com/document/api/213/1378) 接口获取。
|
UnassignIpv6AddressesResponse |
VpcClient.UnassignIpv6Addresses(UnassignIpv6AddressesRequest req)
本接口（UnassignIpv6Addresses）用于释放弹性网卡`IPv6`地址。
本接口是异步完成，如需查询异步任务执行结果，请使用本接口返回的`RequestId`轮询`QueryTask`接口。 |
UnassignIpv6CidrBlockResponse |
VpcClient.UnassignIpv6CidrBlock(UnassignIpv6CidrBlockRequest req)
本接口（UnassignIpv6CidrBlock）用于释放IPv6网段。
网段如果还有IP占用且未回收，则网段无法释放。 |
UnassignIpv6SubnetCidrBlockResponse |
VpcClient.UnassignIpv6SubnetCidrBlock(UnassignIpv6SubnetCidrBlockRequest req)
本接口（UnassignIpv6SubnetCidrBlock）用于释放IPv6子网段。
子网段如果还有IP占用且未回收，则子网段无法释放。 |
UnassignPrivateIpAddressesResponse |
VpcClient.UnassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest req)
本接口（UnassignPrivateIpAddresses）用于弹性网卡退还内网 IP。
退还弹性网卡上的辅助内网IP，接口自动解关联弹性公网 IP。不能退还弹性网卡的主内网IP。
|
| Modifier and Type | Method and Description |
|---|---|
DeleteCertResponse |
WssClient.DeleteCert(DeleteCertRequest req)
本接口（DeleteCert）用于删除证书。
|
DescribeCertListResponse |
WssClient.DescribeCertList(DescribeCertListRequest req)
本接口(DescribeCertList)用于获取证书列表。
|
UploadCertResponse |
WssClient.UploadCert(UploadCertRequest req)
本接口（UploadCert）用于上传证书。
|
| Modifier and Type | Method and Description |
|---|---|
DataManipulationResponse |
YunsouClient.DataManipulation(DataManipulationRequest req)
上传云搜数据的API接口
|
DataSearchResponse |
YunsouClient.DataSearch(DataSearchRequest req)
用于检索云搜中的数据
|
Copyright © 2019. All rights reserved.