| Modifier and Type | Method and Description |
|---|---|
QueryActivityAntiRushResponse |
AaClient.QueryActivityAntiRush(QueryActivityAntiRushRequest req)
腾讯云活动防刷（ActivityAntiRush，AA）是针对电商、O2O、P2P、游戏、支付等行业在促销活动中遇到“羊毛党”恶意刷取优惠福利的行为时，通过防刷引擎，精准识别出“薅羊毛”恶意行为的活动防刷服务，避免了企业被刷带来的巨大经济损失。
|
| 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 |
|---|---|
DescribeStrategiesResponse |
AdvisorClient.DescribeStrategies(DescribeStrategiesRequest req)
用于查询评估项的信息
|
DescribeTaskStrategyRisksResponse |
AdvisorClient.DescribeTaskStrategyRisks(DescribeTaskStrategyRisksRequest req)
查询评估项风险实例列表
|
| Modifier and Type | Method and Description |
|---|---|
DescribeAntiFraudResponse |
AfClient.DescribeAntiFraud(DescribeAntiFraudRequest req)
天御反欺诈服务，主要应用于银行、证券、保险、消费金融等金融行业客户，通过腾讯的大数据风控能力，
可以准确识别恶意用户信息，解决客户在支付、活动、理财，风控等业务环节遇到的欺诈威胁，降低企业
的损失。
|
GetAntiFraudResponse |
AfClient.GetAntiFraud(GetAntiFraudRequest req)
反欺诈评分接口
|
QueryAntiFraudResponse |
AfClient.QueryAntiFraud(QueryAntiFraudRequest req)
天御反欺诈服务，主要应用于银行、证券、保险、消费金融等金融行业客户，通过腾讯的大数据风控能力，
可以准确识别恶意用户信息，解决客户在支付、活动、理财，风控等业务环节遇到的欺诈威胁，降低企业
的损失。
|
| Modifier and Type | Method and Description |
|---|---|
GetAntiFraudVipResponse |
AfcClient.GetAntiFraudVip(GetAntiFraudVipRequest req)
反欺诈VIP评分接口
|
QueryAntiFraudVipResponse |
AfcClient.QueryAntiFraudVip(QueryAntiFraudVipRequest req)
天御反欺诈服务，主要应用于银行、证券、保险、P2P等金融行业客户，通过腾讯的大数据风控能力，
可以准确识别恶意用户信息，解决客户在支付、活动、理财，风控等业务环节遇到的欺诈威胁，降低企业
的损失。
|
TransportGeneralInterfaceResponse |
AfcClient.TransportGeneralInterface(TransportGeneralInterfaceRequest req)
天御信鸽取数平台接口
|
| Modifier and Type | Method and Description |
|---|---|
ImageToImageResponse |
AiartClient.ImageToImage(ImageToImageRequest req)
智能图生图接口将根据输入的图片及辅助描述文本，智能生成与之相关的结果图。
输入：单边分辨率小于2000、转成 Base64 字符串后小于 5MB 的图片，建议同时输入描述文本。
输出：对应风格及分辨率的 AI 生成图。
可支持的风格详见 [智能图生图风格列表](https://cloud.tencent.com/document/product/1668/86250)，请将列表中的“风格编号”传入 Styles 数组，建议选择一种风格。
请求频率限制为1次/秒。
|
QueryTextToImageProJobResponse |
AiartClient.QueryTextToImageProJob(QueryTextToImageProJobRequest req)
文生图（高级版）接口基于高级版文生图大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
提交任务：输入文本等，提交一个文生图（高级版）异步任务，获得任务 ID。
查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。
并发任务数（并发）说明：并发任务数指能同时处理的任务数量。文生图（高级版）默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
|
SubmitTextToImageProJobResponse |
AiartClient.SubmitTextToImageProJob(SubmitTextToImageProJobRequest req)
文生图（高级版）接口基于高级版文生图大模型，将根据输入的文本描述，智能生成与之相关的结果图。分为提交任务和查询任务2个接口。
提交任务：输入文本等，提交一个文生图（高级版）异步任务，获得任务 ID。
查询任务：根据任务 ID 查询任务的处理状态、处理结果，任务处理完成后可获得生成图像结果。
并发任务数（并发）说明：并发任务数指能同时处理的任务数量。文生图（高级版）默认提供1个并发任务数，代表最多能同时处理1个已提交的任务，上一个任务处理完毕后才能开始处理下一个任务。
|
TextToImageResponse |
AiartClient.TextToImage(TextToImageRequest req)
智能文生图接口将根据输入的描述文本，智能生成与之相关的结果图。
输入：256个字符以内的描述性文本，推荐使用中文。
输出：对应风格及分辨率的 AI 生成图。
可支持的风格详见 [智能文生图风格列表](https://cloud.tencent.com/document/product/1668/86249)，请将列表中的“风格编号”传入 Styles 数组，建议选择一种风格。
请求频率限制为1次/秒。
|
| Modifier and Type | Method and Description |
|---|---|
CancelTaskResponse |
AmsClient.CancelTask(CancelTaskRequest req)
取消任务
|
CreateAudioModerationTaskResponse |
AmsClient.CreateAudioModerationTask(CreateAudioModerationTaskRequest req)
本接口（Audio Moderation）用于提交音频内容（包括音频文件或流地址）进行智能审核任务，使用前请您登陆控制台开通音频内容安全服务。
### 功能使用说明：
- 前往“内容安全控制台-音频内容安全”开启使用音频内容安全服务，首次开通可获得20小时免费调用时长
### 接口功能说明：
- 支持对音频流或音频文件进行检测，判断其中是否包含违规内容；
- 支持设置回调地址 Callback 获取检测结果，或通过接口(查询音频检测结果)主动轮询获取检测结果；
- 支持识别违规内容，包括：低俗、谩骂、色情、涉政、广告等场景；
- 支持批量提交检测任务。检测任务列表最多支持10个；
### 音频文件调用说明：
- 音频文件大小支持：文件 < 500M；
- 音频文件时长支持：< 1小时；
- 音频码率类型支持：128 Kbps - 256 Kbps ；
- 音频文件支持格式：wav、mp3、aac、flac、amr、3gp、 m4a、wma、ogg、ape；
- 支持音视频文件分离并对音频文件进行独立识别；
### 音频流调用说明：
- 音频流时长支持：< 3小时；
- 音频码率类型支持：128 Kbps - 256 Kbps ；
- 音频流支持的传输协议：RTMP、HTTP、HTTPS；
- 音频流格式支持的类型：rtp、srtp、rtmp、rtmps、mmsh、 mmst、hls、http、tcp、https、m3u8；
- 支持音视频流分离并对音频流进行独立识别；
|
CreateBizConfigResponse |
AmsClient.CreateBizConfig(CreateBizConfigRequest req)
创建业务配置，1个账号最多可以创建20个配置，可定义音频审核的场景，如色情、谩骂等，
在创建业务配置之前，你需要以下步骤：
1.
|
DescribeAmsListResponse |
AmsClient.DescribeAmsList(DescribeAmsListRequest req)
音频审核明细列表
|
DescribeAudioStatResponse |
AmsClient.DescribeAudioStat(DescribeAudioStatRequest req)
控制台识别统计
|
DescribeBizConfigResponse |
AmsClient.DescribeBizConfig(DescribeBizConfigRequest req)
查看单个配置
|
DescribeTaskDetailResponse |
AmsClient.DescribeTaskDetail(DescribeTaskDetailRequest req)
查看任务详情
|
| Modifier and Type | Method and Description |
|---|---|
CancelTaskResponse |
AmsClient.CancelTask(CancelTaskRequest req)
可使用该接口取消审核任务。请求成功后，接口返回RequestId则说明取消成功。
默认接口请求频率限制：**20次/秒**。 |
CreateAudioModerationSyncTaskResponse |
AmsClient.CreateAudioModerationSyncTask(CreateAudioModerationSyncTaskRequest req)
本接口（CreateAudioModerationSyncTask） 用于提交短音频内容进行智能审核任务，使用前请您使用腾讯云主账号登录控制台 [开通音频内容安全服务](https://console.cloud.tencent.com/cms/audio/package) 并调整好对应的业务配置。
### 接口使用说明：
- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms/audio/package)”开启使用音频内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含**10小时**免费调用时长，有效期为1个月。
- 该接口为收费接口，计费方式敬请参见 [腾讯云音频内容安全定价](https://cloud.tencent.com/product/ams/pricing)。
### 接口调用说明：
- 音频文件大小支持：**文件 <= 4M**;
- 音频文件**时长不超过60s**，超过60s音频调用则报错；
- 音频文件支持格式：**wav (PCM编码)** 、**mp3**、**aac**、**m4a** (采样率：16kHz~48kHz，位深：16bit 小端，声道数：单声道/双声道，建议格式：**16kHz/16bit/单声道**)；
- 接口仅限音频文件传入，视频文件传入请调用长音频异步接口；
- 接口**默认QPS为20**，如需自定义配置并发或请求频率，请工单咨询；
- 接口**默认超时为10s**，请求如超过该时长则接口会报错。
|
CreateAudioModerationTaskResponse |
AmsClient.CreateAudioModerationTask(CreateAudioModerationTaskRequest req)
本接口（Audio Moderation）用于提交音频内容（包括音频文件或流地址）进行智能审核任务，使用前请您使用腾讯云主账号登录控制台[开通音频内容安全服务](https://console.cloud.tencent.com/cms)并调整好对应的业务配置。
### 功能使用说明： - 前往“[内容安全控制台-音频内容安全](https://console.cloud.tencent.com/cms)”开启使用音频内容安全服务，首次开通可获得**10小时**免费调用时长，有效期为1个月。 - 默认接口请求频率限制：**20次/秒**，对于异步审核任务（点播音频），超出频率限制的请求会自动排入待审核队列，对于同步审核任务（直播音频），超出频率限制将会报错。 - 默认并发审核路数限制：点播默认10路，异步审核任务（点播音频）数量超过并发审核路数时，将会进入排队；直播默认100路，同步审核任务（直播音频）超过并发审核路数，接口会返回错误。 ### 接口功能说明： - 支持对音频流或音频文件进行检测，判断其中是否包含违规内容； - 支持设置回调地址 Callback 获取检测结果（对于已在审核的任务，最长回调时间为用户配置的**切片时长 + 2s**），或通过接口(查询音频检测结果)主动轮询获取检测结果； - 支持识别违规内容，包括：低俗、谩骂、色情、广告等场景； - 支持批量提交检测任务，检测任务列表**最多支持10个**。 ### 音频文件调用说明： - 音频文件大小支持：**文件 < 500M**； - 音频文件时长支持：**< 1小时**； - 音频码率类型支持：128 Kbps - 256 Kbps ； - 音频文件支持格式：wav、mp3、aac、flac、amr、3gp、 m4a、wma、ogg、ape； - （**当输入为视频文件时**）支持分离视频文件音轨，并对音频内容进行独立审核。 ### 音频流调用说明： - 音频流时长支持：**< 3小时**； - 音频码率类型支持：128 Kbps - 256 Kbps ； - 音频流支持的传输协议：RTMP、HTTP、HTTPS； - 音频流格式支持的类型：rtp、srtp、rtmp、rtmps、mmsh、 mmst、hls、http、tcp、https、m3u8； - （**当输入为视频流时**）支持提取视频流音轨，并对音频内容进行独立审核。 ### 直播断流处理说明： - 请确认已对接[取消任务](https://cloud.tencent.com/document/product/1219/53258)。 - 如果直播任务取消/结束，则终止直播拉流并退出审核。 - 如果直播任务没有取消/结束，直播视频推流因故中断，产品将在将在10分钟内持续拉流重试。如果10分钟检测到音频切片数据，则恢复正常审核，反之，则终止拉流并退出审核。在拉流终止后，用户如有审核需求，需重新送审。 |
DescribeTaskDetailResponse |
AmsClient.DescribeTaskDetail(DescribeTaskDetailRequest req)
通过该接口可查看音频审核任务的详情信息，包括任务状态、检测结果、音频文件识别出的对应文本内容、检测结果所对应的恶意标签及推荐的后续操作等，具体输出内容可查看输出参数示例。
|
DescribeTasksResponse |
AmsClient.DescribeTasks(DescribeTasksRequest req)
通过该接口可查看审核任务列表；您也可根据多种业务信息（业务类型、审核结果、任务状态等）筛选审核任务列表。任务列表输出内容包括当前查询的任务总量、任务名称、任务状态、音频审核类型、基于检测结果的恶意标签及其后续操作等，具体输出内容可查看输出参数示例。
默认接口请求频率限制：**20次/秒**。 |
| Modifier and Type | Method and Description |
|---|---|
CheckAppidExistResponse |
AnicloudClient.CheckAppidExist(CheckAppidExistRequest req)
查看appid是否存在
|
QueryResourceResponse |
AnicloudClient.QueryResource(QueryResourceRequest req)
查询购买资源
|
QueryResourceInfoResponse |
AnicloudClient.QueryResourceInfo(QueryResourceInfoRequest req)
查询资源信息
|
| Modifier and Type | Method and Description |
|---|---|
GetTaskDetailResponse |
ApcasClient.GetTaskDetail(GetTaskDetailRequest req)
查询画像洞察任务详情
|
GetTaskListResponse |
ApcasClient.GetTaskList(GetTaskListRequest req)
查询当前账号AppID下的画像洞察任务列表
|
PredictRatingResponse |
ApcasClient.PredictRating(PredictRatingRequest req)
根据传入的设备号（IMEI、IDFA、手机号、手机号MD5），返回意向评级结果
|
QueryCallDetailsResponse |
ApcasClient.QueryCallDetails(QueryCallDetailsRequest req)
查询调用明细
|
QueryCallStatResponse |
ApcasClient.QueryCallStat(QueryCallStatRequest req)
按时间维度获取调用量统计
|
QueryGeneralStatResponse |
ApcasClient.QueryGeneralStat(QueryGeneralStatRequest req)
获取日/月/周/总调用量统计数据
|
UploadIdResponse |
ApcasClient.UploadId(UploadIdRequest req)
上传群体画像的ID列表（支持的ID类型：0:imei 7:IDFA 8:MD5(imei)），后台返回生成的画像分析任务ID
|
| Modifier and Type | Method and Description |
|---|---|
BatchDescribeOrderCertificateResponse |
ApeClient.BatchDescribeOrderCertificate(BatchDescribeOrderCertificateRequest req)
批量获取授权书下载地址
|
BatchDescribeOrderImageResponse |
ApeClient.BatchDescribeOrderImage(BatchDescribeOrderImageRequest req)
批量获取图片下载地址
|
CreateOrderAndDownloadsResponse |
ApeClient.CreateOrderAndDownloads(CreateOrderAndDownloadsRequest req)
核销图片，获取原图URL地址
|
CreateOrderAndPayResponse |
ApeClient.CreateOrderAndPay(CreateOrderAndPayRequest req)
购买一张图片并且支付
|
DescribeAuthUsersResponse |
ApeClient.DescribeAuthUsers(DescribeAuthUsersRequest req)
分页查询授权人列表
|
DescribeDownloadInfosResponse |
ApeClient.DescribeDownloadInfos(DescribeDownloadInfosRequest req)
获取用户图片下载记录
|
DescribeImageResponse |
ApeClient.DescribeImage(DescribeImageRequest req)
根据ID查询一张图片的详细信息
|
DescribeImagesResponse |
ApeClient.DescribeImages(DescribeImagesRequest req)
根据关键字搜索图片列表
|
| Modifier and Type | Method and Description |
|---|---|
DescribeProductsResponse |
ApiClient.DescribeProducts(DescribeProductsRequest req)
本接口(DescribeProducts)用于查询各个支持地域列表查询的产品信息。
|
DescribeRegionsResponse |
ApiClient.DescribeRegions(DescribeRegionsRequest req)
本接口(DescribeRegions)用于查询各个产品支持地域信息。
|
DescribeZonesResponse |
ApiClient.DescribeZones(DescribeZonesRequest req)
本接口(DescribeZones)用于查询产品可用区信息。
|
| Modifier and Type | Method and Description |
|---|---|
AttachPluginResponse |
ApigatewayClient.AttachPlugin(AttachPluginRequest req)
绑定插件到API上。
|
BindApiAppResponse |
ApigatewayClient.BindApiApp(BindApiAppRequest req)
本接口（BindApiApp）用于绑定应用到API。
|
BindEnvironmentResponse |
ApigatewayClient.BindEnvironment(BindEnvironmentRequest req)
本接口（BindEnvironment）用于绑定使用计划到服务或API。
用户在发布服务到某个环境中后，如果 API 需要鉴权，还需要绑定使用计划才能进行调用，此接口用户将使用计划绑定到特定环境。
目前支持绑定使用计划到API，但是同一个服务不能同时存在绑定到服务的使用计划和绑定到API的使用计划，所以对已经绑定过服务级别使用计划的环境，请先使用 服务级别使用计划降级 接口进行降级操作。
|
BindIPStrategyResponse |
ApigatewayClient.BindIPStrategy(BindIPStrategyRequest req)
本接口（BindIPStrategy）用于API绑定IP策略。
|
BindSecretIdsResponse |
ApigatewayClient.BindSecretIds(BindSecretIdsRequest req)
本接口（BindSecretIds）用于为使用计划绑定密钥。
将密钥绑定到某个使用计划，并将此使用计划绑定到某个服务发布的环境上，调用者方可使用此密钥调用这个服务中的 API，可使用本接口为使用计划绑定密钥。
|
BindSubDomainResponse |
ApigatewayClient.BindSubDomain(BindSubDomainRequest req)
本接口（BindSubDomain）用于绑定自定义域名到服务。
API 网关中每个服务都会提供一个默认的域名供用户调用，但当用户想使用自己的已有域名时，也可以将自定义域名绑定到此服务，在做好备案、与默认域名的 CNAME 后，可直接调用自定义域名。
|
BuildAPIDocResponse |
ApigatewayClient.BuildAPIDoc(BuildAPIDocRequest req)
构建 API 文档
|
CreateApiResponse |
ApigatewayClient.CreateApi(CreateApiRequest req)
本接口（CreateApi）用于创建 API 接口，创建 API 前，用户需要先创建服务，每个 API 都有自己归属的服务。
|
CreateApiAppResponse |
ApigatewayClient.CreateApiApp(CreateApiAppRequest req)
本接口（CreateApiApp）用于创建应用。
|
CreateAPIDocResponse |
ApigatewayClient.CreateAPIDoc(CreateAPIDocRequest req)
创建 API 文档
|
CreateApiKeyResponse |
ApigatewayClient.CreateApiKey(CreateApiKeyRequest req)
本接口（CreateApiKey）用于创建一对新的 API 密钥。
|
CreateIPStrategyResponse |
ApigatewayClient.CreateIPStrategy(CreateIPStrategyRequest req)
本接口（CreateIPStrategy）用于创建服务IP策略。
|
CreatePluginResponse |
ApigatewayClient.CreatePlugin(CreatePluginRequest req)
创建API网关插件。
|
CreateServiceResponse |
ApigatewayClient.CreateService(CreateServiceRequest req)
本接口（CreateService）用于创建服务。
API 网关使用的最大单元为服务，每个服务中可创建多个 API 接口。每个服务有一个默认域名供客户调用，用户也可绑定自定义域名到此服务中。
|
CreateUpstreamResponse |
ApigatewayClient.CreateUpstream(CreateUpstreamRequest req)
用于创建后端通道
|
CreateUsagePlanResponse |
ApigatewayClient.CreateUsagePlan(CreateUsagePlanRequest req)
本接口（CreateUsagePlan）用于创建使用计划。
用户在使用 API 网关时，需要创建使用计划并将其绑定到服务的环境中使用。
|
DeleteApiResponse |
ApigatewayClient.DeleteApi(DeleteApiRequest req)
本接口（DeleteApi）用于删除已经创建的API。
|
DeleteApiAppResponse |
ApigatewayClient.DeleteApiApp(DeleteApiAppRequest req)
本接口（DeleteApiApp）用于删除已经创建的应用。
|
DeleteAPIDocResponse |
ApigatewayClient.DeleteAPIDoc(DeleteAPIDocRequest req)
删除 API 文档
|
DeleteApiKeyResponse |
ApigatewayClient.DeleteApiKey(DeleteApiKeyRequest req)
本接口（DeleteApiKey）用于删除一对 API 密钥。
|
DeleteIPStrategyResponse |
ApigatewayClient.DeleteIPStrategy(DeleteIPStrategyRequest req)
本接口（DeleteIPStrategy）用于删除服务IP策略。
|
DeletePluginResponse |
ApigatewayClient.DeletePlugin(DeletePluginRequest req)
删除API网关插件
|
DeleteServiceResponse |
ApigatewayClient.DeleteService(DeleteServiceRequest req)
本接口（DeleteService）用于删除 API 网关中某个服务。
|
DeleteServiceSubDomainMappingResponse |
ApigatewayClient.DeleteServiceSubDomainMapping(DeleteServiceSubDomainMappingRequest req)
本接口（DeleteServiceSubDomainMapping）用于删除服务中某个环境的自定义域名映射。
当用户使用自定义域名，并使用了自定义映射时，可使用此接口。但需注意，若删除了所有环境的映射时，调用此 API 均会返回失败。
|
DeleteUpstreamResponse |
ApigatewayClient.DeleteUpstream(DeleteUpstreamRequest req)
删除后端通道，需要注意有API绑定时，不允许删除
|
DeleteUsagePlanResponse |
ApigatewayClient.DeleteUsagePlan(DeleteUsagePlanRequest req)
本接口（DeleteUsagePlan）用于删除使用计划。
|
DemoteServiceUsagePlanResponse |
ApigatewayClient.DemoteServiceUsagePlan(DemoteServiceUsagePlanRequest req)
本接口（DemoteServiceUsagePlan）用于将某个服务在某个环境的使用计划，降级到API上。
如果服务内没有API不允许进行此操作。
如果当前环境没有发布，不允许进行此操作。
|
DescribeAllPluginApisResponse |
ApigatewayClient.DescribeAllPluginApis(DescribeAllPluginApisRequest req)
展示插件相关的API列表，包括已绑定的和未绑定的API信息。
|
DescribeApiResponse |
ApigatewayClient.DescribeApi(DescribeApiRequest req)
本接口（DescribeApi）用于查询用户 API 网关的 API 接口的详细信息。
|
DescribeApiAppResponse |
ApigatewayClient.DescribeApiApp(DescribeApiAppRequest req)
本接口（DescribeApiApp）用于根据应用ID搜索应用。此接口已下线，如需使用功能请使用DescribeApiAppsStatus接口。
|
DescribeApiAppBindApisStatusResponse |
ApigatewayClient.DescribeApiAppBindApisStatus(DescribeApiAppBindApisStatusRequest req)
本接口（DescribeApiAppBindApisStatus）查询应用绑定的Api列表。
|
DescribeApiAppsStatusResponse |
ApigatewayClient.DescribeApiAppsStatus(DescribeApiAppsStatusRequest req)
本接口（DescribeApiAppsStatus）查询应用列表。
|
DescribeApiBindApiAppsStatusResponse |
ApigatewayClient.DescribeApiBindApiAppsStatus(DescribeApiBindApiAppsStatusRequest req)
本接口（DescribeApiBindApiAppsStatus）查询Api绑定的应用列表。
|
DescribeAPIDocDetailResponse |
ApigatewayClient.DescribeAPIDocDetail(DescribeAPIDocDetailRequest req)
查询 API 文档详情
|
DescribeAPIDocsResponse |
ApigatewayClient.DescribeAPIDocs(DescribeAPIDocsRequest req)
查询 API 文档列表
|
DescribeApiEnvironmentStrategyResponse |
ApigatewayClient.DescribeApiEnvironmentStrategy(DescribeApiEnvironmentStrategyRequest req)
本接口（DescribeApiEnvironmentStrategy）用于展示API绑定的限流策略。
|
DescribeApiForApiAppResponse |
ApigatewayClient.DescribeApiForApiApp(DescribeApiForApiAppRequest req)
本接口（DescribeApiForApiApp）用于应用使用者查询部署于 API 网关的 API 接口的详细信息。
|
DescribeApiKeyResponse |
ApigatewayClient.DescribeApiKey(DescribeApiKeyRequest req)
本接口（DescribeApiKey）用于查询密钥详情。
用户在创建密钥后，可用此接口查询一个 API 密钥的详情，该接口会显示密钥 Key。
|
DescribeApiKeysStatusResponse |
ApigatewayClient.DescribeApiKeysStatus(DescribeApiKeysStatusRequest req)
本接口（DescribeApiKeysStatus）用于查询密钥列表。
当用户创建了多个密钥对时，可使用本接口查询一个或多个 API 密钥信息。
|
DescribeApisStatusResponse |
ApigatewayClient.DescribeApisStatus(DescribeApisStatusRequest req)
本接口（DescribeApisStatus）用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。
|
DescribeApiUsagePlanResponse |
ApigatewayClient.DescribeApiUsagePlan(DescribeApiUsagePlanRequest req)
本接口（DescribeApiUsagePlan）用于查询服务中 API 使用计划详情。
服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务及其中 API 的所有使用计划。
|
DescribeExclusiveInstanceDetailResponse |
ApigatewayClient.DescribeExclusiveInstanceDetail(DescribeExclusiveInstanceDetailRequest req)
本接口（DescribeExclusiveInstanceDetail）用于查询独享实例详情信息。
|
DescribeExclusiveInstancesResponse |
ApigatewayClient.DescribeExclusiveInstances(DescribeExclusiveInstancesRequest req)
本接口（DescribeExclusiveInstances）用于查询独享实例列表信息。
|
DescribeExclusiveInstancesStatusResponse |
ApigatewayClient.DescribeExclusiveInstancesStatus(DescribeExclusiveInstancesStatusRequest req)
查询专享实例列表（新）
|
DescribeIPStrategyResponse |
ApigatewayClient.DescribeIPStrategy(DescribeIPStrategyRequest req)
本接口（DescribeIPStrategy）用于查询IP策略详情。
|
DescribeIPStrategyApisStatusResponse |
ApigatewayClient.DescribeIPStrategyApisStatus(DescribeIPStrategyApisStatusRequest req)
本接口（DescribeIPStrategyApisStatus）用于查询IP策略可以绑定的API列表。即服务下所有API和该策略已绑定API的差集。
|
DescribeIPStrategysStatusResponse |
ApigatewayClient.DescribeIPStrategysStatus(DescribeIPStrategysStatusRequest req)
本接口（DescribeIPStrategysStatus）用于查询服务IP策略列表，因为接口名拼写错误，已不推荐使用，请优先使用DescribeIPStrategiesStatus接口。
|
DescribeLogSearchResponse |
ApigatewayClient.DescribeLogSearch(DescribeLogSearchRequest req)
本接口DescribeLogSearch用于搜索日志
|
DescribePluginResponse |
ApigatewayClient.DescribePlugin(DescribePluginRequest req)
展示插件详情，支持按照插件ID进行。
|
DescribePluginApisResponse |
ApigatewayClient.DescribePluginApis(DescribePluginApisRequest req)
查询指定插件下绑定的API信息
|
DescribePluginsResponse |
ApigatewayClient.DescribePlugins(DescribePluginsRequest req)
展示插件列表和详情，支持分页，支持按照插件类型查询，支持按照插件ID批量查询，支持按照插件名称查询。
|
DescribePluginsByApiResponse |
ApigatewayClient.DescribePluginsByApi(DescribePluginsByApiRequest req)
展示API上已绑定的插件列表。
|
DescribeServiceResponse |
ApigatewayClient.DescribeService(DescribeServiceRequest req)
本接口（DescribeService）用于查询一个服务的详细信息、包括服务的描述、域名、协议、创建时间、发布情况等信息。
|
DescribeServiceEnvironmentListResponse |
ApigatewayClient.DescribeServiceEnvironmentList(DescribeServiceEnvironmentListRequest req)
本接口（DescribeServiceEnvironmentList）用于查询一个服务的环境列表，可查询到此服务下所有环境及其状态。
|
DescribeServiceEnvironmentReleaseHistoryResponse |
ApigatewayClient.DescribeServiceEnvironmentReleaseHistory(DescribeServiceEnvironmentReleaseHistoryRequest req)
本接口（DescribeServiceEnvironmentReleaseHistory）用于查询服务环境的发布历史。
用户在创建好服务后需要发布到某个环境中才能进行使用，本接口用于查询一个服务某个环境的发布记录。
|
DescribeServiceEnvironmentStrategyResponse |
ApigatewayClient.DescribeServiceEnvironmentStrategy(DescribeServiceEnvironmentStrategyRequest req)
本接口（DescribeServiceEnvironmentStrategy）用于展示服务限流策略。
|
DescribeServiceForApiAppResponse |
ApigatewayClient.DescribeServiceForApiApp(DescribeServiceForApiAppRequest req)
本接口（DescribeServiceForApiApp）用于应用使用者查询一个服务的详细信息、包括服务的描述、域名、协议等信息。
|
DescribeServiceReleaseVersionResponse |
ApigatewayClient.DescribeServiceReleaseVersion(DescribeServiceReleaseVersionRequest req)
本接口（DescribeServiceReleaseVersion）查询一个服务下面所有已经发布的版本列表。
用户在发布服务时，常有多个版本发布，可使用本接口查询已发布的版本。
|
DescribeServicesStatusResponse |
ApigatewayClient.DescribeServicesStatus(DescribeServicesStatusRequest req)
本接口（DescribeServicesStatus）用于搜索查询某一个服务或多个服务的列表，并返回服务相关的域名、时间等信息。
|
DescribeServiceSubDomainMappingsResponse |
ApigatewayClient.DescribeServiceSubDomainMappings(DescribeServiceSubDomainMappingsRequest req)
本接口（DescribeServiceSubDomainMappings）用于查询自定义域名的路径映射。
API 网关可绑定自定义域名到服务，并且可以对自定义域名的路径进行映射，可自定义不同的路径映射到服务中的三个环境，本接口用于查询绑定服务的自定义域名的路径映射列表。
|
DescribeServiceSubDomainsResponse |
ApigatewayClient.DescribeServiceSubDomains(DescribeServiceSubDomainsRequest req)
本接口（DescribeServiceSubDomains）用于查询自定义域名列表。
API 网关可绑定自定义域名到服务，用于服务调用。此接口用于查询用户绑定在服务的自定义域名列表。
|
DescribeServiceUsagePlanResponse |
ApigatewayClient.DescribeServiceUsagePlan(DescribeServiceUsagePlanRequest req)
本接口（DescribeServiceUsagePlan）用于查询服务使用计划详情。
服务若需要鉴权限流生效，则需要绑定使用计划到此服务中，本接口用于查询绑定到一个服务的所有使用计划。
|
DescribeUpstreamBindApisResponse |
ApigatewayClient.DescribeUpstreamBindApis(DescribeUpstreamBindApisRequest req)
查询后端通道所绑定的API列表
|
DescribeUpstreamsResponse |
ApigatewayClient.DescribeUpstreams(DescribeUpstreamsRequest req)
查询后端通道列表详情
|
DescribeUsagePlanResponse |
ApigatewayClient.DescribeUsagePlan(DescribeUsagePlanRequest req)
本接口（DescribeUsagePlan）用于查询一个使用计划的详细信息，包括名称、QPS、创建时间绑定的环境等。
|
DescribeUsagePlanEnvironmentsResponse |
ApigatewayClient.DescribeUsagePlanEnvironments(DescribeUsagePlanEnvironmentsRequest req)
本接口（DescribeUsagePlanEnvironments）用于查询使用计划绑定的环境列表。
用户在绑定了某个使用计划到环境后，可使用本接口查询这个使用计划绑定的所有服务的环境。
|
DescribeUsagePlanSecretIdsResponse |
ApigatewayClient.DescribeUsagePlanSecretIds(DescribeUsagePlanSecretIdsRequest req)
本接口（DescribeUsagePlanSecretIds）用于查询使用计划绑定的密钥列表。
在 API 网关中，一个使用计划可绑定多个密钥对，可使用本接口查询使用计划绑定的密钥列表。
|
DescribeUsagePlansStatusResponse |
ApigatewayClient.DescribeUsagePlansStatus(DescribeUsagePlansStatusRequest req)
本接口（DescribeUsagePlanStatus）用于查询使用计划的列表。
|
DetachPluginResponse |
ApigatewayClient.DetachPlugin(DetachPluginRequest req)
解除插件与API绑定
|
DisableApiKeyResponse |
ApigatewayClient.DisableApiKey(DisableApiKeyRequest req)
本接口（DisableApiKey）用于禁用一对 API 密钥。
|
EnableApiKeyResponse |
ApigatewayClient.EnableApiKey(EnableApiKeyRequest req)
本接口（EnableApiKey）用于启动一对被禁用的 API 密钥。
|
ImportOpenApiResponse |
ApigatewayClient.ImportOpenApi(ImportOpenApiRequest req)
本接口（ImportOpenApi）用于将OpenAPI规范定义的API导入到API网关。
|
ModifyApiResponse |
ApigatewayClient.ModifyApi(ModifyApiRequest req)
本接口（ModifyApi）用于修改 API 接口，可调用此接口对已经配置的 API 接口进行编辑修改。修改后的 API 需要重新发布 API 所在的服务到对应环境方能生效。
|
ModifyApiAppResponse |
ApigatewayClient.ModifyApiApp(ModifyApiAppRequest req)
本接口（ModifyApiApp）用于修改已经创建的应用。
|
ModifyAPIDocResponse |
ApigatewayClient.ModifyAPIDoc(ModifyAPIDocRequest req)
修改 API 文档
|
ModifyApiEnvironmentStrategyResponse |
ApigatewayClient.ModifyApiEnvironmentStrategy(ModifyApiEnvironmentStrategyRequest req)
本接口（ModifyApiEnvironmentStrategy）用于修改API限流策略
|
ModifyApiIncrementResponse |
ApigatewayClient.ModifyApiIncrement(ModifyApiIncrementRequest req)
提供增量更新API能力，主要是给程序调用（区别于ModifyApi，该接口是需要传入API的全量参数，对console使用较友好）
|
ModifyExclusiveInstanceResponse |
ApigatewayClient.ModifyExclusiveInstance(ModifyExclusiveInstanceRequest req)
本接口（ModifyExclusiveInstance）用于修改独享实例信息。
|
ModifyIPStrategyResponse |
ApigatewayClient.ModifyIPStrategy(ModifyIPStrategyRequest req)
本接口（ModifyIPStrategy）用于修改服务IP策略。
|
ModifyPluginResponse |
ApigatewayClient.ModifyPlugin(ModifyPluginRequest req)
修改API网关插件。
|
ModifyServiceResponse |
ApigatewayClient.ModifyService(ModifyServiceRequest req)
本接口（ModifyService）用于修改服务的相关信息。当服务创建后，服务的名称、描述和服务类型均可被修改。
|
ModifyServiceEnvironmentStrategyResponse |
ApigatewayClient.ModifyServiceEnvironmentStrategy(ModifyServiceEnvironmentStrategyRequest req)
本接口（ModifyServiceEnvironmentStrategy）用于修改服务限流策略
|
ModifySubDomainResponse |
ApigatewayClient.ModifySubDomain(ModifySubDomainRequest req)
本接口（ModifySubDomain）用于修改服务的自定义域名设置中的路径映射，可以修改绑定自定义域名之前的路径映射规则。
|
ModifyUpstreamResponse |
ApigatewayClient.ModifyUpstream(ModifyUpstreamRequest req)
修改后端通道
|
ModifyUsagePlanResponse |
ApigatewayClient.ModifyUsagePlan(ModifyUsagePlanRequest req)
本接口（ModifyUsagePlan）用于修改使用计划的名称，描述及 QPS。
|
ReleaseServiceResponse |
ApigatewayClient.ReleaseService(ReleaseServiceRequest req)
本接口（ReleaseService）用于发布服务。
API 网关的服务创建后，需要发布到某个环境方生效后，使用者才能进行调用，此接口用于发布服务到环境，如 release 环境。
|
ResetAPIDocPasswordResponse |
ApigatewayClient.ResetAPIDocPassword(ResetAPIDocPasswordRequest req)
重置API文档密码
|
UnbindApiAppResponse |
ApigatewayClient.UnbindApiApp(UnbindApiAppRequest req)
本接口（UnbindApiApp）用于解除应用和API绑定。
|
UnBindEnvironmentResponse |
ApigatewayClient.UnBindEnvironment(UnBindEnvironmentRequest req)
本接口（UnBindEnvironment）用于将使用计划从特定环境解绑。
|
UnBindIPStrategyResponse |
ApigatewayClient.UnBindIPStrategy(UnBindIPStrategyRequest req)
本接口（UnBindIPStrategy）用于服务解绑IP策略。
|
UnBindSecretIdsResponse |
ApigatewayClient.UnBindSecretIds(UnBindSecretIdsRequest req)
本接口（UnBindSecretIds）用于为使用计划解绑密钥。
|
UnBindSubDomainResponse |
ApigatewayClient.UnBindSubDomain(UnBindSubDomainRequest req)
本接口（UnBindSubDomain）用于解绑自定义域名。
用户使用 API 网关绑定了自定义域名到服务中后，若想要解绑此自定义域名，可使用此接口。
|
UnReleaseServiceResponse |
ApigatewayClient.UnReleaseService(UnReleaseServiceRequest req)
本接口（UnReleaseService）用于下线服务。
用户发布服务到某个环境后，此服务中的 API 方可被调用者进行调用，当用户需要将此服务从发布环境中下线时，可调用此 API。下线后的服务不可被调用。
|
UpdateApiAppKeyResponse |
ApigatewayClient.UpdateApiAppKey(UpdateApiAppKeyRequest req)
本接口（UpdateApiAppKey）用于更新应用密钥。
|
UpdateApiKeyResponse |
ApigatewayClient.UpdateApiKey(UpdateApiKeyRequest req)
本接口（UpdateApiKey）用于更换用户已创建的一对 API 密钥。
|
UpdateServiceResponse |
ApigatewayClient.UpdateService(UpdateServiceRequest req)
本接口（UpdateService）用于从服务已发布的环境中将运行版本切换到特定版本。用户在使用 API 网关创建服务并发布服务到某个环境后，如在开发过程产生多个版本需要切换，此时可调用本接口。
|
| Modifier and Type | Method and Description |
|---|---|
AttachInstancesResponse |
AsClient.AttachInstances(AttachInstancesRequest req)
本接口（AttachInstances）用于将 CVM 实例添加到伸缩组。
仅支持添加处于`RUNNING`（运行中）或`STOPPED`（已关机）状态的 CVM 实例
添加的 CVM 实例需要和伸缩组 VPC 网络一致
|
AttachLoadBalancersResponse |
AsClient.AttachLoadBalancers(AttachLoadBalancersRequest req)
此接口（AttachLoadBalancers）用于将负载均衡器添加到伸缩组。
|
CancelInstanceRefreshResponse |
AsClient.CancelInstanceRefresh(CancelInstanceRefreshRequest req)
取消伸缩组的实例刷新活动。
已刷新/正在刷新的批次不受影响，待刷新批次被取消
刷新失败的实例保持备用中状态，需用户手动处理后尝试退出备用中状态或销毁
取消后不允许回滚操作，也不支持恢复操作
|
ClearLaunchConfigurationAttributesResponse |
AsClient.ClearLaunchConfigurationAttributes(ClearLaunchConfigurationAttributesRequest req)
本接口（ClearLaunchConfigurationAttributes）用于将启动配置内的特定属性完全清空。
|
CompleteLifecycleActionResponse |
AsClient.CompleteLifecycleAction(CompleteLifecycleActionRequest req)
本接口（CompleteLifecycleAction）用于完成生命周期动作。
用户通过调用本接口，指定一个具体的生命周期挂钩的结果（“CONITNUE”或者“ABANDON”）。如果一直不调用本接口，则生命周期挂钩会在超时后按照“DefaultResult”进行处理。
|
CreateAutoScalingGroupResponse |
AsClient.CreateAutoScalingGroup(CreateAutoScalingGroupRequest req)
本接口（CreateAutoScalingGroup）用于创建伸缩组
|
CreateAutoScalingGroupFromInstanceResponse |
AsClient.CreateAutoScalingGroupFromInstance(CreateAutoScalingGroupFromInstanceRequest req)
本接口（CreateAutoScalingGroupFromInstance）用于根据实例创建启动配置及伸缩组。
说明：根据按包年包月计费的实例所创建的伸缩组，其扩容的实例为按量计费实例。
|
CreateLaunchConfigurationResponse |
AsClient.CreateLaunchConfiguration(CreateLaunchConfigurationRequest req)
本接口（CreateLaunchConfiguration）用于创建新的启动配置。
启动配置，可以通过 `ModifyLaunchConfigurationAttributes` 修改少量字段。如需使用新的启动配置，建议重新创建启动配置。
每个项目最多只能创建20个启动配置，详见[使用限制](https://cloud.tencent.com/document/product/377/3120)。
|
CreateLifecycleHookResponse |
AsClient.CreateLifecycleHook(CreateLifecycleHookRequest req)
本接口（CreateLifecycleHook）用于创建生命周期挂钩。
您可以为生命周期挂钩配置消息通知或执行自动化助手命令。
如果您配置了通知消息，弹性伸缩会通知您的TDMQ消息队列，通知内容形如：
```
{
"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）用于创建通知。
通知到 CMQ 主题或队列时，消息内容如下：
```
{
"Service": "Tencent Cloud Auto Scaling",
"CreatedTime": "2021-10-11T10:15:11Z", // 活动创建时间
"AppId": "100000000",
"ActivityId": "asa-fznnvrja", // 伸缩活动ID
"AutoScalingGroupId": "asg-pc2oqu2z", // 伸缩组ID
"ActivityType": "SCALE_OUT", // 伸缩活动类型
"StatusCode": "SUCCESSFUL", // 伸缩活动结果
"Description": "Activity was launched in response to a difference between desired capacity and actual capacity,
scale out 1 instance(s).", // 伸缩活动描述
"StartTime": "2021-10-11T10:15:11Z", // 活动开始时间
"EndTime": "2021-10-11T10:15:32Z", // 活动结束时间
"DetailedStatusMessageSet": [ // 活动内部错误集合（非空不代表活动失败）
{
"Code": "InvalidInstanceType",
"Zone": "ap-guangzhou-2",
"InstanceId": "",
"InstanceChargeType": "POSTPAID_BY_HOUR",
"SubnetId": "subnet-4t5mgeuu",
"Message": "The specified instance type `S5.LARGE8` is invalid in `subnet-4t5mgeuu`, `ap-guangzhou-2`.",
"InstanceType": "S5.LARGE8"
}
]
}
```
|
CreateScalingPolicyResponse |
AsClient.CreateScalingPolicy(CreateScalingPolicyRequest req)
本接口（CreateScalingPolicy）用于创建告警触发策略。
|
CreateScheduledActionResponse |
AsClient.CreateScheduledAction(CreateScheduledActionRequest req)
本接口（CreateScheduledAction）用于创建定时任务。
|
DeleteAutoScalingGroupResponse |
AsClient.DeleteAutoScalingGroup(DeleteAutoScalingGroupRequest req)
本接口（DeleteAutoScalingGroup）用于删除指定伸缩组，删除前提是伸缩组内无运行中（IN_SERVICE）状态的实例且当前未在执行伸缩活动。删除伸缩组后，创建失败（CREATION_FAILED）、中止失败（TERMINATION_FAILED）、解绑失败（DETACH_FAILED）等非运行中状态的实例不会被销毁。
|
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）用于查询伸缩组的伸缩活动记录。
|
DescribeAutoScalingAdvicesResponse |
AsClient.DescribeAutoScalingAdvices(DescribeAutoScalingAdvicesRequest req)
此接口用于查询伸缩组配置建议。
|
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）的通知。
|
DescribeRefreshActivitiesResponse |
AsClient.DescribeRefreshActivities(DescribeRefreshActivitiesRequest req)
本接口（DescribeRefreshActivities）用于查询伸缩组的实例刷新活动记录。
|
DescribeScalingPoliciesResponse |
AsClient.DescribeScalingPolicies(DescribeScalingPoliciesRequest req)
本接口（DescribeScalingPolicies）用于查询告警触发策略。
|
DescribeScheduledActionsResponse |
AsClient.DescribeScheduledActions(DescribeScheduledActionsRequest req)
本接口 (DescribeScheduledActions) 用于查询一个或多个定时任务的详细信息。
可以根据定时任务ID、定时任务名称或者伸缩组ID等信息来查询定时任务的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的定时任务。
|
DetachInstancesResponse |
AsClient.DetachInstances(DetachInstancesRequest req)
本接口（DetachInstances）用于从伸缩组移出 CVM 实例，本接口不会销毁实例。
如果移出指定实例后，伸缩组内处于`IN_SERVICE`状态的实例数量小于伸缩组最小值，接口将报错
如果伸缩组处于`DISABLED`状态，移出操作不校验`IN_SERVICE`实例数量和最小值的关系
对于伸缩组配置的 CLB，实例在离开伸缩组时，AS 会进行解挂载动作
|
DetachLoadBalancersResponse |
AsClient.DetachLoadBalancers(DetachLoadBalancersRequest req)
本接口（DetachLoadBalancers）用于从伸缩组移出负载均衡器，本接口不会销毁负载均衡器。
|
DisableAutoScalingGroupResponse |
AsClient.DisableAutoScalingGroup(DisableAutoScalingGroupRequest req)
本接口（DisableAutoScalingGroup）用于停用指定伸缩组。
停用伸缩组后，自动触发的伸缩活动不再进行，包括：
- 告警策略触发的伸缩活动
- 匹配期望实例数的伸缩活动
- 不健康实例替换活动
- 定时任务
停用伸缩组后，手动触发的伸缩活动允许进行，包括：
- 指定数量扩容实例（ScaleOutInstances）
- 指定数量缩容实例（ScaleInInstances）
- 从伸缩组中移出 CVM 实例（DetachInstances）
- 从伸缩组中删除 CVM 实例（RemoveInstances）
- 添加 CVM 实例到伸缩组（AttachInstances）
- 关闭伸缩组内 CVM 实例（StopAutoScalingInstances）
- 开启伸缩组内 CVM 实例（StartAutoScalingInstances）
|
EnableAutoScalingGroupResponse |
AsClient.EnableAutoScalingGroup(EnableAutoScalingGroupRequest req)
本接口（EnableAutoScalingGroup）用于启用指定伸缩组。
|
ExecuteScalingPolicyResponse |
AsClient.ExecuteScalingPolicy(ExecuteScalingPolicyRequest req)
本接口（ExecuteScalingPolicy）用于执行伸缩策略。
可以根据伸缩策略ID执行伸缩策略。
伸缩策略所属伸缩组处于伸缩活动时，会拒绝执行伸缩策略。
本接口不支持执行目标追踪策略。
|
ExitStandbyResponse |
AsClient.ExitStandby(ExitStandbyRequest req)
伸缩组内实例退出备用中状态。
备用中状态的实例负载均衡器权重值为 0，退出备用中状态后，权重值也会恢复
对备用中状态实例进行开关机操作也会使其退出备用中状态
|
ModifyAutoScalingGroupResponse |
AsClient.ModifyAutoScalingGroup(ModifyAutoScalingGroupRequest req)
本接口（ModifyAutoScalingGroup）用于修改伸缩组。
|
ModifyDesiredCapacityResponse |
AsClient.ModifyDesiredCapacity(ModifyDesiredCapacityRequest req)
本接口（ModifyDesiredCapacity）用于修改指定伸缩组的期望实例数
|
ModifyLaunchConfigurationAttributesResponse |
AsClient.ModifyLaunchConfigurationAttributes(ModifyLaunchConfigurationAttributesRequest req)
本接口（ModifyLaunchConfigurationAttributes）用于修改启动配置部分属性。
修改启动配置后，已经使用该启动配置扩容的存量实例不会发生变更，此后使用该启动配置的新增实例会按照新的配置进行扩容。
本接口支持修改部分简单类型。
|
ModifyLifecycleHookResponse |
AsClient.ModifyLifecycleHook(ModifyLifecycleHookRequest req)
此接口用于修改生命周期挂钩。
|
ModifyLoadBalancersResponse |
AsClient.ModifyLoadBalancers(ModifyLoadBalancersRequest req)
本接口（ModifyLoadBalancers）用于修改伸缩组的负载均衡器。
本接口用于为伸缩组指定新的负载均衡器配置，采用`完全覆盖`风格，无论之前配置如何，`统一按照接口参数配置为新的负载均衡器`。
如果要为伸缩组清空负载均衡器，则在调用本接口时仅指定伸缩组ID，不指定具体负载均衡器。
本接口会立即修改伸缩组的负载均衡器，并生成一个伸缩活动，异步修改存量实例的负载均衡器。
|
ModifyLoadBalancerTargetAttributesResponse |
AsClient.ModifyLoadBalancerTargetAttributes(ModifyLoadBalancerTargetAttributesRequest req)
本接口（ModifyLoadBalancerTargetAttributes）用于修改伸缩组内负载均衡器的目标规则属性。
|
ModifyNotificationConfigurationResponse |
AsClient.ModifyNotificationConfiguration(ModifyNotificationConfigurationRequest req)
本接口（ModifyNotificationConfiguration）用于修改通知。
通知的接收端类型不支持修改。
|
ModifyScalingPolicyResponse |
AsClient.ModifyScalingPolicy(ModifyScalingPolicyRequest req)
本接口（ModifyScalingPolicy）用于修改告警触发策略。
|
ModifyScheduledActionResponse |
AsClient.ModifyScheduledAction(ModifyScheduledActionRequest req)
本接口（ModifyScheduledAction）用于修改定时任务。
|
RemoveInstancesResponse |
AsClient.RemoveInstances(RemoveInstancesRequest req)
本接口（RemoveInstances）用于从伸缩组删除 CVM 实例。根据当前的产品逻辑，如果实例由弹性伸缩自动创建，则实例会被销毁；如果实例系创建后加入伸缩组的，则会从伸缩组中移除，保留实例。
如果删除指定实例后，伸缩组内处于`IN_SERVICE`状态的实例数量小于伸缩组最小值，接口将报错
如果伸缩组处于`DISABLED`状态，删除操作不校验`IN_SERVICE`实例数量和最小值的关系
对于伸缩组配置的 CLB，实例在离开伸缩组时，AS 会进行解挂载动作
|
ResumeInstanceRefreshResponse |
AsClient.ResumeInstanceRefresh(ResumeInstanceRefreshRequest req)
恢复暂停状态的实例刷新活动，使其重试当前批次刷新失败实例或继续刷新后续批次，非暂停状态下调用该接口无效。
|
RollbackInstanceRefreshResponse |
AsClient.RollbackInstanceRefresh(RollbackInstanceRefreshRequest req)
回滚操作会生成一个新的实例刷新活动，该活动也支持分批次刷新以及暂停、恢复、取消操作，接口返回回滚活动的 RefreshActivityId。
原活动中待刷新实例变更为已取消，忽略不存在实例，其他状态实例进入回滚流程
原活动中正在刷新的实例不会立刻终止，刷新结束后再执行回滚活动
暂停状态或最近一次成功的刷新活动支持回滚，其他状态不支持回滚
原活动刷新方式为重装实例时，对于 ImageId参数，会自动恢复到回滚前镜像 ID；对于 UserData、EnhancedService、LoginSettings、 HostName 参数，依然会从启动配置中读取，需用户在回滚前自行修改启动配置
|
ScaleInInstancesResponse |
AsClient.ScaleInInstances(ScaleInInstancesRequest req)
为伸缩组指定数量缩容实例，返回缩容活动的 ActivityId。
伸缩组需要未处于活动中
伸缩组处于停用状态时，该接口也会生效，可参考[停用伸缩组](https://cloud.tencent.com/document/api/377/20435)文档查看伸缩组停用状态的影响范围
根据伸缩组的`TerminationPolicies`策略，选择被缩容的实例，可参考[缩容处理](https://cloud.tencent.com/document/product/377/8563)
接口只会选择`IN_SERVICE`实例缩容，如果需要缩容其他状态实例，可以使用 [DetachInstances](https://cloud.tencent.com/document/api/377/20436) 或 [RemoveInstances](https://cloud.tencent.com/document/api/377/20431) 接口
接口会减少期望实例数，新的期望实例数需要大于等于最小实例数
缩容如果失败或者部分成功，最后期望实例数只会扣减实际缩容成功的实例数量
|
ScaleOutInstancesResponse |
AsClient.ScaleOutInstances(ScaleOutInstancesRequest req)
为伸缩组指定数量扩容实例，返回扩容活动的 ActivityId。
伸缩组需要未处于活动中
伸缩组处于停用状态时，该接口也会生效，可参考[停用伸缩组](https://cloud.tencent.com/document/api/377/20435)文档查看伸缩组停用状态的影响范围
接口会增加期望实例数，新的期望实例数需要小于等于最大实例数
扩容如果失败或者部分成功，最后期望实例数只会增加实际成功的实例数量
竞价混合模式中一次扩容可能触发多个伸缩活动，该接口仅返回第一个伸缩活动的 ActivityId
|
SetInstancesProtectionResponse |
AsClient.SetInstancesProtection(SetInstancesProtectionRequest req)
本接口（SetInstancesProtection）用于设置实例保护。
实例设置保护之后，当发生不健康替换、报警策略、期望值变更等触发缩容时，将不对此实例缩容操作。
|
StartAutoScalingInstancesResponse |
AsClient.StartAutoScalingInstances(StartAutoScalingInstancesRequest req)
本接口（StartAutoScalingInstances）用于开启伸缩组内 CVM 实例。
开机成功，实例转为`IN_SERVICE`状态后，会增加期望实例数，期望实例数不可超过设置的最大值
本接口支持批量操作，每次请求开机实例的上限为100
|
StartInstanceRefreshResponse |
AsClient.StartInstanceRefresh(StartInstanceRefreshRequest req)
根据启动配置中参数，刷新伸缩组内运行中状态 CVM 实例，返回实例刷新活动的 RefreshActivityId。
对于重装实例的刷新方式（目前仅支持重装），重装时仅会从启动配置中获取 ImageId、UserData、EnhancedService、 HostName、LoginSettings 参数进行刷新，实例的其他参数不会刷新
实例刷新期间（包括暂停状态），伸缩组会被停用。不建议刷新期间修改关联启动配置，否则会影响刷新参数，造成实例配置不一致
滚动更新模式会分成多批次进行刷新实例，单批次中若存在刷新失败实例，活动会进入失败暂停状态
若待刷新实例被移出或销毁，会被标记为 NOT_FOUND 状态，不阻塞实例刷新活动
运行中状态实例与最新启动配置参数一致，实例也会再次刷新
|
StopAutoScalingInstancesResponse |
AsClient.StopAutoScalingInstances(StopAutoScalingInstancesRequest req)
本接口（StopAutoScalingInstances）用于关闭伸缩组内 CVM 实例。
关机方式采用`SOFT_FIRST`方式，表示在正常关闭失败后进行强制关闭
关闭`IN_SERVICE`状态的实例，会减少期望实例数，期望实例数不可低于设置的最小值
使用`STOP_CHARGING`选项关机，待关机的实例需要满足[关机不收费条件](https://cloud.tencent.com/document/product/213/19918)
本接口支持批量操作，每次请求关机实例的上限为100
|
StopInstanceRefreshResponse |
AsClient.StopInstanceRefresh(StopInstanceRefreshRequest req)
暂停正在执行的实例刷新活动。
暂停状态下，伸缩组也会处于停用中状态
当前正在更新的实例不会暂停，待更新的实例会暂停更新
|
UpgradeLaunchConfigurationResponse |
AsClient.UpgradeLaunchConfiguration(UpgradeLaunchConfigurationRequest req)
已有替代接口ModifyLaunchConfiguration。该接口存在覆盖参数风险，目前官网已隐藏
本接口（UpgradeLaunchConfiguration）用于升级启动配置。
本接口用于升级启动配置，采用“完全覆盖”风格，无论之前参数如何，统一按照接口参数设置为新的配置。对于非必填字段，不填写则按照默认值赋值。
升级修改启动配置后，已经使用该启动配置扩容的存量实例不会发生变更，此后使用该启动配置的新增实例会按照新的配置进行扩容。
|
UpgradeLifecycleHookResponse |
AsClient.UpgradeLifecycleHook(UpgradeLifecycleHookRequest req)
本接口（UpgradeLifecycleHook）用于升级生命周期挂钩。
本接口用于升级生命周期挂钩，采用“完全覆盖”风格，无论之前参数如何，统一按照接口参数设置为新的配置。对于非必填字段，不填写则按照默认值赋值。
|
| Modifier and Type | Method and Description |
|---|---|
CloseAsyncRecognitionTaskResponse |
AsrClient.CloseAsyncRecognitionTask(CloseAsyncRecognitionTaskRequest req)
本接口用于关闭语音流异步识别任务。
|
CreateAsrVocabResponse |
AsrClient.CreateAsrVocab(CreateAsrVocabRequest req)
用户通过本接口进行热词表的创建。
• 默认最多可创建30个热词表。 • 每个热词表最多可添加1000个词，每个词最长10个汉字或30个英文字符，不能超出限制。 • 热词表可以通过数组或者本地文件形式上传。 • 本地文件必须为UTF-8编码格式，每行仅添加一个热词且不能包含标点和特殊字符。 • 热词权重取值范围为[1,11]之间的整数，权重越大代表该词被识别出来的概率越大。 • 注意: 热词权重设置为11时，当前热词将升级为超级热词，建议仅将重要且必须生效的热词设置到11，设置过多权重为11的热词将影响整体字准率。 |
CreateAsyncRecognitionTaskResponse |
AsrClient.CreateAsyncRecognitionTask(CreateAsyncRecognitionTaskRequest req)
本接口用于对语音流进行准实时识别，通过异步回调来返回识别结果。适用于直播审核等场景。
• 支持rtmp、rtsp等流媒体协议，以及各类基于http协议的直播流(不支持hls) • 音频流时长无限制，服务会自动拉取音频流数据，若连续10分钟拉不到流数据时，服务会终止识别任务 • 服务通过回调的方式来提供识别结果，用户需要提供CallbackUrl。回调时机为一小段话(最长15秒)回调一次。 • 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。 • 默认单账号限制并发数为20路，如您有提高并发限制的需求，请提[工单](https://console.cloud.tencent.com/workorder/category)进行咨询。 |
CreateCustomizationResponse |
AsrClient.CreateCustomization(CreateCustomizationRequest req)
用户使用该接口可以创建自学习模型，以供识别调用。
注意：调用该接口后，模型会自动训练。新建模型成功后，调用ModifyCustomizationState接口修改为上线状态，即可在识别请求中使用对应模型ID。
|
CreateRecTaskResponse |
AsrClient.CreateRecTask(CreateRecTaskRequest req)
本接口可对较长的录音文件进行识别。如希望直接使用带界面的语音识别产品，请访问[产品体验中心](https://console.cloud.tencent.com/asr/demonstrate)。产品计费标准请查阅 [计费概述（在线版）](https://cloud.tencent.com/document/product/1093/35686)
• 接口默认限频：20次/秒。此处仅限制任务提交频次，与识别结果返回时效无关
• 返回时效：异步回调，非实时返回。最长3小时返回识别结果，**大多数情况下，1小时的音频1-3分钟即可完成识别**。请注意：上述返回时长不含音频下载时延，且30分钟内发送超过1000小时录音或2万条任务的情况除外
• 音频格式：wav、mp3、m4a、flv、mp4、wma、3gp、amr、aac、ogg-opus、flac
• 支持语言：在本页面上搜索 **EngineModelType**，或前往 [产品功能](https://cloud.tencent.com/document/product/1093/35682) 查看
• 音频提交方式：本接口支持**音频 URL 、本地音频文件**两种请求方式。推荐使用 [腾讯云COS](https://cloud.tencent.com/document/product/436/38484) 来存储、生成URL并提交任务，此种方式将不产生外网和流量下行费用，可节约成本、提升任务速度（COS桶权限需要设置公有读私有写，或URL设置外部可访问）
• 音频限制：音频 URL 时长不能大于5小时，文件大小不超过1GB；本地音频文件不能大于5MB
• 如何获取识别结果：支持**回调或轮询**的方式获取结果，具体请参考 [录音文件识别结果查询](https://cloud.tencent.com/document/product/1093/37822)
• 识别结果有效时间：在服务端保存7天
• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法 v3
|
DeleteAsrVocabResponse |
AsrClient.DeleteAsrVocab(DeleteAsrVocabRequest req)
用户通过本接口进行热词表的删除。
|
DeleteCustomizationResponse |
AsrClient.DeleteCustomization(DeleteCustomizationRequest req)
用户通过该接口可以删除自学习模型
|
DescribeAsyncRecognitionTasksResponse |
AsrClient.DescribeAsyncRecognitionTasks(DescribeAsyncRecognitionTasksRequest req)
本接口用于查询当前在运行的语音流异步识别任务列表。
• 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。 |
DescribeTaskStatusResponse |
AsrClient.DescribeTaskStatus(DescribeTaskStatusRequest req)
在调用录音文件识别请求接口后，有回调和轮询两种方式获取识别结果。
• 当采用回调方式时，识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL，具体请参见[ 录音识别结果回调 ](https://cloud.tencent.com/document/product/1093/52632)。 • 当采用轮询方式时，需要主动提交任务ID来轮询识别结果，共有任务成功、等待、执行中和失败四种结果，具体信息请参见下文说明。 • 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8" • 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。 • 默认接口请求频率限制：50次/秒，如您有提高请求频率限制的需求，请提[工单](https://console.cloud.tencent.com/workorder/category)进行咨询。 |
DownloadAsrVocabResponse |
AsrClient.DownloadAsrVocab(DownloadAsrVocabRequest req)
用户通过本接口进行热词表的下载，获得词表权重文件形式的 base64 值，文件形式为通过 “|” 分割的词和权重，即 word|weight 的形式。
|
DownloadCustomizationResponse |
AsrClient.DownloadCustomization(DownloadCustomizationRequest req)
用户通过该接口可以下载自学习模型的语料
|
GetAsrVocabResponse |
AsrClient.GetAsrVocab(GetAsrVocabRequest req)
用户根据词表的ID可以获取对应的热词表信息
|
GetAsrVocabListResponse |
AsrClient.GetAsrVocabList(GetAsrVocabListRequest req)
用户通过该接口，可获得所有的热词表及其信息。
|
GetCustomizationListResponse |
AsrClient.GetCustomizationList(GetCustomizationListRequest req)
查询自学习模型列表
|
GetModelInfoResponse |
AsrClient.GetModelInfo(GetModelInfoRequest req)
通过自学习模型id获取自学习模型详细信息
|
ModifyCustomizationResponse |
AsrClient.ModifyCustomization(ModifyCustomizationRequest req)
用户通过该接口可以更新自学习模型，如模型名称、模型类型、模型语料。
|
ModifyCustomizationStateResponse |
AsrClient.ModifyCustomizationState(ModifyCustomizationStateRequest req)
通过该接口，用户可以修改自学习模型状态，上下线自学习模型
|
SentenceRecognitionResponse |
AsrClient.SentenceRecognition(SentenceRecognitionRequest req)
本接口用于对60秒之内的短音频文件进行识别。
• 支持中文普通话、英语、粤语、日语、越南语、马来语、印度尼西亚语、菲律宾语、泰语、葡萄牙语、土耳其语、阿拉伯语、印地语、法语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄话、黑龙江话、吉林话、辽宁话。 • 支持本地语音文件上传和语音URL上传两种请求方式，音频时长不能超过60s，音频文件大小不能超过3MB。 • 音频格式支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac、 amr。 • 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8" • 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。 • 默认接口请求频率限制：30次/秒，如您有提高请求频率限制的需求，请[前往购买](https://buy.cloud.tencent.com/asr)。 |
SetVocabStateResponse |
AsrClient.SetVocabState(SetVocabStateRequest req)
用户通过该接口可以设置热词表的默认状态。初始状态为0，用户可设置状态为1，即为默认状态。默认状态表示用户在请求识别时，如不设置热词表ID，则默认使用状态为1的热词表。
|
UpdateAsrVocabResponse |
AsrClient.UpdateAsrVocab(UpdateAsrVocabRequest req)
用户通过本接口进行对应的词表信息更新。
|
VoicePrintCompareResponse |
AsrClient.VoicePrintCompare(VoicePrintCompareRequest req)
通过比对两段音频内说话人的声纹，得到一个打分，可通过打分判断两段音频声纹相似度, 打分区间[0 - 100]。 音频要求：16k采样率， 16bit位深，pcm或者wav格式， 单声道，总时长不超过30秒的音频，base64编码数据大小不超过2M，音频内容只有一个说话人声音，并且尽可能清晰，这样结果更加准确。
|
VoicePrintCountResponse |
AsrClient.VoicePrintCount(VoicePrintCountRequest req)
统计并返回注册的说话人id总数
|
VoicePrintDeleteResponse |
AsrClient.VoicePrintDelete(VoicePrintDeleteRequest req)
本接口用于以删除已经注册的说话人信息（删除之后，原有的说话人ID和说话人音频数据都会失效）
|
VoicePrintEnrollResponse |
AsrClient.VoicePrintEnroll(VoicePrintEnrollRequest req)
说话人注册接口用于注册一个指定音频，生成一个唯一的说话人id，后续可通过说话人验证接口验证其它音频和已有的说话人ID匹配度，注册时可指定说话人昵称，方便标识说话人ID， 说话人昵称可重复配置。
（注: 一个appid最多可以注册1000个说话人ID，一个说话人ID仅支持一条音频注册，后续可通过更新接口进行更新）
使用须知
支持的输入格式：编码文件(PCM, WAV)、16 bit采样位数、单声道（mono）。
支持的音频采样率：16000 Hz。
|
VoicePrintUpdateResponse |
AsrClient.VoicePrintUpdate(VoicePrintUpdateRequest req)
本接口用于更新和覆盖已注册的音频数据和说话人昵称，更新后原有的音频数据将失效。
|
VoicePrintVerifyResponse |
AsrClient.VoicePrintVerify(VoicePrintVerifyRequest req)
本接口用于校验传入音频与已注册音频的匹配程度，通过指定说话人ID（VoicePrintId）和一段音频进行音频和说话人的匹配度判断
|
| Modifier and Type | Method and Description |
|---|---|
CreateWeappQRUrlResponse |
BaClient.CreateWeappQRUrl(CreateWeappQRUrlRequest req)
创建渠道备案小程序二维码
|
DescribeGetAuthInfoResponse |
BaClient.DescribeGetAuthInfo(DescribeGetAuthInfoRequest req)
获取实名认证信息
|
SyncIcpOrderWebInfoResponse |
BaClient.SyncIcpOrderWebInfo(SyncIcpOrderWebInfoRequest req)
将备案ICP订单下的一个网站信息 同步给订单下其他网站，需要被同步的网站被检查通过(isCheck:true)；
只有指定的网站信息字段能被同步
|
| Modifier and Type | Method and Description |
|---|---|
CreateGroupResponse |
BdaClient.CreateGroup(CreateGroupRequest req)
用于创建一个空的人体库，如果人体库已存在返回错误。
1个APPID下最多有2000W个人体动作轨迹（Trace），最多1W个人体库（Group）。
单个人体库（Group）最多10W个人体动作轨迹（Trace）。
单个人员（Person）最多添加 5 个人体动作轨迹（Trace）。
|
CreatePersonResponse |
BdaClient.CreatePerson(CreatePersonRequest req)
创建人员，添加对应人员的人体动作轨迹信息。
请注意：
- 我们希望您的输入为 严格符合动作轨迹图片 要求的图片。如果您输入的图片不符合动作轨迹图片要求，会对最终效果产生较大负面影响。请您尽量保证一个Trace中的图片人体清晰、无遮挡、连贯；
- 一个人体动作轨迹（Trace）可以包含1-5张人体图片。提供越多质量高的人体图片有助于提升最终识别结果；
- 无论您在单个Trace中提供了多少张人体图片，我们都将生成一个对应的动作轨迹（Trace）信息。即，Trace仅和本次输入的图片序列相关，和图片的个数无关；
- 输入的图片组中，若有部分图片输入不合法（如图片大小过大、分辨率过大、无法解码等），我们将舍弃这部分图片，确保合法图片被正确搜索。即，我们将尽可能保证请求成功，去除不合法的输入；
- 构成人体动作轨迹单张图片大小不得超过2M，分辨率不得超过1920*1080。
|
CreateSegmentationTaskResponse |
BdaClient.CreateSegmentationTask(CreateSegmentationTaskRequest req)
本接口为人像分割在线处理接口组中的提交任务接口，可以对提交的资源进行处理视频流/图片流识别视频作品中的人像区域，进行一键抠像、背景替换、人像虚化等后期处理。
|
CreateTraceResponse |
BdaClient.CreateTrace(CreateTraceRequest req)
将一个人体动作轨迹添加到一个人员中。一个人员最多允许包含 5 个人体动作轨迹。同一人的人体动作轨迹越多，搜索识别效果越好。
>请注意：
- 我们希望您的输入为 严格符合动作轨迹图片 要求的图片。如果您输入的图片不符合动作轨迹图片要求，会对最终效果产生较大负面影响。请您尽量保证一个Trace中的图片人体清晰、无遮挡、连贯。
- 一个人体动作轨迹（Trace）可以包含1-5张人体图片。提供越多质量高的人体图片有助于提升最终识别结果。
- 无论您在单个Trace中提供了多少张人体图片，我们都将生成一个对应的动作轨迹（Trace）信息。即，Trace仅和本次输入的图片序列相关，和图片的个数无关。
- 输入的图片组中，若有部分图片输入不合法（如图片大小过大、分辨率过大、无法解码等），我们将舍弃这部分图片，确保合法图片被正确搜索。即，我们将尽可能保证请求成功，去除不合法的输入；
- 构成人体动作轨迹单张图片大小限制为2M，分辨率限制为1920*1080。
|
DeleteGroupResponse |
BdaClient.DeleteGroup(DeleteGroupRequest req)
删除该人体库及包含的所有的人员。
|
DeletePersonResponse |
BdaClient.DeletePerson(DeletePersonRequest req)
删除人员。
|
DescribeSegmentationTaskResponse |
BdaClient.DescribeSegmentationTask(DescribeSegmentationTaskRequest req)
可以查看单条任务的处理情况，包括处理状态，处理结果。
|
DetectBodyResponse |
BdaClient.DetectBody(DetectBodyRequest req)
检测给定图片中的人体（Body）的位置信息及属性信息。
|
DetectBodyJointsResponse |
BdaClient.DetectBodyJoints(DetectBodyJointsRequest req)
检测图片中人体的14个关键点。建议用于人体图像清晰、无遮挡的场景。支持一张图片中存在多个人体的识别。
|
GetGroupListResponse |
BdaClient.GetGroupList(GetGroupListRequest req)
获取人体库列表。
|
GetPersonListResponse |
BdaClient.GetPersonList(GetPersonListRequest req)
获取指定人体库中的人员列表。
|
GetSummaryInfoResponse |
BdaClient.GetSummaryInfo(GetSummaryInfoRequest req)
获取人体库汇总信息。
|
ModifyGroupResponse |
BdaClient.ModifyGroup(ModifyGroupRequest req)
修改人体库名称、备注。
|
ModifyPersonInfoResponse |
BdaClient.ModifyPersonInfo(ModifyPersonInfoRequest req)
修改人员信息。
|
SearchTraceResponse |
BdaClient.SearchTrace(SearchTraceRequest req)
本接口用于对一组待识别的人体动作轨迹（Trace）图片，在人体库中识别出最相似的 TopK 人体，按照相似度从大到小排列。
人体动作轨迹（Trace）图片要求：图片中当且仅包含一个人体。人体完整、无遮挡。
> 请注意：
- 我们希望您的输入为严格符合动作轨迹图片要求的图片。如果您输入的图片不符合动作轨迹图片要求，会对最终效果产生较大负面影响；
- 人体动作轨迹，是一个包含1-5张图片的图片序列。您可以输入1张图片作为动作轨迹，也可以输入多张。单个动作轨迹中包含越多符合质量的图片，搜索效果越好。
- 构成人体动作轨迹单张图片大小不得超过2M，分辨率不得超过1920*1080。
|
SegmentCustomizedPortraitPicResponse |
BdaClient.SegmentCustomizedPortraitPic(SegmentCustomizedPortraitPicRequest req)
在前后景分割的基础上优化多分类分割，支持对头发、五官等的分割，既作为换发型、挂件等底层技术，也可用于抠人头、抠人脸等玩法
|
SegmentPortraitPicResponse |
BdaClient.SegmentPortraitPic(SegmentPortraitPicRequest req)
即二分类人像分割，识别传入图片中人体的完整轮廓，进行抠像。
|
TerminateSegmentationTaskResponse |
BdaClient.TerminateSegmentationTask(TerminateSegmentationTaskRequest req)
终止指定视频人像分割处理任务
|
| Modifier and Type | Method and Description |
|---|---|
CreateSessionResponse |
BizliveClient.CreateSession(CreateSessionRequest req)
创建会话
|
DescribeStreamPlayInfoListResponse |
BizliveClient.DescribeStreamPlayInfoList(DescribeStreamPlayInfoListRequest req)
查询播放数据，支持按流名称查询详细播放数据，也可按播放域名查询详细总数据。
|
DescribeWorkersResponse |
BizliveClient.DescribeWorkers(DescribeWorkersRequest req)
查询空闲机器数量
|
ForbidLiveStreamResponse |
BizliveClient.ForbidLiveStream(ForbidLiveStreamRequest req)
禁止某条流的推送，可以预设某个时刻将流恢复。
|
RegisterIMResponse |
BizliveClient.RegisterIM(RegisterIMRequest req)
注册聊天室
|
StopGameResponse |
BizliveClient.StopGame(StopGameRequest req)
强制退出游戏
|
| Modifier and Type | Method and Description |
|---|---|
GetBpaasApproveDetailResponse |
BpaasClient.GetBpaasApproveDetail(GetBpaasApproveDetailRequest req)
查看审批详情
|
OutApproveBpaasApplicationResponse |
BpaasClient.OutApproveBpaasApplication(OutApproveBpaasApplicationRequest req)
外部审批申请单
|
| Modifier and Type | Method and Description |
|---|---|
DescribeBRIResponse |
BriClient.DescribeBRI(DescribeBRIRequest req)
输入业务名 (bri_num, bri_dev, bri_ip, bri_apk, bri_url, bri_social 六种之一) 及其 相应字段, 获取业务风险分数和标签。
当业务名为bri_num时，必须填PhoneNumber字段.
|
| Modifier and Type | Method and Description |
|---|---|
CreateAudioDepositResponse |
BtoeClient.CreateAudioDeposit(CreateAudioDepositRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE写入待存证的音频原文件或下载URL，BTOE对音频原文件存储后，将其Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。音频类型支持格式：mp3、wav、wma、midi、flac；原文件上传大小不超过5 MB，下载URL文件大小不超过25 MB。
|
CreateDataDepositResponse |
BtoeClient.CreateDataDeposit(CreateDataDepositRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE写入待存证的业务数据明文，业务数据明文存证写入后不可修改，BTOE对业务数据明文存证生成含有电子签章的区块链存证电子凭证。
|
CreateDocDepositResponse |
BtoeClient.CreateDocDeposit(CreateDocDepositRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE写入待存证的文档原文件或下载URL，BTOE对文档原文件存储后，将其Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。文档类型支持格式：doc、docx、xls、xlsx、ppt、pptx、 pdf、html、txt、md、csv；原文件上传大小不超过5 MB，下载URL文件大小不超过10 MB。
|
CreateHashDepositResponse |
BtoeClient.CreateHashDeposit(CreateHashDepositRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE写入待存证的原文数据Hash值，BTOE对业务数据Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。
|
CreateHashDepositNoCertResponse |
BtoeClient.CreateHashDepositNoCert(CreateHashDepositNoCertRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE写入待存证的原文数据Hash值，BTOE对业务数据Hash值存证上链，本接口不生成区块链存证电子凭证。
|
CreateHashDepositNoSealResponse |
BtoeClient.CreateHashDepositNoSeal(CreateHashDepositNoSealRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE写入待存证的原文数据Hash值，BTOE对业务数据Hash值存证上链，并生成无电子签章的区块链存证电子凭证。
|
CreateImageDepositResponse |
BtoeClient.CreateImageDeposit(CreateImageDepositRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE写入待存证的图片原文件或下载URL，BTOE对图片原文件存储后，将其Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。图片类型支持格式：png、jpg、jpeg、bmp、gif、svg；原文件上传大小不超过5 MB，下载URL文件大小不超过10 MB。
|
CreateVideoDepositResponse |
BtoeClient.CreateVideoDeposit(CreateVideoDepositRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE写入待存证的视频的原文件或下载URL，BTOE对视频原文件存储后，将其Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。视频文件支持格式：mp4、avi、mkv、mov、flv,wmv,rmvb,3gp；文件大小限制：直接上传原文件不大于5MB，下载URL文件大小不大于200 MB。
|
CreateWebpageDepositResponse |
BtoeClient.CreateWebpageDeposit(CreateWebpageDepositRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过本接口向BTOE提交待存证网页的URL，BTOE对URL进行网页快照，并将快照图片存储，将网页快照Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。URL格式必须以http、https开头。
|
GetDepositCertResponse |
BtoeClient.GetDepositCert(GetDepositCertRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过存证编码向BTOE查询存证电子凭证信息。
|
GetDepositFileResponse |
BtoeClient.GetDepositFile(GetDepositFileRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过存证编码向BTOE获取存证文件的下载URL。
-注：Hash类存证、业务数据明文存证不产生存证文件。
|
GetDepositInfoResponse |
BtoeClient.GetDepositInfo(GetDepositInfoRequest req)
功能迭代，已上线更高版本的接口2021-05-14
用户通过存证编码向BTOE查询存证基本信息。
|
| Modifier and Type | Method and Description |
|---|---|
CreateAudioDepositResponse |
BtoeClient.CreateAudioDeposit(CreateAudioDepositRequest req)
用户通过本接口向BTOE写入待存证的音频原文件或下载URL，BTOE对音频原文件存储后，将其Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。音频类型支持格式：mp3、wav、wma、midi、flac；原文件上传大小不超过5 MB，下载URL文件大小不超过25 MB。
|
CreateDataDepositResponse |
BtoeClient.CreateDataDeposit(CreateDataDepositRequest req)
用户通过本接口向BTOE写入待存证的业务数据明文，业务数据明文存证写入后不可修改，BTOE对业务数据明文存证生成含有电子签章的区块链存证电子凭证。
|
CreateDocDepositResponse |
BtoeClient.CreateDocDeposit(CreateDocDepositRequest req)
用户通过本接口向BTOE写入待存证的文档原文件或下载URL，BTOE对文档原文件存储后，将其Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。文档类型支持格式：doc、docx、xls、xlsx、ppt、pptx、 pdf、html、txt、md、csv；原文件上传大小不超过5 MB，下载URL文件大小不超过10 MB。
|
CreateHashDepositResponse |
BtoeClient.CreateHashDeposit(CreateHashDepositRequest req)
用户通过本接口向BTOE写入待存证的原文数据Hash值，BTOE对业务数据Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。
|
CreateHashDepositNoCertResponse |
BtoeClient.CreateHashDepositNoCert(CreateHashDepositNoCertRequest req)
用户通过本接口向BTOE写入待存证的原文数据Hash值，BTOE对业务数据Hash值存证上链，本接口不生成区块链存证电子凭证。
|
CreateHashDepositNoSealResponse |
BtoeClient.CreateHashDepositNoSeal(CreateHashDepositNoSealRequest req)
用户通过本接口向BTOE写入待存证的原文数据Hash值，BTOE对业务数据Hash值存证上链，并生成无电子签章的区块链存证电子凭证。
|
CreateImageDepositResponse |
BtoeClient.CreateImageDeposit(CreateImageDepositRequest req)
用户通过本接口向BTOE写入待存证的图片原文件或下载URL，BTOE对图片原文件存储后，将其Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。图片类型支持格式：png、jpg、jpeg、bmp、gif、svg；原文件上传大小不超过5 MB，下载URL文件大小不超过10 MB。
|
CreateVideoDepositResponse |
BtoeClient.CreateVideoDeposit(CreateVideoDepositRequest req)
用户通过本接口向BTOE写入待存证的视频的原文件或下载URL，BTOE对视频原文件存储后，将其Hash值存证上链，并生成含有电子签章的区块链存证电子凭证。视频文件支持格式：mp4、avi、mkv、mov、flv,wmv,rmvb,3gp；文件大小限制：直接上传原文件不大于5MB。
|
GetDepositCertResponse |
BtoeClient.GetDepositCert(GetDepositCertRequest req)
用户通过存证编码向BTOE查询存证电子凭证信息。
|
GetDepositFileResponse |
BtoeClient.GetDepositFile(GetDepositFileRequest req)
用户通过存证编码向BTOE获取存证文件的下载URL。
-注：Hash类存证、业务数据明文存证不产生存证文件。
|
GetDepositInfoResponse |
BtoeClient.GetDepositInfo(GetDepositInfoRequest req)
用户通过存证编码向BTOE查询存证基本信息。
|
VerifyEvidenceBlockChainTxHashResponse |
BtoeClient.VerifyEvidenceBlockChainTxHash(VerifyEvidenceBlockChainTxHashRequest req)
用户向BTOE核验存证结果中的区块链交易hash的真实性
|
VerifyEvidenceHashResponse |
BtoeClient.VerifyEvidenceHash(VerifyEvidenceHashRequest req)
用户存证内容hash向BTOE核验存证记录的真实性。
|
| Modifier and Type | Method and Description |
|---|---|
ApplyConcurrentResponse |
CarClient.ApplyConcurrent(ApplyConcurrentRequest req)
本接口用于申请并发。接口超时时间：20秒。
|
CreateSessionResponse |
CarClient.CreateSession(CreateSessionRequest req)
本接口用于创建会话。接口超时时间：5秒。
|
DestroySessionResponse |
CarClient.DestroySession(DestroySessionRequest req)
销毁会话。如果该会话开启了云端推流，那么销毁会话时会结束云端推流。
|
StartPublishStreamResponse |
CarClient.StartPublishStream(StartPublishStreamRequest req)
开始云端推流。云端推流 codec 根据客户端（SDK）能力来自动选择，默认优先顺序为 H265、H264、VP8、VP9。
|
StartPublishStreamWithURLResponse |
CarClient.StartPublishStreamWithURL(StartPublishStreamWithURLRequest req)
开始云端推流到指定URL。云端推流 codec 根据客户端（SDK）能力来自动选择，默认优先顺序为 H265、H264、VP8、VP9。该推流方式需要单独计费，详细计费方式请查看[指定地址推流费用说明](https://cloud.tencent.com/document/product/1547/72168#98ac188a-d122-4caf-88be-05268ecefdf6)
|
StopPublishStreamResponse |
CarClient.StopPublishStream(StopPublishStreamRequest req)
停止云端推流
|
| Modifier and Type | Method and Description |
|---|---|
ApplyDiskBackupResponse |
CbsClient.ApplyDiskBackup(ApplyDiskBackupRequest req)
本接口（ApplyDiskBackup）用于回滚备份点到原云硬盘。
仅支持回滚到原云硬盘上。对于数据盘备份点，如果您需要复制备份点数据到其它云硬盘上，请先使用 CreateSnapshot 将备份点转换为快照，然后使用 CreateDisks 接口创建新的弹性云硬盘，将快照数据复制到新购云硬盘上。
用于回滚的备份点必须处于NORMAL状态。备份点状态可以通过DescribeDiskBackups接口查询，见输出参数中BackupState字段解释。
如果是弹性云硬盘，则云硬盘必须处于未挂载状态，云硬盘挂载状态可以通过DescribeDisks接口查询，见Attached字段解释；如果是随实例一起购买的非弹性云硬盘，则实例必须处于关机状态，实例状态可以通过DescribeInstancesStatus接口查询。
|
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)。
当已绑定定期快照策略的云硬盘处于未使用状态（即弹性云盘未挂载或非弹性云盘的主机处于关机状态）将不会创建定期快照。
|
CopySnapshotCrossRegionsResponse |
CbsClient.CopySnapshotCrossRegions(CopySnapshotCrossRegionsRequest req)
本接口（CopySnapshotCrossRegions）用于快照跨地域复制。
本接口为异步接口，当跨地域复制的请求下发成功后会返回一个新的快照ID，此时快照未立即复制到目标地域，可请求目标地域的[DescribeSnapshots](/document/product/362/15647)接口查询新快照的状态，判断是否复制完成。如果快照的状态为“NORMAL”，表示快照复制完成。
本接口实现的快照跨地域复制操作将产生跨地域流量，预计2022年第三季度会针对此功能进行商业化计费；请留意后续站内信公告，避免产生预期外扣费。
|
CreateAutoSnapshotPolicyResponse |
CbsClient.CreateAutoSnapshotPolicy(CreateAutoSnapshotPolicyRequest req)
本接口（CreateAutoSnapshotPolicy）用于创建定期快照策略。
每个地域可创建的定期快照策略数量限制请参考文档[定期快照](/document/product/362/8191)。
每个地域可创建的快照有数量和容量的限制，具体请见腾讯云控制台快照页面提示，如果快照超配额，定期快照创建会失败。
|
CreateDiskBackupResponse |
CbsClient.CreateDiskBackup(CreateDiskBackupRequest req)
为云硬盘创建一个备份点。
|
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）用于删除定期快照策略。
支持批量操作。如果多个定期快照策略存在无法删除的，则操作不执行，以特定错误码返回。
|
DeleteDiskBackupsResponse |
CbsClient.DeleteDiskBackups(DeleteDiskBackupsRequest req)
批量删除指定的云硬盘备份点。
|
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）用于查询云盘绑定的定期快照策略。
|
DescribeDiskBackupsResponse |
CbsClient.DescribeDiskBackups(DescribeDiskBackupsRequest req)
本接口（DescribeDiskBackups）用于查询备份点的详细信息。
根据备份点ID、创建备份点的云硬盘ID、创建备份点的云硬盘类型等对结果进行过滤，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器Filter。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的备份点列表。
|
DescribeDiskConfigQuotaResponse |
CbsClient.DescribeDiskConfigQuota(DescribeDiskConfigQuotaRequest req)
本接口（DescribeDiskConfigQuota）用于查询云硬盘配额。
|
DescribeDisksResponse |
CbsClient.DescribeDisks(DescribeDisksRequest req)
本接口（DescribeDisks）用于查询云硬盘列表。
可以根据云硬盘ID、云硬盘类型或者云硬盘状态等信息来查询云硬盘的详细信息，不同条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘列表。
|
DescribeDiskStoragePoolResponse |
CbsClient.DescribeDiskStoragePool(DescribeDiskStoragePoolRequest req)
本接口（DescribeDiskStoragePool）查询用户的云硬盘独享集群列表。
可以根据独享集群ID(CdcId)、可用区(zone)等信息来查询和过滤云硬盘独享集群详细信息，不同的过滤条件之间为与(AND)的关系，过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的云硬盘独享集群列表。
|
DescribeInstancesDiskNumResponse |
CbsClient.DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)
本接口（DescribeInstancesDiskNum）用于查询实例已挂载云硬盘数量。
支持批量操作，当传入多个云服务器实例ID，返回结果会分别列出每个云服务器挂载的云硬盘数量。
|
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”，则为卸载成功。
|
GetSnapOverviewResponse |
CbsClient.GetSnapOverview(GetSnapOverviewRequest req)
获取快照概览信息
|
InitializeDisksResponse |
CbsClient.InitializeDisks(InitializeDisksRequest req)
重新初始化云硬盘至云硬盘初始创建时的状态。使用云硬盘的重新初始化功能时需要注意以下4点：
1.
|
InquirePriceModifyDiskBackupQuotaResponse |
CbsClient.InquirePriceModifyDiskBackupQuota(InquirePriceModifyDiskBackupQuotaRequest req)
本接口（InquirePricePriceModifyDiskBackupQuota）用于修改云硬盘备份点配额询价。
|
InquirePriceModifyDiskExtraPerformanceResponse |
CbsClient.InquirePriceModifyDiskExtraPerformance(InquirePriceModifyDiskExtraPerformanceRequest req)
本接口（InquirePriceModifyDiskExtraPerformance）用于调整云硬盘额外性能询价。
|
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，则所有云盘修改为同一属性。如果存在不允许操作的云盘，则操作不执行，以特定错误码返回。
|
ModifyDiskBackupQuotaResponse |
CbsClient.ModifyDiskBackupQuota(ModifyDiskBackupQuotaRequest req)
此接口 (ModifyDiskBackupQuota) 用于修改云硬盘备份点配额。
|
ModifyDiskExtraPerformanceResponse |
CbsClient.ModifyDiskExtraPerformance(ModifyDiskExtraPerformanceRequest req)
本接口（ModifyDiskExtraPerformance）用于调整云硬盘额外的性能。
目前仅支持增强型SSD云硬盘(CLOUD_HSSD)和极速型SSD云硬盘（CLOUD_TSSD）。
|
ModifyDisksChargeTypeResponse |
CbsClient.ModifyDisksChargeType(ModifyDisksChargeTypeRequest req)
本接口 (ModifyDisksChargeType) 用于切换云硬盘的计费模式。
非弹性云硬盘不支持此接口，请通过修改实例计费模式接口将实例连同非弹性云硬盘一起转换。
默认接口请求频率限制：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”，表示正在扩容中。
|
TerminateDisksResponse |
CbsClient.TerminateDisks(TerminateDisksRequest req)
本接口（TerminateDisks）用于退还云硬盘。
不再使用的云盘，可通过本接口主动退还。
本接口支持退还预付费云盘和按小时后付费云盘。按小时后付费云盘可直接退还，预付费云盘需符合退还规则。
支持批量操作，每次请求批量云硬盘的上限为100。如果批量云盘存在不允许操作的，请求会以特定错误码返回。
|
UnbindAutoSnapshotPolicyResponse |
CbsClient.UnbindAutoSnapshotPolicy(UnbindAutoSnapshotPolicyRequest req)
本接口（UnbindAutoSnapshotPolicy）用于解除云硬盘绑定的定期快照策略。
支持批量操作，可一次解除多个云盘与同一定期快照策略的绑定。
如果传入的云盘未绑定到当前定期快照策略，接口将自动跳过，仅解绑与当前定期快照策略绑定的云盘。
|
| Modifier and Type | Method and Description |
|---|---|
AddCdnDomainResponse |
CdnClient.AddCdnDomain(AddCdnDomainRequest req)
AddCdnDomain 用于新增内容分发网络加速域名。1分钟内最多可新增100个域名。
|
AddCLSTopicDomainsResponse |
CdnClient.AddCLSTopicDomains(AddCLSTopicDomainsRequest req)
AddCLSTopicDomains 用于新增域名到某日志主题下
|
CreateClsLogTopicResponse |
CdnClient.CreateClsLogTopic(CreateClsLogTopicRequest req)
CreateClsLogTopic 用于创建日志主题。注意：一个日志集下至多可创建10个日志主题。
|
CreateDiagnoseUrlResponse |
CdnClient.CreateDiagnoseUrl(CreateDiagnoseUrlRequest req)
### **该接口已废弃**
CreateDiagnoseUrl 用于添加域名诊断任务URL。 |
CreateEdgePackTaskResponse |
CdnClient.CreateEdgePackTask(CreateEdgePackTaskRequest req)
动态打包任务提交接口
|
CreateScdnDomainResponse |
CdnClient.CreateScdnDomain(CreateScdnDomainRequest req)
CreateScdnDomain 用于创建 SCDN 加速域名
|
CreateScdnFailedLogTaskResponse |
CdnClient.CreateScdnFailedLogTask(CreateScdnFailedLogTaskRequest req)
CreateScdnFailedLogTask 用于重试创建失败的事件日志任务
|
CreateScdnLogTaskResponse |
CdnClient.CreateScdnLogTask(CreateScdnLogTaskRequest req)
CreateScdnLogTask 用于创建事件日志任务
|
CreateVerifyRecordResponse |
CdnClient.CreateVerifyRecord(CreateVerifyRecordRequest req)
CreateVerifyRecord 用于生成一条子域名解析，提示客户添加到域名解析上，用于泛域名及域名取回校验归属权。
生成的解析记录可通过 [VerifyDomainRecord](https://cloud.tencent.com/document/product/228/48117) 完成归属权校验。
注意：生成的解析记录有效期为24小时，超过24小时后，需重新生成。
具体流程可参考：[使用API接口进行域名归属校验](https://cloud.tencent.com/document/product/228/61702#.E6.96.B9.E6.B3.95.E4.B8.89.EF.BC.9Aapi-.E6.8E.A5.E5.8F.A3.E6.93.8D.E4.BD.9C)
|
DeleteCdnDomainResponse |
CdnClient.DeleteCdnDomain(DeleteCdnDomainRequest req)
DeleteCdnDomain 用于删除指定加速域名
|
DeleteClsLogTopicResponse |
CdnClient.DeleteClsLogTopic(DeleteClsLogTopicRequest req)
DeleteClsLogTopic 用于删除日志主题。注意：删除后，所有该日志主题下绑定域名的日志将不再继续投递至该主题，已经投递的日志将会被全部清空。生效时间约为 5~15 分钟。
|
DeleteScdnDomainResponse |
CdnClient.DeleteScdnDomain(DeleteScdnDomainRequest req)
删除SCDN域名
|
DescribeBillingDataResponse |
CdnClient.DescribeBillingData(DescribeBillingDataRequest req)
DescribeBillingData 用于查询实际计费数据明细。
|
DescribeCcDataResponse |
CdnClient.DescribeCcData(DescribeCcDataRequest req)
CC统计数据查询
|
DescribeCdnDataResponse |
CdnClient.DescribeCdnData(DescribeCdnDataRequest req)
DescribeCdnData 用于查询 CDN 实时访问监控数据，支持以下指标查询：
+ 流量（单位为 byte）
+ 带宽（单位为 bps）
+ 请求数（单位为 次）
+ 命中请求数（单位为 次）
+ 请求命中率（单位为 %）
+ 命中流量（单位为 byte）
+ 流量命中率（单位为 %）
+ 状态码 2xx 汇总及各 2 开头状态码明细（单位为 个）
+ 状态码 3xx 汇总及各 3 开头状态码明细（单位为 个）
+ 状态码 4xx 汇总及各 4 开头状态码明细（单位为 个）
+ 状态码 5xx 汇总及各 5 开头状态码明细（单位为 个）
|
DescribeCdnDomainLogsResponse |
CdnClient.DescribeCdnDomainLogs(DescribeCdnDomainLogsRequest req)
DescribeCdnDomainLogs 用于查询访问日志下载地址，仅支持 30 天以内的境内、境外访问日志下载链接查询。
|
DescribeCdnIpResponse |
CdnClient.DescribeCdnIp(DescribeCdnIpRequest req)
DescribeCdnIp 用于查询 CDN IP 归属。
（注意：此接口请求频率限制以 CDN 侧限制为准：200次/10分钟）
|
DescribeCdnOriginIpResponse |
CdnClient.DescribeCdnOriginIp(DescribeCdnOriginIpRequest req)
### **该接口已废弃**
本接口（DescribeCdnOriginIp）用于查询 CDN 回源节点的IP信息。（注：替换接口为DescribeIpStatus） |
DescribeCertDomainsResponse |
CdnClient.DescribeCertDomains(DescribeCertDomainsRequest req)
DescribeCertDomains 用于校验SSL证书并提取证书中包含的域名。
|
DescribeDDoSDataResponse |
CdnClient.DescribeDDoSData(DescribeDDoSDataRequest req)
DDoS统计数据查询
|
DescribeDiagnoseReportResponse |
CdnClient.DescribeDiagnoseReport(DescribeDiagnoseReportRequest req)
### **该接口已废弃**
DescribeDiagnoseReport 用于获取指定报告id的内容。 |
DescribeDistrictIspDataResponse |
CdnClient.DescribeDistrictIspData(DescribeDistrictIspDataRequest req)
查询指定域名的区域、运营商明细数据
注意事项：接口尚未全面开放，未在内测名单中的账号不支持调用
|
DescribeDomainsResponse |
CdnClient.DescribeDomains(DescribeDomainsRequest req)
DescribeDomains 用于查询内容分发网络加速域名（含境内、境外）基本配置信息，包括项目ID、服务状态，业务类型、创建时间、更新时间等信息。
|
DescribeDomainsConfigResponse |
CdnClient.DescribeDomainsConfig(DescribeDomainsConfigRequest req)
DescribeDomainsConfig 用于查询内容分发网络加速域名（含境内、境外）的所有配置信息。
|
DescribeEdgePackTaskStatusResponse |
CdnClient.DescribeEdgePackTaskStatus(DescribeEdgePackTaskStatusRequest req)
DescribeEdgePackTaskStatus 用于查询动态打包任务状态列表
|
DescribeEventLogDataResponse |
CdnClient.DescribeEventLogData(DescribeEventLogDataRequest req)
DescribeEventLogData 用于查询事件日志统计曲线
|
DescribeHttpsPackagesResponse |
CdnClient.DescribeHttpsPackages(DescribeHttpsPackagesRequest req)
DescribeHttpsPackages 用于查询 CDN HTTPS请求包详情。
|
DescribeImageConfigResponse |
CdnClient.DescribeImageConfig(DescribeImageConfigRequest req)
DescribeImageConfig 用于获取域名图片优化的当前配置，支持Webp、TPG、 Guetzli 和 Avif。
|
DescribeIpStatusResponse |
CdnClient.DescribeIpStatus(DescribeIpStatusRequest req)
DescribeIpStatus 用于查询域名所在加速平台的边缘节点、回源节点明细。注意事项：暂不支持查询边缘节点信息并且数据会存在一定延迟。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
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 用于查询用户的计费类型，计费周期等信息。
|
DescribePurgeQuotaResponse |
CdnClient.DescribePurgeQuota(DescribePurgeQuotaRequest req)
DescribePurgeQuota 用于查询账户刷新配额和每日可用量。
|
DescribePurgeTasksResponse |
CdnClient.DescribePurgeTasks(DescribePurgeTasksRequest req)
DescribePurgeTasks 用于查询提交的 URL 刷新、目录刷新记录及执行进度，通过 PurgePathCache 与 PurgeUrlsCache 接口提交的任务均可通过此接口进行查询。
|
DescribePushQuotaResponse |
CdnClient.DescribePushQuota(DescribePushQuotaRequest req)
DescribePushQuota 用于查询预热配额和每日可用量。
|
DescribePushTasksResponse |
CdnClient.DescribePushTasks(DescribePushTasksRequest req)
DescribePushTasks 用于查询预热任务提交历史记录及执行进度。
|
DescribeReportDataResponse |
CdnClient.DescribeReportData(DescribeReportDataRequest req)
DescribeReportData 用于查询域名/项目维度的日/周/月报表数据。
|
DescribeScdnBotDataResponse |
CdnClient.DescribeScdnBotData(DescribeScdnBotDataRequest req)
获取BOT统计数据列表
|
DescribeScdnBotRecordsResponse |
CdnClient.DescribeScdnBotRecords(DescribeScdnBotRecordsRequest req)
查询BOT会话记录列表
|
DescribeScdnConfigResponse |
CdnClient.DescribeScdnConfig(DescribeScdnConfigRequest req)
DescribeScdnConfig 用于查询指定 SCDN 加速域名的安全相关配置
|
DescribeScdnIpStrategyResponse |
CdnClient.DescribeScdnIpStrategy(DescribeScdnIpStrategyRequest req)
查询在SCDN IP安全策略
|
DescribeScdnTopDataResponse |
CdnClient.DescribeScdnTopData(DescribeScdnTopDataRequest req)
获取SCDN的Top数据
|
DescribeTopDataResponse |
CdnClient.DescribeTopData(DescribeTopDataRequest req)
DescribeTopData 通过入参 Metric 和 Filter 组合不同，可以查询以下排序数据：
+ 依据总流量、总请求数对访问 IP 排序，从大至小返回 TOP 100 IP
+ 依据总流量、总请求数对访问 Refer 排序，从大至小返回 TOP 100 Refer
+ 依据总流量、总请求数对访问 设备 排序，从大至小返回 设备类型
+ 依据总流量、总请求数对访问 操作系统 排序，从大至小返回 操作系统
+ 依据总流量、总请求数对访问 浏览器 排序，从大至小返回 浏览器
注意：
+ 仅支持 90 天内数据查询，且从2021年09月20日开始有数据
+ 本接口为beta版，尚未正式全量发布
|
DescribeTrafficPackagesResponse |
CdnClient.DescribeTrafficPackages(DescribeTrafficPackagesRequest req)
DescribeTrafficPackages 用于查询 CDN 流量包详情。
|
DescribeUrlViolationsResponse |
CdnClient.DescribeUrlViolations(DescribeUrlViolationsRequest req)
DescribeUrlViolations 用于查询被 CDN 系统扫描到的域名违规 URL 列表及当前状态。
对应内容分发网络控制台【图片鉴黄】页面。
|
DescribeWafDataResponse |
CdnClient.DescribeWafData(DescribeWafDataRequest req)
Waf统计数据查询
|
DisableCachesResponse |
CdnClient.DisableCaches(DisableCachesRequest req)
### **该接口已废弃**
DisableCaches 用于禁用 CDN 上指定 URL 的访问，禁用完成后，中国境内访问会直接返回 403。 |
DisableClsLogTopicResponse |
CdnClient.DisableClsLogTopic(DisableClsLogTopicRequest req)
DisableClsLogTopic 用于停止日志主题投递。注意：停止后，所有绑定该日志主题域名的日志将不再继续投递至该主题，已经投递的日志将会继续保留。生效时间约为 5~15 分钟。
|
DuplicateDomainConfigResponse |
CdnClient.DuplicateDomainConfig(DuplicateDomainConfigRequest req)
拷贝参考域名的配置至新域名。暂不支持自有证书以及定制化配置
|
EnableCachesResponse |
CdnClient.EnableCaches(EnableCachesRequest req)
### **该接口已废弃**
EnableCaches 用于解禁手工封禁的 URL，解禁成功后，全网生效时间约 5~10 分钟。 |
EnableClsLogTopicResponse |
CdnClient.EnableClsLogTopic(EnableClsLogTopicRequest req)
EnableClsLogTopic 用于启动日志主题投递。注意：启动后，所有绑定该日志主题域名的日志将继续投递至该主题。生效时间约为 5~15 分钟。
|
GetDisableRecordsResponse |
CdnClient.GetDisableRecords(GetDisableRecordsRequest req)
### **该接口已废弃**
GetDisableRecords 用于查询资源禁用历史，及 URL 当前状态。 |
ListClsLogTopicsResponse |
CdnClient.ListClsLogTopics(ListClsLogTopicsRequest req)
ListClsLogTopics 用于显示日志主题列表。注意：一个日志集下至多含10个日志主题。
|
ListClsTopicDomainsResponse |
CdnClient.ListClsTopicDomains(ListClsTopicDomainsRequest req)
ListClsTopicDomains 用于获取某日志主题下绑定的域名列表。
|
ListDiagnoseReportResponse |
CdnClient.ListDiagnoseReport(ListDiagnoseReportRequest req)
### **该接口已废弃**
ListDiagnoseReport 用于获取用户诊断URL访问后各个子任务的简要详情。 |
ListScdnDomainsResponse |
CdnClient.ListScdnDomains(ListScdnDomainsRequest req)
ListScdnDomains 用于查询 SCDN 安全加速域名列表，及域名基本配置信息
|
ListScdnLogTasksResponse |
CdnClient.ListScdnLogTasks(ListScdnLogTasksRequest req)
ListScdnLogTasks 用于查询SCDN日志下载任务列表,以及展示下载任务基本信息
|
ListScdnTopBotDataResponse |
CdnClient.ListScdnTopBotData(ListScdnTopBotDataRequest req)
获取Bot攻击的Top数据列表
|
ListTopBotDataResponse |
CdnClient.ListTopBotData(ListTopBotDataRequest req)
获取Bot攻击的Top信息
|
ListTopCcDataResponse |
CdnClient.ListTopCcData(ListTopCcDataRequest req)
获取CC攻击Top数据
|
ListTopClsLogDataResponse |
CdnClient.ListTopClsLogData(ListTopClsLogDataRequest req)
通过CLS日志计算Top信息。支持近7天的日志数据。
|
ListTopDataResponse |
CdnClient.ListTopData(ListTopDataRequest req)
ListTopData 通过入参 Metric 和 Filter 组合不同，可以查询以下排序数据：
+ 依据总流量、总请求数对访问 URL 排序，从大至小返回 TOP 1000 URL
+ 依据总流量、总请求数对客户端省份排序，从大至小返回省份列表
+ 依据总流量、总请求数对客户端运营商排序，从大至小返回运营商列表
+ 依据总流量、峰值带宽、总请求数、平均命中率、2XX/3XX/4XX/5XX 状态码对域名排序，从大至小返回域名列表
+ 依据总回源流量、回源峰值带宽、总回源请求数、平均回源失败率、2XX/3XX/4XX/5XX 回源状态码对域名排序，从大至小返回域名列表
注意：仅支持 90 天内数据查询
|
ListTopDDoSDataResponse |
CdnClient.ListTopDDoSData(ListTopDDoSDataRequest req)
获取DDoS攻击Top数据
|
ListTopWafDataResponse |
CdnClient.ListTopWafData(ListTopWafDataRequest req)
获取Waf攻击Top数据
|
ManageClsTopicDomainsResponse |
CdnClient.ManageClsTopicDomains(ManageClsTopicDomainsRequest req)
ManageClsTopicDomains 用于管理某日志主题下绑定的域名列表。
|
ModifyDomainConfigResponse |
CdnClient.ModifyDomainConfig(ModifyDomainConfigRequest req)
ModifyDomainConfig 用于修改内容分发网络加速域名配置信息
注意：
Route 字段，使用点分隔，最后一段称为叶子节点，非叶子节点配置保持不变；
Value 字段，使用 json 进行序列化，其中固定 update 作为 key，配置路径值参考 https://cloud.tencent.com/document/product/228/41116 接口各配置项复杂类型，为配置路径对应复杂类型下的节点。
云审计相关：接口的入参可能包含密钥等敏感信息，所以此接口的入参不会上报到云审计。
|
ModifyPurgeFetchTaskStatusResponse |
CdnClient.ModifyPurgeFetchTaskStatus(ModifyPurgeFetchTaskStatusRequest req)
ModifyPurgeFetchTaskStatus 用于上报定时刷新预热任务执行状态
|
PurgePathCacheResponse |
CdnClient.PurgePathCache(PurgePathCacheRequest req)
PurgePathCache 用于批量提交目录刷新，根据域名的加速区域进行对应区域的刷新。
默认情况下境内、境外加速区域每日目录刷新额度为各 100 条，每次最多可提交 500 条。
|
PurgeUrlsCacheResponse |
CdnClient.PurgeUrlsCache(PurgeUrlsCacheRequest req)
PurgeUrlsCache 用于批量提交 URL 进行刷新，根据 URL 中域名的当前加速区域进行对应区域的刷新。
默认情况下境内、境外加速区域每日 URL 刷新额度各为 10000 条，每次最多可提交 1000 条。
|
PushUrlsCacheResponse |
CdnClient.PushUrlsCache(PushUrlsCacheRequest req)
PushUrlsCache 用于将指定 URL 资源列表加载至 CDN 节点，支持指定加速区域预热。
默认情况下境内、境外每日预热 URL 限额为各 1000 条，每次最多可提交 500 条 URL，每次提交的数量会消耗配额总数。如：1次提交500条URL全球预热，此时境内、境外预热 URL 各剩余 500条。注意：中国境外区域预热，资源默认加载至中国境外边缘节点。
|
SearchClsLogResponse |
CdnClient.SearchClsLog(SearchClsLogRequest req)
SearchClsLog 用于 CLS 日志检索。支持检索今天，24小时（可选近7中的某一天），近7天的日志数据。
|
StartCdnDomainResponse |
CdnClient.StartCdnDomain(StartCdnDomainRequest req)
StartCdnDomain 用于启用已停用域名的加速服务
|
StartScdnDomainResponse |
CdnClient.StartScdnDomain(StartScdnDomainRequest req)
StartScdnDomain 用于开启域名的安全防护配置
|
StopCdnDomainResponse |
CdnClient.StopCdnDomain(StopCdnDomainRequest req)
StopCdnDomain 用于停止域名的加速服务。
注意：停止加速服务后，访问至加速节点的请求将会直接返回 404。为避免对您的业务造成影响，请在停止加速服务前将解析切走。
|
StopScdnDomainResponse |
CdnClient.StopScdnDomain(StopScdnDomainRequest req)
StopScdnDomain 用于关闭域名的安全防护配置
|
UpdateDomainConfigResponse |
CdnClient.UpdateDomainConfig(UpdateDomainConfigRequest req)
UpdateDomainConfig 用于修改内容分发网络加速域名配置信息。
注意：如果需要更新复杂类型的配置项，必须传递整个对象的所有属性，未传递的属性将使用默认值，建议通过查询接口获取配置属性后，直接修改后传递给本接口。
云审计相关：接口的入参可能包含密钥等敏感信息，所以此接口的入参不会上报到云审计。
|
UpdateImageConfigResponse |
CdnClient.UpdateImageConfig(UpdateImageConfigRequest req)
UpdateImageConfig 用于更新控制台图片优化的相关配置，支持Webp、TPG、 Guetzli 和 Avif。
|
UpdatePayTypeResponse |
CdnClient.UpdatePayType(UpdatePayTypeRequest req)
本接口(UpdatePayType)用于修改账号计费类型，暂不支持月结用户或子账号修改。
|
UpdateScdnDomainResponse |
CdnClient.UpdateScdnDomain(UpdateScdnDomainRequest req)
UpdateScdnDomain 用于修改 SCDN 加速域名安全相关配置
|
VerifyDomainRecordResponse |
CdnClient.VerifyDomainRecord(VerifyDomainRecordRequest req)
VerifyDomainRecord 用于验证域名解析值。
验证域名解析记录值前，您需要通过 [CreateVerifyRecord](https://cloud.tencent.com/document/product/228/48118) 生成校验解析值，验证通过后，24小时有效。
具体流程可参考：[使用API接口进行域名归属校验](https://cloud.tencent.com/document/product/228/61702#.E6.96.B9.E6.B3.95.E4.B8.89.EF.BC.9Aapi-.E6.8E.A5.E5.8F.A3.E6.93.8D.E4.BD.9C)
|
| Modifier and Type | Method and Description |
|---|---|
CreateInstanceByApiResponse |
CdwpgClient.CreateInstanceByApi(CreateInstanceByApiRequest req)
创建集群
|
DescribeInstanceResponse |
CdwpgClient.DescribeInstance(DescribeInstanceRequest req)
根据实例ID查询某个实例的具体信息
|
DescribeInstanceInfoResponse |
CdwpgClient.DescribeInstanceInfo(DescribeInstanceInfoRequest req)
获取集群信息
|
DescribeInstancesResponse |
CdwpgClient.DescribeInstances(DescribeInstancesRequest req)
获取云原生实例列表
|
DescribeInstanceStateResponse |
CdwpgClient.DescribeInstanceState(DescribeInstanceStateRequest req)
集群详情页中显示集群状态、流程进度等
|
DescribeSimpleInstancesResponse |
CdwpgClient.DescribeSimpleInstances(DescribeSimpleInstancesRequest req)
获取集群实例列表
|
DestroyInstanceByApiResponse |
CdwpgClient.DestroyInstanceByApi(DestroyInstanceByApiRequest req)
销毁集群
|
ModifyInstanceResponse |
CdwpgClient.ModifyInstance(ModifyInstanceRequest req)
修改实例信息，目前为实例名称
|
| Modifier and Type | Method and Description |
|---|---|
CreateAccessGroupResponse |
ChdfsClient.CreateAccessGroup(CreateAccessGroupRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
创建权限组。
|
CreateAccessRulesResponse |
ChdfsClient.CreateAccessRules(CreateAccessRulesRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
批量创建权限规则，权限规则ID和创建时间无需填写。
|
CreateFileSystemResponse |
ChdfsClient.CreateFileSystem(CreateFileSystemRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
创建文件系统（异步）。
|
CreateLifeCycleRulesResponse |
ChdfsClient.CreateLifeCycleRules(CreateLifeCycleRulesRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
批量创建生命周期规则，生命周期规则ID和创建时间无需填写。
|
CreateMountPointResponse |
ChdfsClient.CreateMountPoint(CreateMountPointRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
创建文件系统挂载点，仅限于创建成功的文件系统。
|
CreateRestoreTasksResponse |
ChdfsClient.CreateRestoreTasks(CreateRestoreTasksRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
批量创建回热任务，回热任务ID、状态和创建时间无需填写。
|
DeleteAccessGroupResponse |
ChdfsClient.DeleteAccessGroup(DeleteAccessGroupRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
删除权限组。
|
DeleteAccessRulesResponse |
ChdfsClient.DeleteAccessRules(DeleteAccessRulesRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
批量删除权限规则。
|
DeleteFileSystemResponse |
ChdfsClient.DeleteFileSystem(DeleteFileSystemRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
删除文件系统，不允许删除非空文件系统。
|
DeleteLifeCycleRulesResponse |
ChdfsClient.DeleteLifeCycleRules(DeleteLifeCycleRulesRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
批量删除生命周期规则。
|
DeleteMountPointResponse |
ChdfsClient.DeleteMountPoint(DeleteMountPointRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
删除挂载点。
|
DescribeAccessGroupsResponse |
ChdfsClient.DescribeAccessGroups(DescribeAccessGroupsRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
查看权限组列表。
|
DescribeAccessRulesResponse |
ChdfsClient.DescribeAccessRules(DescribeAccessRulesRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
通过权限组ID查看权限规则列表。
|
DescribeFileSystemResponse |
ChdfsClient.DescribeFileSystem(DescribeFileSystemRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
查看文件系统详细信息。
|
DescribeFileSystemsResponse |
ChdfsClient.DescribeFileSystems(DescribeFileSystemsRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
查看文件系统列表。
|
DescribeLifeCycleRulesResponse |
ChdfsClient.DescribeLifeCycleRules(DescribeLifeCycleRulesRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
通过文件系统ID查看生命周期规则列表。
|
DescribeMountPointResponse |
ChdfsClient.DescribeMountPoint(DescribeMountPointRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
查看挂载点详细信息。
|
DescribeMountPointsResponse |
ChdfsClient.DescribeMountPoints(DescribeMountPointsRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
通过文件系统ID或者权限组ID查看挂载点列表。
|
DescribeResourceTagsResponse |
ChdfsClient.DescribeResourceTags(DescribeResourceTagsRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
通过文件系统ID查看资源标签列表。
|
DescribeRestoreTasksResponse |
ChdfsClient.DescribeRestoreTasks(DescribeRestoreTasksRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
通过文件系统ID查看回热任务列表。
|
ModifyAccessGroupResponse |
ChdfsClient.ModifyAccessGroup(ModifyAccessGroupRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
修改权限组属性。
|
ModifyAccessRulesResponse |
ChdfsClient.ModifyAccessRules(ModifyAccessRulesRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
批量修改权限规则属性，需要指定权限规则ID，支持修改权限规则地址、访问模式和优先级。
|
ModifyFileSystemResponse |
ChdfsClient.ModifyFileSystem(ModifyFileSystemRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
修改文件系统属性，仅限于创建成功的文件系统。
|
ModifyLifeCycleRulesResponse |
ChdfsClient.ModifyLifeCycleRules(ModifyLifeCycleRulesRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
批量修改生命周期规则属性，需要指定生命周期规则ID，支持修改生命周期规则名称、路径、转换列表和状态。
|
ModifyMountPointResponse |
ChdfsClient.ModifyMountPoint(ModifyMountPointRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
修改挂载点属性。
|
ModifyResourceTagsResponse |
ChdfsClient.ModifyResourceTags(ModifyResourceTagsRequest req)
云API旧版本2019-07-18预下线，所有功能由新版本2020-11-12替代，目前云API主要用作控制台使用。
修改资源标签列表，全量覆盖。
|
| Modifier and Type | Method and Description |
|---|---|
CreateStructureTaskResponse |
CiiClient.CreateStructureTask(CreateStructureTaskRequest req)
基于提供的客户及保单信息，启动结构化识别任务。
|
DescribeStructCompareDataResponse |
CiiClient.DescribeStructCompareData(DescribeStructCompareDataRequest req)
结构化对比查询接口，对比结构化复核前后数据差异，查询识别正确率，召回率。
|
DescribeStructureTaskResultResponse |
CiiClient.DescribeStructureTaskResult(DescribeStructureTaskResultRequest req)
依据任务ID获取结构化结果接口。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeSdkAppidResponse |
CimClient.DescribeSdkAppid(DescribeSdkAppidRequest req)
获取云通信IM中腾讯云账号对应的SDKAppID
|
| Modifier and Type | Method and Description |
|---|---|
AssociateTargetGroupsResponse |
ClbClient.AssociateTargetGroups(AssociateTargetGroupsRequest req)
本接口(AssociateTargetGroups)用来将目标组绑定到负载均衡的监听器（四层协议）或转发规则（七层协议）上。
本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
AutoRewriteResponse |
ClbClient.AutoRewrite(AutoRewriteRequest req)
用户需要先创建出一个HTTPS:443监听器，并在其下创建转发规则。通过调用本接口，系统会自动创建出一个HTTP:80监听器（如果之前不存在），并在其下创建转发规则，与HTTPS:443监听器下的Domains（在入参中指定）对应。创建成功后可以通过HTTP:80地址自动跳转为HTTPS:443地址进行访问。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
BatchDeregisterTargetsResponse |
ClbClient.BatchDeregisterTargets(BatchDeregisterTargetsRequest req)
批量解绑四七层后端服务。批量解绑的资源数量上限为500。只支持VPC网络负载均衡。
|
BatchModifyTargetTagResponse |
ClbClient.BatchModifyTargetTag(BatchModifyTargetTagRequest req)
BatchModifyTargetTag 接口用于批量修改负载均衡监听器绑定的后端机器的标签。批量修改的资源数量上限为500。本接口为同步接口。
负载均衡的4层和7层监听器支持此接口，传统型负载均衡不支持。 |
BatchModifyTargetWeightResponse |
ClbClient.BatchModifyTargetWeight(BatchModifyTargetWeightRequest req)
BatchModifyTargetWeight 接口用于批量修改负载均衡监听器绑定的后端机器的转发权重。批量修改的资源数量上限为500。本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
负载均衡的4层和7层监听器支持此接口，传统型负载均衡不支持。 |
BatchRegisterTargetsResponse |
ClbClient.BatchRegisterTargets(BatchRegisterTargetsRequest req)
批量绑定虚拟主机或弹性网卡，支持跨域绑定，支持四层、七层（TCP、UDP、HTTP、HTTPS）协议绑定。批量绑定的资源数量上限为500。只支持VPC网络负载均衡。
|
CloneLoadBalancerResponse |
ClbClient.CloneLoadBalancer(CloneLoadBalancerRequest req)
克隆负载均衡实例，根据指定的负载均衡实例，复制出相同规则和绑定关系的负载均衡实例。克隆接口为异步操作，克隆的数据以调用CloneLoadBalancer时为准，如果调用CloneLoadBalancer后克隆CLB发生变化，变化规则不会克隆。
注：查询实例创建状态可以根据返回值中的requestId访问[DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683)接口
限制说明：
实例属性维度限制
仅支持克隆按量计费实例，不支持包年包月实例。
不支持克隆未关联实例计费项的 CLB。
不支持克隆传统型负载均衡实例和高防 CLB。
不支持克隆基础网络类型的实例。
不支持克隆 IPv6、IPv6 NAT64 版本以及混绑的实例。
个性化配置、重定向配置、安全组默认放通开关的配置将不会被克隆，需重新配置。
执行克隆操作前，请确保实例上没有使用已过期证书，否则会导致克隆失败。
监听器维度限制
不支持克隆监听器为 QUIC 类型和端口段的实例。
不支持监听器为 TCP_SSL 的内网型负载均衡的实例。
不支持克隆七层监听器没有转发规则的实例。
当实例的监听器个数超过50个时，不支持克隆。
后端服务维度限制
不支持克隆绑定的后端服务类型为目标组和 SCF 云函数的实例。
通过接口调用：
BGP带宽包必须传带宽包id
独占集群克隆必须传对应的参数，否则按共享型创建
功能内测中，请提交 [内测申请](https://cloud.tencent.com/apply/p/1akuvsmyn0g)。
|
CreateClsLogSetResponse |
ClbClient.CreateClsLogSet(CreateClsLogSetRequest req)
创建CLB专有日志集，此日志集用于存储CLB的日志。
|
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；(3)一个账号在每个地域的默认购买配额为：公网100个，内网100个。
本接口为异步接口，接口成功返回后，可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态（如创建中、正常），以确定是否创建成功。
|
CreateLoadBalancerSnatIpsResponse |
ClbClient.CreateLoadBalancerSnatIps(CreateLoadBalancerSnatIpsRequest req)
针对SnatPro负载均衡，这个接口用于添加SnatIp，如果负载均衡没有开启SnatPro，添加SnatIp后会自动开启。
本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
CreateRuleResponse |
ClbClient.CreateRule(CreateRuleRequest req)
CreateRule 接口用于在一个已存在的负载均衡七层监听器下创建转发规则，七层监听器中，后端服务必须绑定到规则上而非监听器上。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
CreateTargetGroupResponse |
ClbClient.CreateTargetGroup(CreateTargetGroupRequest req)
创建目标组。该功能正在内测中，如需使用，请通过[工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6&level2_id=163&source=0&data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20LB&step=1)。
|
CreateTopicResponse |
ClbClient.CreateTopic(CreateTopicRequest req)
创建主题，默认开启全文索引和键值索引。如果不存在CLB专有日志集，则创建失败。
|
DeleteListenerResponse |
ClbClient.DeleteListener(DeleteListenerRequest req)
本接口用来删除负载均衡实例下的监听器（四层和七层）。
本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeleteLoadBalancerResponse |
ClbClient.DeleteLoadBalancer(DeleteLoadBalancerRequest req)
DeleteLoadBalancer 接口用以删除指定的一个或多个负载均衡实例。成功删除后，会把负载均衡实例下的监听器、转发规则一起删除，并把后端服务解绑。
本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeleteLoadBalancerListenersResponse |
ClbClient.DeleteLoadBalancerListeners(DeleteLoadBalancerListenersRequest req)
该接口支持删除负载均衡的多个监听器。
本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeleteLoadBalancerSnatIpsResponse |
ClbClient.DeleteLoadBalancerSnatIps(DeleteLoadBalancerSnatIpsRequest req)
这个接口用于删除SnatPro的负载均衡的SnatIp。
本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeleteRewriteResponse |
ClbClient.DeleteRewrite(DeleteRewriteRequest req)
DeleteRewrite 接口支持删除指定转发规则之间的重定向关系。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeleteRuleResponse |
ClbClient.DeleteRule(DeleteRuleRequest req)
DeleteRule 接口用来删除负载均衡实例七层监听器下的转发规则。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeleteTargetGroupsResponse |
ClbClient.DeleteTargetGroups(DeleteTargetGroupsRequest req)
删除目标组
|
DeregisterFunctionTargetsResponse |
ClbClient.DeregisterFunctionTargets(DeregisterFunctionTargetsRequest req)
DeregisterFunctionTargets 接口用来将一个云函数从负载均衡的转发规则上解绑，对于七层监听器，还需通过 LocationId 或 Domain+Url 指定转发规则。
本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 [DescribeTaskStatus](https://cloud.tencent.com/document/product/214/30683) 接口查询本次任务是否成功。
限制说明： - 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新加坡、孟买、东京、硅谷地域支持绑定 SCF。 - 仅标准账户类型支持绑定 SCF，传统账户类型不支持。建议升级为标准账户类型，详情可参见 [账户类型升级说明](https://cloud.tencent.com/document/product/1199/49090)。 - 传统型负载均衡不支持绑定 SCF。 - 基础网络类型不支持绑定 SCF。 - CLB 默认支持绑定同地域下的所有 SCF，可支持跨 VPC 绑定 SCF，不支持跨地域绑定。 - 目前仅 IPv4、IPv6 NAT64 版本的负载均衡支持绑定 SCF，IPv6 版本的暂不支持。 - 仅七层（HTTP、HTTPS）监听器支持绑定 SCF，四层（TCP、UDP、TCP SSL）监听器和七层 QUIC 监听器不支持。 - CLB 绑定 SCF 仅支持绑定“Event 函数”类型的云函数。 |
DeregisterTargetGroupInstancesResponse |
ClbClient.DeregisterTargetGroupInstances(DeregisterTargetGroupInstancesRequest req)
从目标组中解绑服务器。
本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DeregisterTargetsResponse |
ClbClient.DeregisterTargets(DeregisterTargetsRequest req)
DeregisterTargets 接口用来将一台或多台后端服务从负载均衡的监听器或转发规则上解绑，对于四层监听器，只需指定监听器ID即可，对于七层监听器，还需通过LocationId或Domain+Url指定转发规则。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
DeregisterTargetsFromClassicalLBResponse |
ClbClient.DeregisterTargetsFromClassicalLB(DeregisterTargetsFromClassicalLBRequest req)
DeregisterTargetsFromClassicalLB 接口用于解绑负载均衡后端服务。本接口为异步接口，接口返回成功后，需以返回的 RequestId 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
DescribeBlockIPListResponse |
ClbClient.DescribeBlockIPList(DescribeBlockIPListRequest req)
查询一个负载均衡所封禁的IP列表（黑名单）。（接口灰度中，如需使用请提工单）
|
DescribeBlockIPTaskResponse |
ClbClient.DescribeBlockIPTask(DescribeBlockIPTaskRequest req)
根据 ModifyBlockIPList 接口返回的异步任务的ID，查询封禁IP（黑名单）异步任务的执行状态。（接口灰度中，如需使用请提工单）
|
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用于获取传统型负载均衡绑定的后端服务。
|
DescribeClsLogSetResponse |
ClbClient.DescribeClsLogSet(DescribeClsLogSetRequest req)
获取用户的CLB专有日志集。
|
DescribeClusterResourcesResponse |
ClbClient.DescribeClusterResources(DescribeClusterResourcesRequest req)
查询独占集群中的资源列表，支持按集群ID、VIP、负载均衡ID、是否闲置为过滤条件检索。
|
DescribeCrossTargetsResponse |
ClbClient.DescribeCrossTargets(DescribeCrossTargetsRequest req)
查询跨域2.0版本云联网后端子机和网卡信息。
|
DescribeCustomizedConfigAssociateListResponse |
ClbClient.DescribeCustomizedConfigAssociateList(DescribeCustomizedConfigAssociateListRequest req)
拉取配置绑定的 server 或 location，如果 domain 存在，结果将根据 domain 过滤。或拉取配置绑定的 loadbalancer。
|
DescribeCustomizedConfigListResponse |
ClbClient.DescribeCustomizedConfigList(DescribeCustomizedConfigListRequest req)
拉取个性化配置列表，返回用户 AppId 下指定类型的配置。
|
DescribeExclusiveClustersResponse |
ClbClient.DescribeExclusiveClusters(DescribeExclusiveClustersRequest req)
查询集群信息列表，支持以集群类型、集群唯一ID、集群名字、集群标签、集群内vip、集群内负载均衡唯一id、集群网络类型、可用区等条件进行检索
|
DescribeIdleLoadBalancersResponse |
ClbClient.DescribeIdleLoadBalancers(DescribeIdleLoadBalancersRequest req)
闲置实例是指创建超过7天后付费实例，且没有创建规则或创建规则没有绑定子机的负载均衡实例。
|
DescribeLBListenersResponse |
ClbClient.DescribeLBListeners(DescribeLBListenersRequest req)
查询后端云主机或弹性网卡绑定的负载均衡，支持弹性网卡和cvm查询。
|
DescribeListenersResponse |
ClbClient.DescribeListeners(DescribeListenersRequest req)
DescribeListeners 接口可根据负载均衡器 ID、监听器的协议或端口作为过滤条件获取监听器列表。如果不指定任何过滤条件，则返回该负载均衡实例下的所有监听器。
|
DescribeLoadBalancerListByCertIdResponse |
ClbClient.DescribeLoadBalancerListByCertId(DescribeLoadBalancerListByCertIdRequest req)
根据证书ID查询其在一个地域中所关联到负载均衡实例列表
|
DescribeLoadBalancerOverviewResponse |
ClbClient.DescribeLoadBalancerOverview(DescribeLoadBalancerOverviewRequest req)
查询运行中、隔离中、即将到期和负载均衡总数。
|
DescribeLoadBalancersResponse |
ClbClient.DescribeLoadBalancers(DescribeLoadBalancersRequest req)
查询一个地域的负载均衡实例列表。
|
DescribeLoadBalancersDetailResponse |
ClbClient.DescribeLoadBalancersDetail(DescribeLoadBalancersDetailRequest req)
查询负载均衡的详细信息，包括监听器，规则及后端目标。
|
DescribeLoadBalancerTrafficResponse |
ClbClient.DescribeLoadBalancerTraffic(DescribeLoadBalancerTrafficRequest req)
查询账号下的高流量负载均衡，返回前10个负载均衡。如果是子账号登录，只返回子账号有权限的负载均衡。
|
DescribeQuotaResponse |
ClbClient.DescribeQuota(DescribeQuotaRequest req)
查询用户当前地域下的各项配额
|
DescribeResourcesResponse |
ClbClient.DescribeResources(DescribeResourcesRequest req)
查询用户在当前地域支持可用区列表和资源列表。
|
DescribeRewriteResponse |
ClbClient.DescribeRewrite(DescribeRewriteRequest req)
DescribeRewrite 接口可根据负载均衡实例ID，查询一个负载均衡实例下转发规则的重定向关系。如果不指定监听器ID或转发规则ID，则返回该负载均衡实例下的所有重定向关系。
|
DescribeTargetGroupInstancesResponse |
ClbClient.DescribeTargetGroupInstances(DescribeTargetGroupInstancesRequest req)
获取目标组绑定的服务器信息
|
DescribeTargetGroupListResponse |
ClbClient.DescribeTargetGroupList(DescribeTargetGroupListRequest req)
获取目标组列表
|
DescribeTargetGroupsResponse |
ClbClient.DescribeTargetGroups(DescribeTargetGroupsRequest req)
查询目标组信息
|
DescribeTargetHealthResponse |
ClbClient.DescribeTargetHealth(DescribeTargetHealthRequest req)
DescribeTargetHealth 接口用来获取负载均衡后端服务的健康检查结果，不支持传统型负载均衡。
|
DescribeTargetsResponse |
ClbClient.DescribeTargets(DescribeTargetsRequest req)
DescribeTargets 接口用来查询负载均衡实例的某些监听器绑定的后端服务列表。
|
DescribeTaskStatusResponse |
ClbClient.DescribeTaskStatus(DescribeTaskStatusRequest req)
本接口用于查询异步任务的执行状态，对于非查询类的接口（创建/删除负载均衡实例、监听器、规则以及绑定或解绑后端服务等），在接口调用成功后，都需要使用本接口查询任务最终是否执行成功。
|
DisassociateTargetGroupsResponse |
ClbClient.DisassociateTargetGroups(DisassociateTargetGroupsRequest req)
解除规则的目标组关联关系。
本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
InquiryPriceCreateLoadBalancerResponse |
ClbClient.InquiryPriceCreateLoadBalancer(InquiryPriceCreateLoadBalancerRequest req)
InquiryPriceCreateLoadBalancer接口查询创建负载均衡的价格。
|
InquiryPriceModifyLoadBalancerResponse |
ClbClient.InquiryPriceModifyLoadBalancer(InquiryPriceModifyLoadBalancerRequest req)
InquiryPriceModifyLoadBalancer接口修改负载均衡配置询价。
|
InquiryPriceRefundLoadBalancerResponse |
ClbClient.InquiryPriceRefundLoadBalancer(InquiryPriceRefundLoadBalancerRequest req)
InquiryPriceRefundLoadBalancer接口查询负载均衡退费价格。
|
InquiryPriceRenewLoadBalancerResponse |
ClbClient.InquiryPriceRenewLoadBalancer(InquiryPriceRenewLoadBalancerRequest req)
InquiryPriceRenewLoadBalancer接口查询对负载均衡续费的价格，只支持预付费负载均衡续费。
|
ManualRewriteResponse |
ClbClient.ManualRewrite(ManualRewriteRequest req)
用户手动配置原访问地址和重定向地址，系统自动将原访问地址的请求重定向至对应路径的目的地址。同一域名下可以配置多条路径作为重定向策略，实现http/https之间请求的自动跳转。设置重定向时，需满足如下约束条件：若A已经重定向至B，则A不能再重定向至C（除非先删除老的重定向关系，再建立新的重定向关系），B不能重定向至任何其它地址。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
MigrateClassicalLoadBalancersResponse |
ClbClient.MigrateClassicalLoadBalancers(MigrateClassicalLoadBalancersRequest req)
本接口将传统型负载均衡迁移成(原应用型)负载均衡
本接口为异步接口，接口成功返回后，可使用 DescribeLoadBalancers 接口查询负载均衡实例的状态（如创建中、正常），以确定是否创建成功。
|
ModifyBlockIPListResponse |
ClbClient.ModifyBlockIPList(ModifyBlockIPListRequest req)
修改负载均衡的IP（client IP）封禁黑名单列表，一个转发规则最多支持封禁 2000000 个IP，及黑名单容量为 2000000。
（接口灰度中，如需使用请提工单）
|
ModifyDomainResponse |
ClbClient.ModifyDomain(ModifyDomainRequest req)
ModifyDomain接口用来修改负载均衡七层监听器下的域名。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyDomainAttributesResponse |
ClbClient.ModifyDomainAttributes(ModifyDomainAttributesRequest req)
ModifyDomainAttributes接口用于修改负载均衡7层监听器转发规则的域名级别属性，如修改域名、修改DefaultServer、开启/关闭Http2、修改证书。
本接口为异步接口，本接口返回成功后，需以返回的RequestId为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyFunctionTargetsResponse |
ClbClient.ModifyFunctionTargets(ModifyFunctionTargetsRequest req)
修改负载均衡转发规则上所绑定的云函数。
|
ModifyListenerResponse |
ClbClient.ModifyListener(ModifyListenerRequest req)
ModifyListener接口用来修改负载均衡监听器的属性，包括监听器名称、健康检查参数、证书信息、转发策略等。本接口不支持传统型负载均衡。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyLoadBalancerAttributesResponse |
ClbClient.ModifyLoadBalancerAttributes(ModifyLoadBalancerAttributesRequest req)
修改负载均衡实例的属性。支持修改负载均衡实例的名称、设置负载均衡的跨域属性。
本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
ModifyLoadBalancerMixIpTargetResponse |
ClbClient.ModifyLoadBalancerMixIpTarget(ModifyLoadBalancerMixIpTargetRequest req)
修改IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标特性。
|
ModifyLoadBalancerSlaResponse |
ClbClient.ModifyLoadBalancerSla(ModifyLoadBalancerSlaRequest req)
本接口（ModifyLoadBalancerSla）用于将按量计费模式的共享型实例升级为性能容量型实例。
限制条件： - 本接口只支持升级按量计费的CLB实例，包年包月的CLB实例升级请通过控制台进行升级。 - 升级为性能容量型实例后，不支持再回退到共享型实例。 - 传统型负载均衡实例不支持升级为性能容量型实例。 |
ModifyLoadBalancersProjectResponse |
ClbClient.ModifyLoadBalancersProject(ModifyLoadBalancersProjectRequest req)
修改一个或多个负载均衡实例所属项目。
|
ModifyRuleResponse |
ClbClient.ModifyRule(ModifyRuleRequest req)
ModifyRule 接口用来修改负载均衡七层监听器下的转发规则的各项属性，包括转发路径、健康检查属性、转发策略等。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyTargetGroupAttributeResponse |
ClbClient.ModifyTargetGroupAttribute(ModifyTargetGroupAttributeRequest req)
修改目标组的名称或者默认端口属性
|
ModifyTargetGroupInstancesPortResponse |
ClbClient.ModifyTargetGroupInstancesPort(ModifyTargetGroupInstancesPortRequest req)
批量修改目标组服务器端口。
本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
ModifyTargetGroupInstancesWeightResponse |
ClbClient.ModifyTargetGroupInstancesWeight(ModifyTargetGroupInstancesWeightRequest req)
批量修改目标组的服务器权重。
本接口为异步接口，本接口返回成功后需以返回的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
|
ModifyTargetPortResponse |
ClbClient.ModifyTargetPort(ModifyTargetPortRequest req)
ModifyTargetPort接口用于修改监听器绑定的后端服务的端口。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
ModifyTargetWeightResponse |
ClbClient.ModifyTargetWeight(ModifyTargetWeightRequest req)
ModifyTargetWeight 接口用于修改负载均衡绑定的后端服务的转发权重。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
|
RegisterFunctionTargetsResponse |
ClbClient.RegisterFunctionTargets(RegisterFunctionTargetsRequest req)
RegisterFunctionTargets 接口用来将一个云函数绑定到负载均衡的7层转发规则，在此之前您需要先行创建相关的7层监听器（HTTP、HTTPS）和转发规则。
本接口为异步接口，本接口返回成功后需以返回的RequestID为入参，调用DescribeTaskStatus接口查询本次任务是否成功。
限制说明： - 仅广州、深圳金融、上海、上海金融、北京、成都、中国香港、新加坡、孟买、东京、硅谷地域支持绑定 SCF。 - 仅标准账户类型支持绑定 SCF，传统账户类型不支持。建议升级为标准账户类型，详情可参见 [账户类型升级说明](https://cloud.tencent.com/document/product/1199/49090)。 - 传统型负载均衡不支持绑定 SCF。 - 基础网络类型不支持绑定 SCF。 - CLB 默认支持绑定同地域下的所有 SCF，可支持跨 VPC 绑定 SCF，不支持跨地域绑定。 - 目前仅 IPv4、IPv6 NAT64 版本的负载均衡支持绑定 SCF，IPv6 版本的暂不支持。 - 仅七层（HTTP、HTTPS）监听器支持绑定 SCF，四层（TCP、UDP、TCP SSL）监听器和七层 QUIC 监听器不支持。 - CLB 绑定 SCF 仅支持绑定“Event 函数”类型的云函数。 |
RegisterTargetGroupInstancesResponse |
ClbClient.RegisterTargetGroupInstances(RegisterTargetGroupInstancesRequest req)
注册服务器到目标组。
本接口为异步接口，本接口返回成功后需以返回的 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，则必须传入证书内容等相关信息，用以新建证书并绑定至负载均衡。
注：本接口仅可从广州地域调用。
|
SetCustomizedConfigForLoadBalancerResponse |
ClbClient.SetCustomizedConfigForLoadBalancer(SetCustomizedConfigForLoadBalancerRequest req)
负载均衡维度的个性化配置相关操作：创建、删除、修改、绑定、解绑
|
SetLoadBalancerClsLogResponse |
ClbClient.SetLoadBalancerClsLog(SetLoadBalancerClsLogRequest req)
增加、删除、更新负载均衡的日志服务(CLS)主题。
|
SetLoadBalancerSecurityGroupsResponse |
ClbClient.SetLoadBalancerSecurityGroups(SetLoadBalancerSecurityGroupsRequest req)
SetLoadBalancerSecurityGroups 接口支持对一个公网负载均衡实例执行设置（绑定、解绑）安全组操作。查询一个负载均衡实例目前已绑定的安全组，可使用 DescribeLoadBalancers 接口。本接口是set语义，
绑定操作时，入参需要传入负载均衡实例要绑定的所有安全组（已绑定的+新增绑定的）。
解绑操作时，入参需要传入负载均衡实例执行解绑后所绑定的所有安全组；如果要解绑所有安全组，可不传此参数，或传入空数组。注意：内网 CLB 绑定 EIP 后，CLB 上的安全组对来自 EIP 的流量不生效，对来自内网 CLB 的流量生效。
|
SetLoadBalancerStartStatusResponse |
ClbClient.SetLoadBalancerStartStatus(SetLoadBalancerStartStatusRequest req)
启停负载均衡实例或者监听器。
本接口为异步接口，接口返回成功后，需以得到的 RequestID 为入参，调用 DescribeTaskStatus 接口查询本次任务是否成功。
该功能正在内测中，如需使用，请通过[工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=6&level2_id=163&source=0&data_title=%E8%B4%9F%E8%BD%BD%E5%9D%87%E8%A1%A1%20LB&step=1)。
|
SetSecurityGroupForLoadbalancersResponse |
ClbClient.SetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req)
绑定或解绑一个安全组到多个公网负载均衡实例。注意：内网负载均衡不支持绑定安全组。
|
| Modifier and Type | Method and Description |
|---|---|
CreateAuditResponse |
CloudauditClient.CreateAudit(CreateAuditRequest req)
参数要求：
1、如果IsCreateNewBucket的值存在的话，cosRegion和cosBucketName都是必填参数。
2、如果IsEnableCmqNotify的值是1的话，IsCreateNewQueue、CmqRegion和CmqQueueName都是必填参数。
3、如果IsEnableCmqNotify的值是0的话，IsCreateNewQueue、CmqRegion和CmqQueueName都不能传。
4、如果IsEnableKmsEncry的值是1的话，KmsRegion和KeyId属于必填项
|
CreateAuditTrackResponse |
CloudauditClient.CreateAuditTrack(CreateAuditTrackRequest req)
创建操作审计跟踪集
|
DeleteAuditResponse |
CloudauditClient.DeleteAudit(DeleteAuditRequest req)
删除跟踪集
|
DeleteAuditTrackResponse |
CloudauditClient.DeleteAuditTrack(DeleteAuditTrackRequest req)
删除操作审计跟踪集
|
DescribeAuditResponse |
CloudauditClient.DescribeAudit(DescribeAuditRequest req)
查询跟踪集详情
|
DescribeAuditTrackResponse |
CloudauditClient.DescribeAuditTrack(DescribeAuditTrackRequest req)
查询操作审计跟踪集详情
|
DescribeAuditTracksResponse |
CloudauditClient.DescribeAuditTracks(DescribeAuditTracksRequest req)
查询操作审计跟踪集列表
|
DescribeEventsResponse |
CloudauditClient.DescribeEvents(DescribeEventsRequest req)
查询操作审计日志
|
GetAttributeKeyResponse |
CloudauditClient.GetAttributeKey(GetAttributeKeyRequest req)
查询AttributeKey的有效取值范围
|
InquireAuditCreditResponse |
CloudauditClient.InquireAuditCredit(InquireAuditCreditRequest req)
查询用户可创建跟踪集的数量
|
ListAuditsResponse |
CloudauditClient.ListAudits(ListAuditsRequest req)
查询跟踪集概要
|
ListCmqEnableRegionResponse |
CloudauditClient.ListCmqEnableRegion(ListCmqEnableRegionRequest req)
查询云审计支持的cmq的可用区
|
ListCosEnableRegionResponse |
CloudauditClient.ListCosEnableRegion(ListCosEnableRegionRequest req)
查询云审计支持的cos可用区
|
ListKeyAliasByRegionResponse |
CloudauditClient.ListKeyAliasByRegion(ListKeyAliasByRegionRequest req)
根据地域获取KMS密钥别名
|
LookUpEventsResponse |
CloudauditClient.LookUpEvents(LookUpEventsRequest req)
用于对操作日志进行检索，便于用户进行查询相关的操作信息。
|
ModifyAuditTrackResponse |
CloudauditClient.ModifyAuditTrack(ModifyAuditTrackRequest req)
修改操作审计跟踪集
|
StartLoggingResponse |
CloudauditClient.StartLogging(StartLoggingRequest req)
开启跟踪集
|
StopLoggingResponse |
CloudauditClient.StopLogging(StopLoggingRequest req)
关闭跟踪集
|
UpdateAuditResponse |
CloudauditClient.UpdateAudit(UpdateAuditRequest req)
参数要求：
1、如果IsCreateNewBucket的值存在的话，cosRegion和cosBucketName都是必填参数。
2、如果IsEnableCmqNotify的值是1的话，IsCreateNewQueue、CmqRegion和CmqQueueName都是必填参数。
3、如果IsEnableCmqNotify的值是0的话，IsCreateNewQueue、CmqRegion和CmqQueueName都不能传。
4、如果IsEnableKmsEncry的值是1的话，KmsRegion和KeyId属于必填项
|
| Modifier and Type | Method and Description |
|---|---|
AddTeamMemberResponse |
CmeClient.AddTeamMember(AddTeamMemberRequest req)
向一个团队中添加团队成员，并且指定成员的角色。
|
CopyProjectResponse |
CmeClient.CopyProject(CopyProjectRequest req)
复制一个项目，包括项目素材及轨道数据。目前仅普通剪辑及模板制作项目可复制，其它类型的项目不支持复制。
|
CreateClassResponse |
CmeClient.CreateClass(CreateClassRequest req)
新增分类，用于管理素材。分类层数不能超过20。
|
CreateLinkResponse |
CmeClient.CreateLink(CreateLinkRequest req)
创建媒体链接或分类路径链接，将资源信息链接到目标。
|
CreateProjectResponse |
CmeClient.CreateProject(CreateProjectRequest req)
创建多媒体创作引擎项目，目前支持的项目类型有：
视频剪辑项目：用于普通视频剪辑；
直播剪辑项目：用于直播流剪辑；
导播台项目：用于云导播台；
视频拆条：用于视频拆条；
录制回放项目：用于直播录制回放；
云转推项目：用于直播云转推（废弃，可使用媒体转推项目替代）；
媒体转推项目：用于媒体文件转直播输出。
|
CreateTeamResponse |
CmeClient.CreateTeam(CreateTeamRequest req)
创建一个团队。
|
CreateVideoEncodingPresetResponse |
CmeClient.CreateVideoEncodingPreset(CreateVideoEncodingPresetRequest req)
指定导出的参数，创建一个视频编码配置
|
DeleteClassResponse |
CmeClient.DeleteClass(DeleteClassRequest req)
删除分类信息，删除时检验下述限制：
分类路径必须存在；
分类下没有绑定素材。
|
DeleteLoginStatusResponse |
CmeClient.DeleteLoginStatus(DeleteLoginStatusRequest req)
删除用户登录态，使用户登出多媒体创作引擎平台。
|
DeleteMaterialResponse |
CmeClient.DeleteMaterial(DeleteMaterialRequest req)
根据媒体 Id 删除媒体。
|
DeleteProjectResponse |
CmeClient.DeleteProject(DeleteProjectRequest req)
删除项目。处于推流状态的云转推和点播转直播项目不允许删除，若强行调用删除项目接口会返回失败。
|
DeleteTeamResponse |
CmeClient.DeleteTeam(DeleteTeamRequest req)
删除一个团队。要删除团队，必须满足以下条件：
要删除的团队必须没有归属的素材；
要删除的团队必须没有归属的分类。
|
DeleteTeamMembersResponse |
CmeClient.DeleteTeamMembers(DeleteTeamMembersRequest req)
将团队成员从团队中删除。
|
DeleteVideoEncodingPresetResponse |
CmeClient.DeleteVideoEncodingPreset(DeleteVideoEncodingPresetRequest req)
删除指定 ID 的视频编码配置
|
DescribeAccountsResponse |
CmeClient.DescribeAccounts(DescribeAccountsRequest req)
获取平台中所有的已注册账号。
|
DescribeClassResponse |
CmeClient.DescribeClass(DescribeClassRequest req)
获取指定归属者下所有的分类信息。
|
DescribeJoinTeamsResponse |
CmeClient.DescribeJoinTeams(DescribeJoinTeamsRequest req)
获取用户所加入的团队列表
|
DescribeLoginStatusResponse |
CmeClient.DescribeLoginStatus(DescribeLoginStatusRequest req)
查询指定用户的登录态。
|
DescribeMaterialsResponse |
CmeClient.DescribeMaterials(DescribeMaterialsRequest req)
根据媒体 Id 批量获取媒体详情。
|
DescribePlatformsResponse |
CmeClient.DescribePlatforms(DescribePlatformsRequest req)
支持获取所创建的所有平台列表信息；
支持获取指定的平台列表信息。
关于平台概念，请参见文档 [平台](https://cloud.tencent.com/document/product/1156/43767)。
|
DescribeProjectsResponse |
CmeClient.DescribeProjects(DescribeProjectsRequest req)
支持根据多种条件过滤出项目列表。
|
DescribeResourceAuthorizationResponse |
CmeClient.DescribeResourceAuthorization(DescribeResourceAuthorizationRequest req)
查询资源被授权的情况。
|
DescribeSharedSpaceResponse |
CmeClient.DescribeSharedSpace(DescribeSharedSpaceRequest req)
获取共享空间。当个人或团队A对个人或团队B授权某资源以后，个人或团队B的共享空间就会增加个人或团队A。
|
DescribeTaskDetailResponse |
CmeClient.DescribeTaskDetail(DescribeTaskDetailRequest req)
获取任务详情信息，包含下面几个部分：
任务基础信息：包括任务状态、错误信息、创建时间等；
导出项目输出信息：包括输出的素材 Id 等。
|
DescribeTasksResponse |
CmeClient.DescribeTasks(DescribeTasksRequest req)
获取任务列表，支持条件筛选，返回对应的任务基础信息列表。
|
DescribeTeamMembersResponse |
CmeClient.DescribeTeamMembers(DescribeTeamMembersRequest req)
获取指定团队的成员信息。支持获取指定成员的信息，同时也支持分页拉取指定团队的所有成员信息。
|
DescribeTeamsResponse |
CmeClient.DescribeTeams(DescribeTeamsRequest req)
获取指定团队的信息，拉取团队信息列表。
|
DescribeVideoEncodingPresetsResponse |
CmeClient.DescribeVideoEncodingPresets(DescribeVideoEncodingPresetsRequest req)
查询视频编码配置信息。
|
ExportVideoByEditorTrackDataResponse |
CmeClient.ExportVideoByEditorTrackData(ExportVideoByEditorTrackDataRequest req)
使用 [视频合成协议](https://cloud.tencent.com/document/product/1156/51225) 合成视频，支持导出视频到 CME 云媒资或者云点播媒资。
|
ExportVideoByTemplateResponse |
CmeClient.ExportVideoByTemplate(ExportVideoByTemplateRequest req)
使用视频剪辑模板直接导出视频。
|
ExportVideoByVideoSegmentationDataResponse |
CmeClient.ExportVideoByVideoSegmentationData(ExportVideoByVideoSegmentationDataRequest req)
使用视频智能拆条数据导出视频，将指定的视频拆条片段导出为一个视频(内测中，请勿使用)。
|
ExportVideoEditProjectResponse |
CmeClient.ExportVideoEditProject(ExportVideoEditProjectRequest req)
导出视频编辑项目，支持指定输出的模板。
|
FlattenListMediaResponse |
CmeClient.FlattenListMedia(FlattenListMediaRequest req)
平铺分类路径下及其子分类下的所有媒体基础信息，返回当前分类及子分类中的所有媒体的基础信息。
|
GenerateVideoSegmentationSchemeByAiResponse |
CmeClient.GenerateVideoSegmentationSchemeByAi(GenerateVideoSegmentationSchemeByAiRequest req)
发起视频智能拆条任务，支持智能生成和平精英集锦、王者荣耀集锦、足球集锦、篮球集锦 、人物集锦、新闻拆条等任务。
和平精英集锦和王者荣耀集锦根据击杀场景进行拆条，足球集锦和篮球集锦根据进球场景进行拆条，人物集锦根据人物人脸特征进行拆条，新闻拆条根据导播进行拆条。
【本接口内测中，暂不建议使用】
|
GrantResourceAuthorizationResponse |
CmeClient.GrantResourceAuthorization(GrantResourceAuthorizationRequest req)
资源归属者对个人或团队授予目标资源的相应权限。
|
HandleMediaCastProjectResponse |
CmeClient.HandleMediaCastProject(HandleMediaCastProjectRequest req)
对媒体转推项目进行操作。
### 操作类型
- `AddSource`（添加输入源），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B9-.E6.B7.BB.E5.8A.A0.E8.BE.93.E5.85.A5.E6.BA.90)；
- `DeleteSource`（删除输入源），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B6-.E5.88.A0.E9.99.A4.E8.BE.93.E5.85.A5.E6.BA.90)；
- `SwitchSource`（切换当前播放的输入源），项目状态为 Working 时可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B5-.E5.88.87.E6.8D.A2.E5.BD.93.E5.89.8D.E6.92.AD.E6.94.BE.E7.9A.84.E8.BE.93.E5.85.A5.E6.BA.90)
- `AddDestination`（ 添加输出源），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B8-.E5.90.AF.E5.8A.A8.E8.BE.93.E5.87.BA.E6.BA.90)；
- `DeleteDestination`（删除输出源），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B7-.E5.88.A0.E9.99.A4.E8.BE.93.E5.87.BA.E6.BA.90)；
- `EnableDestination`（启动输出源），项目状态为 Working 时可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B8-.E5.90.AF.E5.8A.A8.E8.BE.93.E5.87.BA.E6.BA.90)；
- `DisableDestination`（停止输出源），项目状态为 Working 时可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B4-.E5.81.9C.E6.AD.A2.E8.BE.93.E5.87.BA.E6.BA.90)；
- `ModifyDestination`（修改输出源），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B2-.E4.BF.AE.E6.94.B9.E8.BE.93.E5.87.BA.E6.BA.90)；
- `Start`（启动媒体转推），项目状态为 Idle 时可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B12-.E5.90.AF.E5.8A.A8.E5.AA.92.E4.BD.93.E8.BD.AC.E6.8E.A8)。发起 Start 请求成功后，媒体转推项目开始启动，30秒内还需要再进行一次 Confirm操作进行确认；
- `Confirm`（确认媒体转推项目启动），项目状态为 Working 时可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B14-.E7.A1.AE.E8.AE.A4.E5.AA.92.E4.BD.93.E8.BD.AC.E6.8E.A8.E9.A1.B9.E7.9B.AE.E5.90.AF.E5.8A.A8)；
- `Stop`（停止媒体转推），项目状态为 Working 时可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B11-.E5.81.9C.E6.AD.A2.E5.AA.92.E4.BD.93.E8.BD.AC.E6.8E.A8)；
- `ModifyOutputMediaSetting`（修改媒体输出配置），项目状态为 Idle 时可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B3-.E4.BF.AE.E6.94.B9.E8.BE.93.E5.87.BA.E7.9A.84.E5.AA.92.E4.BD.93.E9.85.8D.E7.BD.AE)；
- `ModifyPlaySetting`（修改播放结束时间），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B1-.E4.BF.AE.E6.94.B9.E7.BB.93.E6.9D.9F.E6.97.B6.E9.97.B4);
- `DescribePlayInfo`（查询播放信息），项目状态为 Idle、Working 时均可以操作。参见 [示例](#.E7.A4.BA.E4.BE.8B13-.E6.9F.A5.E8.AF.A2.E5.AA.92.E4.BD.93.E8.BD.AC.E6.8E.A8.E9.A1.B9.E7.9B.AE.E7.9A.84.E6.92.AD.E6.94.BE.E4.BF.A1.E6.81.AF)。
|
HandleStreamConnectProjectResponse |
CmeClient.HandleStreamConnectProject(HandleStreamConnectProjectRequest req)
本接口废弃，可创建媒体转推项目替代，操作媒体转推项目可使用 [HandleMediaCastProject 接口](/document/product/1156/87841) 实现。
### 操作类型
- `AddInput`（添加输入源），包括：
- 添加直播拉流输入源，参见 [示例1](#.E7.A4.BA.E4.BE.8B1-.E6.B7.BB.E5.8A.A0.E7.9B.B4.E6.92.AD.E6.8B.89.E6.B5.81.E8.BE.93.E5.85.A5.E6.BA.90)；
- 添加直播推流输入源，参见 [示例2](#.E7.A4.BA.E4.BE.8B2-.E6.B7.BB.E5.8A.A0.E7.9B.B4.E6.92.AD.E6.8E.A8.E6.B5.81.E8.BE.93.E5.85.A5.E6.BA.90)；
- 添加点播拉流输入源，参见 [示例3](#.E7.A4.BA.E4.BE.8B3-.E6.B7.BB.E5.8A.A0.E7.82.B9.E6.92.AD.E6.8B.89.E6.B5.81.E8.BE.93.E5.85.A5.E6.BA.90.E4.B8.94.E5.BE.AA.E7.8E.AF.E6.92.AD.E6.94.BE)、[示例4](#.E7.A4.BA.E4.BE.8B4-.E6.B7.BB.E5.8A.A0.E7.82.B9.E6.92.AD.E6.8B.89.E6.B5.81.E8.BE.93.E5.85.A5.E6.BA.90.E4.B8.94.E5.8D.95.E6.AC.A1.E6.92.AD.E6.94.BE)；
- `DeleteInput`（删除输入源），参见 [示例5](#.E7.A4.BA.E4.BE.8B5-.E5.88.A0.E9.99.A4.E8.BE.93.E5.85.A5.E6.BA.90)；
- `ModifyInput`（修改输入源），参见 [示例6](#.E7.A4.BA.E4.BE.8B6-.E4.BF.AE.E6.94.B9.E8.BE.93.E5.85.A5.E6.BA.90)；
- `AddOutput`（ 添加输出源），参见 [示例7](#.E7.A4.BA.E4.BE.8B7-.E6.B7.BB.E5.8A.A0.E8.BE.93.E5.87.BA.E6.BA.90)；
- `DeleteOutput`（删除输出源），参见 [示例8](#.E7.A4.BA.E4.BE.8B8-.E5.88.A0.E9.99.A4.E8.BE.93.E5.87.BA.E6.BA.90)；
- `ModifyOutput`（修改输出源），参见 [示例9](#.E7.A4.BA.E4.BE.8B9-.E4.BF.AE.E6.94.B9.E8.BE.93.E5.87.BA.E6.BA.90)；
- `Start`（开启转推），参见 [示例10](#.E7.A4.BA.E4.BE.8B10-.E5.BC.80.E5.90.AF.E4.BA.91.E8.BD.AC.E6.8E.A8)；
- `Stop`（停止转推），参见 [示例11](#.E7.A4.BA.E4.BE.8B11-.E5.81.9C.E6.AD.A2.E4.BA.91.E8.BD.AC.E6.8E.A8)；
- `SwitchInput`（切换输入源），参见 [示例12](#.E7.A4.BA.E4.BE.8B12-.E5.88.87.E6.8D.A2.E8.BE.93.E5.85.A5.E6.BA.90)；
- `ModifyCurrentStopTime`（修改当前计划结束时间），参见 [示例13](#.E7.A4.BA.E4.BE.8B13-.E4.BF.AE.E6.94.B9.E8.BD.AC.E6.8E.A8.E7.BB.93.E6.9D.9F.E6.97.B6.E9.97.B4);
- `DescribeInputPlayInfo`（查询播放进度），参见 [示例14](#.E7.A4.BA.E4.BE.8B14-.E6.9F.A5.E8.AF.A2.E7.82.B9.E6.92.AD.E8.BE.93.E5.85.A5.E6.BA.90.E6.92.AD.E6.94.BE.E8.BF.9B.E5.BA.A6)。
|
ImportMaterialResponse |
CmeClient.ImportMaterial(ImportMaterialRequest req)
将云点播媒资文件导入到多媒体创作引擎媒体资源库。支持导入媒体归属团队或者个人。
|
ImportMediaToProjectResponse |
CmeClient.ImportMediaToProject(ImportMediaToProjectRequest req)
将云点播中的媒资或者用户自有媒资文件添加到项目中与项目关联，供后续视频编辑使用。目前仅视频编辑项目和智能视频拆条项目有效。
|
ListMediaResponse |
CmeClient.ListMedia(ListMediaRequest req)
浏览当前分类路径下的资源，包括媒体文件和子分类，返回媒资基础信息和分类信息。
|
ModifyMaterialResponse |
CmeClient.ModifyMaterial(ModifyMaterialRequest req)
修改媒体信息，支持修改媒体名称、分类路径、标签等信息。
|
ModifyProjectResponse |
CmeClient.ModifyProject(ModifyProjectRequest req)
修改项目信息。
|
ModifyTeamResponse |
CmeClient.ModifyTeam(ModifyTeamRequest req)
修改团队信息，目前支持修改的操作有：
修改团队名称。
|
ModifyTeamMemberResponse |
CmeClient.ModifyTeamMember(ModifyTeamMemberRequest req)
修改团队成员信息，包括成员备注、角色等。
|
ModifyVideoEncodingPresetResponse |
CmeClient.ModifyVideoEncodingPreset(ModifyVideoEncodingPresetRequest req)
修改视频编码配置信息。
|
MoveClassResponse |
CmeClient.MoveClass(MoveClassRequest req)
移动某一个分类到另外一个分类下，也可用于分类重命名。
如果 SourceClassPath = /素材/视频/NBA，DestinationClassPath = /素材/视频/篮球
当 DestinationClassPath 不存在时候，操作结果为重命名 ClassPath；
当 DestinationClassPath 存在时候，操作结果为产生新目录 /素材/视频/篮球/NBA
|
MoveResourceResponse |
CmeClient.MoveResource(MoveResourceRequest req)
移动资源，支持跨个人或团队移动媒体以及分类。如果填写了Operator，则需要校验用户对媒体和分类资源的访问以及写权限。
当原始资源为媒体时，该接口效果为将该媒体移动到目标分类下面；
当原始资源为分类时，该接口效果为将原始分类移动到目标分类或者是重命名。
如果 SourceResource.Resource.Id = /素材/视频/NBA，DestinationResource.Resource.Id= /素材/视频/篮球
当 DestinationResource.Resource.Id 不存在时候且原始资源与目标资源归属相同，操作结果为重命名原始分类；
当 DestinationResource.Resource.Id 存在时候，操作结果为产生新目录 /素材/视频/篮球/NBA
|
ParseEventResponse |
CmeClient.ParseEvent(ParseEventRequest req)
该接口接受多媒体创作引擎回调给业务的事件内容，将其转化为对应的 EventContent 结构。请不要实际调用该接口，只需要将接收到的事件内容直接使用 JSON 解析到 EventContent 结构即可使用。
|
RevokeResourceAuthorizationResponse |
CmeClient.RevokeResourceAuthorization(RevokeResourceAuthorizationRequest req)
资源所属实体对目标实体撤销目标资源的相应权限，若原本没有相应权限则不产生变更。
|
SearchMaterialResponse |
CmeClient.SearchMaterial(SearchMaterialRequest req)
根据检索条件搜索媒体，返回媒体的基本信息。
|
| Modifier and Type | Method and Description |
|---|---|
CreateKeywordsSamplesResponse |
CmsClient.CreateKeywordsSamples(CreateKeywordsSamplesRequest req)
创建关键词接口
|
DeleteLibSamplesResponse |
CmsClient.DeleteLibSamples(DeleteLibSamplesRequest req)
删除关键词接口
|
DescribeKeywordsLibsResponse |
CmsClient.DescribeKeywordsLibs(DescribeKeywordsLibsRequest req)
获取用户词库列表
|
DescribeLibSamplesResponse |
CmsClient.DescribeLibSamples(DescribeLibSamplesRequest req)
获取关键词接口
|
ImageModerationResponse |
CmsClient.ImageModeration(ImageModerationRequest req)
图片内容检测服务（Image Moderation, IM）能自动扫描图片，识别涉黄、涉恐、涉政、涉毒等有害内容，同时支持用户配置图片黑名单，打击自定义的违规图片。
|
TextModerationResponse |
CmsClient.TextModeration(TextModerationRequest req)
文本内容检测（Text Moderation）服务使用了深度学习技术，识别涉黄、涉政、涉恐等有害内容，同时支持用户配置词库，打击自定义的违规文本。
|
| 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.
|
String |
AbstractClient.callOctetStream(String action,
HashMap<String,String> headers,
byte[] body)
Use post application/octet-stream with tc3-hmac-sha256 signature to call specific action.
|
String |
CommonClient.commonRequest(AbstractModel req,
String actionName) |
<T> T |
CommonClient.commonRequest(AbstractModel req,
String actionName,
Class<T> typeOfT) |
static byte[] |
Sign.hmac256(byte[] key,
String msg) |
protected String |
AbstractClient.internalRequest(AbstractModel request,
String actionName) |
protected <T> T |
AbstractClient.internalRequest(AbstractModel request,
String actionName,
Class<T> typeOfT) |
protected okhttp3.Response |
AbstractClient.internalRequestRaw(AbstractModel request,
String actionName) |
protected <T> T |
AbstractClient.processResponseJson(okhttp3.Response resp,
Class<T> typeOfT,
CircuitBreaker.Token breakerToken) |
protected <T> T |
AbstractClient.processResponseSSE(okhttp3.Response resp,
Class<T> typeOfT,
CircuitBreaker.Token breakerToken) |
Object |
AbstractClient.retry(AbstractModel req,
int retryTimes)
请注意购买类接口谨慎调用，可能导致多次购买
仅幂等接口推荐使用
|
static String |
Sign.sha256Hex(byte[] b) |
static String |
Sign.sha256Hex(String s) |
static String |
Sign.sign(String secretKey,
String sigStr,
String sigMethod) |
void |
Credential.Updater.update(Credential credential) |
| Modifier and Type | Method and Description |
|---|---|
okhttp3.Response |
HttpConnection.getRequest(String url) |
okhttp3.Response |
HttpConnection.getRequest(String url,
okhttp3.Headers headers) |
okhttp3.Response |
HttpConnection.postRequest(String url,
byte[] body,
okhttp3.Headers headers) |
okhttp3.Response |
HttpConnection.postRequest(String url,
String body) |
okhttp3.Response |
HttpConnection.postRequest(String url,
String body,
okhttp3.Headers headers) |
| Modifier and Type | Method and Description |
|---|---|
Credential |
EnvironmentVariableCredentialsProvider.getCredentials() |
Credential |
CredentialsProvider.getCredentials() |
Credential |
OIDCRoleArnProvider.getCredentials() |
Credential |
ProfileCredentialsProvider.getCredentials() |
Credential |
DefaultCredentialsProvider.getCredentials() |
void |
OIDCRoleArnProvider.update(Credential credential) |
| Constructor and Description |
|---|
OIDCRoleArnProvider() |
| Modifier and Type | Method and Description |
|---|---|
ListAggregateConfigRulesResponse |
ConfigClient.ListAggregateConfigRules(ListAggregateConfigRulesRequest req)
账号组获取规则列表
|
ListConfigRulesResponse |
ConfigClient.ListConfigRules(ListConfigRulesRequest req)
获取规则列表
|
PutEvaluationsResponse |
ConfigClient.PutEvaluations(PutEvaluationsRequest req)
上报自定义规则评估结果
|
| Modifier and Type | Method and Description |
|---|---|
Create5GInstanceResponse |
CsxgClient.Create5GInstance(Create5GInstanceRequest req)
创建5G入云服务接口
|
Delete5GInstanceResponse |
CsxgClient.Delete5GInstance(Delete5GInstanceRequest req)
删除5G入云服务
|
Describe5GAPNsResponse |
CsxgClient.Describe5GAPNs(Describe5GAPNsRequest req)
查询APN信息
|
Describe5GInstancesResponse |
CsxgClient.Describe5GInstances(Describe5GInstancesRequest req)
查询5G入云服务
|
Modify5GInstanceAttributeResponse |
CsxgClient.Modify5GInstanceAttribute(Modify5GInstanceAttributeRequest req)
修改5G入云服务
|
| 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) 用于绑定安全组到指定实例。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ConfigureChcAssistVpcResponse |
CvmClient.ConfigureChcAssistVpc(ConfigureChcAssistVpcRequest req)
配置CHC物理服务器的带外和部署网络。传入带外网络和部署网络信息
|
ConfigureChcDeployVpcResponse |
CvmClient.ConfigureChcDeployVpc(ConfigureChcDeployVpcRequest req)
配置CHC物理服务器部署网络
|
CreateDisasterRecoverGroupResponse |
CvmClient.CreateDisasterRecoverGroup(CreateDisasterRecoverGroupRequest req)
本接口 (CreateDisasterRecoverGroup)用于创建[分散置放群组](https://cloud.tencent.com/document/product/213/15486)。创建好的置放群组，可在[创建实例](https://cloud.tencent.com/document/api/213/15730)时指定。
|
CreateHpcClusterResponse |
CvmClient.CreateHpcCluster(CreateHpcClusterRequest req)
创建高性能计算集群
|
CreateImageResponse |
CvmClient.CreateImage(CreateImageRequest req)
本接口(CreateImage)用于将实例的系统盘制作为新镜像，创建后的镜像可以用于创建实例。
|
CreateKeyPairResponse |
CvmClient.CreateKeyPair(CreateKeyPairRequest req)
本接口 (CreateKeyPair) 用于创建一个 `OpenSSH RSA` 密钥对，可以用于登录 `Linux` 实例。
开发者只需指定密钥对名称，即可由系统自动创建密钥对，并返回所生成的密钥对的 `ID` 及其公钥、私钥的内容。
密钥对名称不能和已经存在的密钥对的名称重复。
私钥的内容可以保存到文件中作为 `SSH` 的一种认证方式。
腾讯云不会保存用户的私钥，请妥善保管。
|
CreateLaunchTemplateResponse |
CvmClient.CreateLaunchTemplate(CreateLaunchTemplateRequest req)
本接口（CreateLaunchTemplate）用于创建实例启动模板。
实例启动模板是一种配置数据并可用于创建实例，其内容包含创建实例所需的配置，比如实例类型，数据盘和系统盘的类型和大小，以及安全组等信息。
初次创建实例模板后，其模板版本为默认版本1，新版本的创建可使用 [CreateLaunchTemplateVersion](https://cloud.tencent.com/document/product/213/66326) 创建，版本号递增。默认情况下，在[RunInstances](https://cloud.tencent.com/document/product/213/15730) 中指定实例启动模板，若不指定模板版本号，则使用默认版本。
|
CreateLaunchTemplateVersionResponse |
CvmClient.CreateLaunchTemplateVersion(CreateLaunchTemplateVersionRequest req)
本接口（CreateLaunchTemplateVersion）根据指定的实例模板ID以及对应的模板版本号创建新的实例启动模板，若未指定模板版本号则使用默认版本号。每个实例启动模板最多创建30个版本。
|
DeleteDisasterRecoverGroupsResponse |
CvmClient.DeleteDisasterRecoverGroups(DeleteDisasterRecoverGroupsRequest req)
本接口 (DeleteDisasterRecoverGroups)用于删除[分散置放群组](https://cloud.tencent.com/document/product/213/15486)。只有空的置放群组才能被删除，非空的群组需要先销毁组内所有云服务器，才能执行删除操作，不然会产生删除置放群组失败的错误。
|
DeleteHpcClustersResponse |
CvmClient.DeleteHpcClusters(DeleteHpcClustersRequest req)
当高性能计算集群为空, 即集群内没有任何设备时候, 可以删除该集群。
|
DeleteImagesResponse |
CvmClient.DeleteImages(DeleteImagesRequest req)
本接口（DeleteImages）用于删除一个或多个镜像。
当[镜像状态](https://cloud.tencent.com/document/product/213/15753#Image)为`创建中`和`使用中`时, 不允许删除。镜像状态可以通过[DescribeImages](https://cloud.tencent.com/document/api/213/9418)获取。
每个地域最多只支持创建500个自定义镜像，删除镜像可以释放账户的配额。
当镜像正在被其它账户分享时，不允许删除。
|
DeleteInstancesActionTimerResponse |
CvmClient.DeleteInstancesActionTimer(DeleteInstancesActionTimerRequest req)
本接口 (DeleteInstancesActionTimer) 用于删除定时任务。
|
DeleteKeyPairsResponse |
CvmClient.DeleteKeyPairs(DeleteKeyPairsRequest req)
本接口 (DeleteKeyPairs) 用于删除已在腾讯云托管的密钥对。
可以同时删除多个密钥对。
不能删除已被实例或镜像引用的密钥对，所以需要独立判断是否所有密钥对都被成功删除。
|
DeleteLaunchTemplateResponse |
CvmClient.DeleteLaunchTemplate(DeleteLaunchTemplateRequest req)
本接口（DeleteLaunchTemplate）用于删除一个实例启动模板。
|
DeleteLaunchTemplateVersionsResponse |
CvmClient.DeleteLaunchTemplateVersions(DeleteLaunchTemplateVersionsRequest req)
本接口（DeleteLaunchTemplateVersions）用于删除一个或者多个实例启动模板版本。
|
DescribeAccountQuotaResponse |
CvmClient.DescribeAccountQuota(DescribeAccountQuotaRequest req)
本接口(DescribeAccountQuota)用于查询用户配额详情。
|
DescribeChcDeniedActionsResponse |
CvmClient.DescribeChcDeniedActions(DescribeChcDeniedActionsRequest req)
查询CHC物理服务器禁止做的操作，返回给用户
|
DescribeChcHostsResponse |
CvmClient.DescribeChcHosts(DescribeChcHostsRequest req)
本接口 (DescribeChcHosts) 用于查询一个或多个CHC物理服务器详细信息。
可以根据实例`ID`、实例名称或者设备类型等信息来查询实例的详细信息。过滤信息详细请见过滤器`Filter`。
如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的实例。
|
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实例的详细信息。
|
DescribeHpcClustersResponse |
CvmClient.DescribeHpcClusters(DescribeHpcClustersRequest req)
查询高性能集群信息
|
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）的实例。
支持查询实例的最新操作（LatestOperation）以及最新操作状态(LatestOperationState)。
|
DescribeInstancesActionTimerResponse |
CvmClient.DescribeInstancesActionTimer(DescribeInstancesActionTimerRequest req)
本接口 (DescribeInstancesActionTimer) 用于查询定时任务信息。
|
DescribeInstancesModificationResponse |
CvmClient.DescribeInstancesModification(DescribeInstancesModificationRequest req)
本接口 (DescribeInstancesModification) 用于查询指定实例支持调整的机型配置。
|
DescribeInstancesOperationLimitResponse |
CvmClient.DescribeInstancesOperationLimit(DescribeInstancesOperationLimitRequest req)
本接口（DescribeInstancesOperationLimit）用于查询实例操作限制。
目前支持调整配置操作限制次数查询。
|
DescribeInstancesStatusResponse |
CvmClient.DescribeInstancesStatus(DescribeInstancesStatusRequest req)
本接口 (DescribeInstancesStatus) 用于查询一个或多个实例的状态。
可以根据实例`ID`来查询实例的状态。
如果参数为空，返回当前用户一定数量（Limit所指定的数量，默认为20）的实例状态。
|
DescribeInstanceTypeConfigsResponse |
CvmClient.DescribeInstanceTypeConfigs(DescribeInstanceTypeConfigsRequest req)
本接口 (DescribeInstanceTypeConfigs) 用于查询实例机型配置。
可以根据`zone`、`instance-family`、`instance-type`来查询实例机型配置。过滤条件详见过滤器[`Filter`](https://cloud.tencent.com/document/api/213/15753#Filter)。
如果参数为空，返回指定地域的所有实例机型配置。
|
DescribeInstanceVncUrlResponse |
CvmClient.DescribeInstanceVncUrl(DescribeInstanceVncUrlRequest req)
本接口 ( DescribeInstanceVncUrl ) 用于查询实例管理终端地址，获取的地址可用于实例的 VNC 登录。
处于 `STOPPED` 状态的机器无法使用此功能。
管理终端地址的有效期为 15 秒，调用接口成功后如果 15 秒内不使用该链接进行访问，管理终端地址自动失效，您需要重新查询。
管理终端地址一旦被访问，将自动失效，您需要重新查询。
如果连接断开，每分钟内重新连接的次数不能超过 30 次。
获取到 `InstanceVncUrl` 后，您需要在链接 `https://img.qcloud.com/qcloud/app/active_vnc/index.html?` 末尾加上参数 `InstanceVncUrl=xxxx`。
- 参数 `InstanceVncUrl` ：调用接口成功后会返回的 `InstanceVncUrl` 的值。
最后组成的 URL 格式如下：
```
https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9
```
|
DescribeInternetChargeTypeConfigsResponse |
CvmClient.DescribeInternetChargeTypeConfigs(DescribeInternetChargeTypeConfigsRequest req)
本接口（DescribeInternetChargeTypeConfigs）用于查询网络的计费类型。
|
DescribeKeyPairsResponse |
CvmClient.DescribeKeyPairs(DescribeKeyPairsRequest req)
本接口 (DescribeKeyPairs) 用于查询密钥对信息。
密钥对是通过一种算法生成的一对密钥，在生成的密钥对中，一个向外界公开，称为公钥；另一个用户自己保留，称为私钥。密钥对的公钥内容可以通过这个接口查询，但私钥内容系统不保留。
|
DescribeLaunchTemplatesResponse |
CvmClient.DescribeLaunchTemplates(DescribeLaunchTemplatesRequest req)
本接口（DescribeLaunchTemplates）用于查询一个或者多个实例启动模板。
|
DescribeLaunchTemplateVersionsResponse |
CvmClient.DescribeLaunchTemplateVersions(DescribeLaunchTemplateVersionsRequest req)
本接口（DescribeLaunchTemplateVersions）用于查询实例模板版本信息。
|
DescribeRegionsResponse |
CvmClient.DescribeRegions(DescribeRegionsRequest req)
本接口(DescribeRegions)用于查询地域信息。因平台策略原因，该接口暂时停止更新，为确保您正常调用，可切换至新链接：https://cloud.tencent.com/document/product/1596/77930。
|
DescribeReservedInstancesResponse |
CvmClient.DescribeReservedInstances(DescribeReservedInstancesRequest req)
本接口(DescribeReservedInstances)可提供列出用户已购买的预留实例
|
DescribeReservedInstancesConfigInfosResponse |
CvmClient.DescribeReservedInstancesConfigInfos(DescribeReservedInstancesConfigInfosRequest req)
本接口(DescribeReservedInstancesConfigInfos)供用户列出可购买预留实例机型配置。预留实例当前只针对国际站白名单用户开放。
|
DescribeReservedInstancesOfferingsResponse |
CvmClient.DescribeReservedInstancesOfferings(DescribeReservedInstancesOfferingsRequest req)
本接口(DescribeReservedInstancesOfferings)供用户列出可购买的预留实例配置
|
DescribeTaskInfoResponse |
CvmClient.DescribeTaskInfo(DescribeTaskInfoRequest req)
本接口 (DescribeTaskInfo) 用于查询云服务器维修任务列表及详细信息。
- 可以根据实例ID、实例名称或任务状态等信息来查询维修任务列表。过滤信息详情可参考入参说明。
- 如果参数为空，返回当前用户一定数量（`Limit`所指定的数量，默认为20）的维修任务列表。
|
DescribeZoneInstanceConfigInfosResponse |
CvmClient.DescribeZoneInstanceConfigInfos(DescribeZoneInstanceConfigInfosRequest req)
本接口(DescribeZoneInstanceConfigInfos) 获取可用区的机型信息。
|
DescribeZonesResponse |
CvmClient.DescribeZones(DescribeZonesRequest req)
本接口(DescribeZones)用于查询可用区信息。
|
DisassociateInstancesKeyPairsResponse |
CvmClient.DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)
本接口 (DisassociateInstancesKeyPairs) 用于解除实例的密钥绑定关系。
只支持[`STOPPED`](https://cloud.tencent.com/document/product/213/15753#InstanceStatus)状态的`Linux`操作系统的实例。
解绑密钥后，实例可以通过原来设置的密码登录。
如果原来没有设置密码，解绑后将无法使用 `SSH` 登录。可以调用 [ResetInstancesPassword](https://cloud.tencent.com/document/api/213/15736) 接口来设置登录密码。
支持批量操作。每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。
|
DisassociateSecurityGroupsResponse |
CvmClient.DisassociateSecurityGroups(DisassociateSecurityGroupsRequest req)
本接口 (DisassociateSecurityGroups) 用于解绑实例的指定安全组。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ExportImagesResponse |
CvmClient.ExportImages(ExportImagesRequest req)
提供导出自定义镜像到指定COS存储桶的能力
|
ImportImageResponse |
CvmClient.ImportImage(ImportImageRequest req)
本接口(ImportImage)用于导入镜像，导入后的镜像可用于创建实例。目前支持 RAW、VHD、QCOW2、VMDK 镜像格式。
|
ImportInstancesActionTimerResponse |
CvmClient.ImportInstancesActionTimer(ImportInstancesActionTimerRequest req)
导入定时任务
|
ImportKeyPairResponse |
CvmClient.ImportKeyPair(ImportKeyPairRequest req)
本接口 (ImportKeyPair) 用于导入密钥对。
本接口的功能是将密钥对导入到用户账户，并不会自动绑定到实例。如需绑定可以使用[AssociasteInstancesKeyPair](https://cloud.tencent.com/document/api/213/9404)接口。
需指定密钥对名称以及该密钥对的公钥文本。
如果用户只有私钥，可以通过 `SSL` 工具将私钥转换成公钥后再导入。
|
InquirePricePurchaseReservedInstancesOfferingResponse |
CvmClient.InquirePricePurchaseReservedInstancesOffering(InquirePricePurchaseReservedInstancesOfferingRequest req)
本接口(InquirePricePurchaseReservedInstancesOffering)用于创建预留实例询价。本接口仅允许针对购买限制范围内的预留实例配置进行询价。预留实例当前只针对国际站白名单用户开放。
|
InquiryPriceModifyInstancesChargeTypeResponse |
CvmClient.InquiryPriceModifyInstancesChargeType(InquiryPriceModifyInstancesChargeTypeRequest req)
本接口 (InquiryPriceModifyInstancesChargeType) 用于切换实例的计费模式询价。
关机不收费的实例、`批量计算型BC1`和`批量计算型BS1`机型族的实例、设置定时销毁的实例、竞价实例不支持该操作。
|
InquiryPriceRenewHostsResponse |
CvmClient.InquiryPriceRenewHosts(InquiryPriceRenewHostsRequest req)
本接口 (InquiryPriceRenewHosts) 用于续费包年包月`CDH`实例询价。
只支持查询包年包月`CDH`实例的续费价格。
|
InquiryPriceRenewInstancesResponse |
CvmClient.InquiryPriceRenewInstances(InquiryPriceRenewInstancesRequest req)
本接口 (InquiryPriceRenewInstances) 用于续费包年包月实例询价。
只支持查询包年包月实例的续费价格。
|
InquiryPriceResetInstanceResponse |
CvmClient.InquiryPriceResetInstance(InquiryPriceResetInstanceRequest req)
本接口 (InquiryPriceResetInstance) 用于重装实例询价。
如果指定了`ImageId`参数，则使用指定的镜像进行重装询价；否则按照当前实例使用的镜像进行重装询价。
目前只支持[系统盘类型](https://cloud.tencent.com/document/api/213/15753#SystemDisk)是`CLOUD_BSSD `、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口实现`Linux`和`Windows`操作系统切换的重装询价。
目前不支持境外地域的实例使用该接口实现`Linux`和`Windows`操作系统切换的重装询价。
|
InquiryPriceResetInstancesInternetMaxBandwidthResponse |
CvmClient.InquiryPriceResetInstancesInternetMaxBandwidth(InquiryPriceResetInstancesInternetMaxBandwidthRequest req)
本接口 (InquiryPriceResetInstancesInternetMaxBandwidth) 用于调整实例公网带宽上限询价。
不同机型带宽上限范围不一致，具体限制详见[公网带宽上限](https://cloud.tencent.com/document/product/213/12523)。
对于`BANDWIDTH_PREPAID`计费方式的带宽，目前不支持调小带宽，且需要输入参数`StartTime`和`EndTime`，指定调整后的带宽的生效时间段。在这种场景下会涉及扣费，请确保账户余额充足。可通过 [DescribeAccountBalance](https://cloud.tencent.com/document/product/555/20253) 接口查询账户余额。
对于 `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/product/213/15753#SystemDisk)是`CLOUD_BSSD`、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口进行调整机型询价。
目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口调整机型询价。
|
InquiryPriceResizeInstanceDisksResponse |
CvmClient.InquiryPriceResizeInstanceDisks(InquiryPriceResizeInstanceDisksRequest req)
本接口 (InquiryPriceResizeInstanceDisks) 用于扩容实例的数据盘询价。
目前只支持扩容非弹性数据盘（[`DescribeDisks`](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性）询价。
目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口扩容数据盘询价。* 仅支持包年包月实例随机器购买的数据盘。* 目前只支持扩容一块数据盘询价。
|
InquiryPriceRunInstancesResponse |
CvmClient.InquiryPriceRunInstances(InquiryPriceRunInstancesRequest req)
本接口(InquiryPriceRunInstances)用于创建实例询价。本接口仅允许针对购买限制范围内的实例配置进行询价, 详见：[创建实例](https://cloud.tencent.com/document/api/213/15730)。
|
InquiryPriceTerminateInstancesResponse |
CvmClient.InquiryPriceTerminateInstances(InquiryPriceTerminateInstancesRequest req)
本接口 (InquiryPriceTerminateInstances) 用于退还实例询价。
查询退还实例可以返还的费用。
在退还包年包月实例时，使用ReleasePrepaidDataDisks参数，会在返回值中包含退还挂载的包年包月数据盘返还的费用。
支持批量操作，每次请求批量实例的上限为100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。
|
ModifyChcAttributeResponse |
CvmClient.ModifyChcAttribute(ModifyChcAttributeRequest req)
修改CHC物理服务器的属性
|
ModifyDisasterRecoverGroupAttributeResponse |
CvmClient.ModifyDisasterRecoverGroupAttribute(ModifyDisasterRecoverGroupAttributeRequest req)
本接口 (ModifyDisasterRecoverGroupAttribute)用于修改[分散置放群组](https://cloud.tencent.com/document/product/213/15486)属性。
|
ModifyHostsAttributeResponse |
CvmClient.ModifyHostsAttribute(ModifyHostsAttributeRequest req)
本接口（ModifyHostsAttribute）用于修改CDH实例的属性，如实例名称和续费标记等。参数HostName和RenewFlag必须设置其中一个，但不能同时设置。
|
ModifyHpcClusterAttributeResponse |
CvmClient.ModifyHpcClusterAttribute(ModifyHpcClusterAttributeRequest req)
修改高性能计算集群属性。
|
ModifyImageAttributeResponse |
CvmClient.ModifyImageAttribute(ModifyImageAttributeRequest req)
本接口（ModifyImageAttribute）用于修改镜像属性。
已分享的镜像无法修改属性。
|
ModifyImageSharePermissionResponse |
CvmClient.ModifyImageSharePermission(ModifyImageSharePermissionRequest req)
本接口（ModifyImageSharePermission）用于修改镜像共享信息。
共享镜像后，被共享账户可以通过该镜像创建实例。
每个自定义镜像最多可共享给500个账户。
共享镜像无法更改名称，描述，仅可用于创建实例。
只支持共享到对方账户相同地域。
|
ModifyInstanceDiskTypeResponse |
CvmClient.ModifyInstanceDiskType(ModifyInstanceDiskTypeRequest req)
本接口 (ModifyInstanceDiskType) 用于修改实例硬盘介质类型。
只支持实例的本地系统盘、本地数据盘转化成指定云硬盘介质。
只支持实例在关机状态下转换成指定云硬盘介质。
不支持竞价实例类型。
若实例同时存在本地系统盘和本地数据盘，需同时调整系统盘和数据盘的介质类型，不支持单独针对本地系统盘或本地数据盘修改介质类型。
修改前请确保账户余额充足。可通过[DescribeAccountBalance](https://cloud.tencent.com/document/product/378/4397)接口查询账户余额。
|
ModifyInstancesAttributeResponse |
CvmClient.ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)
本接口 (ModifyInstancesAttribute) 用于修改实例的属性（目前只支持修改实例的名称和关联的安全组）。
每次请求必须指定实例的一种属性用于修改。
“实例名称”仅为方便用户自己管理之用，腾讯云并不以此名称作为在线支持或是进行实例管理操作的依据。
支持批量操作。每次请求批量实例的上限为100。
修改关联安全组时，子机原来关联的安全组会被解绑。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
修改主机名后实例会立即重启，重启后新的主机名生效。
|
ModifyInstancesChargeTypeResponse |
CvmClient.ModifyInstancesChargeType(ModifyInstancesChargeTypeRequest req)
本接口 (ModifyInstancesChargeType) 用于切换实例的计费模式。
关机不收费的实例、`批量计算型BC1`和`批量计算型BS1`机型族的实例、设置定时销毁的实例不支持该操作。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ModifyInstancesProjectResponse |
CvmClient.ModifyInstancesProject(ModifyInstancesProjectRequest req)
本接口 (ModifyInstancesProject) 用于修改实例所属项目。
项目为一个虚拟概念，用户可以在一个账户下面建立多个项目，每个项目中管理不同的资源；将多个不同实例分属到不同项目中，后续使用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728)接口查询实例，项目ID可用于过滤结果。
绑定负载均衡的实例不支持修改实例所属项目，请先使用[DeregisterInstancesFromLoadBalancer](https://cloud.tencent.com/document/api/214/1258)接口解绑负载均衡。
支持批量操作。每次请求批量实例的上限为100。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ModifyInstancesRenewFlagResponse |
CvmClient.ModifyInstancesRenewFlag(ModifyInstancesRenewFlagRequest req)
本接口 (ModifyInstancesRenewFlag) 用于修改包年包月实例续费标识。
实例被标识为自动续费后，每次在实例到期时，会自动续费一个月。
支持批量操作。每次请求批量实例的上限为100。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ModifyInstancesVpcAttributeResponse |
CvmClient.ModifyInstancesVpcAttribute(ModifyInstancesVpcAttributeRequest req)
本接口(ModifyInstancesVpcAttribute)用于修改实例vpc属性，如私有网络IP。
此操作默认会关闭实例，完成后再启动。
当指定私有网络ID和子网ID（子网必须在实例所在的可用区）与指定实例所在私有网络不一致时，会将实例迁移至指定的私有网络的子网下。执行此操作前请确保指定的实例上没有绑定[弹性网卡](https://cloud.tencent.com/document/product/576)和[负载均衡](https://cloud.tencent.com/document/product/214)。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ModifyKeyPairAttributeResponse |
CvmClient.ModifyKeyPairAttribute(ModifyKeyPairAttributeRequest req)
本接口 (ModifyKeyPairAttribute) 用于修改密钥对属性。
修改密钥对ID所指定的密钥对的名称和描述信息。
密钥对名称不能和已经存在的密钥对的名称重复。
密钥对ID是密钥对的唯一标识，不可修改。
密钥对名称和描述信息必须指定其中之一，也支持同时指定。
|
ModifyLaunchTemplateDefaultVersionResponse |
CvmClient.ModifyLaunchTemplateDefaultVersion(ModifyLaunchTemplateDefaultVersionRequest req)
本接口（ModifyLaunchTemplateDefaultVersion）用于修改实例启动模板默认版本。
|
ProgramFpgaImageResponse |
CvmClient.ProgramFpgaImage(ProgramFpgaImageRequest req)
本接口(ProgramFpgaImage)用于在线烧录由客户提供的FPGA镜像文件到指定实例的指定FPGA卡上。
只支持对单个实例发起在线烧录FPGA镜像的操作。
支持对单个实例的多块FPGA卡同时烧录FPGA镜像，DBDFs参数为空时，默认对指定实例的所有FPGA卡进行烧录。
|
PurchaseReservedInstancesOfferingResponse |
CvmClient.PurchaseReservedInstancesOffering(PurchaseReservedInstancesOfferingRequest req)
本接口(PurchaseReservedInstancesOffering)用于用户购买一个或者多个指定配置的预留实例
|
RebootInstancesResponse |
CvmClient.RebootInstances(RebootInstancesRequest req)
本接口 (RebootInstances) 用于重启实例。
只有状态为`RUNNING`的实例才可以进行此操作。
接口调用成功时，实例会进入`REBOOTING`状态；重启实例成功时，实例会进入`RUNNING`状态。
支持强制重启。强制重启的效果等同于关闭物理计算机的电源开关再重新启动。强制重启可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常重启时使用。
支持批量操作，每次请求批量实例的上限为100。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
RemoveChcAssistVpcResponse |
CvmClient.RemoveChcAssistVpc(RemoveChcAssistVpcRequest req)
清理CHC物理服务器的带外网络和部署网络
|
RemoveChcDeployVpcResponse |
CvmClient.RemoveChcDeployVpc(RemoveChcDeployVpcRequest req)
清理CHC物理服务器的部署网络
|
RenewHostsResponse |
CvmClient.RenewHosts(RenewHostsRequest req)
本接口 (RenewHosts) 用于续费包年包月CDH实例。
只支持操作包年包月实例，否则操作会以特定[错误码](#6.-.E9.94.99.E8.AF.AF.E7.A0.81)返回。
续费时请确保账户余额充足。可通过[`DescribeAccountBalance`](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。
|
RenewInstancesResponse |
CvmClient.RenewInstances(RenewInstancesRequest req)
本接口 (RenewInstances) 用于续费包年包月实例。
只支持操作包年包月实例。
续费时请确保账户余额充足。可通过[DescribeAccountBalance](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
RepairTaskControlResponse |
CvmClient.RepairTaskControl(RepairTaskControlRequest req)
本接口（RepairTaskControl）用于对待授权状态的维修任务进行授权操作。
- 仅当任务状态处于`待授权`状态时，可通过此接口对待授权的维修任务进行授权。
- 调用时需指定产品类型、实例ID、维修任务ID、操作类型。
- 可授权立即处理，或提前预约计划维护时间之前的指定时间进行处理（预约时间需晚于当前时间至少5分钟，且在48小时之内）。
- 针对不同类型的维修任务，提供的可选授权处理策略可参见 [维修任务类型与处理策略](https://cloud.tencent.com/document/product/213/67789)。
|
ResetInstanceResponse |
CvmClient.ResetInstance(ResetInstanceRequest req)
本接口 (ResetInstance) 用于重装指定实例上的操作系统。
如果指定了`ImageId`参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。
系统盘将会被格式化，并重置；请确保系统盘中无重要文件。
系统切换时，该实例系统盘`ID`将发生变化，系统盘关联快照将无法回滚、恢复数据。
密码不指定将会通过站内信下发随机密码。
目前只支持[系统盘类型](https://cloud.tencent.com/document/api/213/9452#SystemDisk)是`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`、`CLOUD_BSSD`类型的实例使用该接口实现操作系统切换。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ResetInstancesInternetMaxBandwidthResponse |
CvmClient.ResetInstancesInternetMaxBandwidth(ResetInstancesInternetMaxBandwidthRequest req)
本接口 (ResetInstancesInternetMaxBandwidth) 用于调整实例公网带宽上限。
不同机型带宽上限范围不一致，具体限制详见[公网带宽上限](https://cloud.tencent.com/document/product/213/12523)。
对于 `BANDWIDTH_PREPAID` 计费方式的带宽，需要输入参数 `StartTime` 和 `EndTime` ，指定调整后的带宽的生效时间段。在这种场景下目前不支持调小带宽，会涉及扣费，请确保账户余额充足。可通过 [DescribeAccountBalance] https://cloud.tencent.com/document/product/555/20253) 接口查询账户余额。
对于 `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` 计费方式的带宽。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ResetInstancesPasswordResponse |
CvmClient.ResetInstancesPassword(ResetInstancesPasswordRequest req)
本接口 (ResetInstancesPassword) 用于将实例操作系统的密码重置为用户指定的密码。
如果是修改系统管理员密码：实例的操作系统不同，管理员账号也会不一样(`Windows`为`Administrator`，`Ubuntu`为`ubuntu`，其它系统为`root`)。
重置处于运行中状态的实例密码，需要设置关机参数`ForceStop`为`TRUE`。如果没有显式指定强制关机参数，则只有处于关机状态的实例才允许执行重置密码操作。
支持批量操作。将多个实例操作系统的密码重置为相同的密码。每次请求批量实例的上限为100。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
|
ResetInstancesTypeResponse |
CvmClient.ResetInstancesType(ResetInstancesTypeRequest req)
本接口 (ResetInstancesType) 用于调整实例的机型。
目前只支持[系统盘类型](/document/api/213/9452#block_device)是CLOUD_BASIC、CLOUD_PREMIUM、CLOUD_SSD、CLOUD_BSSD类型的实例使用该接口进行机型调整。
目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口调整机型。对于包年包月实例，使用该接口会涉及扣费，请确保账户余额充足。可通过[DescribeAccountBalance](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。
本接口为异步接口，调整实例配置请求发送成功后会返回一个RequestId，此时操作并未立即完成。实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表调整实例配置操作成功。
|
ResizeInstanceDisksResponse |
CvmClient.ResizeInstanceDisks(ResizeInstanceDisksRequest req)
本接口 (ResizeInstanceDisks) 用于扩容实例的磁盘。
目前只支持扩容非弹性盘（[ DescribeDisks ](https://cloud.tencent.com/document/api/362/16315)接口返回值中的`Portable`为`false`表示非弹性）。
对于包年包月实例，使用该接口会涉及扣费，请确保账户余额充足。可通过[ DescribeAccountBalance ](https://cloud.tencent.com/document/product/555/20253)接口查询账户余额。
目前只支持扩容一块数据盘。
默认扩容方式为关机后扩容。
实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表操作成功。
如果是系统盘，目前只支持扩容，不支持缩容。
|
RunInstancesResponse |
CvmClient.RunInstances(RunInstancesRequest req)
本接口 (RunInstances) 用于创建一个或多个指定配置的实例。
实例创建成功后将自动开机启动，[实例状态](https://cloud.tencent.com/document/product/213/15753#InstanceStatus)变为“运行中”。
预付费实例的购买会预先扣除本次实例购买所需金额，按小时后付费实例购买会预先冻结本次实例购买一小时内所需金额，在调用本接口前请确保账户余额充足。
调用本接口创建实例，支持代金券自动抵扣（注意，代金券不可用于抵扣后付费冻结金额），详情请参考[代金券选用规则](https://cloud.tencent.com/document/product/555/7428)。
本接口允许购买的实例数量遵循[CVM实例购买限制](https://cloud.tencent.com/document/product/213/2664)，所创建的实例和官网入口创建的实例共用配额。
本接口为异步接口，当创建实例请求下发成功后会返回一个实例`ID`列表和一个`RequestId`，此时创建实例操作并未立即完成。在此期间实例的状态将会处于“PENDING”，实例创建结果可以通过调用 [DescribeInstancesStatus](https://cloud.tencent.com/document/product/213/15738) 接口查询，如果实例状态(InstanceState)由“PENDING(创建中)”变为“RUNNING(运行中)”，则代表实例创建成功，“LAUNCH_FAILED”代表实例创建失败。
|
StartInstancesResponse |
CvmClient.StartInstances(StartInstancesRequest req)
本接口 (StartInstances) 用于启动一个或多个实例。
只有状态为`STOPPED`的实例才可以进行此操作。
接口调用成功时，实例会进入`STARTING`状态；启动实例成功时，实例会进入`RUNNING`状态。
支持批量操作。每次请求批量实例的上限为100。
本接口为异步接口，启动实例请求发送成功后会返回一个RequestId，此时操作并未立即完成。实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表启动实例操作成功。
|
StopInstancesResponse |
CvmClient.StopInstances(StopInstancesRequest req)
本接口 (StopInstances) 用于关闭一个或多个实例。
只有状态为`RUNNING`的实例才可以进行此操作。
接口调用成功时，实例会进入`STOPPING`状态；关闭实例成功时，实例会进入`STOPPED`状态。
支持强制关闭。强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏，请仅在服务器不能正常关机时使用。
支持批量操作。每次请求批量实例的上限为100。
本接口为异步接口，关闭实例请求发送成功后会返回一个RequestId，此时操作并未立即完成。实例操作结果可以通过调用 [DescribeInstances](https://cloud.tencent.com/document/api/213/15728#.E7.A4.BA.E4.BE.8B3-.E6.9F.A5.E8.AF.A2.E5.AE.9E.E4.BE.8B.E7.9A.84.E6.9C.80.E6.96.B0.E6.93.8D.E4.BD.9C.E6.83.85.E5.86.B5) 接口查询，如果实例的最新操作状态(LatestOperationState)为“SUCCESS”，则代表关闭实例操作成功。
|
SyncImagesResponse |
CvmClient.SyncImages(SyncImagesRequest req)
本接口（SyncImages）用于将自定义镜像同步到其它地区。
该接口每次调用只支持同步一个镜像。
该接口支持多个同步地域。
单个账号在每个地域最多支持存在500个自定义镜像。
|
TerminateInstancesResponse |
CvmClient.TerminateInstances(TerminateInstancesRequest req)
本接口 (TerminateInstances) 用于主动退还实例。
不再使用的实例，可通过本接口主动退还。
按量计费的实例通过本接口可直接退还；包年包月实例如符合[退还规则](https://cloud.tencent.com/document/product/213/9711)，也可通过本接口主动退还。
包年包月实例首次调用本接口，实例将被移至回收站，再次调用本接口，实例将被销毁，且不可恢复。按量计费实例调用本接口将被直接销毁。
包年包月实例首次调用本接口，入参中包含ReleasePrepaidDataDisks时，包年包月数据盘同时也会被移至回收站。
支持批量操作，每次请求批量实例的上限为100。
批量操作时，所有实例的付费类型必须一致。
|
| Modifier and Type | Method and Description |
|---|---|
SendMessageResponse |
DataintegrationClient.SendMessage(SendMessageRequest req)
使用SDK将数据上报到DIP
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDBInstancesResponse |
DbdcClient.DescribeDBInstances(DescribeDBInstancesRequest req)
本接口用于查询独享集群内的DB实例列表
|
DescribeHostListResponse |
DbdcClient.DescribeHostList(DescribeHostListRequest req)
本接口用于查询主机列表
|
DescribeInstanceDetailResponse |
DbdcClient.DescribeInstanceDetail(DescribeInstanceDetailRequest req)
本接口用于查询独享集群详情
|
DescribeInstanceListResponse |
DbdcClient.DescribeInstanceList(DescribeInstanceListRequest req)
本接口用于查询独享集群实例列表
|
DescribeInstancesResponse |
DbdcClient.DescribeInstances(DescribeInstancesRequest req)
根据不同地域不同用户，获取集群列表信息
|
ModifyInstanceNameResponse |
DbdcClient.ModifyInstanceName(ModifyInstanceNameRequest req)
本接口用于修改集群名称
|
| Modifier and Type | Method and Description |
|---|---|
AddFairPlayPemResponse |
DrmClient.AddFairPlayPem(AddFairPlayPemRequest req)
本接口用来设置fairplay方案所需的私钥、私钥密钥、ask等信息。
如需使用fairplay方案，请务必先设置私钥。
|
CreateEncryptKeysResponse |
DrmClient.CreateEncryptKeys(CreateEncryptKeysRequest req)
该接口用来设置加密的密钥。注意，同一个content id，只能设置一次！
|
CreateLicenseResponse |
DrmClient.CreateLicense(CreateLicenseRequest req)
本接口用来生成DRM方案对应的播放许可证，开发者需提供DRM方案类型、内容类型参数，后台将生成许可证后返回许可证数据
开发者需要转发终端设备发出的许可证请求信息。
|
DeleteFairPlayPemResponse |
DrmClient.DeleteFairPlayPem(DeleteFairPlayPemRequest req)
本接口用来删除fairplay方案的私钥、ask等信息
注：高风险操作，删除后，您将无法使用腾讯云DRM提供的fairplay服务。
由于缓存，删除操作需要约半小时生效
|
DescribeAllKeysResponse |
DrmClient.DescribeAllKeys(DescribeAllKeysRequest req)
本接口用来查询指定DRM类型、ContentType的所有加密密钥
|
DescribeDRMLicenseResponse |
DrmClient.DescribeDRMLicense(DescribeDRMLicenseRequest req)
开发者需要指定使用的DRM类型取值 NORMALAES、和需要加密的Track类型取值 SD,ContentType取值 LiveVideo
|
DescribeFairPlayPemResponse |
DrmClient.DescribeFairPlayPem(DescribeFairPlayPemRequest req)
该接口用来查询设置的FairPlay私钥校验信息。可用该接口校验设置的私钥与本身的私钥是否一致。
|
DescribeKeysResponse |
DrmClient.DescribeKeys(DescribeKeysRequest req)
开发者需要指定使用的DRM类型、和需要加密的Track类型，后台返回加密使用的密钥
如果加密使用的ContentID没有关联的密钥信息，后台会自动生成新的密钥返回
|
GenerateTDRMKeyResponse |
DrmClient.GenerateTDRMKey(GenerateTDRMKeyRequest req)
开发者需要指定使用的DRM类型取值 NORMALAES、和需要加密的Track类型取值 SD,ContentType取值 LiveVideo
|
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 |
|---|---|
DescribeTransactionsResponse |
DtfClient.DescribeTransactions(DescribeTransactionsRequest req)
查询主事务列表
|
| Modifier and Type | Method and Description |
|---|---|
ActivateSubscribeResponse |
DtsClient.ActivateSubscribe(ActivateSubscribeRequest req)
本接口用于配置数据订阅，只有在未配置状态的订阅实例才能调用此接口。
|
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
|
CreateSubscribeResponse |
DtsClient.CreateSubscribe(CreateSubscribeRequest req)
本接口(CreateSubscribe)用于创建一个数据订阅实例。
|
DeleteMigrateJobResponse |
DtsClient.DeleteMigrateJob(DeleteMigrateJobRequest req)
本接口（DeleteMigrationJob）用于删除数据迁移任务。当通过DescribeMigrateJobs接口查询到任务的状态为：检验中（status=3）、运行中（status=7）、准备完成（status=8）、撤销中（status=11）或者完成中（status=12）时，不允许删除任务。
|
DescribeAsyncRequestInfoResponse |
DtsClient.DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
本接口（DescribeAsyncRequestInfo）用于查询任务执行结果
|
DescribeMigrateCheckJobResponse |
DtsClient.DescribeMigrateCheckJob(DescribeMigrateCheckJobRequest req)
本接口用于创建校验后,获取校验的结果.
|
DescribeMigrateJobsResponse |
DtsClient.DescribeMigrateJobs(DescribeMigrateJobsRequest req)
查询数据迁移任务.
|
DescribeRegionConfResponse |
DtsClient.DescribeRegionConf(DescribeRegionConfRequest req)
本接口（DescribeRegionConf）用于查询可售卖订阅实例的地域
|
DescribeSubscribeConfResponse |
DtsClient.DescribeSubscribeConf(DescribeSubscribeConfRequest req)
本接口（DescribeSubscribeConf）用于查询订阅实例配置
|
DescribeSubscribesResponse |
DtsClient.DescribeSubscribes(DescribeSubscribesRequest req)
本接口(DescribeSubscribes)获取数据订阅实例信息列表，默认分页，每次返回20条
|
IsolateSubscribeResponse |
DtsClient.IsolateSubscribe(IsolateSubscribeRequest req)
本接口（IsolateSubscribe）用于隔离小时计费的订阅实例。调用后，订阅实例将不能使用，同时停止计费。
|
ModifyMigrateJobResponse |
DtsClient.ModifyMigrateJob(ModifyMigrateJobRequest req)
本接口（ModifyMigrateJob）用于修改数据迁移任务。
当迁移任务处于下述状态时，允许调用本接口修改迁移任务：迁移创建中（status=1）、 校验成功(status=4)、校验失败(status=5)、迁移失败(status=10)。但源实例、目标实例类型和目标实例地域不允许修改。
如果是金融区链路, 请使用域名: dts.ap-shenzhen-fsi.tencentcloudapi.com
|
ModifySubscribeAutoRenewFlagResponse |
DtsClient.ModifySubscribeAutoRenewFlag(ModifySubscribeAutoRenewFlagRequest req)
修改订阅实例自动续费标识
|
ModifySubscribeConsumeTimeResponse |
DtsClient.ModifySubscribeConsumeTime(ModifySubscribeConsumeTimeRequest req)
本接口(ModifySubscribeConsumeTime)用于修改数据订阅通道的消费时间点
|
ModifySubscribeNameResponse |
DtsClient.ModifySubscribeName(ModifySubscribeNameRequest req)
本接口(ModifySubscribeName)用于修改数据订阅实例的名称
|
ModifySubscribeObjectsResponse |
DtsClient.ModifySubscribeObjects(ModifySubscribeObjectsRequest req)
本接口(ModifySubscribeObjects)用于修改数据订阅通道的订阅规则
|
ModifySubscribeVipVportResponse |
DtsClient.ModifySubscribeVipVport(ModifySubscribeVipVportRequest req)
本接口(ModifySubscribeVipVport)用于修改数据订阅实例的IP和端口号
|
OfflineIsolatedSubscribeResponse |
DtsClient.OfflineIsolatedSubscribe(OfflineIsolatedSubscribeRequest req)
本接口（OfflineIsolatedSubscribe）用于下线已隔离的数据订阅实例
|
ResetSubscribeResponse |
DtsClient.ResetSubscribe(ResetSubscribeRequest req)
本接口(ResetSubscribe)用于重置数据订阅实例，已经激活的数据订阅实例，重置后可以使用ActivateSubscribe接口绑定其他的数据库实例
|
StartMigrateJobResponse |
DtsClient.StartMigrateJob(StartMigrateJobRequest req)
本接口（StartMigrationJob）用于启动迁移任务。非定时迁移任务会在调用后立即开始迁移，定时任务则会开始倒计时。
调用此接口前，请务必先使用CreateMigrateCheckJob校验数据迁移任务，并通过DescribeMigrateJobs接口查询到任务状态为校验通过（status=4）时，才能启动数据迁移任务。
|
StopMigrateJobResponse |
DtsClient.StopMigrateJob(StopMigrateJobRequest req)
本接口（StopMigrateJob）用于撤销数据迁移任务。
在迁移过程中允许调用该接口撤销迁移, 撤销迁移的任务会失败。通过DescribeMigrateJobs接口查询到任务状态为运行中（status=7）或准备完成（status=8）时，才能撤销数据迁移任务。
|
| Modifier and Type | Method and Description |
|---|---|
CompleteMigrateJobResponse |
DtsClient.CompleteMigrateJob(CompleteMigrateJobRequest req)
本接口（CompleteMigrateJob）用于完成数据迁移任务。
选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。
通过DescribeMigrationJobs接口查询到任务的状态为准备完成（Status="readyComplete"）时，此时可以调用本接口完成迁移任务。
|
ConfigureSubscribeJobResponse |
DtsClient.ConfigureSubscribeJob(ConfigureSubscribeJobRequest req)
本接口(ConfigureSubscribeJob)用于配置数据订阅实例。
|
ConfigureSyncJobResponse |
DtsClient.ConfigureSyncJob(ConfigureSyncJobRequest req)
配置一个同步任务
|
ContinueMigrateJobResponse |
DtsClient.ContinueMigrateJob(ContinueMigrateJobRequest req)
恢复一个暂停中的迁移任务。
|
ContinueSyncJobResponse |
DtsClient.ContinueSyncJob(ContinueSyncJobRequest req)
恢复处于已暂停状态的数据同步任务。
|
CreateCheckSyncJobResponse |
DtsClient.CreateCheckSyncJob(CreateCheckSyncJobRequest req)
校验同步任务，检查必要参数和周边配置。
|
CreateCompareTaskResponse |
DtsClient.CreateCompareTask(CreateCompareTaskRequest req)
本接口用于创建数据对比任务，创建成功后会返回数据对比任务 ID，形如：dts-8yv4w2i1-cmp-37skmii9，创建成功后可通过StartCompare启动一致性校验任务
|
CreateConsumerGroupResponse |
DtsClient.CreateConsumerGroup(CreateConsumerGroupRequest req)
为订阅实例创建消费者组
|
CreateMigrateCheckJobResponse |
DtsClient.CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)
校验迁移任务，
在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移.
|
CreateMigrationServiceResponse |
DtsClient.CreateMigrationService(CreateMigrationServiceRequest req)
购买迁移任务。购买成功后会返回随机生成的迁移任务id列表，也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意，一旦购买成功后源及目标数据库类型，源及目标实例地域不可修改。
|
CreateModifyCheckSyncJobResponse |
DtsClient.CreateModifyCheckSyncJob(CreateModifyCheckSyncJobRequest req)
在修改同步任务的配置后、通过该接口校验当前任务是否支持修改对象操作
|
CreateSubscribeResponse |
DtsClient.CreateSubscribe(CreateSubscribeRequest req)
本接口(CreateSubscribe)用于创建一个数据订阅任务。
|
CreateSubscribeCheckJobResponse |
DtsClient.CreateSubscribeCheckJob(CreateSubscribeCheckJobRequest req)
本接口(CreateSubscribeCheckJob)用于创建一个订阅校验任务。任务必须已经成功调用ConfigureSubscribeJob接口配置了所有的必要信息才能启动校验。
|
CreateSyncJobResponse |
DtsClient.CreateSyncJob(CreateSyncJobRequest req)
创建一个同步任务
|
DeleteCompareTaskResponse |
DtsClient.DeleteCompareTask(DeleteCompareTaskRequest req)
删除一致性校验任务。当一致性校验任务状态为success、failed、canceled 时可以执行此操作。
|
DeleteConsumerGroupResponse |
DtsClient.DeleteConsumerGroup(DeleteConsumerGroupRequest req)
本接口(DeleteConsumerGroup)用于删除一个订阅任务的消费组。
|
DescribeCheckSyncJobResultResponse |
DtsClient.DescribeCheckSyncJobResult(DescribeCheckSyncJobResultRequest req)
查询同步校验任务结果，检查必要参数和周边配置
|
DescribeCompareReportResponse |
DtsClient.DescribeCompareReport(DescribeCompareReportRequest req)
查询一致性校验任务详情
|
DescribeCompareTasksResponse |
DtsClient.DescribeCompareTasks(DescribeCompareTasksRequest req)
查询一致性校验任务列表，调用该接口后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态。
|
DescribeConsumerGroupsResponse |
DtsClient.DescribeConsumerGroups(DescribeConsumerGroupsRequest req)
本接口(DescribeConsumerGroups)用于获取订阅实例配置的消费者组详情。
|
DescribeMigrateDBInstancesResponse |
DtsClient.DescribeMigrateDBInstances(DescribeMigrateDBInstancesRequest req)
本接口用于查询支持迁移的云数据库实例
|
DescribeMigrationCheckJobResponse |
DtsClient.DescribeMigrationCheckJob(DescribeMigrationCheckJobRequest req)
本接口用于创建校验后,获取校验的结果.
|
DescribeMigrationDetailResponse |
DtsClient.DescribeMigrationDetail(DescribeMigrationDetailRequest req)
查询某个迁移任务详情
|
DescribeMigrationJobsResponse |
DtsClient.DescribeMigrationJobs(DescribeMigrationJobsRequest req)
查询数据迁移任务列表
|
DescribeModifyCheckSyncJobResultResponse |
DtsClient.DescribeModifyCheckSyncJobResult(DescribeModifyCheckSyncJobResultRequest req)
在创建修改对象的校验任务后、通过该接口查看校验任务的结果
|
DescribeOffsetByTimeResponse |
DtsClient.DescribeOffsetByTime(DescribeOffsetByTimeRequest req)
本接口(DescribeOffsetByTime)查询KafkaTopic中指定时间前最近的offset。
接口输出的offset是离这个时间最近的offset。
如果输入时间比当前时间晚的多，相当于输出的就是最新的offset；
如果输入时间比当前时间早的多，相当于输出的就是最老的offset；
如果输入空，默认0时间，也就是查询最老的offset。
|
DescribeSubscribeCheckJobResponse |
DtsClient.DescribeSubscribeCheckJob(DescribeSubscribeCheckJobRequest req)
本接口(DescribeSubscribeCheckJob)用于查询订阅校验任务结果。
|
DescribeSubscribeDetailResponse |
DtsClient.DescribeSubscribeDetail(DescribeSubscribeDetailRequest req)
本接口(DescribeSubscribeDetail)获取数据订阅实例的配置信息。
|
DescribeSubscribeJobsResponse |
DtsClient.DescribeSubscribeJobs(DescribeSubscribeJobsRequest req)
本接口(DescribeSubscribes)获取数据订阅实例信息列表，默认分页，每次返回20条
|
DescribeSubscribeReturnableResponse |
DtsClient.DescribeSubscribeReturnable(DescribeSubscribeReturnableRequest req)
本接口(DescribeSubscribeReturnable)用于查询订阅任务是否可以销毁和退货。
|
DescribeSyncJobsResponse |
DtsClient.DescribeSyncJobs(DescribeSyncJobsRequest req)
查询同步任务信息
|
DestroyIsolatedSubscribeResponse |
DtsClient.DestroyIsolatedSubscribe(DestroyIsolatedSubscribeRequest req)
本接口（DestroyIsolatedSubscribe）用于下线已隔离的数据订阅实例
|
DestroyMigrateJobResponse |
DtsClient.DestroyMigrateJob(DestroyMigrateJobRequest req)
下线数据迁移任务。计费任务必须先调用隔离(IsolateMigrateJob)接口，且只有是**已隔离**状态下，才能调用此接口销毁任务。对于不计费任务，调用隔离(IsolateMigrateJob)接口删除任务操作。
|
DestroySyncJobResponse |
DtsClient.DestroySyncJob(DestroySyncJobRequest req)
下线同步任务，任务在已隔离状态下可以通过此操作进行任务下线，即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态，此操作成功后无法看到此任务表示下线成功。
|
IsolateMigrateJobResponse |
DtsClient.IsolateMigrateJob(IsolateMigrateJobRequest req)
隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务，在任务隔离后可进行解除隔离(RecoverMigrationJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务，调用此接口会直接销毁任务，无法进行恢复操作。
|
IsolateSubscribeResponse |
DtsClient.IsolateSubscribe(IsolateSubscribeRequest req)
本接口（IsolateSubscribe）用于隔离订阅任务。调用后，订阅任务将不能使用。按量计费的任务会停止计费，包年包月的任务会自动退费
|
IsolateSyncJobResponse |
DtsClient.IsolateSyncJob(IsolateSyncJobRequest req)
隔离同步任务，隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务，调用此接口后会直接删除任务，无法进行恢复操作。
|
ModifyCompareTaskResponse |
DtsClient.ModifyCompareTask(ModifyCompareTaskRequest req)
修改一致性校验任务，在任务创建后启动之前，可修改一致性校验参数
|
ModifyCompareTaskNameResponse |
DtsClient.ModifyCompareTaskName(ModifyCompareTaskNameRequest req)
修改一致性校验任务名称
|
ModifyConsumerGroupDescriptionResponse |
DtsClient.ModifyConsumerGroupDescription(ModifyConsumerGroupDescriptionRequest req)
本接口(ModifyConsumerGroupDescription)用于修改指定订阅消费组备注。
|
ModifyConsumerGroupPasswordResponse |
DtsClient.ModifyConsumerGroupPassword(ModifyConsumerGroupPasswordRequest req)
本接口(ModifyConsumerGroupPassword)用于修改指定订阅消费组密码。
|
ModifyMigrateJobSpecResponse |
DtsClient.ModifyMigrateJobSpec(ModifyMigrateJobSpecRequest req)
调整实例规格，此接口只支持按量计费任务的调整。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
|
ModifyMigrateNameResponse |
DtsClient.ModifyMigrateName(ModifyMigrateNameRequest req)
修改迁移任务名
|
ModifyMigrateRateLimitResponse |
DtsClient.ModifyMigrateRateLimit(ModifyMigrateRateLimitRequest req)
用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
|
ModifyMigrateRuntimeAttributeResponse |
DtsClient.ModifyMigrateRuntimeAttribute(ModifyMigrateRuntimeAttributeRequest req)
修改任务运行时属性，此接口不同于配置类接口，不会进行状态机判断。
|
ModifyMigrationJobResponse |
DtsClient.ModifyMigrationJob(ModifyMigrationJobRequest req)
配置迁移服务，配置成功后可通过`CreateMigrationCheckJob` 创建迁移校验任务接口发起校验任务，只有校验通过才能启动迁移任务。
|
ModifySubscribeAutoRenewFlagResponse |
DtsClient.ModifySubscribeAutoRenewFlag(ModifySubscribeAutoRenewFlagRequest req)
修改订阅实例自动续费标识。只有包年包月的任务修改才有意义，按量计费任务修改后无影响。
|
ModifySubscribeNameResponse |
DtsClient.ModifySubscribeName(ModifySubscribeNameRequest req)
本接口(ModifySubscribeName)用于修改数据订阅实例的名称
|
ModifySubscribeObjectsResponse |
DtsClient.ModifySubscribeObjects(ModifySubscribeObjectsRequest req)
本接口(ModifySubscribeObjects)用于修改数据订阅对象和kafka分区规则，如果是mongo订阅，还可以修改输出聚合规则。
|
ModifySyncJobConfigResponse |
DtsClient.ModifySyncJobConfig(ModifySyncJobConfigRequest req)
该接口支持在同步任务启动后修改任务的配置
修改同步配置的完整流程：修改同步任务配置->创建修改同步任务配置的校验任务->查询修改配置的校验任务的结果->启动修改配置任务
|
ModifySyncRateLimitResponse |
DtsClient.ModifySyncRateLimit(ModifySyncRateLimitRequest req)
用户在发现同步任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率
|
PauseMigrateJobResponse |
DtsClient.PauseMigrateJob(PauseMigrateJobRequest req)
暂停一个迁移任务。
|
PauseSyncJobResponse |
DtsClient.PauseSyncJob(PauseSyncJobRequest req)
暂停处于同步中的数据同步任务。
|
RecoverMigrateJobResponse |
DtsClient.RecoverMigrateJob(RecoverMigrateJobRequest req)
解除隔离数据迁移任务，用户手动发起隔离后的手动解隔离，只有任务状态为已隔离(手动操作)状态下才能触发此操作。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
|
RecoverSyncJobResponse |
DtsClient.RecoverSyncJob(RecoverSyncJobRequest req)
解除隔离同步任务，任务在已隔离状态下可调用该接口解除隔离状态任务，同时可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。
|
ResetConsumerGroupOffsetResponse |
DtsClient.ResetConsumerGroupOffset(ResetConsumerGroupOffsetRequest req)
本接口(ResetConsumerGroupOffset)用于重置订阅消费组的offset。调用DescribeConsumerGroups接口查询消费组状态，只有消费组状态为 Dead 或 Empty 才可以执行重置该操作。否则重置不会生效，接口也不会报错。
|
ResetSubscribeResponse |
DtsClient.ResetSubscribe(ResetSubscribeRequest req)
本接口(ResetSubscribe)用于重置订阅实例，重置后，可以重新配置订阅任务。
可以调用 DescribeSubscribeDetail 查询订阅信息判断是否置成功。当SubsStatus变为notStarted时，表示重置成功。
|
ResizeSyncJobResponse |
DtsClient.ResizeSyncJob(ResizeSyncJobRequest req)
调整同步任务规格，此接口只支持按量计费任务的调整，调用此接口后不会立即生效，后台调整时间大概为3~5分钟。调用此接口后可通过查询同步任务信息接口DescribeSyncJobs，获取变配后的状态。
|
ResumeMigrateJobResponse |
DtsClient.ResumeMigrateJob(ResumeMigrateJobRequest req)
重试数据迁移任务，针对异常情况可进行重试，对于redis在失败时也可重试。注意：此操作跳过校验阶段，直接重新发起任务，相当于从StartMigrationJob开始执行。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
|
ResumeSubscribeResponse |
DtsClient.ResumeSubscribe(ResumeSubscribeRequest req)
本接口(ResumeSubscribe) 用于恢复报错的订阅任务。当订阅任务的状态为error时，可通过本接口尝试对任务进行恢复。
|
ResumeSyncJobResponse |
DtsClient.ResumeSyncJob(ResumeSyncJobRequest req)
重试同步任务，部分可恢复报错情况下，可通过该接口重试同步任务，可通过查询同步任务信息接口DescribeSyncJobs，获取操作后状态。
|
SkipCheckItemResponse |
DtsClient.SkipCheckItem(SkipCheckItemRequest req)
本接口用于校验检查项不通过后，可进行跳过此校验项操作，后端将不再校验该项。任何校验步骤都是不应该跳过的，通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 [参考文档](https://cloud.tencent.com/document/product/571/61639)。
|
SkipSyncCheckItemResponse |
DtsClient.SkipSyncCheckItem(SkipSyncCheckItemRequest req)
本接口用于校验检查项不通过后，可进行跳过此校验项操作，后端将不再校验该项。任何校验步骤都是不应该跳过的，通过校验是能正确执行的前置条件。支持跳过的产品及链路的校验项可 [参考文档](https://cloud.tencent.com/document/product/571/61639)。
|
StartCompareResponse |
DtsClient.StartCompare(StartCompareRequest req)
启动一致性校验任务，启动之前需要先通过接口`CreateCompareTask` 创建一致性校验任务，启动后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态
|
StartMigrateJobResponse |
DtsClient.StartMigrateJob(StartMigrateJobRequest req)
本接口（StartMigrationJob）用于启动迁移任务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
|
StartModifySyncJobResponse |
DtsClient.StartModifySyncJob(StartModifySyncJobRequest req)
在查询修改对象的校验任务的结果中的status为success后、通过该接口开始修改配置流程
|
StartSubscribeResponse |
DtsClient.StartSubscribe(StartSubscribeRequest req)
本接口(StartSubscribe)用于启动一个kafka版本的数据订阅实例。只有当订阅任务的状态为checkPass时，才能调用本接口。
|
StartSyncJobResponse |
DtsClient.StartSyncJob(StartSyncJobRequest req)
启动同步任务
|
StopCompareResponse |
DtsClient.StopCompare(StopCompareRequest req)
终止一致性校验任务
|
StopMigrateJobResponse |
DtsClient.StopMigrateJob(StopMigrateJobRequest req)
本接口（StopMigrateJob）用于终止数据迁移任务。
调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。
|
StopSyncJobResponse |
DtsClient.StopSyncJob(StopSyncJobRequest req)
结束同步任务，操作后可通过查询同步任务信息接口DescribeSyncJobs，获取操作后的状态。
|
| Modifier and Type | Method and Description |
|---|---|
CorrectMultiImageResponse |
EccClient.CorrectMultiImage(CorrectMultiImageRequest req)
https://ecc.tencentcloudapi.com/?Action=CorrectMultiImage
多图像识别批改接口
|
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 |
|---|---|
AddEcdnDomainResponse |
EcdnClient.AddEcdnDomain(AddEcdnDomainRequest req)
ECDN融合CDN后，接口都用CDN的，此接口已经废弃
本接口（AddEcdnDomain）用于创建加速域名。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
CreateVerifyRecordResponse |
EcdnClient.CreateVerifyRecord(CreateVerifyRecordRequest req)
ECDN融合CDN后，接口都用CDN的，此接口已经废弃
生成一条子域名解析，提示客户添加到域名解析上，用于泛域名及域名取回校验归属权。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
DeleteEcdnDomainResponse |
EcdnClient.DeleteEcdnDomain(DeleteEcdnDomainRequest req)
ECDN融合CDN后，接口都用CDN的，此接口已经废弃
本接口（DeleteEcdnDomain）用于删除指定加速域名。待删除域名必须处于已停用状态。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
DescribeDomainsResponse |
EcdnClient.DescribeDomains(DescribeDomainsRequest req)
本接口（DescribeDomains）用于查询CDN域名基本信息，包括项目id，状态，业务类型，创建时间，更新时间等。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
DescribeDomainsConfigResponse |
EcdnClient.DescribeDomainsConfig(DescribeDomainsConfigRequest req)
本接口（DescribeDomainsConfig）用于查询CDN加速域名详细配置信息。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
DescribeEcdnDomainLogsResponse |
EcdnClient.DescribeEcdnDomainLogs(DescribeEcdnDomainLogsRequest req)
本接口（DescribeEcdnDomainLogs）用于查询域名的访问日志下载地址。
|
DescribeEcdnDomainStatisticsResponse |
EcdnClient.DescribeEcdnDomainStatistics(DescribeEcdnDomainStatisticsRequest req)
本接口（DescribeEcdnDomainStatistics）用于查询指定时间段内的域名访问统计指标。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
DescribeEcdnStatisticsResponse |
EcdnClient.DescribeEcdnStatistics(DescribeEcdnStatisticsRequest req)
DescribeEcdnStatistics用于查询 ECDN 实时访问监控数据，支持以下指标查询：
+ 流量（单位为 byte）
+ 带宽（单位为 bps）
+ 请求数（单位为 次）
+ 状态码 2xx 汇总及各 2 开头状态码明细（单位为 个）
+ 状态码 3xx 汇总及各 3 开头状态码明细（单位为 个）
+ 状态码 4xx 汇总及各 4 开头状态码明细（单位为 个）
+ 状态码 5xx 汇总及各 5 开头状态码明细（单位为 个）
|
DescribeIpStatusResponse |
EcdnClient.DescribeIpStatus(DescribeIpStatusRequest req)
DescribeIpStatus 用于查询域名所在加速平台的所有节点信息, 如果您的源站有白名单设置,可以通过本接口获取ECDN服务的节点IP进行加白, 本接口为内测接口,请联系腾讯云工程师开白。
由于产品服务节点常有更新，对于源站开白的使用场景，请定期调用接口获取最新节点信息，若新增服务节点发布7日后您尚未更新加白导致回源失败等问题，ECDN侧不对此承担责任。
|
DescribePurgeQuotaResponse |
EcdnClient.DescribePurgeQuota(DescribePurgeQuotaRequest req)
ECDN融合CDN后，接口都用CDN的，此接口已经废弃
查询刷新接口的用量配额。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
DescribePurgeTasksResponse |
EcdnClient.DescribePurgeTasks(DescribePurgeTasksRequest req)
DescribePurgeTasks 用于查询刷新任务提交历史记录及执行进度。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
PurgePathCacheResponse |
EcdnClient.PurgePathCache(PurgePathCacheRequest req)
ECDN融合CDN后，接口都用CDN的，此接口已经废弃
PurgePathCache 用于批量刷新目录缓存，一次提交将返回一个刷新任务id。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
PurgeUrlsCacheResponse |
EcdnClient.PurgeUrlsCache(PurgeUrlsCacheRequest req)
PurgeUrlsCache 用于批量刷新Url，一次提交将返回一个刷新任务id。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
StartEcdnDomainResponse |
EcdnClient.StartEcdnDomain(StartEcdnDomainRequest req)
ECDN融合CDN后，接口都用CDN的，此接口已经废弃
本接口（StartEcdnDomain）用于启用加速域名，待启用域名必须处于已下线状态。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
StopEcdnDomainResponse |
EcdnClient.StopEcdnDomain(StopEcdnDomainRequest req)
ECDN融合CDN后，接口都用CDN的，此接口已经废弃
本接口（StopCdnDomain）用于停止加速域名，待停用加速域名必须处于已上线或部署中状态。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
UpdateDomainConfigResponse |
EcdnClient.UpdateDomainConfig(UpdateDomainConfigRequest req)
ECDN融合CDN后，接口都用CDN的，此接口已经废弃
本接口（UpdateDomainConfig）用于更新ECDN加速域名配置信息。
注意：如果需要更新复杂类型的配置项，必须传递整个对象的所有属性，未传递的属性将使用默认值。建议通过查询接口获取配置属性后，直接修改后传递给本接口。Https配置由于证书的特殊性，更新时不用传递证书和密钥字段。
>? 若您的业务已迁移至 CDN 控制台，请参考 CDN 接口文档，使用 CDN 相关API 进行操作。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeEisConnectorConfigResponse |
EisClient.DescribeEisConnectorConfig(DescribeEisConnectorConfigRequest req)
获取连接器配置参数
|
ListEisConnectorOperationsResponse |
EisClient.ListEisConnectorOperations(ListEisConnectorOperationsRequest req)
获取连接器操作列表
|
ListEisConnectorsResponse |
EisClient.ListEisConnectors(ListEisConnectorsRequest req)
连接器列表
|
| Modifier and Type | Method and Description |
|---|---|
GetRuntimeMCResponse |
EisClient.GetRuntimeMC(GetRuntimeMCRequest req)
获取运行时详情
|
GetRuntimeResourceMonitorMetricMCResponse |
EisClient.GetRuntimeResourceMonitorMetricMC(GetRuntimeResourceMonitorMetricMCRequest req)
获取运行时资源监控详情，cpu，memory，bandwidth
|
ListDeployableRuntimesMCResponse |
EisClient.ListDeployableRuntimesMC(ListDeployableRuntimesMCRequest req)
返回用户可用的运行时列表，发布应用时返回的运行时环境，仅shared和private运行时，无sandbox运行时，并且只有running/scaling状态的
|
ListRuntimeDeployedInstancesMCResponse |
EisClient.ListRuntimeDeployedInstancesMC(ListRuntimeDeployedInstancesMCRequest req)
获取运行时部署的应用实例列表
|
ListRuntimesMCResponse |
EisClient.ListRuntimesMC(ListRuntimesMCRequest req)
返回用户的运行时列表，运行时管理主页使用，包含沙箱、共享运行时及独立运行时环境，不包含已经删除的运行时
|
| Modifier and Type | Method and Description | |
|---|---|---|
BindEmployeeUserIdWithClientOpenIdResponse |
EssClient.BindEmployeeUserIdWithClientOpenId(BindEmployeeUserIdWithClientOpenIdRequest req)
此接口（BindEmployeeUserIdWithClientOpenId）用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用
|
|
CancelFlowResponse |
EssClient.CancelFlow(CancelFlowRequest req)
用于撤销合同流程
适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。 - **可撤回合同状态**：未全部签署完成 - **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 注: 1. |
|
CancelMultiFlowSignQRCodeResponse |
EssClient.CancelMultiFlowSignQRCode(CancelMultiFlowSignQRCodeRequest req)
此接口（CancelMultiFlowSignQRCode）用于废除一码多签签署码。
该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。
|
|
CancelUserAutoSignEnableUrlResponse |
EssClient.CancelUserAutoSignEnableUrl(CancelUserAutoSignEnableUrlRequest req)
用来撤销获取个人用户自动签的开通状态生成的开通链接，撤销生成的链接失效。
注:
若个人用户已经用生成的完成自动签署的开通，撤销链接无效不会对开通结果产生影响(此情况接口会报错)。
处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
|
|
CreateBatchCancelFlowUrlResponse |
EssClient.CreateBatchCancelFlowUrl(CreateBatchCancelFlowUrlRequest req)
指定需要批量撤回的签署流程Id，以获取批量撤销链接。
客户需指定要撤回的签署流程Id，最多可指定100个，超过100则不处理。
接口调用成功后，将返回批量撤回合同的链接。通过点击链接，可跳转至电子签小程序完成批量撤回操作。
- **可撤回合同状态**：未全部签署完成
- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
注：
1.
|
|
CreateBatchQuickSignUrlResponse |
EssClient.CreateBatchQuickSignUrl(CreateBatchQuickSignUrlRequest req)
该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。
注意：**
1.
|
|
CreateBatchSignUrlResponse |
EssClient.CreateBatchSignUrl(CreateBatchSignUrlRequest req)
通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。
请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
注：
- 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。
- 参与人点击链接后需短信验证码才能查看合同内容。
- 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。
- 个人批量签署，签名区`仅支持手写签名`。
|
|
CreateConvertTaskApiResponse |
EssClient.CreateConvertTaskApi(CreateConvertTaskApiRequest req)
|
|
CreateDocumentResponse |
EssClient.CreateDocument(CreateDocumentRequest req)
创建签署流程电子文档
### 调用流程 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置创建签署流程和发起签署流程接口使用。具体逻辑可以参考下图:  ### 填充模板中定义的填写控件 模板中配置的发起人填充控件可以通过本接口的**FormFields数组**字段填充  填充的传参示例如下 ``` request.FormFields = [{ "ComponentName": "项目的名字", "ComponentValue": "休闲山庄" }, { "ComponentName": "项目的地址", "ComponentValue": "凤凰山北侧", }, { "ComponentName": "范围", "ComponentValue": "凤凰山至107国道", }, { "ComponentName": "面积", "ComponentValue": "100亩", }, { "ComponentName": "基本情况", "ComponentValue": "完好", }, , { "ComponentName": "用途", "ComponentValue": "经营农家乐", } ] ``` 合成后合同样子示例  |
|
CreateEmbedWebUrlResponse |
EssClient.CreateEmbedWebUrl(CreateEmbedWebUrlRequest req)
本接口（CreateEmbedWebUrl）用于创建嵌入Web的链接，支持以下类型的Web链接创建：
1.
|
|
CreateExtendedServiceAuthInfosResponse |
EssClient.CreateExtendedServiceAuthInfos(CreateExtendedServiceAuthInfosRequest req)
创建企业扩展服务授权，当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口授权给企业员工。
注：“企业自动签授权”支持集团代子企业操作，请联系运营开通此功能。
|
|
CreateFlowResponse |
EssClient.CreateFlow(CreateFlowRequest req)
通过模板创建签署流程
适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。 签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 自己企业的员工签署（已认证加入） 签署企业的名字、员工在电子签平台的ID（UserId） 其他企业的员工签署 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 个人（自然人）签署 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） 注：配合创建电子文档和发起签署流程接口使用。整体的逻辑如下图  注：**静默（自动）签署不支持合同签署方存在填写**功能 相关视频指引 1. |
|
CreateFlowApproversResponse |
EssClient.CreateFlowApprovers(CreateFlowApproversRequest req)
适用场景： 当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人，最终实际签署人取决于谁先领取合同完成签署。
限制条件：
1.本企业（发起方企业）企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
2.本企业（发起方企业）非企业微信签署人仅支持通过姓名+手机号进行补充。
3.他方企业仅支持通过姓名+手机号进行补充。
4.个人签署人支持通过姓名+手机号进行补充，补充动态签署人时：若个人用户已完成实名，则可通过姓名+证件号码进行补充。
|
|
CreateFlowByFilesResponse |
EssClient.CreateFlowByFiles(CreateFlowByFilesRequest req)
此接口（CreateFlowByFiles）用来通过上传后的pdf资源编号来创建待签署的合同流程。
适用场景：适用非制式的合同文件签署。一般开发者自己有完整的签署文件，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。 签署人类别 需要提前准备的信息 自己企业的员工签署（未认证加入或已认证加入） 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 自己企业的员工签署（已认证加入） 签署企业的名字、员工在电子签平台的ID（UserId） 其他企业的员工签署 签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传） 个人（自然人）签署 个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传） 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源）  注： - 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**） - **静默（自动）签署不支持合同签署方存在填写**功能 |
|
CreateFlowEvidenceReportResponse |
EssClient.CreateFlowEvidenceReport(CreateFlowEvidenceReportRequest req)
提交申请出证报告任务并返回报告ID。
注意：
使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。
合同流程必须所有参与方`已经签署完成`。
出证过程需一定时间，建议在`提交出证任务后的24小时之后`，通过获取出证报告任务执行结果接口进行查询执行结果和出证报告的下载URL。
|
|
CreateFlowGroupByFilesResponse |
EssClient.CreateFlowGroupByFiles(CreateFlowGroupByFilesRequest req)
此接口（CreateFlowGroupByFiles）可用于通过多个文件创建合同组签署流程。
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
注意事项：使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
CreateFlowGroupByTemplatesResponse |
EssClient.CreateFlowGroupByTemplates(CreateFlowGroupByTemplatesRequest req)
此接口（CreateFlowGroupByTemplates）可用于通过多个模板创建合同组签署流程。
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
注：`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度（过期，拒签，签署完成，解除完成等状态不会返还额度），合同组中每个合同会扣减一个合同额度`
|
|
CreateFlowGroupSignReviewResponse |
EssClient.CreateFlowGroupSignReview(CreateFlowGroupSignReviewRequest req)
提交合同组签署流程审批结果的适用场景包括：
1.
|
|
CreateFlowRemindsResponse |
EssClient.CreateFlowReminds(CreateFlowRemindsRequest req)
指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办：
1.
|
|
CreateFlowSignReviewResponse |
EssClient.CreateFlowSignReview(CreateFlowSignReviewRequest req)
提交企业流程审批结果
当前存在两种审核操作：**
签署审核
在通过接口
CreateFlowByFiles
CreateFlow
CreateFlowGroupByTemplates
CreateFlowGroupByFiles
CreatePrepareFlow
发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果
在通过接口
CreateFlowByFiles
CreateFlow
CreateFlowGroupByTemplates
CreateFlowGroupByFiles
发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果
发起审核
通过接口CreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效
|
|
CreateFlowSignUrlResponse |
EssClient.CreateFlowSignUrl(CreateFlowSignUrlRequest req)
该接口用于发起合同后，生成用户的签署链接
注意** 1. |
|
CreateIntegrationDepartmentResponse |
EssClient.CreateIntegrationDepartment(CreateIntegrationDepartmentRequest req)
此接口（CreateIntegrationDepartment）用于创建企业的部门信息，支持绑定客户系统部门ID。
|
|
CreateIntegrationEmployeesResponse |
EssClient.CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req)
此接口（CreateIntegrationEmployees）用于创建企业员工。创建的员工初始化为未实名，如下图所示。
支持以下场景
生成端
入参
提醒方式
普通saas员工
将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号
发送短信通知员工（短信中带有认证加入企业的链接） ![image]()
企微员工
将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，需确保该企微员工在应用的可见范围内
企微内部实名消息
H5端 saas员工
传递 InvitationNotifyType = H5，将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号，此场景不支持企微
生成认证加入企业的H5链接，贵方可以通过自己的渠道触达到此员工
注意：
- 新增员工的手机号、OpenId不能与已加入员工重复， 不管已加入员工的手机号、OpenId是否已经实名
- 若通过手机号发现员工已经创建且信息一致（名字，openId等），则不会重复创建，但会发送短信或者生成链接提醒员工实名。
- jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。
短信的样式
|
|
CreateIntegrationRoleResponse |
EssClient.CreateIntegrationRole(CreateIntegrationRoleRequest req)
此接口（CreateIntegrationRole）用来创建企业自定义的SaaS角色或集团角色。
适用场景1：创建当前企业的自定义SaaS角色或集团角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。
适用场景2：创建当前企业的自定义SaaS角色或集团角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
适用场景3：创建集团角色时可同时设置角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。
适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。
注意事项：SaaS角色和集团角色对应的权限树是不一样的。
|
|
CreateIntegrationUserRolesResponse |
EssClient.CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req)
此接口用于赋予员工指定的角色权限，如需解绑请使用 DeleteIntegrationRoleUsers 接口。
|
|
CreateMultiFlowSignQRCodeResponse |
EssClient.CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)
此接口（CreateMultiFlowSignQRCode）用于创建一码多签签署码。
适用场景**:
签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
注意**:
1.
|
|
CreateOrganizationBatchSignUrlResponse |
EssClient.CreateOrganizationBatchSignUrl(CreateOrganizationBatchSignUrlRequest req)
使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
附注： - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方。 - 如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。 - 仅支持待签署状态的合同生成签署链接。 |
|
CreateOrganizationInfoChangeUrlResponse |
EssClient.CreateOrganizationInfoChangeUrl(CreateOrganizationInfoChangeUrlRequest req)
此接口（CreateOrganizationInfoChangeUrl）用于创建企业信息变更链接，支持创建企业超管变更链接或企业基础信息变更链接，通过入参ChangeType指定。
1. |
|
CreatePersonAuthCertificateImageResponse |
EssClient.CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req)
获取个人用户认证证书图片下载URL
个人用户认证证书图片样式如下图
注:
只能获取个人用户证明图片, 企业员工的暂不支持
处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
|
|
CreatePreparedPersonalEsignResponse |
EssClient.CreatePreparedPersonalEsign(CreatePreparedPersonalEsignRequest req)
本接口（CreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。
|
|
CreatePrepareFlowResponse |
EssClient.CreatePrepareFlow(CreatePrepareFlowRequest req)
创建发起流程web页面
适用场景：通过该接口（CreatePrepareFlow）传入合同文件/模板编号及签署人信息，可获得发起流程的可嵌入页面，在页面完成签署控件等信息的编辑与确认后，快速发起流程。 注：该接口包含模板/文件发起流程的全部功能，调用接口后不会立即发起，需在可嵌入页面点击按钮进行发起流程。 |
|
CreateReleaseFlowResponse |
EssClient.CreateReleaseFlow(CreateReleaseFlowRequest req)
发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。
解除协议的模板是官方提供 ，经过提供法务审核，暂不支持自定义。
注意：
原合同必须签署完成后才能发起解除协议。
只有原合同企业类型的参与人才能发起解除协议，个人参与方不能发起解除协议。
原合同个人类型参与人必须是解除协议的参与人，不能更换其他第三方个人参与解除协议。
如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的企业员工代为处理。
发起解除协议同发起其他企业合同一样，也会参与合同扣费，扣费标准同其他类型合同。
在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。
非原合同企业参与人发起解除协议时，需要有解除合同的权限。
|
|
CreateSchemeUrlResponse |
EssClient.CreateSchemeUrl(CreateSchemeUrlRequest req)
获取跳转至腾讯电子签小程序的签署链接
适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置
注：
1.
|
|
CreateSealResponse |
EssClient.CreateSeal(CreateSealRequest req)
本接口（CreateSeal）用于创建企业电子印章，支持创建企业公章，合同章，财务专用章和人事专用章创建。
1.
|
|
CreateSealPolicyResponse |
EssClient.CreateSealPolicy(CreateSealPolicyRequest req)
本接口（CreateSealPolicy）用于对企业员工进行印章授权
|
|
CreateUserAutoSignEnableUrlResponse |
EssClient.CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req)
获取个人用户自动签的开通链接。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
CreateUserAutoSignSealUrlResponse |
EssClient.CreateUserAutoSignSealUrl(CreateUserAutoSignSealUrlRequest req)
获取设置自动签印章小程序链接。
注意：
需要
企业开通自动签后使用。
仅支持已经开通了自动签的个人更换自动签印章。
链接有效期默认7天，最多30天。
该接口的链接适用于小程序端。
该接口不会扣除您的合同套餐，暂不参与计费。 |
|
CreateWebThemeConfigResponse |
EssClient.CreateWebThemeConfig(CreateWebThemeConfigRequest req)
用来设置本企业嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），设置后获取的web签署界面都会使用此配置进行展示。
如果多次调用，会以最后一次的配置为准
|
|
DeleteExtendedServiceAuthInfosResponse |
EssClient.DeleteExtendedServiceAuthInfos(DeleteExtendedServiceAuthInfosRequest req)
删除企业扩展服务授权，当前仅支持 “企业自动签” 和“批量签署” 的取消授权。
该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同，可通过该接口取消企业员工授权。
注：支持集团代子企业操作，请联系运营开通此功能。
|
|
DeleteIntegrationDepartmentResponse |
EssClient.DeleteIntegrationDepartment(DeleteIntegrationDepartmentRequest req)
此接口（DeleteIntegrationDepartment）用于删除企业的部门信息。
|
|
DeleteIntegrationEmployeesResponse |
EssClient.DeleteIntegrationEmployees(DeleteIntegrationEmployeesRequest req)
该接口（DeleteIntegrationEmployees）用于离职本企业员工，同时可选择是否进行离职交接。
- 如果该员工没有未处理的合同，可不设置交接人的ReceiveUserId或ReceiveOpenId进行离职操作。
- 如果该员工有未处理的合同，需要设置ReceiveUserId或ReceiveOpenId表示交接的负责人，交接后员工会进行离职操作。
未处理的合同包括以下：
- 待签署的合同（包括顺序签署还没有轮到的合同，此类合同某些情况可能不会出现在用户的列表中）。
- 待填写的合同。
- 待解除的合同等。
注：
1.
|
|
DeleteIntegrationRoleUsersResponse |
EssClient.DeleteIntegrationRoleUsers(DeleteIntegrationRoleUsersRequest req)
解绑员工与对应角色的关系，如需绑定请使用 CreateIntegrationUserRoles 接口。
|
|
DeleteSealPoliciesResponse |
EssClient.DeleteSealPolicies(DeleteSealPoliciesRequest req)
本接口（DeleteSealPolicies）用于撤销企业员工持有的印章权限
|
|
DescribeBillUsageDetailResponse |
EssClient.DescribeBillUsageDetail(DescribeBillUsageDetailRequest req)
通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。
|
|
DescribeCancelFlowsTaskResponse |
EssClient.DescribeCancelFlowsTask(DescribeCancelFlowsTaskRequest req)
通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。
|
|
DescribeExtendedServiceAuthDetailResponse |
EssClient.DescribeExtendedServiceAuthDetail(DescribeExtendedServiceAuthDetailRequest req)
查询企业扩展服务的授权详情（列表），当前支持查询以下内容：
1.
|
|
DescribeExtendedServiceAuthInfosResponse |
EssClient.DescribeExtendedServiceAuthInfos(DescribeExtendedServiceAuthInfosRequest req)
查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
1.
|
|
DescribeFileUrlsResponse |
EssClient.DescribeFileUrls(DescribeFileUrlsRequest req)
本接口（DescribeFileUrls）用于查询文件的下载URL。
适用场景：通过传参合同流程编号，下载对应的合同PDF文件流到本地。
|
|
DescribeFlowBriefsResponse |
EssClient.DescribeFlowBriefs(DescribeFlowBriefsRequest req)
查询流程基础信息
适用场景：可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
注: `每个企业限制日调用量限制：100W，当日超过此限制后再调用接口返回错误`
|
|
DescribeFlowComponentsResponse |
EssClient.DescribeFlowComponents(DescribeFlowComponentsRequest req)
查询流程填写控件内容，可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
|
|
DescribeFlowEvidenceReportResponse |
EssClient.DescribeFlowEvidenceReport(DescribeFlowEvidenceReportRequest req)
获取出证报告任务执行结果，返回报告 URL。
注意：
使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
需调用创建并返回出证报告接口提交申请出证报告任务获取报告编号后调用当前接口获取报告链接。
|
|
DescribeFlowInfoResponse |
EssClient.DescribeFlowInfo(DescribeFlowInfoRequest req)
此接口用于查询合同流程的详情信息，支持查询多个（数量不能超过100）。
适用场景：可用于主动查询某个合同详情信息。
|
|
DescribeFlowTemplatesResponse |
EssClient.DescribeFlowTemplates(DescribeFlowTemplatesRequest req)
此接口（DescribeFlowTemplates）用于查询本企业模板列表信息。
适用场景**
该接口常用来配合模板发起合同-创建电子文档接口，作为创建电子文档的前置接口使用。
通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。
一个模板通常会包含以下结构信息**
- 模板模板ID, 模板名字等基本信息
- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
- 发起方和签署方的填写控件 Components
- 签署方的签署控件 SignComponents
模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
|
|
DescribeIntegrationDepartmentsResponse |
EssClient.DescribeIntegrationDepartments(DescribeIntegrationDepartmentsRequest req)
此接口（DescribeIntegrationDepartments）用于查询企业的部门信息列表，支持查询单个部门节点或单个部门节点及一级子节点部门列表。
|
|
DescribeIntegrationEmployeesResponse |
EssClient.DescribeIntegrationEmployees(DescribeIntegrationEmployeesRequest req)
此接口（DescribeIntegrationEmployees）用于分页查询企业员工信息列表，支持设置过滤条件以筛选员工查询结果。
|
|
DescribeIntegrationRolesResponse |
EssClient.DescribeIntegrationRoles(DescribeIntegrationRolesRequest req)
此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。
|
|
DescribeOrganizationGroupOrganizationsResponse |
EssClient.DescribeOrganizationGroupOrganizations(DescribeOrganizationGroupOrganizationsRequest req)
此API接口用来查询加入集团的成员企业信息
适用场景：子企业在加入集团后，主企业可能通过此接口获取到所有的子企业列表，方便进行展示和统计
|
|
DescribeOrganizationSealsResponse |
EssClient.DescribeOrganizationSeals(DescribeOrganizationSealsRequest req)
查询企业印章的列表，需要操作者具有查询印章权限
客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理；入参InfoType控制印章是否携带授权人信息，为1则携带，为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
|
|
DescribePersonCertificateResponse |
EssClient.DescribePersonCertificate(DescribePersonCertificateRequest req)
此接口（DescribePersonCertificate）用于查询个人数字证书信息。
注：`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。` `2.调用此接口需要开通白名单，使用前请联系相关人员开通白名单。` |
|
DescribeSignFaceVideoResponse |
EssClient.DescribeSignFaceVideo(DescribeSignFaceVideoRequest req)
该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。
1.
|
|
DescribeThirdPartyAuthCodeResponse |
EssClient.DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)
通过AuthCode查询个人用户是否实名
注意:
此接口为合作引流场景使用，使用`有白名单限制`，使用前请联系对接的客户经理沟通。
`AuthCode 只能使用一次`，查询一次再次查询会返回错误
|
|
DescribeUserAutoSignStatusResponse |
EssClient.DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req)
通过此接口获取个人用户自动签的开通状态。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
DisableUserAutoSignResponse |
EssClient.DisableUserAutoSign(DisableUserAutoSignRequest req)
通过此接口可以关闭个人用户自动签功能。
无需对应的用户刷脸等方式同意即可关闭。
注意:
处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。
|
|
GetTaskResultApiResponse |
EssClient.GetTaskResultApi(GetTaskResultApiRequest req)
此接口（GetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作
前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。 注： 1. |
|
ModifyApplicationCallbackInfoResponse |
EssClient.ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req)
新增/删除企业应用集成中的回调配置。
新增回调配置只会增加不存在的CallbackUrl；删除操作将针对找到的相同CallbackUrl的配置进行删除。
请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。
更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
|
|
ModifyExtendedServiceResponse |
EssClient.ModifyExtendedService(ModifyExtendedServiceRequest req)
管理企业扩展服务 ，企业经办人需要是企业超管或者法人。
跳转小程序的几种方式：主要是设置不同的EndPoint
1.
|
|
ModifyFlowDeadlineResponse |
EssClient.ModifyFlowDeadline(ModifyFlowDeadlineRequest req)
在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度：
1.
|
|
ModifyIntegrationDepartmentResponse |
EssClient.ModifyIntegrationDepartment(ModifyIntegrationDepartmentRequest req)
此接口（ModifyIntegrationDepartment）用于更新企业的部门信息，支持更新部门名称、客户系统部门ID和部门序号等信息。
|
|
ModifyIntegrationRoleResponse |
EssClient.ModifyIntegrationRole(ModifyIntegrationRoleRequest req)
此接口（ModifyIntegrationRole）用来更新企业自定义的SaaS角色或集团角色。
适用场景1：更新当前企业的自定义SaaS角色或集团角色，并且更新时不进行角色中权限的更新（PermissionGroups 参数不传）。
适用场景2：更新当前企业的自定义SaaS角色或集团角色，并且更新时进行角色中权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
适用场景3：更新集团角色管理的子企业列表，可通过设置 SubOrganizationIds 参数达到此效果。
适用场景4：主企业代理子企业操作的场景，需要设置Agent参数，并且ProxyOrganizationId设置为子企业的id即可。
注意事项：SaaS角色和集团角色对应的权限树是不一样的。
|
|
RenewAutoSignLicenseResponse |
EssClient.RenewAutoSignLicense(RenewAutoSignLicenseRequest req)
给医疗个人自动签许可续期。续期成功后，可对医疗自动签许可追加一年有效期，只可续期一次。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
|
StartFlowResponse |
EssClient.StartFlow(StartFlowRequest req)
此接口用于启动流程。它是模板发起合同的最后一步。
在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
注：
1.合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
2.静默（自动）签署不支持非本企业合同签署方存在填写功能
3.在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_file_resources)，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
|
|
UnbindEmployeeUserIdWithClientOpenIdResponse |
EssClient.UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req)
此接口（UnbindEmployeeUserIdWithClientOpenId）用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。
注：`在调用此接口时，需确保OpenId已通过调用`BindEmployeeUserIdWithClientOpenId`接口与电子签系统的UserId绑定过。若OpenId未经过绑定，则无法使用此接口进行解绑操作。`
|
|
UpdateIntegrationEmployeesResponse |
EssClient.UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req)
此接口（UpdateIntegrationEmployees）用于修改未实名企业员工信息(姓名，手机号，邮件、部门)。
如果企业员工已经实名， 姓名，手机号，邮件等需要企业员工到小程序或者控制台自己修改， 部门则需要超管到控制台分配
修改手机号的时候,支持以下场景进行提醒通知
生成端
入参
提醒方式
普通saas员工
将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号
发送短信通知员工（短信中带有认证加入企业的链接）
企微员工
将Employees 中的WeworkOpenId字段设置为企微员工明文的openid，需确保该企微员工在应用的可见范围内
企微内部实名消息
H5端 saas员工
传递 InvitationNotifyType = H5，将Employees中的DisplayName设置员工的名字，Mobile设置成员工的手机号，此场景不支持企微
生成认证加入企业的H5链接，贵方可以通过自己的渠道触达到此员工
注意：
- 若通过手机号发现员工已经创建，则不会重复创建，但会发送短信或者生成链接提醒员工实名。
- jumpUrl 仅支持H5的邀请方式，回跳的url，使用前请联系对接的客户经理沟通，进行域名的配置。
|
|
UploadFilesResponse |
EssClient.UploadFiles(UploadFilesRequest req)
此接口（UploadFiles）文件上传。
适用场景：用于合同，印章的文件上传。文件上传以后， 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. |
|
VerifyPdfResponse |
EssClient.VerifyPdf(VerifyPdfRequest req)
对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。
|
| Modifier and Type | Method and Description |
|---|---|
ArchiveFlowResponse |
EssbasicClient.ArchiveFlow(ArchiveFlowRequest req)
此接口（ArchiveFlow）用于流程的归档。
注意：归档后的流程不可再进行发送、签署、拒签、撤回等一系列操作。
|
CancelFlowResponse |
EssbasicClient.CancelFlow(CancelFlowRequest req)
此接口（CancelFlow）用于撤销正在进行中的流程。
注：已归档流程不可完成撤销动作。
|
CheckBankCard2EVerificationResponse |
EssbasicClient.CheckBankCard2EVerification(CheckBankCard2EVerificationRequest req)
该接口为第三方平台向电子签平台验证银行卡二要素
|
CheckBankCard3EVerificationResponse |
EssbasicClient.CheckBankCard3EVerification(CheckBankCard3EVerificationRequest req)
该接口为第三方平台向电子签平台验证银行卡三要素
|
CheckBankCard4EVerificationResponse |
EssbasicClient.CheckBankCard4EVerification(CheckBankCard4EVerificationRequest req)
该接口为第三方平台向电子签平台验证银行卡四要素
|
CheckBankCardVerificationResponse |
EssbasicClient.CheckBankCardVerification(CheckBankCardVerificationRequest req)
该接口为第三方平台向电子签平台验证银行卡二/三/四要素
银行卡二要素(同CheckBankCard2EVerification): bank_card + name
银行卡三要素(同CheckBankCard3EVerification): bank_card + name + id_card_number
银行卡四要素(同CheckBankCard4EVerification): bank_card + name + id_card_number + mobile
|
CheckFaceIdentifyResponse |
EssbasicClient.CheckFaceIdentify(CheckFaceIdentifyRequest req)
该接口为第三方平台向电子签平台检测慧眼或腾讯电子签小程序人脸核身结果
|
CheckIdCardVerificationResponse |
EssbasicClient.CheckIdCardVerification(CheckIdCardVerificationRequest req)
该接口为第三方平台向电子签平台验证姓名和身份证信息
|
CheckMobileAndNameResponse |
EssbasicClient.CheckMobileAndName(CheckMobileAndNameRequest req)
该接口为第三方平台向电子签平台验证手机号二要素
|
CheckMobileVerificationResponse |
EssbasicClient.CheckMobileVerification(CheckMobileVerificationRequest req)
该接口为第三方平台向电子签平台验证手机号三要素
|
CheckVerifyCodeMatchFlowIdResponse |
EssbasicClient.CheckVerifyCodeMatchFlowId(CheckVerifyCodeMatchFlowIdRequest req)
此接口用于确认验证码是否正确
|
CreateFaceIdSignResponse |
EssbasicClient.CreateFaceIdSign(CreateFaceIdSignRequest req)
该接口为第三方平台向电子签平台获取慧眼慧眼API签名
|
CreateFlowByFilesResponse |
EssbasicClient.CreateFlowByFiles(CreateFlowByFilesRequest req)
此接口（CreateFlowByFiles）用于通过PDF文件创建签署流程。
注意：调用此接口前，请先调用多文件上传接口 (UploadFiles)，提前上传合同文件。
|
CreateH5FaceIdUrlResponse |
EssbasicClient.CreateH5FaceIdUrl(CreateH5FaceIdUrlRequest req)
该接口为第三方平台向电子签平台获取慧眼H5人脸核身Url
|
CreatePreviewSignUrlResponse |
EssbasicClient.CreatePreviewSignUrl(CreatePreviewSignUrlRequest req)
此接口（CreatePreviewSignUrl）用于生成生成预览签署URL。
注：调用此接口前，请确保您已提前调用了发送流程接口（SendFlow）指定相关签署方。
|
CreateSealResponse |
EssbasicClient.CreateSeal(CreateSealRequest req)
此接口（CreateSeal）用于创建个人/企业印章。
注意：使用FileId参数指定印章，需先调用多文件上传 (UploadFiles) 上传印章图片。
|
CreateServerFlowSignResponse |
EssbasicClient.CreateServerFlowSign(CreateServerFlowSignRequest req)
此接口（CreateServerFlowSign）用于静默签署文件。
注：
1、此接口为白名单接口，调用前请提前与客服经理或邮件至[email protected]进行联系。
2、仅合同发起者可使用流程静默签署能力。
|
CreateSignUrlResponse |
EssbasicClient.CreateSignUrl(CreateSignUrlRequest req)
此接口（CreateSignUrl）用于生成指定用户的签署URL。
注：调用此接口前，请确保您已提前调用了发送流程接口（SendFlow）指定相关签署方。
|
CreateSubOrganizationResponse |
EssbasicClient.CreateSubOrganization(CreateSubOrganizationRequest req)
此接口（CreateSubOrganization）用于在腾讯电子签内注册子机构。
|
CreateSubOrganizationAndSealResponse |
EssbasicClient.CreateSubOrganizationAndSeal(CreateSubOrganizationAndSealRequest req)
此接口（CreateSubOrganizationAndSeal）用于注册子机构，同时系统将为该子企业自动生成一个默认电子印章图片。
注意：
1.
|
CreateUserResponse |
EssbasicClient.CreateUser(CreateUserRequest req)
此接口（CreateUser）用于注册腾讯电子签个人用户。
|
CreateUserAndSealResponse |
EssbasicClient.CreateUserAndSeal(CreateUserAndSealRequest req)
第三方应用可通过此接口（CreateUserAndSeal）注册腾讯电子签实名个人用户，同时系统将为该用户自动生成一个默认电子签名图片。
注意：
1.
|
DeleteSealResponse |
EssbasicClient.DeleteSeal(DeleteSealRequest req)
此接口 (DeleteSeal) 用于删除指定ID的印章。
注意：默认印章不支持删除
|
DescribeCatalogApproversResponse |
EssbasicClient.DescribeCatalogApprovers(DescribeCatalogApproversRequest req)
第三方应用可通过此接口（DescribeCatalogApprovers）查询指定目录的参与者列表
|
DescribeCatalogSignComponentsResponse |
EssbasicClient.DescribeCatalogSignComponents(DescribeCatalogSignComponentsRequest req)
第三方应用可通过此接口（DescribeCatalogSignComponents）拉取目录签署区
|
DescribeCustomFlowIdsResponse |
EssbasicClient.DescribeCustomFlowIds(DescribeCustomFlowIdsRequest req)
此接口（DescribeCustomFlowIds）用于通过自定义流程id来查询对应的电子签流程id
|
DescribeCustomFlowIdsByFlowIdResponse |
EssbasicClient.DescribeCustomFlowIdsByFlowId(DescribeCustomFlowIdsByFlowIdRequest req)
此接口（DescribeCustomFlowIdsByFlowId）用于根据流程id反查自定义流程id
|
DescribeFaceIdPhotosResponse |
EssbasicClient.DescribeFaceIdPhotos(DescribeFaceIdPhotosRequest req)
该接口为第三方平台向电子签平台获取慧眼人脸核身照片
|
DescribeFaceIdResultsResponse |
EssbasicClient.DescribeFaceIdResults(DescribeFaceIdResultsRequest req)
该接口为第三方平台向电子签平台获取慧眼人脸核身结果
|
DescribeFileIdsByCustomIdsResponse |
EssbasicClient.DescribeFileIdsByCustomIds(DescribeFileIdsByCustomIdsRequest req)
根据用户自定义id查询文件id
|
DescribeFileUrlsResponse |
EssbasicClient.DescribeFileUrls(DescribeFileUrlsRequest req)
此接口（DescribeFileUrls）用于获取签署文件下载的URL。
|
DescribeFlowResponse |
EssbasicClient.DescribeFlow(DescribeFlowRequest req)
通过此接口（DescribeFlow）可查询签署流程的详细信息。
|
DescribeFlowApproversResponse |
EssbasicClient.DescribeFlowApprovers(DescribeFlowApproversRequest req)
第三方应用可通过此接口（DescribeFlowApprovers）查询流程参与者信息。
|
DescribeFlowFilesResponse |
EssbasicClient.DescribeFlowFiles(DescribeFlowFilesRequest req)
查询流程文件
|
DescribeSealsResponse |
EssbasicClient.DescribeSeals(DescribeSealsRequest req)
此接口（DescribeSeals）用于查询指定ID的印章信息。
|
DescribeSubOrganizationsResponse |
EssbasicClient.DescribeSubOrganizations(DescribeSubOrganizationsRequest req)
此接口（DescribeSubOrganizations）用于查询子机构信息。
注：此接口仅可查询您所属机构应用号创建的子机构信息，不可跨应用/跨机构查询。
|
DescribeUsersResponse |
EssbasicClient.DescribeUsers(DescribeUsersRequest req)
此接口（DescribeUsers）用于查询应用号下的个人用户信息。
注：此接口仅可查询您所属机构应用号创建的个人用户信息，不可跨应用/跨机构查询。
|
DestroyFlowFileResponse |
EssbasicClient.DestroyFlowFile(DestroyFlowFileRequest req)
通过此接口（DestroyFlowFile）可删除指定流程中的合同文件。
注：调用此接口前，请确保此流程已属于归档状态。您可通过查询流程信息接口（DescribeFlow）进行查询。
|
GenerateOrganizationSealResponse |
EssbasicClient.GenerateOrganizationSeal(GenerateOrganizationSealRequest req)
生成企业电子印章
|
GenerateUserSealResponse |
EssbasicClient.GenerateUserSeal(GenerateUserSealRequest req)
此接口（GenerateUserSeal）用于生成个人签名图片。
注意：
1.
|
ModifyOrganizationDefaultSealResponse |
EssbasicClient.ModifyOrganizationDefaultSeal(ModifyOrganizationDefaultSealRequest req)
此接口 (ModifyOrganizationDefaultSeal) 用于重新指定企业默认印章。
|
ModifySealResponse |
EssbasicClient.ModifySeal(ModifySealRequest req)
此接口（ModifySeal）用于修改指定印章ID的印章图片和名称。
注：印章类型暂不支持修改，如需调整，请联系客服经理或通过创建印章接口（CreateSeal）进行创建新印章。
|
ModifySubOrganizationInfoResponse |
EssbasicClient.ModifySubOrganizationInfo(ModifySubOrganizationInfoRequest req)
此接口（ModifySubOrganizationInfo）用于更新子机构信息。
注：若修改子机构名称或更新机构证件照片，需要重新通过子机构实名接口（VerifySubOrganization）进行重新实名。
|
ModifyUserResponse |
EssbasicClient.ModifyUser(ModifyUserRequest req)
此接口（ModifyUser）用于更新个人用户信息。
注：若修改用户姓名，需要重新通过个人用户实名接口（VerifyUser）进行重新实名。
|
ModifyUserDefaultSealResponse |
EssbasicClient.ModifyUserDefaultSeal(ModifyUserDefaultSealRequest req)
此接口 (ModifyUserDefaultSeal) 用于重新指定个人默认印章。
|
RejectFlowResponse |
EssbasicClient.RejectFlow(RejectFlowRequest req)
此接口（RejectFlow）用于用户拒绝签署合同流程。
|
SendFlowResponse |
EssbasicClient.SendFlow(SendFlowRequest req)
此接口（SendFlow）用于指定签署者及签署内容，后续可通过生成签署接口（CreateSignUrl）获取签署url。
|
SendFlowUrlResponse |
EssbasicClient.SendFlowUrl(SendFlowUrlRequest req)
发送流程并获取签署URL
|
SendSignInnerVerifyCodeResponse |
EssbasicClient.SendSignInnerVerifyCode(SendSignInnerVerifyCodeRequest req)
此接口用于发送签署验证码
|
SignFlowResponse |
EssbasicClient.SignFlow(SignFlowRequest req)
此接口（SignFlow）可用于对流程文件进行签署。
|
UploadFilesResponse |
EssbasicClient.UploadFiles(UploadFilesRequest req)
此接口（UploadFiles）用于文件上传。
|
VerifySubOrganizationResponse |
EssbasicClient.VerifySubOrganization(VerifySubOrganizationRequest req)
此接口（VerifySubOrganization）用于通过子机构的实名认证。
注：此接口为白名单接口，如您需要使用此能力，请提前与客户经理沟通或邮件至[email protected]与我们联系。
|
VerifyUserResponse |
EssbasicClient.VerifyUser(VerifyUserRequest req)
第三方应用可通过此接口（VerifyUser）将腾讯电子签个人用户的实名认证状态设为通过。
注：此接口为白名单接口，如您需要使用此能力，请提前与客户经理沟通或邮件至[email protected]与我们联系。
|
| Modifier and Type | Method and Description |
|---|---|
ChannelBatchCancelFlowsResponse |
EssbasicClient.ChannelBatchCancelFlows(ChannelBatchCancelFlowsRequest req)
通过合同编号批量撤销合同，单次最多支持撤销100份合同。
适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
- **可撤回合同状态**：未全部签署完成
- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
注:
- 有对应合同撤销权限的人: **合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**
- 签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口
- 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。
|
ChannelCancelFlowResponse |
EssbasicClient.ChannelCancelFlow(ChannelCancelFlowRequest req)
撤销签署流程接口
适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
- **可撤回合同状态**：未全部签署完成
- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
注:
- 有对应合同撤销权限的人: **合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**
- 签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口
- 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。
|
ChannelCancelMultiFlowSignQRCodeResponse |
EssbasicClient.ChannelCancelMultiFlowSignQRCode(ChannelCancelMultiFlowSignQRCodeRequest req)
此接口（CancelMultiFlowSignQRCode）用于废除取消一码多签签署码。
该接口所需的二维码ID，源自[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
如果该签署码尚处于有效期内，可通过本接口将其设置为失效状态。
|
ChannelCancelUserAutoSignEnableUrlResponse |
EssbasicClient.ChannelCancelUserAutoSignEnableUrl(ChannelCancelUserAutoSignEnableUrlRequest req)
此接口（ChannelCancelUserAutoSignEnableUrl）用来撤销发送给个人用户的自动签开通链接，撤销后对应的个人用户开通链接失效。若个人用户已经完成开通，将无法撤销。（处方单场景专用，使用此接口请与客户经理确认）
|
ChannelCreateBatchCancelFlowUrlResponse |
EssbasicClient.ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req)
通过合同编号生成批量撤销合同的链接，单次最多支持撤销100份合同, 返回的链接需要有此权限的人**合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人**在**手机端**打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
适用场景：如果某个合同当前**至少还有一方没有签署**，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。
- **可撤回合同状态**：未全部签署完成
- **不撤回合同状态**：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/partner/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销合同结果](https://qian.tencent.com/developers/partnerApis/operateFlows/DescribeCancelFlowsTask)主动查询。
注:
- 签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口
- 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。
|
ChannelCreateBatchQuickSignUrlResponse |
EssbasicClient.ChannelCreateBatchQuickSignUrl(ChannelCreateBatchQuickSignUrlRequest req)
该接口用于发起合同后，生成个人用户的批量签署链接, 暂时不支持企业端签署。
注意**：
1.
|
ChannelCreateBatchSignUrlResponse |
EssbasicClient.ChannelCreateBatchSignUrl(ChannelCreateBatchSignUrlRequest req)
通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。
请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
注：
- 使用此接口生成链接，需要提前开通 `使用手机号验证签署方身份` 功能，在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。
- 参与人点击链接后需短信验证码才能查看合同内容。
- 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接，不支持子客企业。
- 个人批量签署，签名区`仅支持手写签名`。
|
ChannelCreateBoundFlowsResponse |
EssbasicClient.ChannelCreateBoundFlows(ChannelCreateBoundFlowsRequest req)
此接口（ChannelCreateBoundFlows）用于子客企业领取未归属给员工的合同，将合同领取给当前员工，合同不能重复领取。
未归属合同发起方式**
指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下
```
FlowApprovers: []*essbasic.FlowApproverInfo{
{
ApproverType: common.StringPtr("ORGANIZATION"),
OrganizationOpenId: common.StringPtr("org_dianziqian"),
OrganizationName: common.StringPtr("典子谦示例企业"),
}
},
```
可以生成子客登录链接登录控制台查看带领取的合同
注:
1.
|
ChannelCreateConvertTaskApiResponse |
EssbasicClient.ChannelCreateConvertTaskApi(ChannelCreateConvertTaskApiRequest req)
|
ChannelCreateEmbedWebUrlResponse |
EssbasicClient.ChannelCreateEmbedWebUrl(ChannelCreateEmbedWebUrlRequest req)
本接口（ChannelCreateEmbedWebUrl）用于创建常规模块嵌入web的链接
本接口下面功能的签署页面链接的生成
- 创建印章
- 创建模板
- 修改模板
- 预览模板
- 预览合同流程
|
ChannelCreateFlowApproversResponse |
EssbasicClient.ChannelCreateFlowApprovers(ChannelCreateFlowApproversRequest req)
适用场景：
当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口动态补充签署人。同一签署人只允许补充一人，最终实际签署人取决于谁先领取合同完成签署。
限制条件：
1.
|
ChannelCreateFlowByFilesResponse |
EssbasicClient.ChannelCreateFlowByFiles(ChannelCreateFlowByFilesRequest req)
接口（ChannelCreateFlowByFiles）用PDF文件创建签署流程。
适用场景：适用非制式的合同文件签署，开发者有每个签署流程的PDF，可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
注**:
此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。
此接口需要依赖文件上传接口生成pdf资源编号（FileIds）进行使用。整体的逻辑如下图
可以作为发起方和签署方的角色列表**
场景编号
可作为发起方类型
可作为签署方的类型
场景一
第三方子企业A员工
第三方子企业A员工
场景二
第三方子企业A员工
第三方子企业B(不指定经办人)
场景三
第三方子企业A员工
第三方子企业B员工
场景四
第三方子企业A员工
个人/自然人
场景五
第三方子企业A员工
SaaS平台企业员工
注**:
`1.
|
ChannelCreateFlowGroupByFilesResponse |
EssbasicClient.ChannelCreateFlowGroupByFiles(ChannelCreateFlowGroupByFilesRequest req)
接口（ChannelCreateFlowGroupByFiles）用于使用 PDF 文件创建合同组签署流程。
合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
注**:
此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。
合同组暂不支持抄送功能
此接口需要依赖文件上传接口生成pdf资源编号（FileIds）进行使用。
可以作为发起方和签署方的角色列表**
场景编号
可作为发起方类型
可作为签署方的类型
场景一
第三方子企业A员工
第三方子企业A员工
场景二
第三方子企业A员工
第三方子企业B(不指定经办人)
场景三
第三方子企业A员工
第三方子企业B员工
场景四
第三方子企业A员工
个人/自然人
场景五
第三方子企业A员工
SaaS平台企业员工
注**:
`1.
|
ChannelCreateFlowGroupByTemplatesResponse |
EssbasicClient.ChannelCreateFlowGroupByTemplates(ChannelCreateFlowGroupByTemplatesRequest req)
接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。
合同组是将多个合同签署流程组织在一起，多个合同同时创建，每个签署方得到一个签署链接，`一次完成合同组中多个合同的签署`。合同组的合同`不能拆分一个一个签署`，只能作为一个整体签署。
适用场景：该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。
注**:
此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。
合同组暂不支持抄送功能
可以作为发起方和签署方的角色列表**
场景编号
可作为发起方类型
可作为签署方的类型
场景一
第三方子企业A员工
第三方子企业A员工
场景二
第三方子企业A员工
第三方子企业B(不指定经办人)
场景三
第三方子企业A员工
第三方子企业B员工
场景四
第三方子企业A员工
个人/自然人
场景五
第三方子企业A员工
SaaS平台企业员工
注**:
`1.
|
ChannelCreateFlowRemindsResponse |
EssbasicClient.ChannelCreateFlowReminds(ChannelCreateFlowRemindsRequest req)
指定需要批量催办的签署流程ID，批量催办合同，最多100个。需要符合以下条件的合同才可被催办
1.
|
ChannelCreateFlowSignReviewResponse |
EssbasicClient.ChannelCreateFlowSignReview(ChannelCreateFlowSignReviewRequest req)
提交企业流程审批结果
当前存在两种审核操作：**
签署审核
在通过接口CreateFlowsByTemplatesChannelCreateFlowByFilesChannelCreateFlowGroupByTemplatesChannelCreateFlowGroupByFilesChannelCreatePrepareFlow 发起签署流程时，通过指定NeedSignReview为true，则可以调用此接口，并指定operate=SignReview，以提交企业内部签署审批结果
在通过接口CreateFlowsByTemplatesChannelCreateFlowByFilesChannelCreateFlowGroupByTemplatesChannelCreateFlowGroupByFiles发起签署流程时，通过指定签署人ApproverNeedSignReview为true，则可以调用此接口，并指定operate=SignReview，并指定RecipientId，以提交企业内部签署审批结果
发起审核
通过接口ChannelCreatePrepareFlow指定发起后需要审核，那么可以调用此接口，并指定operate=CreateReview，以提交企业内部审批结果。可以多次提交审批结果，但一旦审批通过，后续提交的结果将无效
|
ChannelCreateFlowSignUrlResponse |
EssbasicClient.ChannelCreateFlowSignUrl(ChannelCreateFlowSignUrlRequest req)
该接口用于发起合同后，生成用户的签署链接
注意** 1. |
ChannelCreateMultiFlowSignQRCodeResponse |
EssbasicClient.ChannelCreateMultiFlowSignQRCode(ChannelCreateMultiFlowSignQRCodeRequest req)
此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多签签署码。
适用场景**:
签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
注意**:
1.
|
ChannelCreateOrganizationBatchSignUrlResponse |
EssbasicClient.ChannelCreateOrganizationBatchSignUrl(ChannelCreateOrganizationBatchSignUrlRequest req)
通过此接口，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
注：
- 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方或者领取方。
- 仅支持传入待签署或者待领取的合同，待填写暂不支持。
- 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
|
ChannelCreateOrganizationModifyQrCodeResponse |
EssbasicClient.ChannelCreateOrganizationModifyQrCode(ChannelCreateOrganizationModifyQrCodeRequest req)
生成渠道子客编辑企业信息二维码
|
ChannelCreatePreparedPersonalEsignResponse |
EssbasicClient.ChannelCreatePreparedPersonalEsign(ChannelCreatePreparedPersonalEsignRequest req)
本接口（ChannelCreatePreparedPersonalEsign）用于创建导入个人印章（处方单场景专用，使用此接口请与客户经理确认）。
|
ChannelCreatePrepareFlowResponse |
EssbasicClient.ChannelCreatePrepareFlow(ChannelCreatePrepareFlowRequest req)
通过此接口指定合同、签署人、填写控件等信息，生成嵌入式链接，此链接可以嵌入到其他网页或者直接打开，打开后进入发起页面。在此页面上，合同信息和签署人信息均不可更改。
注意：
1.
|
ChannelCreateReleaseFlowResponse |
EssbasicClient.ChannelCreateReleaseFlow(ChannelCreateReleaseFlowRequest req)
发起解除协议的主要应用场景为：基于一份已经签署的合同(签署流程)，进行解除操作。
解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。
注意：
原合同必须签署完成后才能发起解除协议。
只有原合同企业类型的参与人才能发起解除协议，个人参与方不能发起解除协议。
原合同个人类型参与人必须是解除协议的参与人，不能更换其他第三方个人参与解除协议。
如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的企业员工代为处理。
发起解除协议同发起其他企业合同一样，也会参与合同扣费，扣费标准同其他类型合同。
在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。
非原合同企业参与人发起解除协议时，需要有解除合同的权限。
|
ChannelCreateRoleResponse |
EssbasicClient.ChannelCreateRole(ChannelCreateRoleRequest req)
此接口（ChannelCreateRole）用来创建企业自定义角色。
适用场景1：创建当前企业的自定义角色，并且创建时不进行权限的设置（PermissionGroups 参数不传），角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
适用场景2：创建当前企业的自定义角色，并且创建时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
ChannelCreateSealPolicyResponse |
EssbasicClient.ChannelCreateSealPolicy(ChannelCreateSealPolicyRequest req)
将指定印章授权给第三方平台子客企业下的某些员工
|
ChannelCreateUserAutoSignEnableUrlResponse |
EssbasicClient.ChannelCreateUserAutoSignEnableUrl(ChannelCreateUserAutoSignEnableUrlRequest req)
获取个人用户自动签的开通链接。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
ChannelCreateUserAutoSignSealUrlResponse |
EssbasicClient.ChannelCreateUserAutoSignSealUrl(ChannelCreateUserAutoSignSealUrlRequest req)
获取设置自动签印章小程序链接。
注意：
需要
企业开通自动签后使用。
仅支持已经开通了自动签的个人更换自动签印章。
链接有效期默认7天，最多30天。
该接口的链接适用于小程序端。
该接口不会扣除您的合同套餐，暂不参与计费。 |
ChannelCreateUserRolesResponse |
EssbasicClient.ChannelCreateUserRoles(ChannelCreateUserRolesRequest req)
使用此接口，用来绑定企业实名员工的角色，
支持以电子签userId、客户系统openId两种方式进行绑定。
对应控制台的操作如下图
|
ChannelCreateWebThemeConfigResponse |
EssbasicClient.ChannelCreateWebThemeConfig(ChannelCreateWebThemeConfigRequest req)
用来创建嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），该接口配合其他所有可嵌入页面接口使用
创建配置对当前第三方应用全局生效，如果多次调用，会以最后一次的配置为准
|
ChannelDeleteRoleResponse |
EssbasicClient.ChannelDeleteRole(ChannelDeleteRoleRequest req)
此接口（ChannelDeleteRole）用来删除企业自定义角色。
注意：系统角色不可删除。
|
ChannelDeleteRoleUsersResponse |
EssbasicClient.ChannelDeleteRoleUsers(ChannelDeleteRoleUsersRequest req)
通过此接口，删除员工绑定的角色，支持以电子签userId、客户系统userId两种方式调用。
对应控制台的操作如下图
|
ChannelDeleteSealPoliciesResponse |
EssbasicClient.ChannelDeleteSealPolicies(ChannelDeleteSealPoliciesRequest req)
此接口（ChannelDeleteSealPolicies）用于删除已指定员工印章授权信息，删除员工的印章授权后，该员工使用印章进行盖章时，将需要提交印章授权申请且通过审核后才能使用该印章进行签署。
|
ChannelDescribeBillUsageDetailResponse |
EssbasicClient.ChannelDescribeBillUsageDetail(ChannelDescribeBillUsageDetailRequest req)
通过此接口（ChannelDescribeBillUsageDetail）查询该第三方平台子客企业的套餐消耗详情。可以支持单个子客和整个应用下所有子客的查询。
对于单个子客企业的查询，通过指定子客的唯一标识(Agent.ProxyOrganizationOpenId)来查询该子客消耗详情
对于整个应用下所有企业的查询，不需要指定子客的唯一标识，只需要传入渠道应用标识(Agent.AppId)直接查询整个应用下所有子客企业消耗详情
|
ChannelDescribeEmployeesResponse |
EssbasicClient.ChannelDescribeEmployees(ChannelDescribeEmployeesRequest req)
获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息，支持设置过滤条件以筛选员工查询结果。
注**:通过企业员工新增或离职接口增加的新员工或者离职的员工也会在列表中。
|
ChannelDescribeFlowComponentsResponse |
EssbasicClient.ChannelDescribeFlowComponents(ChannelDescribeFlowComponentsRequest req)
用于获取合同中填写控件填写状态和填写的内容。
注意**: `附件控件不会出现在结果列表中`
授权**:
此接口需要授权, 有两种开通权限的途径
第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
|
ChannelDescribeOrganizationSealsResponse |
EssbasicClient.ChannelDescribeOrganizationSeals(ChannelDescribeOrganizationSealsRequest req)
此接口（ChannelDescribeOrganizationSeals）查询子客企业电子印章。
注: 1. |
ChannelDescribeRolesResponse |
EssbasicClient.ChannelDescribeRoles(ChannelDescribeRolesRequest req)
分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
系统默认角色说明可参考下表
| 角色名称| 建议授予对象 | 角色描述 |
| --- | --- | --- |
| **超级管理员** |电子签业务最高权限，可以授权给法务/企业法人/业务负责人等 | 所有功能和数据管理权限，只能设置一位超管。 |
| **业务管理员**|IT 系统负责人，可以授权给CTO等 | 企业合同模块、印章模块、模板模块等全量功能及数据权限。 |
| **经办人**|企业法务负责人等 | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。 |
| **业务员**|销售员、采购员 等| 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。 |
附件：点击下载角色对应的权限点的excel文档
|
ChannelDescribeSignFaceVideoResponse |
EssbasicClient.ChannelDescribeSignFaceVideo(ChannelDescribeSignFaceVideoRequest req)
该接口用于在使用视频认证方式签署合同后，获取用户的签署人脸认证视频。
1.
|
ChannelDescribeUserAutoSignStatusResponse |
EssbasicClient.ChannelDescribeUserAutoSignStatus(ChannelDescribeUserAutoSignStatusRequest req)
通过此接口获取个人用户自动签的开通状态。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
ChannelDisableUserAutoSignResponse |
EssbasicClient.ChannelDisableUserAutoSign(ChannelDisableUserAutoSignRequest req)
通过此接口可以关闭个人用户自动签功能。
无需对应的用户刷脸等方式同意即可关闭。
注意:
处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。
如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。
|
ChannelGetTaskResultApiResponse |
EssbasicClient.ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)
此接口（ChannelGetTaskResultApi）用来查询转换任务的状态。如需发起转换任务，请使用创建文件转换任务接口进行资源文件的转换操作
前提条件：已调用 创建文件转换任务接口进行文件转换，并得到了返回的转换任务Id。 适用场景：已创建一个文件转换任务，想查询该文件转换任务的状态，或获取转换后的文件资源Id。 注： 1. |
ChannelModifyRoleResponse |
EssbasicClient.ChannelModifyRole(ChannelModifyRoleRequest req)
此接口（ChannelModifyRole）用来更新企业自定义角色。
适用场景1：更新当前企业的自定义角色的名称或描述等其他信息，更新时不进行权限的设置（PermissionGroups 参数不传）。
适用场景2：更新当前企业的自定义角色的权限信息，更新时进行权限的设置（PermissionGroups 参数要传），权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新，需尽量拉取最新的权限树内容，并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
ChannelRenewAutoSignLicenseResponse |
EssbasicClient.ChannelRenewAutoSignLicense(ChannelRenewAutoSignLicenseRequest req)
给医疗个人自动签许可续期。续期成功后，可对医疗自动签许可追加一年有效期，只可续期一次。
注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
|
ChannelUpdateSealStatusResponse |
EssbasicClient.ChannelUpdateSealStatus(ChannelUpdateSealStatusRequest req)
此接口（ChannelUpdateSealStatus）用于第三方应用平台为子客企业更新印章状态。
|
ChannelVerifyPdfResponse |
EssbasicClient.ChannelVerifyPdf(ChannelVerifyPdfRequest req)
对合同流程文件进行数字签名验证，判断数字签名是否有效，合同文件内容是否被篡改。
|
CreateBatchOrganizationRegistrationTasksResponse |
EssbasicClient.CreateBatchOrganizationRegistrationTasks(CreateBatchOrganizationRegistrationTasksRequest req)
本接口（CreateBatchOrganizationRegistrationTasks）用于批量创建企业认证链接
该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
|
CreateChannelFlowEvidenceReportResponse |
EssbasicClient.CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req)
提交申请出证报告任务并返回报告ID。
注意：
- 使用此功能**需搭配出证套餐** ，使用前请联系对接的客户经理沟通。
- 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
- 合同流程必须**所有参与方已经签署完成**。
- 出证过程需一定时间，建议在**提交出证任务后的24小时之后**，通过获取出证报告任务执行结果接口进行查询执行结果和出证报告的下载URL。
|
CreateChannelOrganizationInfoChangeUrlResponse |
EssbasicClient.CreateChannelOrganizationInfoChangeUrl(CreateChannelOrganizationInfoChangeUrlRequest req)
此接口（CreateChannelOrganizationInfoChangeUrl）用于创建子客企业信息变更链接。
支持变更链接类型，通过入参 Endpoint 指定，默认为WEIXINAPP。 |
CreateConsoleLoginUrlResponse |
EssbasicClient.CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)
此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。
Web链接访问后，会根据子客企业(**Agent中ProxyOrganizationOpenId表示**)和员工(**Agent中OpenId表示**)的状态，进入不同的流程，主要情况分类如下：
子客企业状态
子客企业员工状态
点击链接进入的流程
视频样例
企业未激活
员工未认证
进入企业激活流程，首次完成企业激活流程的员工会成为超管
打开
企业已激活
员工未认证
进入员认证并加入企业流程
-
企业已激活
员工已认证
进入子客企业Web控制台
-
如果是企业激活流程，需要注意如下情况：
1.
|
CreateFlowGroupSignReviewResponse |
EssbasicClient.CreateFlowGroupSignReview(CreateFlowGroupSignReviewRequest req)
1.
|
CreateFlowsByTemplatesResponse |
EssbasicClient.CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)
接口（CreateFlowsByTemplates）用于使用模板批量创建签署流程。当前可批量发起合同（签署流程）数量为1-20个。
如若在模板中配置了动态表格, 上传的附件必须为A4大小
合同发起人必须在电子签已经进行实名。
### 一.
|
CreatePartnerAutoSignAuthUrlResponse |
EssbasicClient.CreatePartnerAutoSignAuthUrl(CreatePartnerAutoSignAuthUrlRequest req)
创建他方自动签授权链接，通过该链接可进入小程序进行合作方企业的自动签授权，若当前企业未开通企业自动签，通过该链接会先引导开通本企业自动签。
该接口效果同控制台： 企业设置-> 扩展服务 -> 企业自动签署 -> 合作企业方授权
注:
1.
|
CreateSealByImageResponse |
EssbasicClient.CreateSealByImage(CreateSealByImageRequest req)
1.
|
CreateSignUrlsResponse |
EssbasicClient.CreateSignUrls(CreateSignUrlsRequest req)
创建跳转小程序查看或签署的链接
腾讯电子签小程序的AppID 和 原始Id如下:**
| 小程序 | AppID | 原始ID |
| ------------ | ------------ | ------------ |
| 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
主要使用场景EndPoint分类**
|EndPoint| 场景| 说明和示例|
| ---- | ---- | --- |
| WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序（与腾讯电子签官方短信提醒用户签署形式一样）
示例: https://essurl.cn/x9nvWU8fTg| | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链| | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl 示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd | |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景 跳转到腾讯电子签小程序的实现可以参考微信的官方文档:开放能力/打开 App 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 | |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方小程序直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景 跳转到腾讯电子签小程序的实现可以参考微信官方文档全屏方式和半屏方式 此时返回的SignUrl就是官方文档中的path 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 | |
DescribeBatchOrganizationRegistrationUrlsResponse |
EssbasicClient.DescribeBatchOrganizationRegistrationUrls(DescribeBatchOrganizationRegistrationUrlsRequest req)
此接口用于获取企业批量认证异步任务的状态及结果。
前提条件：已调用 CreateBatchOrganizationRegistrationTasks创建企业批量认证链接任务接口，并得到了任务Id。
异步任务的处理完成时间视当前已提交的任务量、任务的复杂程度等因素决定，正常情况下 3~5 秒即可完成，但也可能需要更长的时间
|
DescribeCancelFlowsTaskResponse |
EssbasicClient.DescribeCancelFlowsTask(DescribeCancelFlowsTaskRequest req)
通过接口[批量撤销合同流程](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelBatchCancelFlows)或者[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateBatchCancelFlowUrl)发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。
|
DescribeChannelFlowEvidenceReportResponse |
EssbasicClient.DescribeChannelFlowEvidenceReport(DescribeChannelFlowEvidenceReportRequest req)
获取出证报告任务执行结果，返回报告 URL。
注意：
- 使用此功能`需搭配出证套餐` ，使用前请联系对接的客户经理沟通。
- 需调用创建并返回出证报告接口提交申请出证报告任务获取报告编号后调用当前接口获取报告链接。
|
DescribeChannelOrganizationsResponse |
EssbasicClient.DescribeChannelOrganizations(DescribeChannelOrganizationsRequest req)
查询渠道子客企业信息时，可以支持单个子客和整个应用下所有子客的查询。返回的信息包括超管、法人的信息以及当前企业的认证状态等信息。
- 对于单个企业的查询，通过**指定子客的唯一标识**来查询该子客的企业信息
- 对于整个应用下所有企业的查询，**不需要指定子客的唯一标识**，直接查询整个应用下所有子客企业的企业信息
|
DescribeChannelSealPolicyWorkflowUrlResponse |
EssbasicClient.DescribeChannelSealPolicyWorkflowUrl(DescribeChannelSealPolicyWorkflowUrlRequest req)
制定渠道分支客户的印刷申请审批微型应用程序链接，链接模式（通过H5触发微型应用程序或通过APP跳转进行查看）。
此刻，代理参数中的OpenId 必须为审批者的openId，生成的链接必须由该用户启动，其他用户则无审批权限。
|
DescribeExtendedServiceAuthDetailResponse |
EssbasicClient.DescribeExtendedServiceAuthDetail(DescribeExtendedServiceAuthDetailRequest req)
查询企业扩展服务的授权详情（列表），当前支持查询以下内容：
1.
|
DescribeExtendedServiceAuthInfoResponse |
EssbasicClient.DescribeExtendedServiceAuthInfo(DescribeExtendedServiceAuthInfoRequest req)
查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
1.
|
DescribeFlowDetailInfoResponse |
EssbasicClient.DescribeFlowDetailInfo(DescribeFlowDetailInfoRequest req)
此接口用于查询合同或者合同组的详情信息，支持查询多个（数量不能超过100）。
适用场景：可用于主动查询某个合同或者合同组的详情信息。
注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
|
DescribeResourceUrlsByFlowsResponse |
EssbasicClient.DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req)
获取合同流程PDF的下载链接，可以下载签署中、签署完的此子企业创建的合同
注意**:
有两种开通权限的途径
第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
|
DescribeTemplatesResponse |
EssbasicClient.DescribeTemplates(DescribeTemplatesRequest req)
通过此接口（DescribeTemplates）查询该第三方平台子客企业在电子签拥有的有效模板，不包括第三方平台模板。
适用场景**
该接口常用来配合用模板创建签署流程和通过多模板创建合同组签署流程接口，作为创建合同的前置接口使用。
通过此接口查询到模板信息后，再通过调用创建合同的接口，指定模板ID，指定模板中需要的填写控件内容等，完成合同文档的创建。
模板的来源**
子客企业的模板有两种途径获取
- 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
- 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
一个模板通常会包含以下结构信息**
- 模板ID, 模板名字等基本信息
- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
- 发起方和签署方的填写控件 Components
- 签署方的签署控件 SignComponents
模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
注意**
>1.
|
DescribeUsageResponse |
EssbasicClient.DescribeUsage(DescribeUsageRequest req)
此接口（DescribeUsage）用于获取此应用下子客企业的合同消耗数量。
注: 此接口**每日限频50次**，若要扩大限制次数,请提前与客服经理或邮件至[email protected]进行联系。
|
GetDownloadFlowUrlResponse |
EssbasicClient.GetDownloadFlowUrl(GetDownloadFlowUrlRequest req)
此接口（GetDownloadFlowUrl）用户获取合同控制台下载页面链接, 点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图
注:
仅支持下载 本企业 下合同，链接会 登录企业控制台
链接仅可使用一次，不可重复使用
|
ModifyExtendedServiceResponse |
EssbasicClient.ModifyExtendedService(ModifyExtendedServiceRequest req)
管理企业扩展服务 ，企业经办人需要是企业超管或者法人。
跳转小程序的几种方式：主要是设置不同的EndPoint
1.
|
ModifyFlowDeadlineResponse |
EssbasicClient.ModifyFlowDeadline(ModifyFlowDeadlineRequest req)
在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度：
1.
|
OperateChannelTemplateResponse |
EssbasicClient.OperateChannelTemplate(OperateChannelTemplateRequest req)
此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业发布授权的查询和设置。
平台模板库中的模板的位置在控制台 企业应用管理 中下面的应用模板库管理目录, 可以参照下图位置
# 支持的操作
## 1.
|
PrepareFlowsResponse |
EssbasicClient.PrepareFlows(PrepareFlowsRequest req)
该接口 (PrepareFlows) 用于创建待发起文件
用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
目前该接口只支持B2C， **不建议使用，将会废弃**。
|
SyncProxyOrganizationResponse |
EssbasicClient.SyncProxyOrganization(SyncProxyOrganizationRequest req)
此接口（SyncProxyOrganization）用于同步第三方平台子客企业信息，包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等，便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。
注意：
- **需要在生成子客登录链接前同步的企业信息**, 否则会出现信息同步没有用的情形
- **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题
- **企业统一社会信用代码**: 对应上图中的**1**
- **第三方平台子客企业名称**: 对应上图中的**2**
- **企业法定代表人的名字**:对应上图中的**3**
- **企业详细住所**:对应上图中的**4**
|
SyncProxyOrganizationOperatorsResponse |
EssbasicClient.SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req)
此接口（SyncProxyOrganizationOperators）用于同步 第三方平台子客企业经办人列表，主要是同步经办人的离职状态。
子客Web控制台的组织架构管理，依赖于第三方应用平台的，无法在页面针对员工做新增/更新/离职等操作， 必须通过 API 来操作。
- **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用生成子客登录链接分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起。
- **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**。
注**:
- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
- 超管和法人无法通过此接口离职, 需要超管和法人将权限转移给其他人后才可通过此接口离职
- 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
UploadFilesResponse |
EssbasicClient.UploadFiles(UploadFilesRequest req)
此接口（UploadFiles）文件上传。
适用场景：用于合同，印章的文件上传。文件上传以后， 如果是PDF格式文件可配合用PDF文件创建签署流程接口进行合同流程的发起 如果是其他类型可以配合创建文件转换任务接口转换成PDF文件 注: 1. |
| Modifier and Type | Method and Description |
|---|---|
DescribeMaterialListResponse |
FacefusionClient.DescribeMaterialList(DescribeMaterialListRequest req)
通常通过腾讯云人脸融合的控制台可以查看到素材相关的参数数据，可以满足使用。本接口返回活动的素材数据，包括素材状态等。用于用户通过Api查看素材相关数据，方便使用。
|
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 |
|---|---|
DescribeMaterialListResponse |
FacefusionClient.DescribeMaterialList(DescribeMaterialListRequest req)
通常通过腾讯云人脸融合的控制台可以查看到素材相关的参数数据，可以满足使用。本接口返回活动的素材数据，包括素材状态等。用于用户通过Api查看素材相关数据，方便使用。
|
FuseFaceResponse |
FacefusionClient.FuseFace(FuseFaceRequest req)
本接口用于单脸、多脸、选脸融合，上传人脸图片，得到与素材模板融合后的人脸图片。支持为融合结果图添加标识。查看 融合接入指引。
请求频率限制为20次/秒。
>
- 公共参数中的签名方式必须指定为V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
| Modifier and Type | Method and Description |
|---|---|
BankCard2EVerificationResponse |
FaceidClient.BankCard2EVerification(BankCard2EVerificationRequest req)
本接口用于校验姓名和银行卡号的真实性和一致性。
|
BankCard4EVerificationResponse |
FaceidClient.BankCard4EVerification(BankCard4EVerificationRequest req)
本接口用于输入银行卡号、姓名、开户证件号、开户手机号，校验信息的真实性和一致性。
|
BankCardVerificationResponse |
FaceidClient.BankCardVerification(BankCardVerificationRequest req)
本接口用于银行卡号、姓名、开户证件号信息的真实性和一致性。
|
CheckBankCardInformationResponse |
FaceidClient.CheckBankCardInformation(CheckBankCardInformationRequest req)
银行卡基础信息查询
|
CheckEidTokenStatusResponse |
FaceidClient.CheckEidTokenStatus(CheckEidTokenStatusRequest req)
用于轮询E证通H5场景EidToken验证状态。
|
CheckIdCardInformationResponse |
FaceidClient.CheckIdCardInformation(CheckIdCardInformationRequest req)
传入身份证人像面照片，识别身份证照片上的信息，并将姓名、身份证号、身份证人像照片与权威库的证件照进行比对，是否属于同一个人，从而验证身份证信息的真实性。
|
CheckIdNameDateResponse |
FaceidClient.CheckIdNameDate(CheckIdNameDateRequest req)
本接口用于校验姓名、身份证号、身份证有效期的真实性和一致性。
|
CheckPhoneAndNameResponse |
FaceidClient.CheckPhoneAndName(CheckPhoneAndNameRequest req)
手机号二要素核验接口用于校验手机号和姓名的真实性和一致性，支持的手机号段详情请查阅运营商类文档。
|
DetectAIFakeFacesResponse |
FaceidClient.DetectAIFakeFaces(DetectAIFakeFacesRequest req)
提供对人脸图片/视频的AI合成、翻拍、水印等攻击痕迹的检测，增强图片/视频防伪能力
|
DetectAuthResponse |
FaceidClient.DetectAuth(DetectAuthRequest req)
每次调用人脸核身SaaS化服务前，需先调用本接口获取BizToken，用来串联核身流程，在验证完成后，用于获取验证结果信息。
|
EncryptedPhoneVerificationResponse |
FaceidClient.EncryptedPhoneVerification(EncryptedPhoneVerificationRequest req)
本接口用于校验手机号、姓名和身份证号的真实性和一致性，入参支持明文、MD5和SHA256加密传输。
|
GetActionSequenceResponse |
FaceidClient.GetActionSequence(GetActionSequenceRequest req)
使用动作活体检测模式前，需调用本接口获取动作顺序。
|
GetDetectInfoResponse |
FaceidClient.GetDetectInfo(GetDetectInfoRequest req)
完成验证后，用BizToken调用本接口获取结果信息，BizToken生成后三天内（3\*24\*3,600秒）可多次拉取。
|
GetDetectInfoEnhancedResponse |
FaceidClient.GetDetectInfoEnhanced(GetDetectInfoEnhancedRequest req)
完成验证后，用BizToken调用本接口获取结果信息，BizToken生成后三天内（3\*24\*3,600秒）可多次拉取。
|
GetEidResultResponse |
FaceidClient.GetEidResult(GetEidResultRequest req)
完成验证后，用EidToken调用本接口获取结果信息，EidToken生成后三天内（3\*24\*3,600秒）可多次拉取。
|
GetEidTokenResponse |
FaceidClient.GetEidToken(GetEidTokenRequest req)
每次调用E证通服务前，需先调用本接口获取EidToken，用来串联E证通流程，在验证完成后，用于获取E证通结果信息。
|
GetFaceIdResultResponse |
FaceidClient.GetFaceIdResult(GetFaceIdResultRequest req)
完成验证后，用FaceIdToken调用本接口获取结果信息，FaceIdToken生成后三天内（3\*24\*3,600秒）可多次拉取。
|
GetFaceIdRiskInfoResponse |
FaceidClient.GetFaceIdRiskInfo(GetFaceIdRiskInfoRequest req)
完成验证后，用FaceIdToken调用本接口获取设备风险相关信息，FaceIdToken生成后三天内（3\*24\*3,600秒）可多次拉取。
|
GetFaceidRiskInfoTokenResponse |
FaceidClient.GetFaceidRiskInfoToken(GetFaceidRiskInfoTokenRequest req)
每次调用人脸核身SDK服务前，需先调用本接口获取SDKToken，用来串联核身流程，在验证完成后，用于获取风险结果信息，该Token仅能核身一次。
|
GetFaceIdTokenResponse |
FaceidClient.GetFaceIdToken(GetFaceIdTokenRequest req)
每次调用人脸核身SDK服务前，需先调用本接口获取SDKToken，用来串联核身流程，在验证完成后，用于获取验证结果信息，该token仅能核身一次。
|
GetLiveCodeResponse |
FaceidClient.GetLiveCode(GetLiveCodeRequest req)
使用数字活体检测模式前，需调用本接口获取数字验证码。
|
GetWeChatBillDetailsResponse |
FaceidClient.GetWeChatBillDetails(GetWeChatBillDetailsRequest req)
查询微信渠道服务（微信小程序、微信原生H5、微信普通H5）的账单明细及计费状态。
|
IdCardOCRVerificationResponse |
FaceidClient.IdCardOCRVerification(IdCardOCRVerificationRequest req)
本接口用于校验姓名和身份证号的真实性和一致性，您可以通过输入姓名和身份证号或传入身份证人像面照片提供所需验证信息。
|
IdCardVerificationResponse |
FaceidClient.IdCardVerification(IdCardVerificationRequest req)
传入姓名和身份证号，校验两者的真实性和一致性。
|
ImageRecognitionResponse |
FaceidClient.ImageRecognition(ImageRecognitionRequest req)
传入照片和身份信息，判断该照片与权威库的证件照是否属于同一个人。
|
ImageRecognitionV2Response |
FaceidClient.ImageRecognitionV2(ImageRecognitionV2Request req)
传入照片和身份信息，判断该照片与权威库的证件照是否属于同一个人。
|
LivenessResponse |
FaceidClient.Liveness(LivenessRequest req)
活体检测
|
LivenessCompareResponse |
FaceidClient.LivenessCompare(LivenessCompareRequest req)
传入视频和照片，先判断视频中是否为真人，判断为真人后，再判断该视频中的人与上传照片是否属于同一个人。
|
LivenessRecognitionResponse |
FaceidClient.LivenessRecognition(LivenessRecognitionRequest req)
传入视频和身份信息，先判断视频中是否为真人，判断为真人后，再判断该视频中的人与权威库的证件照是否属于同一个人。
|
MinorsVerificationResponse |
FaceidClient.MinorsVerification(MinorsVerificationRequest req)
通过传入手机号或姓名和身份证号，结合权威数据源和腾讯健康守护可信模型，判断该信息是否真实且年满18周岁。腾讯健康守护可信模型覆盖了上十亿手机库源，覆盖率高、准确率高，如果不在库中的手机号，还可以通过姓名+身份证进行兜底验证。
|
MobileNetworkTimeVerificationResponse |
FaceidClient.MobileNetworkTimeVerification(MobileNetworkTimeVerificationRequest req)
本接口用于查询手机号在网时长，输入手机号进行查询。
|
MobileStatusResponse |
FaceidClient.MobileStatus(MobileStatusRequest req)
本接口用于验证手机号的状态，您可以输入手机号进行查询。
|
ParseNfcDataResponse |
FaceidClient.ParseNfcData(ParseNfcDataRequest req)
解析SDK获取到的证件NFC数据，接口传入SDK返回的ReqId，返回证件信息（个别字段为特定证件类型特有）。SDK生成的ReqId五分钟内有效，重复查询仅收一次费。支持身份证类证件（二代身份证、港澳居住证、台湾居住证、外国人永居证）以及旅行类证件（港澳通行证、台湾通行证、台胞证、回乡证）的NFC识别及核验。
|
PhoneVerificationResponse |
FaceidClient.PhoneVerification(PhoneVerificationRequest req)
本接口用于校验手机号、姓名和身份证号的真实性和一致性。支持的手机号段详情请查阅运营商类文档。
|
PhoneVerificationCMCCResponse |
FaceidClient.PhoneVerificationCMCC(PhoneVerificationCMCCRequest req)
本接口用于校验中国移动手机号、姓名和身份证号的真实性和一致性。中国移动支持的手机号段详情请查阅运营商类文档。
|
PhoneVerificationCTCCResponse |
FaceidClient.PhoneVerificationCTCC(PhoneVerificationCTCCRequest req)
本接口用于校验中国电信手机号、姓名和身份证号的真实性和一致性。中国电信支持的手机号段详情请查阅运营商类文档。
|
PhoneVerificationCUCCResponse |
FaceidClient.PhoneVerificationCUCC(PhoneVerificationCUCCRequest req)
本接口用于校验中国联通手机号、姓名和身份证号的真实性和一致性。中国联通支持的手机号段详情请查阅运营商类文档。
|
| Modifier and Type | Method and Description |
|---|---|
BeautifyPicResponse |
FmuClient.BeautifyPic(BeautifyPicRequest req)
用户上传一张人脸图片（最多能处理一张图片中最大的五张人脸信息），精准定位五官，实现美肤、亮肤、祛痘等美颜功能。
|
BeautifyVideoResponse |
FmuClient.BeautifyVideo(BeautifyVideoRequest req)
视频美颜(此接口目前已下线)
|
CancelBeautifyVideoJobResponse |
FmuClient.CancelBeautifyVideoJob(CancelBeautifyVideoJobRequest req)
撤销视频美颜任务请求
|
CreateModelResponse |
FmuClient.CreateModel(CreateModelRequest req)
在使用LUT素材的modelid实现试唇色前，您需要先上传 LUT 格式的cube文件注册唇色ID。查看 [LUT文件的使用说明](https://cloud.tencent.com/document/product/1172/41701)。
注：您也可以直接使用 [试唇色接口](https://cloud.tencent.com/document/product/1172/40706)，通过输入RGBA模型数值的方式指定唇色，更简单易用。
|
DeleteModelResponse |
FmuClient.DeleteModel(DeleteModelRequest req)
删除已注册的唇色素材。
|
GetModelListResponse |
FmuClient.GetModelList(GetModelListRequest req)
查询已注册的唇色素材。
|
QueryBeautifyVideoJobResponse |
FmuClient.QueryBeautifyVideoJob(QueryBeautifyVideoJobRequest req)
查询视频美颜处理进度
|
StyleImageResponse |
FmuClient.StyleImage(StyleImageRequest req)
上传一张照片，输出滤镜处理后的图片。
|
StyleImageProResponse |
FmuClient.StyleImagePro(StyleImageProRequest req)
上传一张照片，输出滤镜处理后的图片。
|
TryLipstickPicResponse |
FmuClient.TryLipstickPic(TryLipstickPicRequest req)
对图片中的人脸嘴唇进行着色，最多支持同时对一张图中的3张人脸进行试唇色。
您可以通过事先注册在腾讯云的唇色素材（LUT文件）改变图片中的人脸唇色，也可以输入RGBA模型数值。
为了更好的效果，建议您使用事先注册在腾讯云的唇色素材（LUT文件）。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
| Modifier and Type | Method and Description |
|---|---|
CancelFaceMorphJobResponse |
FtClient.CancelFaceMorphJob(CancelFaceMorphJobRequest req)
撤销人像渐变任务请求
|
ChangeAgePicResponse |
FtClient.ChangeAgePic(ChangeAgePicRequest req)
用户上传一张人脸图片，基于人脸编辑与生成算法，输出一张人脸变老或变年轻的图片，支持实现人脸不同年龄的变化。
|
FaceCartoonPicResponse |
FtClient.FaceCartoonPic(FaceCartoonPicRequest req)
输入一张人脸照片，生成个性化的二次元动漫形象，可用于打造个性头像、趣味活动、特效类应用等场景，提升社交娱乐的体验。
|
MorphFaceResponse |
FtClient.MorphFace(MorphFaceRequest req)
输入2-5张人脸照片，生成一段以人脸为焦点的渐变视频或GIF图，支持自定义图片播放速度、视频每秒传输帧数，可用于短视频、表情包、创意H5等应用场景，丰富静态图片的玩法。
|
QueryFaceMorphJobResponse |
FtClient.QueryFaceMorphJob(QueryFaceMorphJobRequest req)
查询人像渐变处理进度
|
SwapGenderPicResponse |
FtClient.SwapGenderPic(SwapGenderPicRequest req)
用户上传一张人脸图片，基于人脸编辑与生成算法，输出一张人脸性别转换的图片。男变女可实现美颜、淡妆、加刘海和长发的效果；女变男可实现加胡须、变短发的效果。
|
| Modifier and Type | Method and Description |
|---|---|
CreateAgeDetectTaskResponse |
GmeClient.CreateAgeDetectTask(CreateAgeDetectTaskRequest req)
目前该功能底层能力已不具备，不对外提供，目前需要下线，走预下线流程。
用于创建年龄语音识别任务的接口，请求频率10次/秒。该接口目前通过白名单开放试用，如有需求，请提交工单申请。
|
CreateAppResponse |
GmeClient.CreateApp(CreateAppRequest req)
本接口(CreateApp)用于创建一个GME应用。
|
CreateCustomizationResponse |
GmeClient.CreateCustomization(CreateCustomizationRequest req)
用户使用该接口可以创建语音消息转文本热句模型，以供识别调用
|
CreateScanUserResponse |
GmeClient.CreateScanUser(CreateScanUserRequest req)
新增自定义送检用户。**接口使用前提**：目前 CreateScanUser 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。
|
DeleteCustomizationResponse |
GmeClient.DeleteCustomization(DeleteCustomizationRequest req)
用户通过该接口可以删除语音消息转文本热句模型
|
DeleteRoomMemberResponse |
GmeClient.DeleteRoomMember(DeleteRoomMemberRequest req)
本接口(DeleteRoomMember)用户删除房间或者剔除房间内用户
|
DeleteScanUserResponse |
GmeClient.DeleteScanUser(DeleteScanUserRequest req)
删除自定义送检用户。**接口使用前提**：目前 DeleteScanUser 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。
|
DescribeAgeDetectTaskResponse |
GmeClient.DescribeAgeDetectTask(DescribeAgeDetectTaskRequest req)
目前该功能底层能力已不具备，不对外提供，目前需要下线，走预下线流程。
查询年龄语音识别任务结果，请求频率10次/秒。该接口目前通过白名单开放试用，如有需求，请提交工单申请。
|
DescribeApplicationDataResponse |
GmeClient.DescribeApplicationData(DescribeApplicationDataRequest req)
本接口(DescribeApplicationData)用于获取数据详情信息，最多可拉取最近90天的数据。
|
DescribeApplicationListResponse |
GmeClient.DescribeApplicationList(DescribeApplicationListRequest req)
本接口(DescribeApplicationList)用于查询自己账号下的应用列表
|
DescribeAppStatisticsResponse |
GmeClient.DescribeAppStatistics(DescribeAppStatisticsRequest req)
本接口(DescribeAppStatistics)用于获取某个GME应用的用量数据。包括实时语音，语音消息及转文本，语音分析等。最长查询周期为最近60天。
|
DescribeRealtimeScanConfigResponse |
GmeClient.DescribeRealtimeScanConfig(DescribeRealtimeScanConfigRequest req)
获取用户自定义送检信息。**接口使用前提**：目前 DescribeRealtimeScanConfig 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。
|
DescribeRecordInfoResponse |
GmeClient.DescribeRecordInfo(DescribeRecordInfoRequest req)
查询录制任务信息。
|
DescribeRoomInfoResponse |
GmeClient.DescribeRoomInfo(DescribeRoomInfoRequest req)
获取房间内用户信息
|
DescribeScanResultListResponse |
GmeClient.DescribeScanResultList(DescribeScanResultListRequest req)
本接口(DescribeScanResultList)用于查询语音检测结果，查询任务列表最多支持100个。
如果在提交语音检测任务时未设置 Callback 字段，则需要通过本接口获取检测结果 |
DescribeTaskInfoResponse |
GmeClient.DescribeTaskInfo(DescribeTaskInfoRequest req)
查询房间录制的详细信息
|
DescribeUserInAndOutTimeResponse |
GmeClient.DescribeUserInAndOutTime(DescribeUserInAndOutTimeRequest req)
拉取用户在房间得进出时间
|
GetCustomizationListResponse |
GmeClient.GetCustomizationList(GetCustomizationListRequest req)
查询语音消息转文本热句模型列表
|
ModifyAppStatusResponse |
GmeClient.ModifyAppStatus(ModifyAppStatusRequest req)
本接口(ModifyAppStatus)用于修改应用总开关状态。
|
ModifyCustomizationResponse |
GmeClient.ModifyCustomization(ModifyCustomizationRequest req)
用户通过该接口可以更新语音消息转文本热句模型。
|
ModifyCustomizationStateResponse |
GmeClient.ModifyCustomizationState(ModifyCustomizationStateRequest req)
通过该接口，用户可以修改语音消息转文本热句模型状态，上下线热句模型
|
ModifyRecordInfoResponse |
GmeClient.ModifyRecordInfo(ModifyRecordInfoRequest req)
修改录制配置信息
|
ModifyUserMicStatusResponse |
GmeClient.ModifyUserMicStatus(ModifyUserMicStatusRequest req)
接口作用**：此接口用于修改房间用户的麦克风状态，例如房间内用户麦克风为打开状态，可调用此接口将该用户麦克风进行关闭，关闭后即使该用户使用客户端接口 EnableMic 打开麦克风，依然无法与房间内成员通话，属于被禁言状态。该状态持续到此用户退房后失效，或者调用该接口重新打开此用户麦克风状态。
接口应用场景**：此接口多用于游戏业务中台或者风控后台，对一些发表不当言论的玩家进行禁言处理。
接口使用前提**：目前 ModifyUserMicStatus 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。
|
ScanVoiceResponse |
GmeClient.ScanVoice(ScanVoiceRequest req)
本接口(ScanVoice)用于提交语音检测任务，检测任务列表最多支持100个。使用前请您登录[控制台 - 服务配置](https://console.cloud.tencent.com/gamegme/conf)开启语音内容安全服务。
|
StartRecordResponse |
GmeClient.StartRecord(StartRecordRequest req)
开启录制
|
StopRecordResponse |
GmeClient.StopRecord(StopRecordRequest req)
停止录制
|
UpdateScanRoomsResponse |
GmeClient.UpdateScanRooms(UpdateScanRoomsRequest req)
更新自定义送检房间号。**接口使用前提**：目前 UpdateScanRooms 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。
|
UpdateScanUsersResponse |
GmeClient.UpdateScanUsers(UpdateScanUsersRequest req)
更新自定义送检用户号。
接口使用前提**：目前 UpdateScanUsers 接口通过白名单开放，如需使用，需要 [提交工单申请](https://console.cloud.tencent.com/workorder/category?level1_id=438&level2_id=445&source=0&data_title=%E6%B8%B8%E6%88%8F%E5%A4%9A%E5%AA%92%E4%BD%93%E5%BC%95%E6%93%8EGME&step=1)。
|
| Modifier and Type | Method and Description |
|---|---|
CancelMatchingResponse |
GpmClient.CancelMatching(CancelMatchingRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
取消匹配。
|
CreateMatchResponse |
GpmClient.CreateMatch(CreateMatchRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
创建匹配
|
CreateRuleResponse |
GpmClient.CreateRule(CreateRuleRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
创建规则
|
DeleteMatchResponse |
GpmClient.DeleteMatch(DeleteMatchRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
删除匹配
|
DeleteRuleResponse |
GpmClient.DeleteRule(DeleteRuleRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
删除规则
|
DescribeDataResponse |
GpmClient.DescribeData(DescribeDataRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
统计数据
|
DescribeMatchResponse |
GpmClient.DescribeMatch(DescribeMatchRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
查询匹配详情
|
DescribeMatchCodesResponse |
GpmClient.DescribeMatchCodes(DescribeMatchCodesRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
分页查询匹配Code
|
DescribeMatchesResponse |
GpmClient.DescribeMatches(DescribeMatchesRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
分页查询匹配列表
|
DescribeMatchingProgressResponse |
GpmClient.DescribeMatchingProgress(DescribeMatchingProgressRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
查询匹配进度。
|
DescribeRuleResponse |
GpmClient.DescribeRule(DescribeRuleRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
查询规则详情
|
DescribeRulesResponse |
GpmClient.DescribeRules(DescribeRulesRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
分页查询规则集列表
|
DescribeTokenResponse |
GpmClient.DescribeToken(DescribeTokenRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
查询匹配Token，Token用于push消息验证。
|
ModifyMatchResponse |
GpmClient.ModifyMatch(ModifyMatchRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
修改匹配
|
ModifyRuleResponse |
GpmClient.ModifyRule(ModifyRuleRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
修改规则（描述、标签）
|
ModifyTokenResponse |
GpmClient.ModifyToken(ModifyTokenRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
修改匹配Token。
|
StartMatchingResponse |
GpmClient.StartMatching(StartMatchingRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
支持传入一个玩家或多个玩家发起匹配，在同一个请求内的玩家将被分到同一个对局。
|
StartMatchingBackfillResponse |
GpmClient.StartMatchingBackfill(StartMatchingBackfillRequest req)
此接口无法使用，游戏玩家匹配GPM已于6.1正式下架，感谢您的支持
通过调用StartMatchingBackfill，用户可以传入一个回填的匹配请求，GPM为回填请求搜索符合条件的ticket并形成一个新的match。
|
| Modifier and Type | Method and Description |
|---|---|
CreateSessionResponse |
GsClient.CreateSession(CreateSessionRequest req)
创建会话
|
DescribeInstancesCountResponse |
GsClient.DescribeInstancesCount(DescribeInstancesCountRequest req)
获取并发总数和运行数
|
SaveGameArchiveResponse |
GsClient.SaveGameArchive(SaveGameArchiveRequest req)
保存游戏存档
|
StartPublishStreamResponse |
GsClient.StartPublishStream(StartPublishStreamRequest req)
开始云端推流
|
StopGameResponse |
GsClient.StopGame(StopGameRequest req)
强制退出游戏
|
StopPublishStreamResponse |
GsClient.StopPublishStream(StopPublishStreamRequest req)
停止云端推流
|
SwitchGameArchiveResponse |
GsClient.SwitchGameArchive(SwitchGameArchiveRequest req)
切换游戏存档
|
TrylockWorkerResponse |
GsClient.TrylockWorker(TrylockWorkerRequest req)
尝试锁定机器
|
| Modifier and Type | Method and Description |
|---|---|
AttachCcnInstancesResponse |
GseClient.AttachCcnInstances(AttachCcnInstancesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（AttachCcnInstances）用于关联云联网实例。
|
CopyFleetResponse |
GseClient.CopyFleet(CopyFleetRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（CopyFleet）用于复制服务器舰队。
|
CreateAliasResponse |
GseClient.CreateAlias(CreateAliasRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（CreateAlias）用于创建别名。
|
CreateAssetResponse |
GseClient.CreateAsset(CreateAssetRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（CreateAsset）用于创建生成包。
通过获取上传cos的临时密钥，将文件上传至cos，然后将生成包的zip名称下发给本接口完成资源创建。
上传文件至 cos支持俩种方式：
- 获取预签名方式，COS 简单上传
1.
|
CreateAssetWithImageResponse |
GseClient.CreateAssetWithImage(CreateAssetWithImageRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（CreateAssetWithImage）用于创建生成包镜像信息。
|
CreateFleetResponse |
GseClient.CreateFleet(CreateFleetRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（CreateFleet）用于创建服务器舰队。
|
CreateGameServerSessionResponse |
GseClient.CreateGameServerSession(CreateGameServerSessionRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（CreateGameServerSession）用于创建游戏服务会话。
|
CreateGameServerSessionQueueResponse |
GseClient.CreateGameServerSessionQueue(CreateGameServerSessionQueueRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（CreateGameServerSessionQueue）用于创建游戏服务器会话队列。
|
DeleteAliasResponse |
GseClient.DeleteAlias(DeleteAliasRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DeleteAlias）用于删除别名。
|
DeleteAssetResponse |
GseClient.DeleteAsset(DeleteAssetRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DeleteAsset）用于删除生成包。
|
DeleteFleetResponse |
GseClient.DeleteFleet(DeleteFleetRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DeleteFleet）用于删除服务器舰队。
|
DeleteGameServerSessionQueueResponse |
GseClient.DeleteGameServerSessionQueue(DeleteGameServerSessionQueueRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DeleteGameServerSessionQueue）用于删除游戏服务器会话队列。
|
DeleteScalingPolicyResponse |
GseClient.DeleteScalingPolicy(DeleteScalingPolicyRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DeleteScalingPolicy）用于删除服务器舰队的扩缩容策略。
通过服务器舰队ID和策略名称删除服务器舰队的扩缩容策略，只传递服务器舰队ID时，会将这个服务器舰队下的所有策略都删除。
传递策略名称时，单独删除策略名称对应的策略。
|
DeleteTimerScalingPolicyResponse |
GseClient.DeleteTimerScalingPolicy(DeleteTimerScalingPolicyRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DeleteTimerScalingPolicy）用于删除fleet下的定时器。
|
DescribeAliasResponse |
GseClient.DescribeAlias(DescribeAliasRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeAlias）用于获取别名详情。
|
DescribeAssetResponse |
GseClient.DescribeAsset(DescribeAssetRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeAsset）获取生成包信息。
|
DescribeAssetsResponse |
GseClient.DescribeAssets(DescribeAssetsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeAssets）用于获取生成包列表。
|
DescribeAssetSystemsResponse |
GseClient.DescribeAssetSystems(DescribeAssetSystemsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeAssetSystems）用于获取生成包支持的操作系统。
|
DescribeCcnInstancesResponse |
GseClient.DescribeCcnInstances(DescribeCcnInstancesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeCcnInstances）用于查询云联网实例。
|
DescribeFleetAttributesResponse |
GseClient.DescribeFleetAttributes(DescribeFleetAttributesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetAttributes）用于查询服务器舰队属性。
|
DescribeFleetCapacityResponse |
GseClient.DescribeFleetCapacity(DescribeFleetCapacityRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetCapacity）用于查询服务部署容量配置。
|
DescribeFleetEventsResponse |
GseClient.DescribeFleetEvents(DescribeFleetEventsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetEvents）用于查询服务器舰队相关的事件列表。
|
DescribeFleetPortSettingsResponse |
GseClient.DescribeFleetPortSettings(DescribeFleetPortSettingsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetPortSettings）用于获取服务器舰队安全组信息。
|
DescribeFleetRelatedResourcesResponse |
GseClient.DescribeFleetRelatedResources(DescribeFleetRelatedResourcesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetRelatedResources）用于获取与游戏服务器舰队关联的资源信息，如别名、队列
|
DescribeFleetStatisticDetailsResponse |
GseClient.DescribeFleetStatisticDetails(DescribeFleetStatisticDetailsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetStatisticDetails）用于查询服务部署统计详情。
|
DescribeFleetStatisticFlowsResponse |
GseClient.DescribeFleetStatisticFlows(DescribeFleetStatisticFlowsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetStatisticFlows）用于查询服务部署统计用量。
|
DescribeFleetStatisticSummaryResponse |
GseClient.DescribeFleetStatisticSummary(DescribeFleetStatisticSummaryRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetStatisticSummary）用于查询服务部署统计汇总信息。
|
DescribeFleetUtilizationResponse |
GseClient.DescribeFleetUtilization(DescribeFleetUtilizationRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeFleetUtilization）用于查询服务器舰队的利用率信息。
|
DescribeGameServerSessionDetailsResponse |
GseClient.DescribeGameServerSessionDetails(DescribeGameServerSessionDetailsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeGameServerSessionDetails）用于查询游戏服务器会话详情列表。
|
DescribeGameServerSessionPlacementResponse |
GseClient.DescribeGameServerSessionPlacement(DescribeGameServerSessionPlacementRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeGameServerSessionPlacement）用于查询游戏服务器会话的放置。
|
DescribeGameServerSessionQueuesResponse |
GseClient.DescribeGameServerSessionQueues(DescribeGameServerSessionQueuesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeGameServerSessionQueues）用于查询游戏服务器会话队列。
|
DescribeGameServerSessionsResponse |
GseClient.DescribeGameServerSessions(DescribeGameServerSessionsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeGameServerSessions）用于查询游戏服务器会话列表。
|
DescribeInstanceLimitResponse |
GseClient.DescribeInstanceLimit(DescribeInstanceLimitRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeInstanceLimit）用于查询用户实例数限额。
|
DescribeInstancesResponse |
GseClient.DescribeInstances(DescribeInstancesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeInstances）用于查询服务器实例列表。
|
DescribeInstancesExtendResponse |
GseClient.DescribeInstancesExtend(DescribeInstancesExtendRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeInstancesExtend）用于查询实例扩展信息列表。
|
DescribeInstanceTypesResponse |
GseClient.DescribeInstanceTypes(DescribeInstanceTypesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeInstanceTypes）用于获取服务器实例类型列表。
|
DescribePlayerSessionsResponse |
GseClient.DescribePlayerSessions(DescribePlayerSessionsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribePlayerSessions）用于获取玩家会话列表。
|
DescribeRuntimeConfigurationResponse |
GseClient.DescribeRuntimeConfiguration(DescribeRuntimeConfigurationRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeRuntimeConfiguration）用于获取服务器舰队运行配置。
|
DescribeScalingPoliciesResponse |
GseClient.DescribeScalingPolicies(DescribeScalingPoliciesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeScalingPolicies）用于查询服务器舰队的动态扩缩容策略列表。
|
DescribeTimerScalingPoliciesResponse |
GseClient.DescribeTimerScalingPolicies(DescribeTimerScalingPoliciesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeTimerScalingPolicies）用于查询fleet下的定时器列表。可以通过fleetid，定时器名称分页查询。
|
DescribeUserQuotaResponse |
GseClient.DescribeUserQuota(DescribeUserQuotaRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeUserQuota）获取用户单个模块配额。
|
DescribeUserQuotasResponse |
GseClient.DescribeUserQuotas(DescribeUserQuotasRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DescribeUserQuotas）用于获取用户配额
|
DetachCcnInstancesResponse |
GseClient.DetachCcnInstances(DetachCcnInstancesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（DetachCcnInstances）用于解关联云联网实例。
|
EndGameServerSessionAndProcessResponse |
GseClient.EndGameServerSessionAndProcess(EndGameServerSessionAndProcessRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（EndGameServerSessionAndProcess）用于终止游戏服务器会话和对应的进程，适用于时限保护和不保护。
|
GetGameServerInstanceLogUrlResponse |
GseClient.GetGameServerInstanceLogUrl(GetGameServerInstanceLogUrlRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口用于获取游戏服务器实例的日志URL。
|
GetGameServerSessionLogUrlResponse |
GseClient.GetGameServerSessionLogUrl(GetGameServerSessionLogUrlRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（GetGameServerSessionLogUrl）用于获取游戏服务器会话的日志URL。
|
GetInstanceAccessResponse |
GseClient.GetInstanceAccess(GetInstanceAccessRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（GetInstanceAccess）用于获取实例登录所需要的凭据。
|
GetUploadCredentialsResponse |
GseClient.GetUploadCredentials(GetUploadCredentialsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（GetUploadCredentials）获取上传文件授权信息。
通过 [GetUploadCredentials](https://cloud.tencent.com/document/product/1165/48727) 接口获取临时授权信息后，调用 COS API将数据上传，根据上传的 BucketKey 信息进行生成包 [CreateAsset](https://cloud.tencent.com/document/product/1165/48731) 的创建。参考下面的示例部分。
|
GetUploadFederationTokenResponse |
GseClient.GetUploadFederationToken(GetUploadFederationTokenRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（GetUploadFederationToken）用于 获取生成包上传所需要的临时密钥。
|
JoinGameServerSessionResponse |
GseClient.JoinGameServerSession(JoinGameServerSessionRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（JoinGameServerSession）用于加入游戏服务器会话。
|
JoinGameServerSessionBatchResponse |
GseClient.JoinGameServerSessionBatch(JoinGameServerSessionBatchRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（JoinGameServerSessionBatch）用于批量加入游戏服务器会话。
|
ListAliasesResponse |
GseClient.ListAliases(ListAliasesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（ListAliases）用于检索帐户下的所有别名。
|
ListFleetsResponse |
GseClient.ListFleets(ListFleetsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（ListFleets）用于获取服务器舰队列表。
|
PutScalingPolicyResponse |
GseClient.PutScalingPolicy(PutScalingPolicyRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（PutScalingPolicy）用于设置服务器舰队的动态扩缩容策略。
通过此接口可以增加或者更新服务器舰队的扩缩容策略。
服务器舰队可以有多个扩缩容策略，但是只有一个TargetBased基于目标的策略。
## TargetBased基于目标的策略
TargetBased策略计算的指标是PercentAvailableGameSessions，这个策略用于计算当前服务器舰队应该有多少个CVM实例来支撑和分配游戏会话。
PercentAvailableGameSessions表示服务器舰队的缓冲值；用来计算服务器舰队在当前容量下可以处理的额外玩家会话数量。
如果使用基于目标的策略，可以按照业务需求设置一个期望的缓冲区大小，GSE的会按照配置的策略来扩容和缩容到这个目标要求的CVM实例数。
例如：客户可以设置同时承载100个游戏会话的服务器舰队预留10%的缓冲区。GSE会按照这个策略执行时，若服务器舰队的可用容量低于或高于10%的游戏服务器会话时，执行扩缩容动作。
GSE按照策略期望，扩容新CVM实例或缩容未使用的实例，保持在10%左右的缓冲区。
#### 请求参数取值说明
```
Name取值策略名称，
FleetId取值为选择的服务器舰队ID，
PolicyType取值TargetBased，
MetricName取值PercentAvailableGameSessions，
TargetConfiguration取值为所需的缓冲区值对象，
其他参数不用传递。
请求成功时，将返回策略名称。扩缩容策略在成功创建立即自动生效。
```
## RuleBased基于规则的策略
#### 请求参数取值说明
```
Name取值策略名称，
FleetId取值为选择的服务器舰队ID，
PolicyType取值RuleBased，
MetricName取值（AvailableGameServerSessions，AvailableCustomCount，PercentAvailableCustomCount，ActiveInstances，IdleInstances，CurrentPlayerSessions和PercentIdleInstances）说明见备注1，
其他参数不用传递。
ComparisonOperator取值为 >,>=,<,<=这4个比较符号中的一个，
Threshold取值为指标MetricName达到的阈值是多少，
EvaluationPeriods取值为指标MetricName达到的阈值持续了多少时间，单位是分钟，
ScalingAdjustmentType取值（ChangeInCapacity，ExactCapacity，PercentChangeInCapacity）说明见备注2
ScalingAdjustment取值为指标MetricName达到的阈值的条件后，扩缩容多少个CVM实例。
请求成功时，将返回策略名称。扩缩容策略在成功创建立即自动生效。
```
规则执行的条件表达式如下所示：
```
若 [MetricName] 是 [ComparisonOperator] [Threshold] 持续 [EvaluationPeriods] 分钟, 则 [ScalingAdjustmentType] 调整 [ScalingAdjustment]个实例。
```
```
if [MetricName] ComparisonOperator [Threshold] for [EvaluationPeriods] minutes, then scaling up by/to [ScalingAdjustment]
```
例如1：如果当前AvailableCustomCount值大于等于10，持续5分钟，扩容1台CVM实例。
```
ScalingAdjustmentType = ChangeInCapacity
if [AvailableGameServerSessions] >= [10] for [5] minutes, then scaling up [1]
```
例如2：如果当前AvailableGameServerSessions值大于等于200，持续5分钟，扩容到2台CVM实例。
```
ScalingAdjustmentType = ExactCapacity
if [AvailableGameServerSessions] >= [200] for [5] minutes, then scaling to [2]
```
例如3：如果当前AvailableCustomCount值大于等于400，持续5分钟，扩容20%台CVM实例。
当前CVM实例数为10台。扩容20%台CVM实例就是增加 10*20%等于2台
```
ScalingAdjustmentType = PercentChangeInCapacity
if [AvailableGameServerSessions] >= [400] for [5] minutes, then scaling by [currentCVMCount * 20 %]
```
备注1**
- | 策略名称（MetricName） | 计算公式 | 场景 | 场景使用举例 |
| :----------------------------------------------------------- | :----------------------------------------- | :------------------------------------------ | :----------------------------------------------------------- |
| CurrentPlayerSessions
当前玩家数指标 | = 当前在线的玩家数 | CVM随着玩家会话数变化做扩缩容。 | 例如： MetricName: CurrentPlayerSessions ComparisonOperator: '<=' Threshold: 300 EvaluationPeriods: 1 ScalingAdjustment: 2 ScalingAdjustment: ChangeInCapacity 说明：若当前CurrentPlayerSessions小于等于300，持续1分钟，则扩容2台CVM。 | | AvailableGameServerSessions 可用游戏服务器会话数 | = 可用游戏服务会话数 | CVM随着可用游戏会话数变化做扩缩容。 | 例如： MetricName: AvailableGameServerSessions ComparisonOperator: '<' Threshold: 50 EvaluationPeriods: 5 ScalingAdjustment: 2 ScalingAdjustment: ExactCapacity 说明：若当前AvailableGameServerSessions小于50，持续5分钟，则扩容到2台CVM。 | | PercentAvailableGameServerSessions 可用游戏服务器会话百分比 | = 空闲游戏会话数 / 所有的游戏会话数 * 100% | CVM随着可用游戏会话数百分比变化做扩缩容。 | 例如： MetricName: PercentAvailableGameServerSessions ComparisonOperator: '<' Threshold: 50 EvaluationPeriods: 1 ScalingAdjustment: -30 ScalingAdjustment: PercentChangeInCapacity 说明：若当前PercentAvailableGameServerSessions小于50%，持续1分钟，则缩容当前实例数30%台CVM。 | | AvailableCustomCount 可用客户自定义数指标 | = 客户自定义的数 | CVM随着可用客户自定义数变化做扩缩容。 | 例如： MetricName: AvailableCustomCount ComparisonOperator: '>=' Threshold: 6 EvaluationPeriods: 3 ScalingAdjustment: -1 ScalingAdjustment: ExactCapacity 说明：若当前AvailableCustomCount大于等于6，持续3分钟，则缩容到1台CVM。 | | PercentAvailableCustomCount 可用客户自定义数百分比 | = 客户自定义数 / 客户最大自定义数* 100% | CVM随着可用客户自定义数百分比变化做扩缩容。 | 例如： MetricName: PercentAvailableCustomCount ComparisonOperator: '<' Threshold: 15 EvaluationPeriods: 3 ScalingAdjustment: 1 ScalingAdjustment: ChangeInCapacity 说明：若当前PercentAvailableCustomCount小于15%，持续3分钟，则扩容1台CVM。 | | ActiveInstances 活跃实例数指标 | = 总实例数 - 缩容中的实例数 | CVM随着活跃实例数变化做扩缩容。 | 例如： MetricName: ActiveInstances ComparisonOperator: '<' Threshold: 3 EvaluationPeriods: 1 ScalingAdjustment: 3 ScalingAdjustment: ExactCapacity 说明：若当前ActiveInstances小于3台，持续1分钟，则扩容保留到3台CVM。 | | IdleInstances 空闲实例数指标 | = 未使用的进程数 / 每实例进程数 | CVM随着空闲实例数变化做扩缩容。 | 例如： MetricName: IdleInstances ComparisonOperator: '<' Threshold: 2 EvaluationPeriods: 3 ScalingAdjustment: 1 ScalingAdjustment: ChangeInCapacity 说明：若当前IdleInstances小于2台，持续3分钟，则扩容1台CVM。 | | PercentIdleInstances 空闲实例百分比 | = IdleInstances / ActiveInstances * 100% | CVM随着空闲实例百分比变化做扩缩容。 | 例如： MetricName: PercentIdleInstances ComparisonOperator: '<' Threshold: 50 EvaluationPeriods: 3 ScalingAdjustment: 1 ScalingAdjustment: ChangeInCapacity 说明：若当前PercentIdleInstances小于50%，持续3分钟，则扩容1台CVM。 | 备注2** ChangeInCapacity** 当前CVM实例个数的扩容或缩容的调整值。正值按值扩容，负值按值缩容。 ExactCapacity** 把当前CVM实例个数调整为ScalingAdjustment设置的CVM实例数。 PercentChangeInCapacity** 按比例增加或减少的百分比。正值按比例扩容，负值按比例缩容；例如，值“-10”将按10%的比例缩容CVM实例。 |
PutTimerScalingPolicyResponse |
GseClient.PutTimerScalingPolicy(PutTimerScalingPolicyRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（PutTimerScalingPolicy）用于给fleet创建或更新定时器。
填写字段timer_id，表示更新；不填字段timer_id表示新增。
|
ResolveAliasResponse |
GseClient.ResolveAlias(ResolveAliasRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（ResolveAlias）用于获取别名当前指向的fleetId。
|
SearchGameServerSessionsResponse |
GseClient.SearchGameServerSessions(SearchGameServerSessionsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（SearchGameServerSessions）用于搜索游戏服务器会话列表。
|
SetServerReservedResponse |
GseClient.SetServerReserved(SetServerReservedRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（SetServerReserved）用于将异常的实例标记为保留，用于问题排查。
字段ReserveValue：0默认值，不保留；1 保留
|
SetServerWeightResponse |
GseClient.SetServerWeight(SetServerWeightRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（SetServerWeight）用于设置服务器权重。
|
StartFleetActionsResponse |
GseClient.StartFleetActions(StartFleetActionsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（StartFleetActions）用于启用服务器舰队自动扩缩容。
|
StartGameServerSessionPlacementResponse |
GseClient.StartGameServerSessionPlacement(StartGameServerSessionPlacementRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（StartGameServerSessionPlacement）用于开始放置游戏服务器会话。
|
StopFleetActionsResponse |
GseClient.StopFleetActions(StopFleetActionsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（StopFleetActions）用于停止服务器舰队自动扩缩容，改为手动扩缩容。
|
StopGameServerSessionPlacementResponse |
GseClient.StopGameServerSessionPlacement(StopGameServerSessionPlacementRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（StopGameServerSessionPlacement）用于停止放置游戏服务器会话。
|
UpdateAliasResponse |
GseClient.UpdateAlias(UpdateAliasRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateAlias）用于更新别名的属性。
|
UpdateAssetResponse |
GseClient.UpdateAsset(UpdateAssetRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateAsset）用于修改生成包信息。
|
UpdateBucketAccelerateOptResponse |
GseClient.UpdateBucketAccelerateOpt(UpdateBucketAccelerateOptRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateBucketAccelerateOpt）用于开启cos全球加速。
|
UpdateBucketCORSOptResponse |
GseClient.UpdateBucketCORSOpt(UpdateBucketCORSOptRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateBucketCORSOpt）用于设置cos跨域访问。
|
UpdateFleetAttributesResponse |
GseClient.UpdateFleetAttributes(UpdateFleetAttributesRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateFleetAttributes）用于更新服务器舰队属性。
|
UpdateFleetCapacityResponse |
GseClient.UpdateFleetCapacity(UpdateFleetCapacityRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateFleetCapacity）用于更新服务器舰队容量配置。
|
UpdateFleetNameResponse |
GseClient.UpdateFleetName(UpdateFleetNameRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateFleetName）用于更新服务器舰队名称。
|
UpdateFleetPortSettingsResponse |
GseClient.UpdateFleetPortSettings(UpdateFleetPortSettingsRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateFleetPortSettings）用于更新服务器舰队安全组。
|
UpdateGameServerSessionResponse |
GseClient.UpdateGameServerSession(UpdateGameServerSessionRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateGameServerSession）用于更新游戏服务器会话。
|
UpdateGameServerSessionQueueResponse |
GseClient.UpdateGameServerSessionQueue(UpdateGameServerSessionQueueRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateGameServerSessionQueue）用于修改游戏服务器会话队列。
|
UpdateRuntimeConfigurationResponse |
GseClient.UpdateRuntimeConfiguration(UpdateRuntimeConfigurationRequest req)
此接口无法使用，游戏服务器引擎GSE已于6.1正式下架，感谢您的支持
本接口（UpdateRuntimeConfiguration）用于更新服务器舰队配置。
|
| 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 |
|---|---|
ChatProResponse |
HunyuanClient.ChatPro(ChatProRequest req)
腾讯混元大模型高级版是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口为SSE协议。
1.本接口暂不支持返回图片内容。
2.默认单账号限制并发数为5路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
3.请使用SDK调用本接口 ，每种开发语言的SDK GitHub仓库examples/hunyuan/v20230901/目录下有提供示例供参考。
|
ChatStdResponse |
HunyuanClient.ChatStd(ChatStdRequest req)
腾讯混元大模型标准版是由腾讯研发的大语言模型，具备强大的中文创作能力，复杂语境下的逻辑推理能力，以及可靠的任务执行能力。本接口为SSE协议。
1.本接口暂不支持返回图片内容。
2.默认单账号限制并发数为5路，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。
3.请使用SDK调用本接口 ，每种开发语言的SDK GitHub仓库examples/hunyuan/v20230901/目录下有提供示例供参考。
|
GetEmbeddingResponse |
HunyuanClient.GetEmbedding(GetEmbeddingRequest req)
腾讯混元-Embedding接口，可以将文本转化为高质量的向量数据。
|
GetTokenCountResponse |
HunyuanClient.GetTokenCount(GetTokenCountRequest req)
该接口用于计算文本对应Token数、字符数。
|
| Modifier and Type | Method and Description |
|---|---|
AnalyzeDenseLandmarksResponse |
IaiClient.AnalyzeDenseLandmarks(AnalyzeDenseLandmarksRequest req)
对请求图片进行五官定位（也称人脸关键点定位），获得人脸的精准信息，返回多达888点关键信息，对五官和脸部轮廓进行精确定位。
|
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)或[人员验证](https://cloud.tencent.com/document/product/867/38879)接口。
>
- 公共参数中的签名方式请使用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下最多创建10万个人员库（Group）、最多包含5000万张人脸（Face）。
不同算法模型版本（FaceModelVersion）的人员库（Group）最多可包含人脸（Face）数不同。算法模型版本为2.0的人员库最多包含100万张人脸，算法模型版本为3.0的人员库最多可包含300万张人脸。
|
CreatePersonResponse |
IaiClient.CreatePerson(CreatePersonRequest req)
创建人员，添加人脸、姓名、性别及其他相关信息。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
DeleteFaceResponse |
IaiClient.DeleteFace(DeleteFaceRequest req)
删除一个人员下的人脸图片。如果该人员只有一张人脸图片，则返回错误。
|
DeleteGroupResponse |
IaiClient.DeleteGroup(DeleteGroupRequest req)
删除该人员库及包含的所有的人员。同时，人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中，该人员不会被删除，但属于该人员库中的自定义描述字段信息会被删除，属于其他人员库的自定义描述字段信息不受影响。
|
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。
|
DetectFaceAttributesResponse |
IaiClient.DetectFaceAttributes(DetectFaceAttributesRequest 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)：保证上传的人脸质量，人脸融合的效果更好。
>
- 本接口是[人脸检测与分析](https://cloud.tencent.com/document/product/867/32800)的升级，具体在于：
1.本接口可以指定需要计算返回的人脸属性，避免无效计算，降低耗时；
2.本接口支持更多属性细项数，也会持续增加更多功能。
请您使用本接口完成相应的人脸检测与属性分析需求。
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
DetectLiveFaceResponse |
IaiClient.DetectLiveFace(DetectLiveFaceRequest req)
用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是：静态活体检测中，用户不需要通过唇语或摇头眨眼等动作来识别。
静态活体检测适用于手机自拍的场景，或对防攻击要求不高的场景。如果对活体检测有更高安全性要求，请使用[人脸核身·云智慧眼](https://cloud.tencent.com/product/faceid)产品。
>
- 图片的宽高比请接近3：4，不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景，非类手机自拍照返回的分值不具备参考意义。
>
- 使用过程中建议正对摄像头，不要距离太远，使面部可以完整地显示在识别的框内，识别过程中不要移动设备或遮挡面部。不要选择光线过强或过弱的环境进行面部识别，识别时不要添加任何滤镜。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
## 调用次数计费（资源包）
|资源包规格|100万次|1000万次|5000万次|1亿次|
|-|-|-|-|-|
|人脸静态活体检测|1800元|17400元|75000元|110000元|
## 调用次数计费（后付费）
|月接口调用总量|0<调用量≤300万|300万<调用量≤1500万|调用量>1500万|
|-|-|-|-|
|人脸静态活体检测|0.0019元/次|0.0017元/次|0.0013元/次|
|
GetGroupInfoResponse |
IaiClient.GetGroupInfo(GetGroupInfoRequest req)
获取人员库信息。
|
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)
获取指定人员库中人员数量。
|
GetUpgradeGroupFaceModelVersionJobListResponse |
IaiClient.GetUpgradeGroupFaceModelVersionJobList(GetUpgradeGroupFaceModelVersionJobListRequest req)
避免官网歧义
获取人员库升级任务列表
|
GetUpgradeGroupFaceModelVersionResultResponse |
IaiClient.GetUpgradeGroupFaceModelVersionResult(GetUpgradeGroupFaceModelVersionResultRequest req)
避免官网歧义
人员库升级结果查询
|
ModifyGroupResponse |
IaiClient.ModifyGroup(ModifyGroupRequest req)
修改人员库名称、备注、自定义描述字段名称。
|
ModifyPersonBaseInfoResponse |
IaiClient.ModifyPersonBaseInfo(ModifyPersonBaseInfoRequest req)
修改人员信息，包括名称、性别等。人员名称和性别修改会同步到包含该人员的所有人员库。
|
ModifyPersonGroupInfoResponse |
IaiClient.ModifyPersonGroupInfo(ModifyPersonGroupInfoRequest req)
修改指定人员库人员描述内容。
|
RevertGroupFaceModelVersionResponse |
IaiClient.RevertGroupFaceModelVersion(RevertGroupFaceModelVersionRequest req)
此接口文档早已废弃，为了避免官网18版本存留歧义，需要下线
本接口用于回滚人员库的人脸识别算法模型版本。单个人员库有且仅有一次回滚机会。
回滚操作会在10s内生效，回滚操作中，您对人员库的操作可能会失效。
|
SearchFacesResponse |
IaiClient.SearchFaces(SearchFacesRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，识别结果按照相似度从大到小排序。
支持一次性识别图片中的最多 10 张人脸，支持一次性跨 100 个人员库（Group）搜索。
单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。
与[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口不同的是，本接口将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而人员搜索及人员搜索按库返回接口 会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使搜索更加准确。
本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
SearchFacesReturnsByGroupResponse |
IaiClient.SearchFacesReturnsByGroup(SearchFacesReturnsByGroupRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照**人员库的维度**以人员相似度从大到小顺序排列。
支持一次性识别图片中的最多 10 张人脸，支持跨人员库（Group）搜索。
单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。
与[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口不同的是，本接口将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而[人员搜索](https://cloud.tencent.com/document/product/867/38881)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/38880)接口 会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使搜索更加准确。
本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/32794)结合使用。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
SearchPersonsResponse |
IaiClient.SearchPersons(SearchPersonsRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照相似度从大到小排列。
支持一次性识别图片中的最多 10 张人脸，支持一次性跨 100 个人员库（Group）搜索。
单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。
本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/32798)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/38882)将该人员（Person）下的每个人脸（Face）都作为单独个体进行搜索。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
- 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
|
SearchPersonsReturnsByGroupResponse |
IaiClient.SearchPersonsReturnsByGroup(SearchPersonsReturnsByGroupRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照**人员库的维度**以人员相似度从大到小顺序排列。
支持一次性识别图片中的最多 10 张人脸，支持跨人员库（Group）搜索。
单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。
本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/32798)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/38882)将该人员（Person）下的每个人脸（Face）都作为单独个体进行搜索。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
- 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
|
UpgradeGroupFaceModelVersionResponse |
IaiClient.UpgradeGroupFaceModelVersion(UpgradeGroupFaceModelVersionRequest req)
接口已经不使用了，需要下线掉，以免留在官网产生歧义
升级人员库。升级过程中，人员库仍然为原算法版本，人员库相关操作仍然支持。升级完成后，人员库为新算法版本。
单个人员库有且仅支持一次回滚操作。
注：此处QPS限制为10。
|
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/32802)用于判断两张人脸的相似度。
与[人员验证](https://cloud.tencent.com/document/product/867/38879)接口不同的是，人脸验证将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而[人员验证](https://cloud.tencent.com/document/product/867/38879)会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person下有4张 Face，人员验证接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。
>
- 公共参数中的签名方式请使用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。
- 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
|
| Modifier and Type | Method and Description |
|---|---|
AnalyzeDenseLandmarksResponse |
IaiClient.AnalyzeDenseLandmarks(AnalyzeDenseLandmarksRequest req)
对请求图片进行五官定位（也称人脸关键点定位），获得人脸的精准信息，返回多达888点关键信息，对五官和脸部轮廓进行精确定位。
|
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/44983)或[人员验证](https://cloud.tencent.com/document/product/867/44982)接口。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
CompareMaskFaceResponse |
IaiClient.CompareMaskFace(CompareMaskFaceRequest req)
对两张图片中的人脸进行相似度比对，返回人脸相似度分数。
防疫场景人脸比对接口可在人脸戴口罩情况下使用，口罩遮挡程度最高可以遮挡鼻尖。
如图片人脸不存在防疫场景下戴口罩的情况，建议使用人脸比对服务。
|
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下最多创建10万个人员库（Group）、最多包含5000万张人脸（Face）。
不同算法模型版本（FaceModelVersion）的人员库（Group）最多可包含人脸（Face）数不同。算法模型版本为2.0的人员库最多包含100万张人脸，算法模型版本为3.0的人员库最多可包含300万张人脸。
|
CreatePersonResponse |
IaiClient.CreatePerson(CreatePersonRequest req)
创建人员，添加人脸、姓名、性别及其他相关信息。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
DeleteFaceResponse |
IaiClient.DeleteFace(DeleteFaceRequest req)
删除一个人员下的人脸图片。如果该人员只有一张人脸图片，则返回错误。
|
DeleteGroupResponse |
IaiClient.DeleteGroup(DeleteGroupRequest req)
删除该人员库及包含的所有的人员。同时，人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中，该人员不会被删除，但属于该人员库中的自定义描述字段信息会被删除，属于其他人员库的自定义描述字段信息不受影响。
|
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/45014)/[增加人脸](https://cloud.tencent.com/document/product/867/45016)：保证人员人脸信息的质量，便于后续的业务处理。
2） [人脸搜索](https://cloud.tencent.com/document/product/867/44994)：保证输入的图片质量，快速准确匹配到对应的人员。
3） [人脸验证](https://cloud.tencent.com/document/product/867/44983)：保证人脸信息的质量，避免明明是本人却认证不通过的情况。
4） 人脸融合：保证上传的人脸质量，人脸融合的效果更好。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
DetectFaceAttributesResponse |
IaiClient.DetectFaceAttributes(DetectFaceAttributesRequest req)
检测给定图片中的人脸（Face）的位置、相应的面部属性和人脸质量信息，位置包括 (x，y，w，h)，面部属性包括性别（gender）、年龄（age）、表情（expression）、魅力（beauty）、眼镜（glass）、发型（hair）、口罩（mask）和姿态 (pitch，roll，yaw)。
其中，人脸质量信息主要用于评价输入的人脸图片的质量。在使用人脸识别服务时，建议您对输入的人脸图片进行质量检测，提升后续业务处理的效果。该功能的应用场景包括：
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)：保证上传的人脸质量，人脸融合的效果更好。
>
- 本接口是[人脸检测与分析](https://cloud.tencent.com/document/product/867/44989)的升级，具体在于：
1.本接口可以指定需要计算返回的人脸属性，避免无效计算，降低耗时；
2.本接口支持更多属性细项数，也会持续增加更多功能。
请您使用本接口完成相应的人脸检测与属性分析需求。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
DetectLiveFaceResponse |
IaiClient.DetectLiveFace(DetectLiveFaceRequest req)
用于对用户上传的静态图片进行人脸活体检测。与动态活体检测的区别是：静态活体检测中，用户不需要通过唇语或摇头眨眼等动作来识别。
静态活体检测适用于手机自拍的场景，或对防攻击要求不高的场景。如果对活体检测有更高安全性要求，请使用[人脸核身·云智慧眼](https://cloud.tencent.com/product/faceid)产品。
>
- 图片的宽高比请接近3：4，不符合宽高比的图片返回的分值不具备参考意义。本接口适用于类手机自拍场景，非类手机自拍照返回的分值不具备参考意义。
>
- 使用过程中建议正对摄像头，不要距离太远，使面部可以完整地显示在识别的框内，识别过程中不要移动设备或遮挡面部。不要选择光线过强或过弱的环境进行面部识别，识别时不要添加任何滤镜。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
DetectLiveFaceAccurateResponse |
IaiClient.DetectLiveFaceAccurate(DetectLiveFaceAccurateRequest req)
人脸静态活体检测（高精度版）可用于对用户上传的静态图片进行防翻拍活体检测，以判断是否是翻拍图片。
相比现有静态活体检测服务，高精度版在维持高真人通过率的前提下，增强了对高清屏幕、裁剪纸片、3D面具等攻击的防御能力，攻击拦截率约为业内同类型产品形态4-5倍。同时支持多场景人脸核验，满足移动端、PC端各类型场景的图片活体检验需求，适用于各个行业不同的活体检验应用。
人脸静态活体检测（高精度版）接口于2022年8月1日 00:00起正式开始计费，采取后付费按量计费模式，详见[计费概述](https://cloud.tencent.com/document/product/867/17640)。
|
GetGroupInfoResponse |
IaiClient.GetGroupInfo(GetGroupInfoRequest req)
获取人员库信息。
|
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)
获取指定人员库中人员数量。
|
GetUpgradeGroupFaceModelVersionJobListResponse |
IaiClient.GetUpgradeGroupFaceModelVersionJobList(GetUpgradeGroupFaceModelVersionJobListRequest req)
避免官网歧义
获取人员库升级任务列表
|
GetUpgradeGroupFaceModelVersionResultResponse |
IaiClient.GetUpgradeGroupFaceModelVersionResult(GetUpgradeGroupFaceModelVersionResultRequest req)
避免官网歧义
人员库升级结果查询
|
ModifyGroupResponse |
IaiClient.ModifyGroup(ModifyGroupRequest req)
修改人员库名称、备注、自定义描述字段名称。
|
ModifyPersonBaseInfoResponse |
IaiClient.ModifyPersonBaseInfo(ModifyPersonBaseInfoRequest req)
修改人员信息，包括名称、性别等。人员名称和性别修改会同步到包含该人员的所有人员库。
|
ModifyPersonGroupInfoResponse |
IaiClient.ModifyPersonGroupInfo(ModifyPersonGroupInfoRequest req)
修改指定人员库人员描述内容。
|
RevertGroupFaceModelVersionResponse |
IaiClient.RevertGroupFaceModelVersion(RevertGroupFaceModelVersionRequest req)
同理
本接口用于回滚人员库的人脸识别算法模型版本。单个人员库有且仅有一次回滚机会。
回滚操作会在10s内生效，回滚操作中，您对人员库的操作可能会失效。
|
SearchFacesResponse |
IaiClient.SearchFaces(SearchFacesRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，识别结果按照相似度从大到小排序。
支持一次性识别图片中的最多 10 张人脸，支持一次性跨 100 个人员库（Group）搜索。
单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。
与[人员搜索](https://cloud.tencent.com/document/product/867/44992)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/44991)接口不同的是，本接口将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而人员搜索及人员搜索按库返回接口 会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使搜索更加准确。
本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/45015)结合使用。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
>
- 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
|
SearchFacesReturnsByGroupResponse |
IaiClient.SearchFacesReturnsByGroup(SearchFacesReturnsByGroupRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照**人员库的维度**以人员相似度从大到小顺序排列。
支持一次性识别图片中的最多 10 张人脸，支持跨人员库（Group）搜索。
单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。
与[人员搜索](https://cloud.tencent.com/document/product/867/44992)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/44991)接口不同的是，本接口将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而[人员搜索](https://cloud.tencent.com/document/product/867/44992)及[人员搜索按库返回](https://cloud.tencent.com/document/product/867/44991)接口 会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使搜索更加准确。
本接口需与[人员库管理相关接口](https://cloud.tencent.com/document/product/867/45015)结合使用。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
>
- 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
|
SearchPersonsResponse |
IaiClient.SearchPersons(SearchPersonsRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照相似度从大到小排列。
支持一次性识别图片中的最多 10 张人脸，支持一次性跨 100 个人员库（Group）搜索。
单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。
本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/44994)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/44993)将该人员（Person）下的每个人脸（Face）都作为单独个体进行搜索。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
- 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
|
SearchPersonsReturnsByGroupResponse |
IaiClient.SearchPersonsReturnsByGroup(SearchPersonsReturnsByGroupRequest req)
用于对一张待识别的人脸图片，在一个或多个人员库中识别出最相似的 TopK 人员，按照**人员库的维度**以人员相似度从大到小顺序排列。
支持一次性识别图片中的最多 10 张人脸，支持跨人员库（Group）搜索。
单次搜索的人员库人脸总数量和人员库的算法模型版本（FaceModelVersion）相关。算法模型版本为2.0的人员库，单次搜索人员库人脸总数量不得超过 100 万张；算法模型版本为3.0的人员库，单次搜索人员库人脸总数量不得超过 300 万张。
本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person 下有4张 Face ，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员搜索（确定待识别的人脸图片是某人）更加准确。而[人脸搜索](https://cloud.tencent.com/document/product/867/44994)及[人脸搜索按库返回接口](https://cloud.tencent.com/document/product/867/44993)将该人员（Person）下的每个人脸（Face）都作为单独个体进行搜索。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
- 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
|
UpgradeGroupFaceModelVersionResponse |
IaiClient.UpgradeGroupFaceModelVersion(UpgradeGroupFaceModelVersionRequest req)
避免官网歧义
升级人员库。升级过程中，人员库仍然为原算法版本，人员库相关操作仍然支持。升级完成后，人员库为新算法版本。
单个人员库有且仅支持一次回滚操作。
升级是一个耗时的操作，执行时间与人员库的人脸数相关，升级的人员库中的人脸数越多，升级的耗时越长。升级接口是个异步任务，调用成功后返回JobId，通过GetUpgradeGroupFaceModelVersionResult查询升级进度和结果。如果升级成功，人员库版本将切换到新版本。如果想回滚到旧版本，可以调用RevertGroupFaceModelVersion进行回滚。
注：某些接口无法进行跨人员库版本操作，例如SearchFaces，SearchPersons和CopyPerson等。当业务有多个Group操作的场景时，如同时搜索Group1和Group2，如果升级了Group1，此时Group1和Group2版本不同，造成了跨版本操作，将导致Search接口无法正常执行，返回不允许执行跨版本操作错误，升级前需考虑业务是否有多库操作的场景，否则会影响线上接口表现。
|
VerifyFaceResponse |
IaiClient.VerifyFace(VerifyFaceRequest req)
给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考[人员库管理相关接口](https://cloud.tencent.com/document/product/867/45015)。
与[人脸比对](https://cloud.tencent.com/document/product/867/44987)接口不同的是，人脸验证用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而[人脸比对](https://cloud.tencent.com/document/product/867/44987)用于判断两张人脸的相似度。
与[人员验证](https://cloud.tencent.com/document/product/867/44982)接口不同的是，人脸验证将该人员（Person）下的每个人脸（Face）都作为单独个体进行验证，而[人员验证](https://cloud.tencent.com/document/product/867/44982)会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个 Person下有4张 Face，人员验证接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
|
VerifyPersonResponse |
IaiClient.VerifyPerson(VerifyPersonRequest req)
给定一张人脸图片和一个 PersonId，判断图片中的人和 PersonId 对应的人是否为同一人。PersonId 请参考[人员库管理相关接口](https://cloud.tencent.com/document/product/867/45015)。
本接口会将该人员（Person）下的所有人脸（Face）进行融合特征处理，即若某个Person下有4张 Face，本接口会将4张 Face 的特征进行融合处理，生成对应这个 Person 的特征，使人员验证（确定待识别的人脸图片是某人员）更加准确。
和人脸比对相关接口不同的是，人脸验证相关接口用于判断 “此人是否是此人”，“此人”的信息已存于人员库中，“此人”可能存在多张人脸图片；而人脸比对相关接口用于判断两张人脸的相似度。
>
- 公共参数中的签名方式请使用V3版本，即配置SignatureMethod参数为TC3-HMAC-SHA256。
- 仅支持算法模型版本（FaceModelVersion）为3.0的人员库。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeAppResponse |
IcClient.DescribeApp(DescribeAppRequest req)
根据应用id查询物联卡应用详情
|
DescribeCardResponse |
IcClient.DescribeCard(DescribeCardRequest req)
查询卡片详细信息
|
DescribeCardsResponse |
IcClient.DescribeCards(DescribeCardsRequest req)
查询卡片列表信息
|
DescribeSmsResponse |
IcClient.DescribeSms(DescribeSmsRequest req)
查询短信列表
|
ModifyUserCardRemarkResponse |
IcClient.ModifyUserCardRemark(ModifyUserCardRemarkRequest req)
编辑卡片备注
|
PayForExtendDataResponse |
IcClient.PayForExtendData(PayForExtendDataRequest req)
购买套外流量包
|
RenewCardsResponse |
IcClient.RenewCards(RenewCardsRequest req)
批量为卡片续费，此接口建议调用至少间隔10s,如果出现返回deal lock failed相关的错误，请过10s再重试。
续费的必要条件：
1、单次续费的卡片不可以超过 100张。
2、接口只支持在控制台购买的卡片进行续费
3、销户和未激活的卡片不支持续费。
4、每张物联网卡，续费总周期不能超过24个月
|
SendMultiSmsResponse |
IcClient.SendMultiSms(SendMultiSmsRequest req)
群发短信
|
SendSmsResponse |
IcClient.SendSms(SendSmsRequest req)
发送短信息接口
|
| Modifier and Type | Method and Description |
|---|---|
GetIndustryV1HomeMembersResponse |
IcrClient.GetIndustryV1HomeMembers(GetIndustryV1HomeMembersRequest req)
获取成员列表接口
|
| Modifier and Type | Method and Description |
|---|---|
RecognizeProductResponse |
IirClient.RecognizeProduct(RecognizeProductRequest req)
商品识别，使用微信扫一扫识物同款技术，基于人工智能技术、海量训练图片、亿级商品库，可以实现全覆盖、细粒度、高准确率的商品识别和商品推荐功能。 本服务可以识别出图片中的主体位置、主体商品类型，覆盖亿级SKU，输出具体商品的价格、型号等详细信息。 客户无需自建商品库，即可快速实现商品识别、拍照搜商品等功能。
目前“商品识别”为公测服务，需要申请、开通后方可使用。请在[服务开通申请表](https://cloud.tencent.com/apply/p/y1q2mnf0vdl) 中填写详细信息和需求，如果通过审核，我们将会在2个工作日内与您联系，并开通服务。 公测期间，本服务免费提供最高2QPS，收费模式和标准会在正式版上线前通过站内信、短信通知客户。如果需要提升并发，请与我们联系洽谈。
注意：本文档为公测版本，仅适用于功能体验和测试，正式业务接入请等待正式版。正式版的输入、输出可能会与公测版存在少量差异。
|
| Modifier and Type | Method and Description |
|---|---|
ImageModerationResponse |
ImsClient.ImageModeration(ImageModerationRequest req)
图片同步检测服务（Image Moderation, IM）能自动扫描图片，识别可能令人反感、不安全或不适宜的内容，同时支持用户配置图片黑名单，打击自定义识别类型的图片。
关于版本迭代的描述
|
| Modifier and Type | Method and Description |
|---|---|
CreateImageModerationAsyncTaskResponse |
ImsClient.CreateImageModerationAsyncTask(CreateImageModerationAsyncTaskRequest req)
本接口用于提交图片文件进行异步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms/image/package) 并调整好对应的业务配置。
### 接口使用说明：
- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms/image/package)”开启使用图片内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含**1万张图片**识别额度，有效期为1个月。
- 该接口为收费接口，计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。
### 接口功能说明：
- 支持对图片文件或链接进行检测，通过深度学习技术，识别可能令人反感、不安全或不适宜的违规图片内容；
- 支持对GIF图/长图进行截帧或拆分检测；
- 支持识别多种违规场景，包括：低俗、违法违规、色情、广告等场景；
- 支持多种物体检测（实体、广告台标、二维码等）及图片中文本的OCR文本识别；
- 支持根据不同的业务场景配置自定义的审核策略；
- 支持用户自定义选择图片风险库，打击自定义识别类型的违规图片（目前仅支持黑名单配置）；
- 支持在审核图片内容时同时关联账号或设备信息，可识别违规风险账号或设备。
### 接口调用说明：
- 图片尺寸支持：**长或者宽 >50分辨率**和**长或者宽<40000分辨率**,并且**图片长宽比<90:1；**
- 图片文件分辨率支持：建议**分辨率大于256x256**，否则可能会影响识别效果；
- 图片文件支持格式：PNG、JPG、JPEG、BMP、GIF、WEBP格式；
- 图片文件链接支持的传输协议：HTTP、HTTPS；
- 若传入图片文件的访问链接，则需要注意**图片下载时间限制为3秒**，为保障被检测图片的稳定性和可靠性，建议您使用腾讯云COS存储或者CDN缓存等；
- 默认接口请求频率限制：**20次/秒**，超过此调用频率则会报错。
|
ImageModerationResponse |
ImsClient.ImageModeration(ImageModerationRequest req)
本接口（Image Moderation, IM）用于提交图片文件进行同步智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通图片内容安全服务](https://console.cloud.tencent.com/cms) 并调整好对应的业务配置。
### 接口使用说明：
- 前往“[内容安全控制台-图片内容安全](https://console.cloud.tencent.com/cms)”开启使用图片内容安全服务，首次开通服务的用户可免费领用试用套餐包，包含**3000张图片**识别额度，有效期为15天。
- 该接口为收费接口，计费方式敬请参见 [腾讯云图片内容安全定价](https://cloud.tencent.com/product/ims/pricing)。
### 接口功能说明：
- 支持对图片文件或链接进行检测，通过深度学习技术，识别可能令人反感、不安全或不适宜的违规图片内容；
- 支持对GIF图/长图进行截帧或拆分检测；
- 支持识别多种违规场景，包括：低俗、违法违规、色情、广告等场景；
- 支持多种物体检测（实体、广告台标、二维码等）及图片中文本的OCR文本识别；
- 支持根据不同的业务场景配置自定义的审核策略；
- 支持用户自定义选择图片风险库，打击自定义识别类型的违规图片（目前仅支持黑名单配置）；
- 支持在审核图片内容时同时关联账号或设备信息，可识别违规风险账号或设备。
### 接口调用说明：
- 图片文件大小支持：**文件 < 5M**
- 图片尺寸支持：**长或者宽 >50分辨率**和**长或者宽<10000分辨率**
- 图片文件分辨率支持：建议**分辨率大于256x256**，否则可能会影响识别效果；
- 图片文件支持格式：PNG、JPG、JPEG、BMP、GIF、WEBP格式；
- 图片文件链接支持的传输协议：HTTP、HTTPS；
- 若传入图片文件的访问链接，则需要注意**图片下载时间限制为3秒**，为保障被检测图片的稳定性和可靠性，建议您使用腾讯云COS存储或者CDN缓存等；
- 默认接口请求频率限制：**100次/秒**，超过此调用频率则会报错。
-审核列表中，排序是按照用户通过API接口上传调用的时间进行排序；
关于版本迭代的描述
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDevicesResponse |
IoaClient.DescribeDevices(DescribeDevicesRequest req)
查询满足条件的终端数据详情，私有化调用path为：/capi/Assets/Device/DescribeDevices
|
| Modifier and Type | Method and Description |
|---|---|
ClearDeviceActiveCodeResponse |
IotvideoClient.ClearDeviceActiveCode(ClearDeviceActiveCodeRequest req)
清除设备激活码
|
CreateAnonymousAccessTokenResponse |
IotvideoClient.CreateAnonymousAccessToken(CreateAnonymousAccessTokenRequest req)
创建匿名访问Token
|
CreateAppUsrResponse |
IotvideoClient.CreateAppUsr(CreateAppUsrRequest req)
本接口（CreateAppUsr）用于接收由厂商云发送过来的注册请求,建立厂商云终端用户与IoT Video终端用户的映射关系。
|
CreateBindingResponse |
IotvideoClient.CreateBinding(CreateBindingRequest req)
本接口（CreateBinding）用于终端用户和设备进行绑定，具体的应用场景如下：
终端用户与设备具有“强关联”关系。用户与设备绑定之后，用户终端即具备了该设备的访问权限,访问或操作设备时，无需获取设备访问Token。
|
CreateDevicesResponse |
IotvideoClient.CreateDevices(CreateDevicesRequest req)
本接口（CreateDevices）用于批量创建新的物联网视频通信设备。
注意：腾讯云不会对设备私钥进行保存，请自行保管好您的设备私钥。
|
CreateDevTokenResponse |
IotvideoClient.CreateDevToken(CreateDevTokenRequest req)
本接口（CreateDevToken）用于以下场景：
终端用户与设备没有强绑定关联关系;
允许终端用户短时或一次性临时访问设备;
当终端用户与设备有强绑定关系时，可以不用调用此接口
|
CreateGencodeResponse |
IotvideoClient.CreateGencode(CreateGencodeRequest req)
本接口（CreateGencode）用于生成设备物模型源代码
|
CreateIotDataTypeResponse |
IotvideoClient.CreateIotDataType(CreateIotDataTypeRequest req)
本接口（CreateIotDataType）用于创建自定义物模型数据类型。
|
CreateIotModelResponse |
IotvideoClient.CreateIotModel(CreateIotModelRequest req)
本接口（CreateIotModel）用于定义的物模型提交。
该接口实现了物模型草稿箱的功能，保存用户最后一次编辑的物模型数据。
|
CreateProductResponse |
IotvideoClient.CreateProduct(CreateProductRequest req)
本接口（CreateProduct）用于创建一个新的物联网智能视频产品。
|
CreateStorageResponse |
IotvideoClient.CreateStorage(CreateStorageRequest req)
该接口已经停止维护，请勿使用
|
CreateStorageServiceResponse |
IotvideoClient.CreateStorageService(CreateStorageServiceRequest req)
购买云存服务
|
CreateTraceIdsResponse |
IotvideoClient.CreateTraceIds(CreateTraceIdsRequest req)
本接口（CreateTraceIds）用于将设备加到日志跟踪白名单。
|
CreateUploadPathResponse |
IotvideoClient.CreateUploadPath(CreateUploadPathRequest req)
本接口（CreateUploadPath）用于获取固件上传路径。
|
CreateUsrTokenResponse |
IotvideoClient.CreateUsrToken(CreateUsrTokenRequest req)
本接口（CreateUsrToken）用于终端用户获取IoT Video平台的accessToken，初始化SDK,连接到IoT Video接入服务器。
|
DeleteAppUsrResponse |
IotvideoClient.DeleteAppUsr(DeleteAppUsrRequest req)
本接口（DeleteAppUsr）用于删除终端用户。
|
DeleteBindingResponse |
IotvideoClient.DeleteBinding(DeleteBindingRequest req)
本接口（DeleteBinding）用于终端用户和设备进行解绑定。
|
DeleteDeviceResponse |
IotvideoClient.DeleteDevice(DeleteDeviceRequest req)
本接口（DeleteDevice）用于删除设备，可进行批量操作，每次操作最多100台设备。
|
DeleteIotDataTypeResponse |
IotvideoClient.DeleteIotDataType(DeleteIotDataTypeRequest req)
本接口（DeleteIotDataType）用于删除自定义物模型数据类型。
|
DeleteMessageQueueResponse |
IotvideoClient.DeleteMessageQueue(DeleteMessageQueueRequest req)
本接口（DeleteMessageQueue）用于删除物联网智能视频产品的转发消息配置信息。
|
DeleteOtaVersionResponse |
IotvideoClient.DeleteOtaVersion(DeleteOtaVersionRequest req)
本接口（DeleteOtaVersion）用于删除固件版本信息。
|
DeleteProductResponse |
IotvideoClient.DeleteProduct(DeleteProductRequest req)
本接口（DeleteProduct）用于删除一个物联网智能视频产品。
|
DeleteTraceIdsResponse |
IotvideoClient.DeleteTraceIds(DeleteTraceIdsRequest req)
本接口（DeleteTraceIds）用于将设备从日志跟踪白名单中删除，该接口可批量操作，最多支持同时操作100台设备。
|
DeliverStorageServiceResponse |
IotvideoClient.DeliverStorageService(DeliverStorageServiceRequest req)
将已购买的云存服务转移到另一设备
|
DescribeAccountBalanceResponse |
IotvideoClient.DescribeAccountBalance(DescribeAccountBalanceRequest req)
客户可通过本接口获取账户余额信息, 默认接口请求频率限制：1次/秒
|
DescribeBindDevResponse |
IotvideoClient.DescribeBindDev(DescribeBindDevRequest req)
本接口（DescribeBindDev）用于查询终端用户绑定的设备列表。
|
DescribeBindUsrResponse |
IotvideoClient.DescribeBindUsr(DescribeBindUsrRequest req)
本接口（DescribeBindUsr）用于查询设备被分享的所有用户列表。
|
DescribeDeviceResponse |
IotvideoClient.DescribeDevice(DescribeDeviceRequest req)
本接口（DescribeDevice）获取设备信息。
|
DescribeDeviceModelResponse |
IotvideoClient.DescribeDeviceModel(DescribeDeviceModelRequest req)
本接口（DescribeDeviceModel）用于获取设备物模型。
|
DescribeDevicesResponse |
IotvideoClient.DescribeDevices(DescribeDevicesRequest req)
本接口（DescribeDevices）用于获取设备信息列表。
|
DescribeIotDataTypeResponse |
IotvideoClient.DescribeIotDataType(DescribeIotDataTypeRequest req)
本接口（DescribeIotDataType）用于查询自定义的物模型数据类型。
|
DescribeIotModelResponse |
IotvideoClient.DescribeIotModel(DescribeIotModelRequest req)
本接口（DescribeIotModel）用于获取物模型定义详情。
|
DescribeIotModelsResponse |
IotvideoClient.DescribeIotModels(DescribeIotModelsRequest req)
本接口（DescribeIotModels）用于列出物模型历史版本列表。
|
DescribeLogsResponse |
IotvideoClient.DescribeLogs(DescribeLogsRequest req)
本接口（DescribeLogs）用于查询设备日志列表。
设备日志最长保留时长为15天,超期自动清除。
|
DescribeMessageQueueResponse |
IotvideoClient.DescribeMessageQueue(DescribeMessageQueueRequest req)
本接口（DescribeMessageQueue）用于查询物联网智能视频产品转发消息配置。
|
DescribeModelDataRetResponse |
IotvideoClient.DescribeModelDataRet(DescribeModelDataRetRequest req)
本接口（DescribeModelDataRet）用于根据TaskId获取对设备物模型操作最终响应的结果。
|
DescribeOsListResponse |
IotvideoClient.DescribeOsList(DescribeOsListRequest req)
查看操作系统支持的芯片列表
|
DescribeOtaVersionsResponse |
IotvideoClient.DescribeOtaVersions(DescribeOtaVersionsRequest req)
本接口（DescribeOtaVersions）用于查询固件版本信息列表。
|
DescribeProductResponse |
IotvideoClient.DescribeProduct(DescribeProductRequest req)
本接口（DescribeProduct）用于获取单个产品的详细信息。
|
DescribeProductsResponse |
IotvideoClient.DescribeProducts(DescribeProductsRequest req)
本接口（DescribeProducts）用于列出用户账号下的物联网智能视频产品列表。
|
DescribePubVersionsResponse |
IotvideoClient.DescribePubVersions(DescribePubVersionsRequest req)
本接口（DescribePubVersions）用于获取某一产品发布过的全部固件版本。
|
DescribeRechargeRecordsResponse |
IotvideoClient.DescribeRechargeRecords(DescribeRechargeRecordsRequest req)
客户可通过本接口获取充值记录信息, 一次最多返回50条记录。
|
DescribeRegistrationStatusResponse |
IotvideoClient.DescribeRegistrationStatus(DescribeRegistrationStatusRequest req)
本接口（DescribeRegistrationStatus）用于查询终端用户的注册状态。
|
DescribeRunLogResponse |
IotvideoClient.DescribeRunLog(DescribeRunLogRequest req)
本接口（DescribeRunLog）用于获取设备运行日志。
|
DescribeStorageServiceResponse |
IotvideoClient.DescribeStorageService(DescribeStorageServiceRequest req)
查询云存服务
|
DescribeStreamResponse |
IotvideoClient.DescribeStream(DescribeStreamRequest req)
请求设备直播流地址
|
DescribeTraceIdsResponse |
IotvideoClient.DescribeTraceIds(DescribeTraceIdsRequest req)
本接口（DescribeTraceIds）用于查询设备日志跟踪白名单。
|
DescribeTraceStatusResponse |
IotvideoClient.DescribeTraceStatus(DescribeTraceStatusRequest req)
本接口（DescribeTraceStatus）用于查询指定设备是否在白名单中。
|
DisableDeviceResponse |
IotvideoClient.DisableDevice(DisableDeviceRequest req)
本接口（DisableDevice）用于禁用设备，可进行批量操作，每次操作最多100台设备。
|
DisableDeviceStreamResponse |
IotvideoClient.DisableDeviceStream(DisableDeviceStreamRequest req)
本接口（DisableDeviceStream）用于停止设备推流，可进行批量操作，每次操作最多100台设备。
|
DisableOtaVersionResponse |
IotvideoClient.DisableOtaVersion(DisableOtaVersionRequest req)
本接口（DisableOtaVersion）用于禁用固件版本。
|
ModifyDeviceResponse |
IotvideoClient.ModifyDevice(ModifyDeviceRequest req)
修改设备信息
|
ModifyDeviceActionResponse |
IotvideoClient.ModifyDeviceAction(ModifyDeviceActionRequest req)
本接口（ModifyDeviceAction）用于修改设备物模型的行为（Action）。
可对ctlVal数据属性进行写入,如:Action.takePhoto.ctlVal,设备在线且成功发送到设备才返回,物模型写入数据时,不需要传入时标信息,平台以当前时标作为数据的时标更新物模型中的时标信息。
注意:
1.若设备当前不在线,会直接返回错误
2.若设备网络出现异常时,消息发送可能超时,超时等待最长时间为3秒
3.value的内容必须与实际物模型的定义一致
|
ModifyDevicePropertyResponse |
IotvideoClient.ModifyDeviceProperty(ModifyDevicePropertyRequest req)
本接口（ModifyDeviceProperty）用于修改设备物模型的属性（ProWritable）。
可对setVal数据属性进行写入,如:
ProWritable.Pos.setVal
对于嵌套类型的可写属性，可以仅对其部分数据内容进行写入，如:
ProWritable.Pos.setVal.x;
可写属性云端写入成功即返回;云端向设备端发布属性变更参数;若当前设备不在线,在设备下次上线时会自动更新这些属性参数;
物模型写入数据时,不需要传入时标信息,平台以当前时标作为数据的时标更新物模型中的时标信息。
|
ModifyProductResponse |
IotvideoClient.ModifyProduct(ModifyProductRequest req)
本接口（ModifyProduct）用于编辑物联网智能视频产品的相关信息。
|
ModifyVerContentResponse |
IotvideoClient.ModifyVerContent(ModifyVerContentRequest req)
编辑版本描述信息
|
RefundStorageServiceResponse |
IotvideoClient.RefundStorageService(RefundStorageServiceRequest req)
本接口（RefundStorageService）用于退订已购买的云存服务。
退订时，云存服务对应订单的处理方式 :
1.
|
RunDeviceResponse |
IotvideoClient.RunDevice(RunDeviceRequest req)
本接口（RunDevice）用于启用设备，可进行批量操作，每次操作最多100台设备。
|
RunDeviceStreamResponse |
IotvideoClient.RunDeviceStream(RunDeviceStreamRequest req)
本接口（RunDeviceStream）用于开启设备推流，可进行批量操作，每次操作最多100台设备。
|
RunIotModelResponse |
IotvideoClient.RunIotModel(RunIotModelRequest req)
本接口（RunIotModel）用于对定义的物模型进行发布。
|
RunOtaVersionResponse |
IotvideoClient.RunOtaVersion(RunOtaVersionRequest req)
本接口（RunOtaVersion）用于固件版本正式发布。
|
RunTestOtaVersionResponse |
IotvideoClient.RunTestOtaVersion(RunTestOtaVersionRequest req)
本接口（RunTestOtaVersion）用于固件版本测试发布。
|
SendOnlineMsgResponse |
IotvideoClient.SendOnlineMsg(SendOnlineMsgRequest req)
本接口（SendOnlineMsg）用于向设备发送在线消息。
注意：
若设备当前不在线,会直接返回错误;
若设备网络出现异常时,消息发送可能超时,超时等待最长时间为3秒.waitresp非0情况下,会导致本接口阻塞3秒。
|
SetMessageQueueResponse |
IotvideoClient.SetMessageQueue(SetMessageQueueRequest req)
本接口（SetMessageQueue）用于配置物联网智能视频产品的转发消息队列。
|
UpgradeDeviceResponse |
IotvideoClient.UpgradeDevice(UpgradeDeviceRequest req)
本接口（UpgradeDevice）用于对设备进行固件升级。
该接口向指定的设备下发固件更新指令,可将固件升级到任意版本(可实现固件降级)。
警告:使能UpgradeNow参数存在一定的风险性！建议仅在debug场景下使用!
|
UploadOtaVersionResponse |
IotvideoClient.UploadOtaVersion(UploadOtaVersionRequest req)
本接口（UploadOtaVersion）接收上传到控制台的固件版本信息。
|
| Modifier and Type | Method and Description |
|---|---|
RecommendContentResponse |
IrpClient.RecommendContent(RecommendContentRequest req)
获取推荐结果
|
ReportActionResponse |
IrpClient.ReportAction(ReportActionRequest req)
上报行为
|
ReportMaterialResponse |
IrpClient.ReportMaterial(ReportMaterialRequest req)
上报物料
|
ReportPortraitResponse |
IrpClient.ReportPortrait(ReportPortraitRequest req)
上报用户画像
|
| Modifier and Type | Method and Description |
|---|---|
DescribeGoodsRecommendResponse |
IrpClient.DescribeGoodsRecommend(DescribeGoodsRecommendRequest req)
获取电商类推荐结果
|
FeedRecommendResponse |
IrpClient.FeedRecommend(FeedRecommendRequest req)
获取信息流推荐结果
|
ReportFeedBehaviorResponse |
IrpClient.ReportFeedBehavior(ReportFeedBehaviorRequest req)
上报信息流场景内的行为数据，随着数据的积累，模型的效果会逐渐稳定。
|
ReportFeedItemResponse |
IrpClient.ReportFeedItem(ReportFeedItemRequest req)
上报被用于推荐的信息流内容信息
|
ReportFeedUserResponse |
IrpClient.ReportFeedUser(ReportFeedUserRequest req)
上报信息流用户信息，请务必确认用户的唯一性，并在请求推荐结果时指定用户的唯一标识信息（UserId），否则将无法进行千人千面的推荐
|
ReportGoodsBehaviorResponse |
IrpClient.ReportGoodsBehavior(ReportGoodsBehaviorRequest req)
上报电商类行为数据
|
ReportGoodsInfoResponse |
IrpClient.ReportGoodsInfo(ReportGoodsInfoRequest req)
上报电商类商品信息
|
| Modifier and Type | Method and Description |
|---|---|
AddCustomPersonImageResponse |
IvldClient.AddCustomPersonImage(AddCustomPersonImageRequest req)
增加自定义人脸图片，每个自定义人物最多可包含10张人脸图片
请注意，与创建自定义人物一样，图片数据优先级优于图片URL优先级
|
CreateCustomCategoryResponse |
IvldClient.CreateCustomCategory(CreateCustomCategoryRequest req)
创建自定义人物分类信息
当L2Category为空时，将创建一级自定义分类。
当L1Category与L2Category均不为空时，将创建二级自定义分类。请注意，**只有当一级自定义分类存在时，才可创建二级自定义分类**。
|
CreateCustomGroupResponse |
IvldClient.CreateCustomGroup(CreateCustomGroupRequest req)
创建自定义人物库
Bucket的格式参考为 `bucketName-123456.cos.ap-shanghai.myqcloud.com`
在调用CreateCustomPerson和AddCustomPersonImage接口之前，请先确保本接口成功调用。当前每个用户只支持一个自定义人物库，一旦自定义人物库创建成功，后续接口调用均会返回人物库已存在错误。
由于人脸图片对于自定义人物识别至关重要，因此自定义人物识别功能需要用户显式指定COS存储桶方可使用。具体来说，自定义人物识别功能接口(主要是CreateCustomPerson和AddCustomPersonImage)会在此COS桶下面新建IVLDCustomPersonImage目录，并在此目录下存储自定义人物图片数据以支持后续潜在的特征更新。
请注意：本接口指定的COS桶仅用于**备份存储自定义人物图片**，CreateCustomPerson和AddCustomPersonImage接口入参URL可使用任意COS存储桶下的任意图片。
重要**：请务必确保本接口指定的COS存储桶存在(不要手动删除COS桶)。COS存储桶一旦指定，将不能修改。
|
CreateCustomPersonResponse |
IvldClient.CreateCustomPerson(CreateCustomPersonRequest req)
创建自定义人物。
输入人物名称，基本信息，分类信息与人脸图片，创建自定义人物
人脸图片可使用图片数据(base64编码的图片数据)或者图片URL(推荐使用COS以减少下载时间，其他地址也支持)，原始图片优先，也即如果同时指定了图片数据和图片URL，接口将仅使用图片数据
|
CreateDefaultCategoriesResponse |
IvldClient.CreateDefaultCategories(CreateDefaultCategoriesRequest req)
创建默认自定义人物类型
|
CreateTaskResponse |
IvldClient.CreateTask(CreateTaskRequest req)
创建智能标签任务。
请注意，本接口为异步接口，**返回TaskId只代表任务创建成功，不代表任务执行成功**。
|
DeleteCustomCategoryResponse |
IvldClient.DeleteCustomCategory(DeleteCustomCategoryRequest req)
删除自定义分类信息
|
DeleteCustomPersonResponse |
IvldClient.DeleteCustomPerson(DeleteCustomPersonRequest req)
删除自定义人物
|
DeleteCustomPersonImageResponse |
IvldClient.DeleteCustomPersonImage(DeleteCustomPersonImageRequest req)
删除自定义人脸数据
|
DeleteMediaResponse |
IvldClient.DeleteMedia(DeleteMediaRequest req)
将MediaId对应的媒资文件从系统中删除。
请注意，本接口仅删除媒资文件，媒资文件对应的视频分析结果不会被删除**。如您需要删除结构化分析结果，请调用DeleteTask接口。
|
DeleteTaskResponse |
IvldClient.DeleteTask(DeleteTaskRequest req)
删除任务信息
请注意，本接口**不会**删除媒资文件
只有已完成(成功或者失败)的任务可以删除，**正在执行中的任务不支持删除**
|
DescribeCustomCategoriesResponse |
IvldClient.DescribeCustomCategories(DescribeCustomCategoriesRequest req)
批量描述自定义人物分类信息
|
DescribeCustomGroupResponse |
IvldClient.DescribeCustomGroup(DescribeCustomGroupRequest req)
描述自定义人物库信息，当前库大小(库中有多少人脸)，以及库中的存储桶
|
DescribeCustomPersonDetailResponse |
IvldClient.DescribeCustomPersonDetail(DescribeCustomPersonDetailRequest req)
描述自定义人物详细信息，包括人物信息与人物信息
|
DescribeCustomPersonsResponse |
IvldClient.DescribeCustomPersons(DescribeCustomPersonsRequest req)
批量描述自定义人物
|
DescribeMediaResponse |
IvldClient.DescribeMedia(DescribeMediaRequest req)
描述媒资文件信息，包括媒资状态，分辨率，帧率等。
如果媒资文件未完成导入，本接口将仅输出媒资文件的状态信息；导入完成后，本接口还将输出媒资文件的其他元信息。
|
DescribeMediasResponse |
IvldClient.DescribeMedias(DescribeMediasRequest req)
依照输入条件，描述命中的媒资文件信息，包括媒资状态，分辨率，帧率等。
请注意，本接口最多支持同时描述**50**个媒资文件
如果媒资文件未完成导入，本接口将仅输出媒资文件的状态信息；导入完成后，本接口还将输出媒资文件的其他元信息。
|
DescribeTaskResponse |
IvldClient.DescribeTask(DescribeTaskRequest req)
描述智能标签任务进度。
请注意，**此接口仅返回任务执行状态信息，不返回任务执行结果**
|
DescribeTaskDetailResponse |
IvldClient.DescribeTaskDetail(DescribeTaskDetailRequest req)
描述任务信息，如果任务成功完成，还将返回任务结果
|
DescribeTasksResponse |
IvldClient.DescribeTasks(DescribeTasksRequest req)
依照输入条件，描述命中的任务信息，包括任务创建时间，处理时间信息等。
请注意，本接口最多支持同时描述**50**个任务信息
|
ImportMediaResponse |
IvldClient.ImportMedia(ImportMediaRequest req)
将URL指向的媒资视频文件导入系统之中。
请注意，本接口为异步接口**。接口返回MediaId仅代表导入视频任务发起，不代表任务完成，您可调用读接口(DescribeMedia/DescribeMedias)接口查询MediaId
URL字段推荐您使用COS地址，其形式为`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}`，其中`${Bucket}`为您的COS桶名称，Region为COS桶所在[可用区](https://cloud.tencent.com/document/product/213/6091)，`${ObjectKey}`为指向存储在COS桶内的待分析的视频的[ObjectKey](https://cloud.tencent.com/document/product/436/13324)
另外，目前产品也支持使用外部URL地址，但是当传入URL为非COS地址时，需要您指定额外的WriteBackCosPath以供产品回写结果数据。
分析完成后，本产品将在您的`${Bucket}`桶内创建名为`${ObjectKey}_${task-create-time}`的目录(`task-create-time`形式为1970-01-01T08:08:08)并将分析结果将回传回该目录，也即，结构化分析结果(包括图片，JSON等数据)将会写回`https://${Bucket}-${AppId}.cos.${Region}.myqcloud.com/${ObjectKey}_${task-create-time}`目录
|
ModifyCallbackResponse |
IvldClient.ModifyCallback(ModifyCallbackRequest req)
用户设置对应事件的回调地址
### 回调事件消息通知协议
#### 网络协议
- 回调接口协议目前仅支持http/https协议；
- 请求：HTTP POST 请求，包体内容为 JSON，每一种消息的具体包体内容参见后文。
- 应答：HTTP STATUS CODE = 200，服务端忽略应答包具体内容，为了协议友好，建议客户应答内容携带 JSON： `{"code":0}`
#### 通知可靠性
事件通知服务具备重试能力，事件通知失败后会总计重试3次；
为了避免重试对您的服务器以及网络带宽造成冲击，请保持正常回包。触发重试条件如下：
- 长时间（5 秒）未回包应答。
- 应答 HTTP STATUS 不为200。
#### 回调接口协议
##### 分析任务完成消息回调
| 参数名称 | 必选 | 类型 | 描述 |
|---------|---------|---------|---------|
| EventType | 是 | int | 回调时间类型，1-任务分析完成，2-媒资导入完成 |
| TaskId | 是 | String | 任务ID |
| TaskStatus | 是 | [TaskStatus](/document/product/1509/65063#TaskInfo) | 任务执行状态 |
| FailedReason | 是 | String | 若任务失败，该字段为失败原因 |
##### 导入媒资完成消息回调
| 参数名称 | 必选 | 类型 | 描述 |
|---------|---------|---------|---------|
| EventType | 是 | int | 回调时间类型，1-任务分析完成，2-媒资导入完成 |
| MediaId | 是 | String | 媒资ID |
| MediaStatus | 是 | [MediaStatus](/document/product/1509/65063#MediaInfo) | 媒资导入状态|
| FailedReason | 是 | String | 若任务失败，该字段为失败原因 |
|
QueryCallbackResponse |
IvldClient.QueryCallback(QueryCallbackRequest req)
查询用户回调设置
|
UpdateCustomCategoryResponse |
IvldClient.UpdateCustomCategory(UpdateCustomCategoryRequest req)
更新自定义人物分类
当L2Category为空时，代表更新CategoryId对应的一级自定义人物类型以及所有二级自定义人物类型所从属的一级自定义人物类型；
当L2Category非空时，仅更新CategoryId对应的二级自定义人物类型
|
UpdateCustomPersonResponse |
IvldClient.UpdateCustomPerson(UpdateCustomPersonRequest req)
更新自定义人物信息，包括姓名，简要信息，分类信息等
|
| Modifier and Type | Method and Description |
|---|---|
ApplyDiskBackupResponse |
LighthouseClient.ApplyDiskBackup(ApplyDiskBackupRequest req)
本接口（ApplyDiskBackup）用于回滚指定云硬盘的备份点。
仅支持回滚到原云硬盘。
用于回滚的云硬盘备份点必须处于 NORMAL 状态。
云硬盘备份点状态可以通过 [DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379) 接口查询。
回滚云硬盘备份点时，云硬盘的状态必须为 UNATTACHED或ATTACHED。
云硬盘状态可通过 [DescribeDisks](https://cloud.tencent.com/document/api/1207/66093) 接口查询。
如果云硬盘处于 ATTACHED状态，相关RUNNING 状态的实例会强制关机，然后回滚云硬盘备份点。
|
ApplyFirewallTemplateResponse |
LighthouseClient.ApplyFirewallTemplate(ApplyFirewallTemplateRequest req)
本接口 (ApplyFirewallTemplate) 用于应用防火墙模板到多个实例。
|
ApplyInstanceSnapshotResponse |
LighthouseClient.ApplyInstanceSnapshot(ApplyInstanceSnapshotRequest req)
本接口（ApplyInstanceSnapshot）用于回滚指定实例的系统盘快照。
仅支持回滚到原系统盘。
用于回滚的快照必须处于 NORMAL 状态。快照状态可以通过 DescribeSnapshots 接口查询，见输出参数中 SnapshotState 字段解释。
回滚快照时，实例的状态必须为 STOPPED 或 RUNNING，可通过 DescribeInstances 接口查询实例状态。处于 RUNNING 状态的实例会强制关机，然后回滚快照。
|
AssociateInstancesKeyPairsResponse |
LighthouseClient.AssociateInstancesKeyPairs(AssociateInstancesKeyPairsRequest req)
本接口（AssociateInstancesKeyPairs）用于绑定用户指定密钥对到实例。
只支持 [RUNNING, STOPPED] 状态的 LINUX_UNIX 操作系统的实例。处于 RUNNING 状态的实例会强制关机，然后绑定。
将密钥的公钥写入到实例的 SSH 配置当中，用户就可以通过该密钥的私钥来登录实例。
如果实例原来绑定过密钥，那么原来的密钥将失效。
如果实例原来是通过密码登录，绑定密钥后无法使用密码登录。
支持批量操作。每次请求批量实例的上限为 100。如果批量实例存在不允许操作的实例，操作会以特定错误码返回。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
AttachCcnResponse |
LighthouseClient.AttachCcn(AttachCcnRequest req)
本接口 (AttachCcn) 用于建立与云联网的关联。
|
AttachDisksResponse |
LighthouseClient.AttachDisks(AttachDisksRequest req)
本接口（AttachDisks）用于挂载一个或多个云硬盘。
|
CancelShareBlueprintAcrossAccountsResponse |
LighthouseClient.CancelShareBlueprintAcrossAccounts(CancelShareBlueprintAcrossAccountsRequest req)
本接口（CancelShareBlueprintAcrossAccounts）用于取消镜像跨账号共享。
指定的镜像ID必须为自定义镜像，且指定账号ID必须已进行共享。
|
CreateBlueprintResponse |
LighthouseClient.CreateBlueprint(CreateBlueprintRequest req)
本接口 (CreateBlueprint) 用于创建镜像。
|
CreateDiskBackupResponse |
LighthouseClient.CreateDiskBackup(CreateDiskBackupRequest req)
本接口 ( CreateDiskBackup ) 用于创建指定云硬盘（当前只支持数据盘）的备份点。
|
CreateDisksResponse |
LighthouseClient.CreateDisks(CreateDisksRequest req)
本接口(CreateDisks)用于创建一个或多个云硬盘。
|
CreateFirewallRulesResponse |
LighthouseClient.CreateFirewallRules(CreateFirewallRulesRequest req)
本接口（CreateFirewallRules）用于在实例上添加防火墙规则。
FirewallVersion 为防火墙版本号，用户每次更新防火墙规则版本会自动加1，防止您更新的规则已过期，不填不考虑冲突。
在 FirewallRules 参数中：
Protocol 字段支持输入 TCP，UDP，ICMP，ALL。
Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。
Action 字段只允许输入 ACCEPT 或 DROP。
FirewallRuleDescription 字段长度不得超过 64。
|
CreateFirewallTemplateResponse |
LighthouseClient.CreateFirewallTemplate(CreateFirewallTemplateRequest req)
本接口 (CreateFirewallTemplate) 用于创建防火墙模板。
|
CreateFirewallTemplateRulesResponse |
LighthouseClient.CreateFirewallTemplateRules(CreateFirewallTemplateRulesRequest req)
本接口 (CreateFirewallTemplateRules) 用于创建防火墙模板规则。
|
CreateInstancesResponse |
LighthouseClient.CreateInstances(CreateInstancesRequest req)
本接口(CreateInstances)用于创建一个或多个指定套餐的轻量应用服务器实例。
|
CreateInstanceSnapshotResponse |
LighthouseClient.CreateInstanceSnapshot(CreateInstanceSnapshotRequest req)
本接口（CreateInstanceSnapshot）用于创建指定实例的系统盘快照。
|
CreateKeyPairResponse |
LighthouseClient.CreateKeyPair(CreateKeyPairRequest req)
本接口（CreateKeyPair）用于创建一个密钥对。
|
DeleteBlueprintsResponse |
LighthouseClient.DeleteBlueprints(DeleteBlueprintsRequest req)
本接口 (DeleteBlueprints) 用于删除镜像。
|
DeleteDiskBackupsResponse |
LighthouseClient.DeleteDiskBackups(DeleteDiskBackupsRequest req)
本接口（DeleteDiskBackups）用于删除云硬盘备份点。
云硬盘备份点必须处于 NORMAL 状态，云硬盘备份点状态可以通过 [DescribeDiskBackups](https://cloud.tencent.com/document/api/1207/84379)接口查询，见输出参数中 DiskBackupState 字段解释。
|
DeleteFirewallRulesResponse |
LighthouseClient.DeleteFirewallRules(DeleteFirewallRulesRequest req)
本接口（DeleteFirewallRules）用于删除实例的防火墙规则。
FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接删除指定的规则。
在 FirewallRules 参数中：
Protocol 字段支持输入 TCP，UDP，ICMP，ALL。
Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。
Action 字段只允许输入 ACCEPT 或 DROP。
FirewallRuleDescription 字段长度不得超过 64。
|
DeleteFirewallTemplateResponse |
LighthouseClient.DeleteFirewallTemplate(DeleteFirewallTemplateRequest req)
本接口 (DeleteFirewallTemplate) 用于删除防火墙模板。
|
DeleteFirewallTemplateRulesResponse |
LighthouseClient.DeleteFirewallTemplateRules(DeleteFirewallTemplateRulesRequest req)
本接口 (DeleteFirewallTemplateRules) 用于删除防火墙模板规则。
|
DeleteKeyPairsResponse |
LighthouseClient.DeleteKeyPairs(DeleteKeyPairsRequest req)
本接口（DeleteKeyPairs）用于删除密钥对。
|
DeleteSnapshotsResponse |
LighthouseClient.DeleteSnapshots(DeleteSnapshotsRequest req)
本接口（DeleteSnapshots）用于删除快照。
快照必须处于 NORMAL 状态，快照状态可以通过 DescribeSnapshots 接口查询，见输出参数中 SnapshotState 字段解释。
|
DescribeAllScenesResponse |
LighthouseClient.DescribeAllScenes(DescribeAllScenesRequest req)
本接口(DescribeAllScenes)用于查询全地域使用场景列表。
|
DescribeBlueprintInstancesResponse |
LighthouseClient.DescribeBlueprintInstances(DescribeBlueprintInstancesRequest req)
本接口（DescribeBlueprintInstances）用于查询镜像实例信息。
|
DescribeBlueprintsResponse |
LighthouseClient.DescribeBlueprints(DescribeBlueprintsRequest req)
本接口（DescribeBlueprints）用于查询镜像信息。
|
DescribeBundleDiscountResponse |
LighthouseClient.DescribeBundleDiscount(DescribeBundleDiscountRequest req)
本接口（DescribeBundleDiscount）用于查询套餐折扣信息。
|
DescribeBundlesResponse |
LighthouseClient.DescribeBundles(DescribeBundlesRequest req)
本接口（DescribeBundles）用于查询套餐信息。
|
DescribeCcnAttachedInstancesResponse |
LighthouseClient.DescribeCcnAttachedInstances(DescribeCcnAttachedInstancesRequest req)
本接口 (DescribeCcnAttachedInstances) 用于查询云联网关联的实例信息。
|
DescribeDiskBackupsResponse |
LighthouseClient.DescribeDiskBackups(DescribeDiskBackupsRequest req)
本接口（DescribeDiskBackups）用于查询云硬盘备份点的详细信息。
|
DescribeDiskBackupsDeniedActionsResponse |
LighthouseClient.DescribeDiskBackupsDeniedActions(DescribeDiskBackupsDeniedActionsRequest req)
本接口（DescribeDiskBackupsDeniedActions）用于查询一个或多个云硬盘备份点的操作限制列表信息。
|
DescribeDiskConfigsResponse |
LighthouseClient.DescribeDiskConfigs(DescribeDiskConfigsRequest req)
本接口（DescribeDiskConfigs）用于查询云硬盘配置。
|
DescribeDiskDiscountResponse |
LighthouseClient.DescribeDiskDiscount(DescribeDiskDiscountRequest req)
本接口(DescribeDiskDiscount)用于查询云硬盘折扣信息。
|
DescribeDisksResponse |
LighthouseClient.DescribeDisks(DescribeDisksRequest req)
本接口（DescribeDisks）用于查询云硬盘信息。
|
DescribeDisksDeniedActionsResponse |
LighthouseClient.DescribeDisksDeniedActions(DescribeDisksDeniedActionsRequest req)
本接口（DescribeDisksDeniedActions）用于查询一个或多个云硬盘的操作限制列表信息。
|
DescribeDisksReturnableResponse |
LighthouseClient.DescribeDisksReturnable(DescribeDisksReturnableRequest req)
本接口（DescribeDisksReturnable）用于查询云硬盘是否可退还。
|
DescribeDockerActivitiesResponse |
LighthouseClient.DescribeDockerActivities(DescribeDockerActivitiesRequest req)
查询实例内的Docker活动列表。
|
DescribeDockerContainerConfigurationResponse |
LighthouseClient.DescribeDockerContainerConfiguration(DescribeDockerContainerConfigurationRequest req)
查询实例内的Docker容器配置信息
|
DescribeDockerContainerDetailResponse |
LighthouseClient.DescribeDockerContainerDetail(DescribeDockerContainerDetailRequest req)
查询实例内的Docker容器详情
|
DescribeDockerContainersResponse |
LighthouseClient.DescribeDockerContainers(DescribeDockerContainersRequest req)
查询实例内的容器列表。
|
DescribeFirewallRulesResponse |
LighthouseClient.DescribeFirewallRules(DescribeFirewallRulesRequest req)
本接口（DescribeFirewallRules）用于查询实例的防火墙规则。
|
DescribeFirewallRulesTemplateResponse |
LighthouseClient.DescribeFirewallRulesTemplate(DescribeFirewallRulesTemplateRequest req)
本接口（DescribeFirewallRulesTemplate）用于查询防火墙规则模板。
|
DescribeFirewallTemplateApplyRecordsResponse |
LighthouseClient.DescribeFirewallTemplateApplyRecords(DescribeFirewallTemplateApplyRecordsRequest req)
本接口 (DescribeFirewallTemplateApplyRecords) 用于查询防火墙模板应用记录列表。
|
DescribeFirewallTemplateQuotaResponse |
LighthouseClient.DescribeFirewallTemplateQuota(DescribeFirewallTemplateQuotaRequest req)
本接口 (DescribeFirewallTemplateQuota) 用于查询防火墙模板配额。
|
DescribeFirewallTemplateRuleQuotaResponse |
LighthouseClient.DescribeFirewallTemplateRuleQuota(DescribeFirewallTemplateRuleQuotaRequest req)
本接口 (DescribeFirewallTemplateRuleQuota) 用于查询防火墙模板规则配额。
|
DescribeFirewallTemplateRulesResponse |
LighthouseClient.DescribeFirewallTemplateRules(DescribeFirewallTemplateRulesRequest req)
本接口 (DescribeFirewallTemplateRules) 用于查询防火墙模板规则列表。
|
DescribeFirewallTemplatesResponse |
LighthouseClient.DescribeFirewallTemplates(DescribeFirewallTemplatesRequest req)
本接口 (DescribeFirewallTemplates) 用于查询防火墙模板列表。
|
DescribeGeneralResourceQuotasResponse |
LighthouseClient.DescribeGeneralResourceQuotas(DescribeGeneralResourceQuotasRequest req)
本接口（DescribeGeneralResourceQuotas）用于查询通用资源配额信息。
|
DescribeInstanceLoginKeyPairAttributeResponse |
LighthouseClient.DescribeInstanceLoginKeyPairAttribute(DescribeInstanceLoginKeyPairAttributeRequest req)
本接口用于查询实例默认登录密钥属性。
|
DescribeInstancesResponse |
LighthouseClient.DescribeInstances(DescribeInstancesRequest req)
本接口（DescribeInstances）用于查询一个或多个实例的详细信息。
可以根据实例 ID、实例名称或者实例的内网 IP 查询实例的详细信息。
过滤信息详细请见过滤器 [Filters](https://cloud.tencent.com/document/product/1207/47576#Filter) 。
如果参数为空，返回当前用户一定数量（Limit 所指定的数量，默认为 20）的实例。
支持查询实例的最新操作（LatestOperation）以及最新操作状态（LatestOperationState）。
|
DescribeInstancesDeniedActionsResponse |
LighthouseClient.DescribeInstancesDeniedActions(DescribeInstancesDeniedActionsRequest req)
本接口（DescribeInstancesDeniedActions）用于查询一个或多个实例的操作限制列表信息。
|
DescribeInstancesDiskNumResponse |
LighthouseClient.DescribeInstancesDiskNum(DescribeInstancesDiskNumRequest req)
本接口(DescribeInstancesDiskNum)用于查询实例挂载云硬盘数量。
|
DescribeInstancesReturnableResponse |
LighthouseClient.DescribeInstancesReturnable(DescribeInstancesReturnableRequest req)
本接口（DescribeInstancesReturnable）用于查询实例是否可退还。
|
DescribeInstancesTrafficPackagesResponse |
LighthouseClient.DescribeInstancesTrafficPackages(DescribeInstancesTrafficPackagesRequest req)
本接口（DescribeInstancesTrafficPackages）用于查询一个或多个实例的流量包详情。
|
DescribeInstanceVncUrlResponse |
LighthouseClient.DescribeInstanceVncUrl(DescribeInstanceVncUrlRequest req)
本接口 ( DescribeInstanceVncUrl ) 用于查询实例管理终端地址，获取的地址可用于实例的 VNC 登录。
处于 `STOPPED` 状态的机器无法使用此功能。
管理终端地址的有效期为 15 秒，调用接口成功后如果 15 秒内不使用该链接进行访问，管理终端地址自动失效，您需要重新查询。
管理终端地址一旦被访问，将自动失效，您需要重新查询。
如果连接断开，每分钟内重新连接的次数不能超过 30 次。
参数 `InstanceVncUrl` ：调用接口成功后会返回的 `InstanceVncUrl` 的值。
获取到 `InstanceVncUrl` 后，您需要在链接 `https://img.qcloud.com/qcloud/app/active_vnc/index.html?` 末尾加上参数 `InstanceVncUrl=xxxx`。
最后组成的 URL 格式如下：
```
https://img.qcloud.com/qcloud/app/active_vnc/index.html?InstanceVncUrl=wss%3A%2F%2Fbjvnc.qcloud.com%3A26789%2Fvnc%3Fs%3DaHpjWnRVMFNhYmxKdDM5MjRHNlVTSVQwajNUSW0wb2tBbmFtREFCTmFrcy8vUUNPMG0wSHZNOUUxRm5PMmUzWmFDcWlOdDJIbUJxSTZDL0RXcHZxYnZZMmRkWWZWcEZia2lyb09XMzdKNmM9
```
|
DescribeKeyPairsResponse |
LighthouseClient.DescribeKeyPairs(DescribeKeyPairsRequest req)
本接口 (DescribeKeyPairs) 用于查询用户密钥对信息。
|
DescribeModifyInstanceBundlesResponse |
LighthouseClient.DescribeModifyInstanceBundles(DescribeModifyInstanceBundlesRequest req)
本接口（DescribeModifyInstanceBundles）用于查询实例可变更套餐列表。
|
DescribeRegionsResponse |
LighthouseClient.DescribeRegions(DescribeRegionsRequest req)
本接口（DescribeRegions）用于查询地域信息。
|
DescribeResetInstanceBlueprintsResponse |
LighthouseClient.DescribeResetInstanceBlueprints(DescribeResetInstanceBlueprintsRequest req)
本接口（DescribeResetInstanceBlueprints）查询重置实例的镜像信息。
|
DescribeScenesResponse |
LighthouseClient.DescribeScenes(DescribeScenesRequest req)
本接口(DescribeScenes)用于查看使用场景列表。
|
DescribeSnapshotsResponse |
LighthouseClient.DescribeSnapshots(DescribeSnapshotsRequest req)
本接口（DescribeSnapshots）用于查询快照的详细信息。
|
DescribeSnapshotsDeniedActionsResponse |
LighthouseClient.DescribeSnapshotsDeniedActions(DescribeSnapshotsDeniedActionsRequest req)
本接口（DescribeSnapshotsDeniedActions）用于查询一个或多个快照的操作限制列表信息。
|
DescribeZonesResponse |
LighthouseClient.DescribeZones(DescribeZonesRequest req)
查询地域下可用区
|
DetachCcnResponse |
LighthouseClient.DetachCcn(DetachCcnRequest req)
本接口 (DetachCcn) 用于解除与云联网的关联。
|
DetachDisksResponse |
LighthouseClient.DetachDisks(DetachDisksRequest req)
本接口（DetachDisks）用于卸载一个或多个云硬盘。
|
DisassociateInstancesKeyPairsResponse |
LighthouseClient.DisassociateInstancesKeyPairs(DisassociateInstancesKeyPairsRequest req)
本接口（DisassociateInstancesKeyPairs）用于解除实例与指定密钥对的绑定关系。
只支持 [RUNNING, STOPPED] 状态的 LINUX_UNIX 操作系统的实例。处于 RUNNING 状态的实例会强制关机，然后解绑。
解绑密钥后，实例可以通过原来设置的密码登录。
如果原来没有设置密码，解绑后将无法使用 SSH 登录。可以调用 ResetInstancesPassword 接口来设置登录密码。
支持批量操作。每次请求批量实例的上限为 100。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
ImportKeyPairResponse |
LighthouseClient.ImportKeyPair(ImportKeyPairRequest req)
本接口（ImportKeyPair）用于导入用户指定密钥对。
|
InquirePriceCreateBlueprintResponse |
LighthouseClient.InquirePriceCreateBlueprint(InquirePriceCreateBlueprintRequest req)
本接口 (InquirePriceCreateBlueprint) 用于创建镜像询价。
|
InquirePriceCreateDisksResponse |
LighthouseClient.InquirePriceCreateDisks(InquirePriceCreateDisksRequest req)
本接口（InquirePriceCreateDisks）用于新购云硬盘询价。
|
InquirePriceCreateInstancesResponse |
LighthouseClient.InquirePriceCreateInstances(InquirePriceCreateInstancesRequest req)
本接口（InquiryPriceCreateInstances）用于创建实例询价。
|
InquirePriceRenewDisksResponse |
LighthouseClient.InquirePriceRenewDisks(InquirePriceRenewDisksRequest req)
本接口（InquirePriceRenewDisks）用于续费云硬盘询价。
|
InquirePriceRenewInstancesResponse |
LighthouseClient.InquirePriceRenewInstances(InquirePriceRenewInstancesRequest req)
本接口（InquirePriceRenewInstances）用于续费实例询价。
|
IsolateDisksResponse |
LighthouseClient.IsolateDisks(IsolateDisksRequest req)
本接口(IsolateDisks)用于退还一个或多个轻量应用服务器云硬盘。
只有状态为 UNATTACHED 的数据盘才可以进行此操作。
接口调用成功后，云硬盘会进入SHUTDOWN 状态。
支持批量操作。每次请求批量资源的上限为 20。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。云硬盘操作结果可以通过调用 [DescribeDisks](https://cloud.tencent.com/document/product/1207/66093) 接口查询，如果云硬盘的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
IsolateInstancesResponse |
LighthouseClient.IsolateInstances(IsolateInstancesRequest req)
本接口(IsolateInstances)用于退还一个或多个轻量应用服务器实例。
只有状态为 RUNNING 或 STOPPED 的实例才可以进行此操作。
接口调用成功后，实例会进入SHUTDOWN 状态。
支持批量操作。每次请求批量资源（包括实例与数据盘）的上限为 20。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
ModifyBlueprintAttributeResponse |
LighthouseClient.ModifyBlueprintAttribute(ModifyBlueprintAttributeRequest req)
本接口 (ModifyBlueprintAttribute) 用于修改镜像属性。
|
ModifyDiskBackupsAttributeResponse |
LighthouseClient.ModifyDiskBackupsAttribute(ModifyDiskBackupsAttributeRequest req)
本接口 (ModifyDiskBackupsAttribute) 用于修改云硬盘备份点属性。
|
ModifyDisksAttributeResponse |
LighthouseClient.ModifyDisksAttribute(ModifyDisksAttributeRequest req)
本接口(ModifyDisksAttribute)用于修改云硬盘属性。
|
ModifyDisksBackupQuotaResponse |
LighthouseClient.ModifyDisksBackupQuota(ModifyDisksBackupQuotaRequest req)
本接口(ModifyDisksBackupQuota)用于调整云硬盘备份点配额。该操作目前仅支持云硬盘类型为数据盘的云硬盘。
|
ModifyDisksRenewFlagResponse |
LighthouseClient.ModifyDisksRenewFlag(ModifyDisksRenewFlagRequest req)
本接口（ModifyDisksRenewFlag）用于修改云硬盘续费标识。
|
ModifyDockerContainerResponse |
LighthouseClient.ModifyDockerContainer(ModifyDockerContainerRequest req)
修改实例内的Docker容器，之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询重建情况。
请注意：本接口会重新创建并运行实例内的Docker容器。
|
ModifyFirewallRuleDescriptionResponse |
LighthouseClient.ModifyFirewallRuleDescription(ModifyFirewallRuleDescriptionRequest req)
本接口（ModifyFirewallRuleDescription）用于修改单条防火墙规则描述。
FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接修改防火墙规则备注。
在 FirewallRule 参数中：
Protocol 字段支持输入 TCP，UDP，ICMP，ALL。
Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。
Action 字段只允许输入 ACCEPT 或 DROP。
FirewallRuleDescription 字段长度不得超过 64。
|
ModifyFirewallRulesResponse |
LighthouseClient.ModifyFirewallRules(ModifyFirewallRulesRequest req)
本接口（ModifyFirewallRules）用于重置实例防火墙规则。
本接口先删除当前实例的所有防火墙规则，然后添加新的规则。
FirewallVersion 用于指定要操作的防火墙的版本。传入 FirewallVersion 版本号若不等于当前防火墙的最新版本，将返回失败；若不传 FirewallVersion 则直接重置防火墙规则。
在 FirewallRules 参数中：
Protocol 字段支持输入 TCP，UDP，ICMP，ALL。
Port 字段允许输入 ALL，或者一个单独的端口号，或者用逗号分隔的离散端口号，或者用减号分隔的两个端口号代表的端口范围。当 Port 为范围时，减号分隔的第一个端口号小于第二个端口号。当 Protocol 字段不是 TCP 或 UDP 时，Port 字段只能为空或 ALL。Port 字段长度不得超过 64。
CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。租户之间网络隔离规则优先于防火墙中的内网规则。
Action 字段只允许输入 ACCEPT 或 DROP。
FirewallRuleDescription 字段长度不得超过 64。
|
ModifyFirewallTemplateResponse |
LighthouseClient.ModifyFirewallTemplate(ModifyFirewallTemplateRequest req)
本接口 (ModifyFirewallTemplate) 用于修改防火墙模板。
|
ModifyInstancesAttributeResponse |
LighthouseClient.ModifyInstancesAttribute(ModifyInstancesAttributeRequest req)
本接口（ModifyInstancesAttribute）用于修改实例的属性。
“实例名称”仅为方便用户自己管理之用。
支持批量操作。每次请求批量实例的上限为 100。
|
ModifyInstancesBundleResponse |
LighthouseClient.ModifyInstancesBundle(ModifyInstancesBundleRequest req)
本接口(ModifyInstancesBundle)用于变更一个或多个轻量应用服务器实例套餐。
只有状态为 RUNNING，STOPPED的实例才可以进行此操作。
支持批量操作。每次请求批量实例的上限为 30。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
ModifyInstancesLoginKeyPairAttributeResponse |
LighthouseClient.ModifyInstancesLoginKeyPairAttribute(ModifyInstancesLoginKeyPairAttributeRequest req)
本接口用于设置实例默认登录密钥对属性。
|
ModifyInstancesRenewFlagResponse |
LighthouseClient.ModifyInstancesRenewFlag(ModifyInstancesRenewFlagRequest req)
本接口 (ModifyInstancesRenewFlag) 用于修改包年包月实例续费标识。
实例被标识为自动续费后，每次在实例到期时，会自动续费一个月。
支持批量操作。每次请求批量实例的上限为100。
|
ModifySnapshotAttributeResponse |
LighthouseClient.ModifySnapshotAttribute(ModifySnapshotAttributeRequest req)
本接口（ModifySnapshotAttribute）用于修改指定快照的属性。
“快照名称”仅为方便用户自己管理之用。
|
RebootInstancesResponse |
LighthouseClient.RebootInstances(RebootInstancesRequest req)
本接口（RebootInstances）用于重启实例。
只有状态为 RUNNING 的实例才可以进行此操作。
接口调用成功时，实例会进入 REBOOTING 状态；重启实例成功时，实例会进入 RUNNING 状态。
支持批量操作，每次请求批量实例的上限为 100。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
RemoveDockerContainersResponse |
LighthouseClient.RemoveDockerContainers(RemoveDockerContainersRequest req)
删除实例内的Docker容器，之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询删除情况。
|
RenameDockerContainerResponse |
LighthouseClient.RenameDockerContainer(RenameDockerContainerRequest req)
重命名实例内的Docker容器，之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询重命名情况。
|
RenewDisksResponse |
LighthouseClient.RenewDisks(RenewDisksRequest req)
本接口(RenewDisks)用于续费一个或多个轻量应用服务器云硬盘。
只有状态为 ATTACHED，UNATTACHED 或 SHUTDOWN 的数据盘才可以进行此操作。
支持批量操作。每次请求批量云硬盘的上限为 50。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。云硬盘操作结果可以通过调用 [DescribeDisks](https://cloud.tencent.com/document/product/1207/66093) 接口查询，如果云硬盘的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
RenewInstancesResponse |
LighthouseClient.RenewInstances(RenewInstancesRequest req)
本接口(RenewInstances)用于续费一个或多个轻量应用服务器实例。
只有状态为 RUNNING，STOPPED 或 SHUTDOWN 的实例才可以进行此操作。
支持批量操作。每次请求批量实例的上限为 100。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
ReplaceFirewallTemplateRuleResponse |
LighthouseClient.ReplaceFirewallTemplateRule(ReplaceFirewallTemplateRuleRequest req)
本接口 (ReplaceFirewallTemplateRules) 用于替换防火墙模板规则。
|
RerunDockerContainerResponse |
LighthouseClient.RerunDockerContainer(RerunDockerContainerRequest req)
重新创建并运行实例内的Docker容器，之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询重建情况。
|
ResetAttachCcnResponse |
LighthouseClient.ResetAttachCcn(ResetAttachCcnRequest req)
本接口 (ResetAttachCcn) 用于关联云联网实例申请过期时，重新申请关联操作。
|
ResetFirewallTemplateRulesResponse |
LighthouseClient.ResetFirewallTemplateRules(ResetFirewallTemplateRulesRequest req)
本接口 (ResetFirewallTemplateRules) 用于重置防火墙模板下所有规则。
|
ResetInstanceResponse |
LighthouseClient.ResetInstance(ResetInstanceRequest req)
本接口（ResetInstance）用于重装指定实例上的镜像。
如果指定了 BlueprintId 参数，则使用指定的镜像重装；否则按照当前实例使用的镜像进行重装。
系统盘将会被格式化，并重置；请确保系统盘中无重要文件。
目前不支持实例使用该接口实现 LINUX_UNIX 和 WINDOWS 操作系统切换。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
ResetInstancesPasswordResponse |
LighthouseClient.ResetInstancesPassword(ResetInstancesPasswordRequest req)
本接口（ResetInstancesPassword）用于将实例操作系统的密码重置为用户指定的密码。
只修改管理员账号的密码。实例的操作系统不同，管理员账号也会不一样（Windows 为 Administrator，Ubuntu 为 ubuntu ，其它系统为 root）。
支持批量操作。将多个实例操作系统的密码重置为相同的密码。每次请求批量实例的上限为 100。
建议对运行中的实例先手动关机，然后再进行密码重置。如实例处于运行中状态，本接口操作过程中会对实例进行关机操作，尝试正常关机失败后进行强制关机。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
注意：强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏。
|
ResizeDisksResponse |
LighthouseClient.ResizeDisks(ResizeDisksRequest req)
本接口(ResizeDisks)用于扩容云硬盘。该操作目前仅支持云硬盘类型为数据盘的云硬盘。
|
RestartDockerContainersResponse |
LighthouseClient.RestartDockerContainers(RestartDockerContainersRequest req)
重启实例内的Docker容器，之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询重启情况。
|
RunDockerContainersResponse |
LighthouseClient.RunDockerContainers(RunDockerContainersRequest req)
创建并运行多个Docker容器，之后可以通过返回的ActivityIds调用DescribeDockerActivities接口查询创建情况。
|
ShareBlueprintAcrossAccountsResponse |
LighthouseClient.ShareBlueprintAcrossAccounts(ShareBlueprintAcrossAccountsRequest req)
本接口（ShareBlueprintAcrossAccounts）用于跨账号共享镜像。
仅支持共享自定义镜像， 且用于共享的镜像状态必须为NORMAL。
共享的账号必须为主账号。
|
StartDockerContainersResponse |
LighthouseClient.StartDockerContainers(StartDockerContainersRequest req)
启动实例内的Docker容器，之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询启动情况。
|
StartInstancesResponse |
LighthouseClient.StartInstances(StartInstancesRequest req)
本接口（StartInstances）用于启动一个或多个实例。
只有状态为 STOPPED 的实例才可以进行此操作。
接口调用成功时，实例会进入 STARTING 状态；启动实例成功时，实例会进入 RUNNING 状态。
支持批量操作。每次请求批量实例的上限为 100。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
StopDockerContainersResponse |
LighthouseClient.StopDockerContainers(StopDockerContainersRequest req)
停止实例内的Docker容器，之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询停止情况。
|
StopInstancesResponse |
LighthouseClient.StopInstances(StopInstancesRequest req)
本接口（StopInstances）用于关闭一个或多个实例。
只有状态为 RUNNING 的实例才可以进行此操作。
接口调用成功时，实例会进入 STOPPING 状态；关闭实例成功时，实例会进入 STOPPED 状态。
支持批量操作。每次请求批量实例的上限为 100。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态（LatestOperationState）为“SUCCESS”，则代表操作成功。
|
TerminateDisksResponse |
LighthouseClient.TerminateDisks(TerminateDisksRequest req)
本接口（TerminateDisks）用于销毁一个或多个云硬盘。
|
TerminateInstancesResponse |
LighthouseClient.TerminateInstances(TerminateInstancesRequest req)
本接口 (TerminateInstances) 用于销毁实例。
处于 SHUTDOWN 状态的实例，可通过本接口销毁，且不可恢复。
支持批量操作，每次请求批量实例的上限为100。
本接口为异步接口，请求发送成功后会返回一个 RequestId，此时操作并未立即完成。实例操作结果可以通过调用 DescribeInstances 接口查询，如果实例的最新操作状态 (LatestOperationState) 为“SUCCESS”，则代表操作成功。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDataSourceListResponse |
LowcodeClient.DescribeDataSourceList(DescribeDataSourceListRequest req)
获取数据源详情列表
|
| Modifier and Type | Method and Description |
|---|---|
QueryLoginProtectionResponse |
LpClient.QueryLoginProtection(QueryLoginProtectionRequest req)
登录保护服务（LoginProtection，LP）针对网站和 APP 的用户登录场景，实时检测是否存在盗号、撞库等恶意登录行为，帮助开发者发现异常登录，降低恶意用户登录给业务带来的风险。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeDrawResourceListResponse |
MallClient.DescribeDrawResourceList(DescribeDrawResourceListRequest req)
依据客户的Uin查询开通的资源列表
|
| Modifier and Type | Method and Description |
|---|---|
FlowProductRemindResponse |
MarketClient.FlowProductRemind(FlowProductRemindRequest req)
计量商品用量提醒，用于服务商调用云服务，云服务向客户发送提醒信息
|
GetUsagePlanUsageAmountResponse |
MarketClient.GetUsagePlanUsageAmount(GetUsagePlanUsageAmountRequest req)
该接口可以根据InstanceId查询实例的api的使用情况。
|
| Modifier and Type | Method and Description |
|---|---|
DescribeInstancesResponse |
MemcachedClient.DescribeInstances(DescribeInstancesRequest req)
获取Cmem实例列表
|
| Modifier and Type | Method and Description |
|---|---|
DismissRoomResponse |
MgobeClient.DismissRoom(DismissRoomRequest req)
通过game_id、room_id解散房间
|
| Modifier and Type | Method and Description |
|---|---|
ChangeRoomPlayerProfileResponse |
MgobeClient.ChangeRoomPlayerProfile(ChangeRoomPlayerProfileRequest req)
此接口无法使用，游戏联机对战引擎MGOBE已于6.1正式下架，感谢您的支持
修改房间玩家自定义属性
|
ChangeRoomPlayerStatusResponse |
MgobeClient.ChangeRoomPlayerStatus(ChangeRoomPlayerStatusRequest req)
此接口无法使用，游戏联机对战引擎MGOBE已于6.1正式下架，感谢您的支持
修改玩家自定义状态
|
DescribePlayerResponse |
MgobeClient.DescribePlayer(DescribePlayerRequest req)
此接口无法使用，游戏联机对战引擎MGOBE已于6.1正式下架，感谢您的支持
该接口用于查询玩家信息。支持两种用法，当OpenId不传的时候，PlayerId必传，传入PlayerId可以查询当前PlayerId的玩家信息，当OpenId传入的时候，PlayerId可不传，按照OpenId查询玩家信息。
|
DescribeRoomResponse |
MgobeClient.DescribeRoom(DescribeRoomRequest req)
此接口无法使用，游戏联机对战引擎MGOBE已于6.1正式下架，感谢您的支持
该接口用于查询房间信息。支持两种用法，当房间Id不传的时候，玩家Id必传，传入玩家Id可以查询当前玩家所在的房间信息，当房间Id传入的时候，玩家Id可不传，按照房间Id查询房间信息。
|
DismissRoomResponse |
MgobeClient.DismissRoom(DismissRoomRequest req)
此接口无法使用，游戏联机对战引擎MGOBE已于6.1正式下架，感谢您的支持
通过game_id、room_id解散房间
|
ModifyRoomResponse |
MgobeClient.ModifyRoom(ModifyRoomRequest req)
此接口无法使用，游戏联机对战引擎MGOBE已于6.1正式下架，感谢您的支持
修改房间
|
RemoveRoomPlayerResponse |
MgobeClient.RemoveRoomPlayer(RemoveRoomPlayerRequest req)
此接口无法使用，游戏联机对战引擎MGOBE已于6.1正式下架，感谢您的支持
踢出房间玩家
|
| 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)用于设置（初始化）MongoDB云数据库实例账户密码。
|
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 |
|---|---|
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 |
|---|---|
MarketingValueJudgementResponse |
MvjClient.MarketingValueJudgement(MarketingValueJudgementRequest req)
欢迎使用营销价值判断（Marketing Value Judgement，简称 MVJ）。
营销价值判断（MVJ）是针对零售场景的风控服务，通过识别高价值顾客，以帮助零售商保障营销资金
|
| Modifier and Type | Method and Description |
|---|---|
AnalyzeSentimentResponse |
NlpClient.AnalyzeSentiment(AnalyzeSentimentRequest req)
情感分析接口能够对带有情感色彩的主观性文本进行分析、处理、归纳和推理，识别出用户的情感倾向，是积极、中性还是消极，并且提供各自概率。
|
ClassifyContentResponse |
NlpClient.ClassifyContent(ClassifyContentRequest req)
文本分类接口能够对用户输入的文章进行自动分类，将其映射到具体的类目上，用户只需要提供待分类的文本，而无需关注具体实现。该功能定义了一套较为完备的[三级分类体系](https://cloud.tencent.com/document/product/271/94286)，积累了数百万的语料，经过多轮迭代优化打造了较先进的深度学习模型，以保证效果不断提升。
|
ComposeCoupletResponse |
NlpClient.ComposeCouplet(ComposeCoupletRequest req)
对联生成接口根据用户输入的命题关键词，智能生成一副完整的春联，包括上联、下联和横批。该接口利用先进的自然语言处理技术，确保生成的春联既符合传统对仗、对韵、对义的要求，又具有新意和创意，为用户提供独特的春节祝福。
|
ComposePoetryResponse |
NlpClient.ComposePoetry(ComposePoetryRequest req)
诗词生成接口利用现代的自然语言处理和深度学习技术，模仿了古代著名诗人的风格，为用户产生独特的诗词。用户只需输入的命题关键词，接口就能自动生成一首七言律诗或五言律诗。
|
EvaluateSentenceSimilarityResponse |
NlpClient.EvaluateSentenceSimilarity(EvaluateSentenceSimilarityRequest req)
通过计算句子间的语义相似性，帮助您快速找到文本中重复或相似的句子，用于文本聚类、相似问题检索等应用场景。
|
EvaluateWordSimilarityResponse |
NlpClient.EvaluateWordSimilarity(EvaluateWordSimilarityRequest req)
评估两个词语在语义空间的相似程度，为您的场景应用提供有力支持，如关键词过滤、热门话题挖掘等。（目前仅支持中文）
|
GenerateKeywordSentenceResponse |
NlpClient.GenerateKeywordSentence(GenerateKeywordSentenceRequest req)
根据提供的关键词，生成简洁明了的关键句子，便于用户快速获取核心观点。
|
ParseWordsResponse |
NlpClient.ParseWords(ParseWordsRequest req)
通过精准地对文本进行分词、词性标注、命名实体识别等功能，助您更好地理解文本内容，挖掘出潜在的价值信息。
|
RetrieveSimilarWordsResponse |
NlpClient.RetrieveSimilarWords(RetrieveSimilarWordsRequest req)
基于大数据和深度学习技术，可以快速地找到与给定词语高度相似的其他词语，有助于提高搜索和推荐的准确性。（目前仅支持中文）
|
SentenceCorrectionResponse |
NlpClient.SentenceCorrection(SentenceCorrectionRequest req)
智能识别并纠正句子中的语法、拼写、用词等错误，确保文本的准确性和可读性。
|
TextEmbellishResponse |
NlpClient.TextEmbellish(TextEmbellishRequest req)
运用先进的自然语言处理技术，对原始文本进行优化润色，提升文本的通顺性、表达力和语言质量。
|
TextWritingResponse |
NlpClient.TextWriting(TextWritingRequest req)
通过自动补全文本片段，帮助用户快速生成高质量、连贯的完整文本，提高创作效率。
|
| Modifier and Type | Method and Description |
|---|---|
CreateCallBackResponse |
NppClient.CreateCallBack(CreateCallBackRequest req)
回拨呼叫请求
|
DeleteCallBackResponse |
NppClient.DeleteCallBack(DeleteCallBackRequest req)
回拨呼叫取消
|
DelVirtualNumResponse |
NppClient.DelVirtualNum(DelVirtualNumRequest req)
直拨解绑中间号
|
DescribeCallBackCdrResponse |
NppClient.DescribeCallBackCdr(DescribeCallBackCdrRequest req)
回拨话单获取接口
|
DescribeCallBackStatusResponse |
NppClient.DescribeCallBackStatus(DescribeCallBackStatusRequest req)
回拨通话状态获取
|
DescribeCallerDisplayListResponse |
NppClient.DescribeCallerDisplayList(DescribeCallerDisplayListRequest req)
回拨拉取主叫显号号码集合
|
Get400CdrResponse |
NppClient.Get400Cdr(Get400CdrRequest req)
直拨话单获取接口
|
GetVirtualNumResponse |
NppClient.GetVirtualNum(GetVirtualNumRequest req)
直拨获取中间号（App 使用方发起）
|