Uses of Class
com.tencentcloudapi.common.exception.TencentCloudSDKException
-
-
Uses of TencentCloudSDKException in com.tencentcloudapi.aa.v20200224
Methods in com.tencentcloudapi.aa.v20200224 that throw TencentCloudSDKException Modifier and Type Method Description QueryActivityAntiRushResponse
AaClient. QueryActivityAntiRush(QueryActivityAntiRushRequest req)
腾讯云活动防刷(ActivityAntiRush,AA)是针对电商、O2O、P2P、游戏、支付等行业在促销活动中遇到“羊毛党”恶意刷取优惠福利的行为时,通过防刷引擎,精准识别出“薅羊毛”恶意行为的活动防刷服务,避免了企业被刷带来的巨大经济损失。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.aai.v20180522
Methods in com.tencentcloudapi.aai.v20180522 that throw TencentCloudSDKException Modifier and Type Method 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语音播报新闻;智能设备语音提醒;依靠网上现有节目或少量录音,快速合成明星语音,降低邀约成本;支持车载导航语音合成的个性化语音播报。 内测期间免费使用。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.acp.v20220105
-
Uses of TencentCloudSDKException in com.tencentcloudapi.advisor.v20200721
Methods in com.tencentcloudapi.advisor.v20200721 that throw TencentCloudSDKException Modifier and Type Method Description DescribeStrategiesResponse
AdvisorClient. DescribeStrategies(DescribeStrategiesRequest req)
用于查询评估项的信息DescribeTaskStrategyRisksResponse
AdvisorClient. DescribeTaskStrategyRisks(DescribeTaskStrategyRisksRequest req)
查询评估项风险实例列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.af.v20200226
Methods in com.tencentcloudapi.af.v20200226 that throw TencentCloudSDKException Modifier and Type Method Description DescribeAntiFraudResponse
AfClient. DescribeAntiFraud(DescribeAntiFraudRequest req)
天御反欺诈服务,主要应用于银行、证券、保险、消费金融等金融行业客户,通过腾讯的大数据风控能力, 可以准确识别恶意用户信息,解决客户在支付、活动、理财,风控等业务环节遇到的欺诈威胁,降低企业 的损失。GetAntiFraudResponse
AfClient. GetAntiFraud(GetAntiFraudRequest req)
反欺诈评分接口QueryAntiFraudResponse
AfClient. QueryAntiFraud(QueryAntiFraudRequest req)
天御反欺诈服务,主要应用于银行、证券、保险、消费金融等金融行业客户,通过腾讯的大数据风控能力, 可以准确识别恶意用户信息,解决客户在支付、活动、理财,风控等业务环节遇到的欺诈威胁,降低企业 的损失。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.afc.v20200226
Methods in com.tencentcloudapi.afc.v20200226 that throw TencentCloudSDKException Modifier and Type Method Description GetAntiFraudVipResponse
AfcClient. GetAntiFraudVip(GetAntiFraudVipRequest req)
反欺诈VIP评分接口QueryAntiFraudVipResponse
AfcClient. QueryAntiFraudVip(QueryAntiFraudVipRequest req)
天御反欺诈服务,主要应用于银行、证券、保险、P2P等金融行业客户,通过腾讯的大数据风控能力, 可以准确识别恶意用户信息,解决客户在支付、活动、理财,风控等业务环节遇到的欺诈威胁,降低企业 的损失。TransportGeneralInterfaceResponse
AfcClient. TransportGeneralInterface(TransportGeneralInterfaceRequest req)
天御信鸽取数平台接口 -
Uses of TencentCloudSDKException in com.tencentcloudapi.aiart.v20221229
Methods in com.tencentcloudapi.aiart.v20221229 that throw TencentCloudSDKException Modifier and Type Method Description ImageToImageResponse
AiartClient. ImageToImage(ImageToImageRequest req)
智能图生图接口将根据输入的图片及辅助描述文本,智能生成与之相关的结果图。 输入:单边分辨率小于2000、转成 Base64 字符串后小于 5MB 的图片,建议同时输入描述文本。 输出:对应风格及分辨率的 AI 生成图。 可支持的风格详见 [智能图生图风格列表](https://cloud.tencent.com/document/product/1668/86250),请将列表中的“风格编号”传入 Styles 数组,建议选择一种风格。 请求频率限制为1次/秒。TextToImageResponse
AiartClient. TextToImage(TextToImageRequest req)
智能文生图接口将根据输入的描述文本,智能生成与之相关的结果图。 输入:256个字符以内的描述性文本,推荐使用中文。 输出:对应风格及分辨率的 AI 生成图。 可支持的风格详见 [智能文生图风格列表](https://cloud.tencent.com/document/product/1668/86249),请将列表中的“风格编号”传入 Styles 数组,建议选择一种风格。 请求频率限制为1次/秒。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ame.v20190916
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ams.v20200608
Methods in com.tencentcloudapi.ams.v20200608 that throw TencentCloudSDKException Modifier and Type Method 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)
查看任务详情 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ams.v20201229
Methods in com.tencentcloudapi.ams.v20201229 that throw TencentCloudSDKException Modifier and Type Method 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分钟检测到音频切片数据,则恢复正常审核,反之,则终止拉流并退出审核。在拉流终止后,用户如有审核需求,需重新送审。 默认接口请求频率限制:20次/秒。DescribeTaskDetailResponse
AmsClient. DescribeTaskDetail(DescribeTaskDetailRequest req)
通过该接口可查看音频审核任务的详情信息,包括任务状态、检测结果、音频文件识别出的对应文本内容、检测结果所对应的恶意标签及推荐的后续操作等,具体输出内容可查看输出参数示例。
默认接口请求频率限制:**100次/秒**。DescribeTasksResponse
AmsClient. DescribeTasks(DescribeTasksRequest req)
通过该接口可查看审核任务列表;您也可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表。任务列表输出内容包括当前查询的任务总量、任务名称、任务状态、音频审核类型、基于检测结果的恶意标签及其后续操作等,具体输出内容可查看输出参数示例。
默认接口请求频率限制:**20次/秒**。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.anicloud.v20220923
Methods in com.tencentcloudapi.anicloud.v20220923 that throw TencentCloudSDKException Modifier and Type Method Description CheckAppidExistResponse
AnicloudClient. CheckAppidExist(CheckAppidExistRequest req)
查看appid是否存在QueryResourceResponse
AnicloudClient. QueryResource(QueryResourceRequest req)
查询购买资源QueryResourceInfoResponse
AnicloudClient. QueryResourceInfo(QueryResourceInfoRequest req)
查询资源信息 -
Uses of TencentCloudSDKException in com.tencentcloudapi.antiddos.v20200309
-
Uses of TencentCloudSDKException in com.tencentcloudapi.apcas.v20201127
Methods in com.tencentcloudapi.apcas.v20201127 that throw TencentCloudSDKException Modifier and Type Method 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 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ape.v20200513
Methods in com.tencentcloudapi.ape.v20200513 that throw TencentCloudSDKException Modifier and Type Method 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)
根据关键字搜索图片列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.api.v20201106
Methods in com.tencentcloudapi.api.v20201106 that throw TencentCloudSDKException Modifier and Type Method Description DescribeProductsResponse
ApiClient. DescribeProducts(DescribeProductsRequest req)
本接口(DescribeProducts)用于查询各个支持地域列表查询的产品信息。DescribeRegionsResponse
ApiClient. DescribeRegions(DescribeRegionsRequest req)
本接口(DescribeRegions)用于查询各个产品支持地域信息。DescribeZonesResponse
ApiClient. DescribeZones(DescribeZonesRequest req)
本接口(DescribeZones)用于查询产品可用区信息。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.apigateway.v20180808
Methods in com.tencentcloudapi.apigateway.v20180808 that throw TencentCloudSDKException Modifier and Type Method 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 网关创建服务并发布服务到某个环境后,如在开发过程产生多个版本需要切换,此时可调用本接口。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.apm.v20210622
-
Uses of TencentCloudSDKException in com.tencentcloudapi.as.v20180419
Methods in com.tencentcloudapi.as.v20180419 that throw TencentCloudSDKException Modifier and Type Method Description AttachInstancesResponse
AsClient. AttachInstances(AttachInstancesRequest req)
本接口(AttachInstances)用于将 CVM 实例添加到伸缩组。 仅支持添加处于`RUNNING`(运行中)或`STOPPED`(已关机)状态的 CVM 实例 添加的 CVM 实例需要和伸缩组 VPC 网络一致AttachLoadBalancersResponse
AsClient. AttachLoadBalancers(AttachLoadBalancersRequest req)
此接口(AttachLoadBalancers)用于将负载均衡器添加到伸缩组。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)的通知。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执行伸缩策略。 伸缩策略所属伸缩组处于伸缩活动时,会拒绝执行伸缩策略。 本接口不支持执行目标追踪策略。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 会进行解挂载动作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)文档查看伸缩组停用状态的影响范围 接口会增加期望实例数,新的期望实例数需要小于等于最大实例数 扩容如果失败或者部分成功,最后期望实例数只会增加实际成功的实例数量 竞价混合模式中一次扩容可能触发多个伸缩活动,该接口仅返回第一个伸缩活动的 ActivityIdSetInstancesProtectionResponse
AsClient. SetInstancesProtection(SetInstancesProtectionRequest req)
本接口(SetInstancesProtection)用于设置实例保护。 实例设置保护之后,当发生不健康替换、报警策略、期望值变更等触发缩容时,将不对此实例缩容操作。StartAutoScalingInstancesResponse
AsClient. StartAutoScalingInstances(StartAutoScalingInstancesRequest req)
本接口(StartAutoScalingInstances)用于开启伸缩组内 CVM 实例。 开机成功,实例转为`IN_SERVICE`状态后,会增加期望实例数,期望实例数不可超过设置的最大值 本接口支持批量操作,每次请求开机实例的上限为100StopAutoScalingInstancesResponse
AsClient. StopAutoScalingInstances(StopAutoScalingInstancesRequest req)
本接口(StopAutoScalingInstances)用于关闭伸缩组内 CVM 实例。 关机方式采用`SOFT_FIRST`方式,表示在正常关闭失败后进行强制关闭 关闭`IN_SERVICE`状态的实例,会减少期望实例数,期望实例数不可低于设置的最小值 使用`STOP_CHARGING`选项关机,待关机的实例需要满足[关机不收费条件](https://cloud.tencent.com/document/product/213/19918) 本接口支持批量操作,每次请求关机实例的上限为100UpgradeLaunchConfigurationResponse
AsClient. UpgradeLaunchConfiguration(UpgradeLaunchConfigurationRequest req)
已有替代接口ModifyLaunchConfiguration。该接口存在覆盖参数风险,目前官网已隐藏 本接口(UpgradeLaunchConfiguration)用于升级启动配置。 本接口用于升级启动配置,采用“完全覆盖”风格,无论之前参数如何,统一按照接口参数设置为新的配置。对于非必填字段,不填写则按照默认值赋值。 升级修改启动配置后,已经使用该启动配置扩容的存量实例不会发生变更,此后使用该启动配置的新增实例会按照新的配置进行扩容。UpgradeLifecycleHookResponse
AsClient. UpgradeLifecycleHook(UpgradeLifecycleHookRequest req)
本接口(UpgradeLifecycleHook)用于升级生命周期挂钩。 本接口用于升级生命周期挂钩,采用“完全覆盖”风格,无论之前参数如何,统一按照接口参数设置为新的配置。对于非必填字段,不填写则按照默认值赋值。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.asr.v20190614
Methods in com.tencentcloudapi.asr.v20190614 that throw TencentCloudSDKException Modifier and Type Method Description CloseAsyncRecognitionTaskResponse
AsrClient. CloseAsyncRecognitionTask(CloseAsyncRecognitionTaskRequest req)
本接口用于关闭语音流异步识别任务。CreateAsrVocabResponse
AsrClient. CreateAsrVocab(CreateAsrVocabRequest req)
用户通过本接口进行热词表的创建。
• 默认最多可创建30个热词表。
• 每个热词表最多可添加1000个词,每个词最长10个汉字或30个英文字符,不能超出限制。
• 热词表可以通过数组或者本地文件形式上传。
• 本地文件必须为UTF-8编码格式,每行仅添加一个热词且不能包含标点和特殊字符。
• 热词权重取值范围为[1,10]之间的整数,权重越大代表该词被识别出来的概率越大。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) 中签名方法 v3DeleteAsrVocabResponse
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。
• 请求方法为 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)
用户通过本接口进行对应的词表信息更新。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)和一段音频进行音频和说话人的匹配度判断 -
Uses of TencentCloudSDKException in com.tencentcloudapi.asw.v20200722
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ba.v20200720
Methods in com.tencentcloudapi.ba.v20200720 that throw TencentCloudSDKException Modifier and Type Method Description CreateWeappQRUrlResponse
BaClient. CreateWeappQRUrl(CreateWeappQRUrlRequest req)
创建渠道备案小程序二维码DescribeGetAuthInfoResponse
BaClient. DescribeGetAuthInfo(DescribeGetAuthInfoRequest req)
获取实名认证信息SyncIcpOrderWebInfoResponse
BaClient. SyncIcpOrderWebInfo(SyncIcpOrderWebInfoRequest req)
将备案ICP订单下的一个网站信息 同步给订单下其他网站,需要被同步的网站被检查通过(isCheck:true); 只有指定的网站信息字段能被同步 -
Uses of TencentCloudSDKException in com.tencentcloudapi.batch.v20170312
-
Uses of TencentCloudSDKException in com.tencentcloudapi.bda.v20200324
Methods in com.tencentcloudapi.bda.v20200324 that throw TencentCloudSDKException Modifier and Type Method 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)
终止指定视频人像分割处理任务 -
Uses of TencentCloudSDKException in com.tencentcloudapi.bi.v20220105
Methods in com.tencentcloudapi.bi.v20220105 that throw TencentCloudSDKException Modifier and Type Method Description ApplyEmbedIntervalResponse
BiClient. ApplyEmbedInterval(ApplyEmbedIntervalRequest req)
申请延长Token可用时间接口-强鉴权CreateEmbedTokenResponse
BiClient. CreateEmbedToken(CreateEmbedTokenRequest req)
创建嵌出报表-强鉴权 -
Uses of TencentCloudSDKException in com.tencentcloudapi.billing.v20180709
-
Uses of TencentCloudSDKException in com.tencentcloudapi.bizlive.v20190313
Methods in com.tencentcloudapi.bizlive.v20190313 that throw TencentCloudSDKException Modifier and Type Method 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)
强制退出游戏 -
Uses of TencentCloudSDKException in com.tencentcloudapi.bm.v20180423
-
Uses of TencentCloudSDKException in com.tencentcloudapi.bma.v20210624
-
Uses of TencentCloudSDKException in com.tencentcloudapi.bma.v20221115
-
Uses of TencentCloudSDKException in com.tencentcloudapi.bmeip.v20180625
-
Uses of TencentCloudSDKException in com.tencentcloudapi.bmlb.v20180625
-
Uses of TencentCloudSDKException in com.tencentcloudapi.bmvpc.v20180625
-
Uses of TencentCloudSDKException in com.tencentcloudapi.bpaas.v20181217
Methods in com.tencentcloudapi.bpaas.v20181217 that throw TencentCloudSDKException Modifier and Type Method Description GetBpaasApproveDetailResponse
BpaasClient. GetBpaasApproveDetail(GetBpaasApproveDetailRequest req)
查看审批详情OutApproveBpaasApplicationResponse
BpaasClient. OutApproveBpaasApplication(OutApproveBpaasApplicationRequest req)
外部审批申请单 -
Uses of TencentCloudSDKException in com.tencentcloudapi.bri.v20190328
Methods in com.tencentcloudapi.bri.v20190328 that throw TencentCloudSDKException Modifier and Type Method Description DescribeBRIResponse
BriClient. DescribeBRI(DescribeBRIRequest req)
输入业务名 (bri_num, bri_dev, bri_ip, bri_apk, bri_url, bri_social 六种之一) 及其 相应字段, 获取业务风险分数和标签。 当业务名为bri_num时,必须填PhoneNumber字段. -
Uses of TencentCloudSDKException in com.tencentcloudapi.bsca.v20210811
Methods in com.tencentcloudapi.bsca.v20210811 that throw TencentCloudSDKException Modifier and Type Method Description DescribeKBComponentResponse
BscaClient. DescribeKBComponent(DescribeKBComponentRequest req)
本接口(DescribeKBComponent)用于在知识库中查询开源组件信息。本接口根据用户输入的PURL在知识库中寻找对应的开源组件,其中Name为必填字段。DescribeKBComponentVulnerabilityResponse
BscaClient. DescribeKBComponentVulnerability(DescribeKBComponentVulnerabilityRequest req)
本接口(DescribeKBComponentVulnerability)用于在知识库中查询开源组件的漏洞信息。DescribeKBLicenseResponse
BscaClient. DescribeKBLicense(DescribeKBLicenseRequest req)
本接口(DescribeKBLicense)用于在知识库中查询许可证信息。DescribeKBVulnerabilityResponse
BscaClient. DescribeKBVulnerability(DescribeKBVulnerabilityRequest req)
本接口(DescribeKBVulnerability)用于在知识库中查询漏洞详细信息,支持根据CVE ID查询或者根据Vul ID查询。MatchKBPURLListResponse
BscaClient. MatchKBPURLList(MatchKBPURLListRequest req)
本接口(MatchKBPURLList)用于在知识库中匹配与特征对应的开源组件列表。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.btoe.v20210303
Methods in com.tencentcloudapi.btoe.v20210303 that throw TencentCloudSDKException Modifier and Type Method 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查询存证基本信息。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.btoe.v20210514
Methods in com.tencentcloudapi.btoe.v20210514 that throw TencentCloudSDKException Modifier and Type Method 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核验存证记录的真实性。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cam.v20190116
-
Uses of TencentCloudSDKException in com.tencentcloudapi.captcha.v20190722
-
Uses of TencentCloudSDKException in com.tencentcloudapi.car.v20220110
Methods in com.tencentcloudapi.car.v20220110 that throw TencentCloudSDKException Modifier and Type Method Description ApplyConcurrentResponse
CarClient. ApplyConcurrent(ApplyConcurrentRequest req)
本接口用于申请并发。接口超时时间:20秒。CreateSessionResponse
CarClient. CreateSession(CreateSessionRequest req)
本接口用于创建会话。接口超时时间:5秒。DestroySessionResponse
CarClient. DestroySession(DestroySessionRequest req)
销毁会话StartPublishStreamResponse
CarClient. StartPublishStream(StartPublishStreamRequest req)
开始云端推流StopPublishStreamResponse
CarClient. StopPublishStream(StopPublishStreamRequest req)
停止云端推流 -
Uses of TencentCloudSDKException in com.tencentcloudapi.casb.v20200507
Methods in com.tencentcloudapi.casb.v20200507 that throw TencentCloudSDKException Modifier and Type Method Description CopyCryptoColumnPolicyResponse
CasbClient. CopyCryptoColumnPolicy(CopyCryptoColumnPolicyRequest req)
同region下 根据用户输入的CasbId,MetaDataId 复制策略到DstCasbId,MetaDataId中。 场景1: 相同CasbId,不同MetadataId 下策略复制 场景2: 不同Casbid,不同MetaDataId 下策略复制 场景3: 相同CasbId,相同MetaDataId 且 DatabaseName不同 策略复制 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cat.v20180409
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cbs.v20170312
Methods in com.tencentcloudapi.cbs.v20170312 that throw TencentCloudSDKException Modifier and Type Method 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)用于解除云硬盘绑定的定期快照策略。 支持批量操作,可一次解除多个云盘与同一定期快照策略的绑定。 如果传入的云盘未绑定到当前定期快照策略,接口将自动跳过,仅解绑与当前定期快照策略绑定的云盘。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ccc.v20200210
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cdb.v20170320
Methods in com.tencentcloudapi.cdb.v20170320 that throw TencentCloudSDKException Modifier and Type Method Description AddTimeWindowResponse
CdbClient. AddTimeWindow(AddTimeWindowRequest req)
本接口(AddTimeWindow)用于添加云数据库实例的维护时间窗口,以指定实例在哪些时间段可以自动执行切换访问操作。AdjustCdbProxyResponse
CdbClient. AdjustCdbProxy(AdjustCdbProxyRequest req)
调整数据库代理配置AdjustCdbProxyAddressResponse
CdbClient. AdjustCdbProxyAddress(AdjustCdbProxyAddressRequest req)
调整数据库代理地址配置AnalyzeAuditLogsResponse
CdbClient. AnalyzeAuditLogs(AnalyzeAuditLogsRequest req)
在不同过滤条件下的审计日志结果集中,选定特定的数据列进行聚合统计。AssociateSecurityGroupsResponse
CdbClient. AssociateSecurityGroups(AssociateSecurityGroupsRequest req)
本接口(AssociateSecurityGroups)用于安全组批量绑定实例。BalanceRoGroupLoadResponse
CdbClient. BalanceRoGroupLoad(BalanceRoGroupLoadRequest req)
本接口(BalanceRoGroupLoad)用于重新均衡 RO 组内实例的负载。注意,RO 组内 RO 实例会有一次数据库连接瞬断,请确保应用程序能重连数据库,谨慎操作。CloseCDBProxyResponse
CdbClient. CloseCDBProxy(CloseCDBProxyRequest req)
关闭数据库代理CloseCdbProxyAddressResponse
CdbClient. CloseCdbProxyAddress(CloseCdbProxyAddressRequest req)
请求关闭数据库代理地址CloseWanServiceResponse
CdbClient. CloseWanService(CloseWanServiceRequest req)
本接口(CloseWanService)用于关闭云数据库实例的外网访问。关闭外网访问后,外网地址将不可访问。CreateAccountsResponse
CdbClient. CreateAccounts(CreateAccountsRequest req)
本接口(CreateAccounts)用于创建云数据库的账户,需要指定新的账户名和域名,以及所对应的密码,同时可以设置账号的备注信息以及最大可用连接数。CreateAuditLogFileResponse
CdbClient. CreateAuditLogFile(CreateAuditLogFileRequest req)
本接口(CreateAuditLogFile)用于创建云数据库实例的审计日志文件。CreateAuditPolicyResponse
CdbClient. CreateAuditPolicy(CreateAuditPolicyRequest req)
本接口(CreateAuditPolicy)用于创建云数据库实例的审计策略,即将审计规则绑定到具体的云数据库实例上。CreateAuditRuleResponse
CdbClient. CreateAuditRule(CreateAuditRuleRequest req)
本接口(CreateAuditRule)用于创建用户在当前地域的审计规则。CreateBackupResponse
CdbClient. CreateBackup(CreateBackupRequest req)
本接口(CreateBackup)用于创建数据库备份。CreateCdbProxyResponse
CdbClient. CreateCdbProxy(CreateCdbProxyRequest req)
主实例创建数据库代理CreateCdbProxyAddressResponse
CdbClient. CreateCdbProxyAddress(CreateCdbProxyAddressRequest req)
数据库代理增加代理地址CreateCloneInstanceResponse
CdbClient. CreateCloneInstance(CreateCloneInstanceRequest req)
本接口(CreateCloneInstance) 用于从目标源实例创建一个克隆实例,可以指定克隆实例回档到源实例的指定物理备份文件或者指定的回档时间点。CreateDatabaseResponse
CdbClient. CreateDatabase(CreateDatabaseRequest req)
本接口(CreateDatabase)用于在云数据库实例中创建数据库。CreateDBImportJobResponse
CdbClient. CreateDBImportJob(CreateDBImportJobRequest req)
本接口(CreateDBImportJob)用于创建云数据库数据导入任务。 注意,用户进行数据导入任务的文件,必须提前上传到腾讯云。用户须在控制台进行文件导入。CreateDBInstanceResponse
CdbClient. CreateDBInstance(CreateDBInstanceRequest req)
本接口(CreateDBInstance)用于创建包年包月的云数据库实例(包括主实例、灾备实例和只读实例),可通过传入实例规格、MySQL 版本号、购买时长和数量等信息创建云数据库实例。 该接口为异步接口,您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为1,且 TaskStatus 为0,表示实例已经发货成功。 1.CreateDBInstanceHourResponse
CdbClient. CreateDBInstanceHour(CreateDBInstanceHourRequest req)
本接口(CreateDBInstanceHour)用于创建按量计费的实例,可通过传入实例规格、MySQL 版本号和数量等信息创建云数据库实例,支持主实例、灾备实例和只读实例的创建。 该接口为异步接口,您还可以使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询该实例的详细信息。当该实例的 Status 为 1,且 TaskStatus 为 0,表示实例已经发货成功。 1.CreateDeployGroupResponse
CdbClient. CreateDeployGroup(CreateDeployGroupRequest req)
本接口(CreateDeployGroup)用于创建放置实例的置放群组CreateParamTemplateResponse
CdbClient. CreateParamTemplate(CreateParamTemplateRequest req)
该接口(CreateParamTemplate)用于创建参数模板,全地域公共参数Region均为ap-guangzhou。CreateRoInstanceIpResponse
CdbClient. CreateRoInstanceIp(CreateRoInstanceIpRequest req)
本接口(CreateRoInstanceIp)用于创建云数据库只读实例的独立VIP。DeleteAccountsResponse
CdbClient. DeleteAccounts(DeleteAccountsRequest req)
本接口(DeleteAccounts)用于删除云数据库的账户。DeleteAuditLogFileResponse
CdbClient. DeleteAuditLogFile(DeleteAuditLogFileRequest req)
本接口(DeleteAuditLogFile)用于删除云数据库实例的审计日志文件。DeleteAuditPolicyResponse
CdbClient. DeleteAuditPolicy(DeleteAuditPolicyRequest req)
本接口(DeleteAuditPolicy)用于删除用户的审计策略。DeleteAuditRuleResponse
CdbClient. DeleteAuditRule(DeleteAuditRuleRequest req)
本接口(DeleteAuditRule)用于删除用户的审计规则。DeleteBackupResponse
CdbClient. DeleteBackup(DeleteBackupRequest req)
本接口(DeleteBackup)用于删除数据库备份。本接口只支持删除手动发起的备份。DeleteDeployGroupsResponse
CdbClient. DeleteDeployGroups(DeleteDeployGroupsRequest req)
根据置放群组ID删除置放群组(置放群组中有资源存在时不能删除该置放群组)DeleteParamTemplateResponse
CdbClient. DeleteParamTemplate(DeleteParamTemplateRequest req)
该接口(DeleteParamTemplate)用于删除参数模板,全地域公共参数Region均为ap-guangzhou。DeleteTimeWindowResponse
CdbClient. DeleteTimeWindow(DeleteTimeWindowRequest req)
本接口(DeleteTimeWindow)用于删除云数据库实例的维护时间窗口。删除实例维护时间窗口之后,默认的维护时间窗为 03:00-04:00,即当选择在维护时间窗口内切换访问新实例时,默认会在 03:00-04:00 点进行切换访问新实例。DescribeAccountPrivilegesResponse
CdbClient. DescribeAccountPrivileges(DescribeAccountPrivilegesRequest req)
本接口(DescribeAccountPrivileges)用于查询云数据库账户支持的权限信息。DescribeAccountsResponse
CdbClient. DescribeAccounts(DescribeAccountsRequest req)
本接口(DescribeAccounts)用于查询云数据库的所有账户信息。DescribeAsyncRequestInfoResponse
CdbClient. DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
本接口(DescribeAsyncRequestInfo)用于查询云数据库实例异步任务的执行结果。DescribeAuditConfigResponse
CdbClient. DescribeAuditConfig(DescribeAuditConfigRequest req)
本接口(DescribeAuditConfig)用于查询云数据库审计策略的服务配置,包括审计日志保存时长等。DescribeAuditLogFilesResponse
CdbClient. DescribeAuditLogFiles(DescribeAuditLogFilesRequest req)
本接口(DescribeAuditLogFiles)用于查询云数据库实例的审计日志文件。DescribeAuditLogsResponse
CdbClient. DescribeAuditLogs(DescribeAuditLogsRequest req)
本接口(DescribeAuditLogs)用于查询数据库审计日志。DescribeAuditPoliciesResponse
CdbClient. DescribeAuditPolicies(DescribeAuditPoliciesRequest req)
本接口(DescribeAuditPolicies)用于查询云数据库实例的审计策略。DescribeAuditRulesResponse
CdbClient. DescribeAuditRules(DescribeAuditRulesRequest req)
本接口(DescribeAuditRules)用于查询用户在当前地域的审计规则。DescribeBackupConfigResponse
CdbClient. DescribeBackupConfig(DescribeBackupConfigRequest req)
本接口(DescribeBackupConfig)用于查询数据库备份配置信息。DescribeBackupDecryptionKeyResponse
CdbClient. DescribeBackupDecryptionKey(DescribeBackupDecryptionKeyRequest req)
本接口(DescribeBackupDecryptionKey)用于查询备份文件解密密钥。DescribeBackupDownloadRestrictionResponse
CdbClient. DescribeBackupDownloadRestriction(DescribeBackupDownloadRestrictionRequest req)
该接口用户查询当前地域用户设置的默认备份下载来源限制。DescribeBackupEncryptionStatusResponse
CdbClient. DescribeBackupEncryptionStatus(DescribeBackupEncryptionStatusRequest req)
本接口(DescribeBackupEncryptionStatus)用于查询实例默认备份加密状态。DescribeBackupOverviewResponse
CdbClient. DescribeBackupOverview(DescribeBackupOverviewRequest req)
本接口(DescribeBackupOverview)用于查询用户的备份概览。返回用户当前备份总个数、备份总的占用容量、赠送的免费容量、计费容量(容量单位为字节)。DescribeBackupsResponse
CdbClient. DescribeBackups(DescribeBackupsRequest req)
本接口(DescribeBackups)用于查询云数据库实例的备份数据。DescribeBackupSummariesResponse
CdbClient. DescribeBackupSummaries(DescribeBackupSummariesRequest req)
本接口(DescribeBackupSummaries)用于查询备份的统计情况,返回以实例为维度的备份占用容量,以及每个实例的数据备份和日志备份的个数和容量(容量单位为字节)。DescribeBinlogBackupOverviewResponse
CdbClient. DescribeBinlogBackupOverview(DescribeBinlogBackupOverviewRequest req)
本接口(DescribeBinlogBackupOverview)用于查询用户在当前地域总的日志备份概览。DescribeBinlogsResponse
CdbClient. DescribeBinlogs(DescribeBinlogsRequest req)
本接口(DescribeBinlogs)用于查询云数据库实例的 binlog 文件列表。DescribeCdbProxyInfoResponse
CdbClient. DescribeCdbProxyInfo(DescribeCdbProxyInfoRequest req)
查询数据库代理详情信息DescribeCdbZoneConfigResponse
CdbClient. DescribeCdbZoneConfig(DescribeCdbZoneConfigRequest req)
本接口(DescribeCdbZoneConfig)用于查询云数据库各地域可售卖的规格配置。DescribeCloneListResponse
CdbClient. DescribeCloneList(DescribeCloneListRequest req)
本接口(DescribeCloneList) 用于查询用户实例的克隆任务列表。DescribeCpuExpandStrategyResponse
CdbClient. DescribeCpuExpandStrategy(DescribeCpuExpandStrategyRequest req)
通过该 API 可以查询实例的 CPU 弹性扩容策略DescribeDataBackupOverviewResponse
CdbClient. DescribeDataBackupOverview(DescribeDataBackupOverviewRequest req)
本接口(DescribeDataBackupOverview)用于查询用户在当前地域总的数据备份概览。DescribeDatabasesResponse
CdbClient. DescribeDatabases(DescribeDatabasesRequest req)
本接口(DescribeDatabases)用于查询云数据库实例的数据库信息,仅支持主实例和灾备实例,不支持只读实例。DescribeDBFeaturesResponse
CdbClient. DescribeDBFeatures(DescribeDBFeaturesRequest req)
本接口(DescribeDBFeatures)用于查询云数据库版本属性,包括是否支持数据库加密、数据库审计等功能。DescribeDBImportRecordsResponse
CdbClient. DescribeDBImportRecords(DescribeDBImportRecordsRequest req)
本接口(DescribeDBImportRecords)用于查询云数据库导入任务操作日志。DescribeDBInstanceCharsetResponse
CdbClient. DescribeDBInstanceCharset(DescribeDBInstanceCharsetRequest req)
本接口(DescribeDBInstanceCharset)用于查询云数据库实例的字符集,获取字符集的名称。DescribeDBInstanceConfigResponse
CdbClient. DescribeDBInstanceConfig(DescribeDBInstanceConfigRequest req)
本接口(DescribeDBInstanceConfig)用于云数据库实例的配置信息,包括同步模式,部署模式等。DescribeDBInstanceGTIDResponse
CdbClient. DescribeDBInstanceGTID(DescribeDBInstanceGTIDRequest req)
本接口(DescribeDBInstanceGTID)用于查询云数据库实例是否开通了 GTID,不支持版本为 5.5 以及以下的实例。DescribeDBInstanceInfoResponse
CdbClient. DescribeDBInstanceInfo(DescribeDBInstanceInfoRequest req)
查询实例基本信息(实例 ID ,实例名称,是否开通加密 )DescribeDBInstanceRebootTimeResponse
CdbClient. DescribeDBInstanceRebootTime(DescribeDBInstanceRebootTimeRequest req)
本接口(DescribeDBInstanceRebootTime)用于查询云数据库实例重启预计所需的时间。DescribeDBInstancesResponse
CdbClient. DescribeDBInstances(DescribeDBInstancesRequest req)
本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目 ID、实例 ID、访问地址、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。DescribeDBPriceResponse
CdbClient. DescribeDBPrice(DescribeDBPriceRequest req)
本接口(DescribeDBPrice)用于查询购买或续费云数据库实例的价格,支持查询按量计费或者包年包月的价格。可传入实例类型、购买时长、购买数量、内存大小、硬盘大小和可用区信息等来查询实例价格。可传入实例名称来查询实例续费价格。 注意:对某个地域进行询价,请使用对应地域的接入点,接入点信息请参照 服务地址 文档。例如:对广州地域进行询价,请把请求发到:cdb.ap-guangzhou.tencentcloudapi.com。同理对上海地域询价,把请求发到:cdb.ap-shanghai.tencentcloudapi.com。DescribeDBSecurityGroupsResponse
CdbClient. DescribeDBSecurityGroups(DescribeDBSecurityGroupsRequest req)
本接口(DescribeDBSecurityGroups)用于查询实例的安全组详情。DescribeDBSwitchRecordsResponse
CdbClient. DescribeDBSwitchRecords(DescribeDBSwitchRecordsRequest req)
本接口(DescribeDBSwitchRecords)用于查询云数据库实例切换记录。DescribeDefaultParamsResponse
CdbClient. DescribeDefaultParams(DescribeDefaultParamsRequest req)
该接口(DescribeDefaultParams)用于查询默认的可设置参数列表。DescribeDeployGroupListResponse
CdbClient. DescribeDeployGroupList(DescribeDeployGroupListRequest req)
本接口(DescribeDeployGroupList)用于查询用户的置放群组列表,可以指定置放群组 ID 或置放群组名称。DescribeDeviceMonitorInfoResponse
CdbClient. DescribeDeviceMonitorInfo(DescribeDeviceMonitorInfoRequest req)
本接口(DescribeDeviceMonitorInfo)用于查询云数据库物理机当天的监控信息,暂只支持内存488G、硬盘6T的实例查询。DescribeErrorLogDataResponse
CdbClient. DescribeErrorLogData(DescribeErrorLogDataRequest req)
根据检索条件查询实例错误日志详情。只能查询一个月之内的错误日志。 使用时需要注意:可能存在单条错误日志太大,导致整个http请求的回包太大,进而引发接口超时。一旦发生超时,建议您缩小查询时的Limit参数值,从而降低包的大小,让接口能够及时返回内容。DescribeInstanceParamRecordsResponse
CdbClient. DescribeInstanceParamRecords(DescribeInstanceParamRecordsRequest req)
该接口(DescribeInstanceParamRecords)用于查询实例参数修改历史。DescribeInstanceParamsResponse
CdbClient. DescribeInstanceParams(DescribeInstanceParamsRequest req)
该接口(DescribeInstanceParams)用于查询实例的参数列表。DescribeLocalBinlogConfigResponse
CdbClient. DescribeLocalBinlogConfig(DescribeLocalBinlogConfigRequest req)
该接口用于查询实例本地binlog保留策略。DescribeParamTemplateInfoResponse
CdbClient. DescribeParamTemplateInfo(DescribeParamTemplateInfoRequest req)
该接口(DescribeParamTemplateInfo)用于查询参数模板详情,全地域公共参数Region均为ap-guangzhou。DescribeParamTemplatesResponse
CdbClient. DescribeParamTemplates(DescribeParamTemplatesRequest req)
该接口(DescribeParamTemplates)查询参数模板列表,全地域公共参数Region均为ap-guangzhou。DescribeProjectSecurityGroupsResponse
CdbClient. DescribeProjectSecurityGroups(DescribeProjectSecurityGroupsRequest req)
本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。DescribeProxyCustomConfResponse
CdbClient. DescribeProxyCustomConf(DescribeProxyCustomConfRequest req)
查询代理规格配置DescribeProxySupportParamResponse
CdbClient. DescribeProxySupportParam(DescribeProxySupportParamRequest req)
查询实例支持代理版本和参数DescribeRemoteBackupConfigResponse
CdbClient. DescribeRemoteBackupConfig(DescribeRemoteBackupConfigRequest req)
本接口(DescribeRemoteBackupConfig)用于查询数据库异地备份配置信息。DescribeRoGroupsResponse
CdbClient. DescribeRoGroups(DescribeRoGroupsRequest req)
本接口(DescribeRoGroups)用于查询云数据库实例的所有的RO组的信息。DescribeRollbackRangeTimeResponse
CdbClient. DescribeRollbackRangeTime(DescribeRollbackRangeTimeRequest req)
本接口(DescribeRollbackRangeTime)用于查询云数据库实例可回档的时间范围。DescribeRollbackTaskDetailResponse
CdbClient. DescribeRollbackTaskDetail(DescribeRollbackTaskDetailRequest req)
本接口(DescribeRollbackTaskDetail)用于查询云数据库实例回档任务详情。DescribeRoMinScaleResponse
CdbClient. DescribeRoMinScale(DescribeRoMinScaleRequest req)
本接口(DescribeRoMinScale)用于获取只读实例购买、升级时的最小规格。DescribeSlowLogDataResponse
CdbClient. DescribeSlowLogData(DescribeSlowLogDataRequest req)
条件检索实例的慢日志。只允许查看一个月之内的慢日志。 使用时需要注意:可能存在单条慢日志太大,导致整个http请求的回包太大,进而引发接口超时。一旦发生超时,建议您缩小查询时的Limit参数值,从而降低包的大小,让接口能够及时返回内容。DescribeSlowLogsResponse
CdbClient. DescribeSlowLogs(DescribeSlowLogsRequest req)
本接口(DescribeSlowLogs)用于获取云数据库实例的慢查询日志。说明:若单次查询数据量过大,则有可能响应超时,建议缩短单次查询时间范围,如一小时,避免导致超时。DescribeSupportedPrivilegesResponse
CdbClient. DescribeSupportedPrivileges(DescribeSupportedPrivilegesRequest req)
本接口(DescribeSupportedPrivileges)用于查询云数据库的支持的权限信息,包括全局权限,数据库权限,表权限以及列权限。DescribeTablesResponse
CdbClient. DescribeTables(DescribeTablesRequest req)
本接口(DescribeTables)用于查询云数据库实例的数据库表信息,仅支持主实例和灾备实例,不支持只读实例。DescribeTagsOfInstanceIdsResponse
CdbClient. DescribeTagsOfInstanceIds(DescribeTagsOfInstanceIdsRequest req)
本接口(DescribeTagsOfInstanceIds)用于获取云数据库实例的标签信息。DescribeTasksResponse
CdbClient. DescribeTasks(DescribeTasksRequest req)
本接口(DescribeTasks)用于查询云数据库实例任务列表。DescribeTimeWindowResponse
CdbClient. DescribeTimeWindow(DescribeTimeWindowRequest req)
本接口(DescribeTimeWindow)用于查询云数据库实例的维护时间窗口。DescribeUploadedFilesResponse
CdbClient. DescribeUploadedFiles(DescribeUploadedFilesRequest req)
本接口(DescribeUploadedFiles)用于查询用户导入的SQL文件列表,全地域公共参数Region均为ap-shanghai。DisassociateSecurityGroupsResponse
CdbClient. DisassociateSecurityGroups(DisassociateSecurityGroupsRequest req)
本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。InitDBInstancesResponse
CdbClient. InitDBInstances(InitDBInstancesRequest req)
该接口不再维护,参考CreateDBInstance+API文档,在发货时即可完成初始化。 本接口(InitDBInstances)用于初始化云数据库实例,包括初始化密码、默认字符集、实例端口号等。该接口已经废弃,在发货接口CreateDBInstance、CreateDBInstanceHour可以直接使用参数Password设置密码,使用参数ParamList设置字符集,使用参数Port设置端口号。InquiryPriceUpgradeInstancesResponse
CdbClient. InquiryPriceUpgradeInstances(InquiryPriceUpgradeInstancesRequest req)
本接口(InquiryPriceUpgradeInstances)用于查询云数据库实例升级的价格,支持查询按量计费或者包年包月实例的升级价格,实例类型支持主实例、灾备实例和只读实例。IsolateDBInstanceResponse
CdbClient. IsolateDBInstance(IsolateDBInstanceRequest req)
本接口(IsolateDBInstance)用于隔离云数据库实例,隔离后不能通过IP和端口访问数据库。隔离的实例可在回收站中进行开机。若为欠费隔离,请尽快进行充值。ModifyAccountDescriptionResponse
CdbClient. ModifyAccountDescription(ModifyAccountDescriptionRequest req)
本接口(ModifyAccountDescription)用于修改云数据库账户的备注信息。ModifyAccountHostResponse
CdbClient. ModifyAccountHost(ModifyAccountHostRequest req)
本接口(ModifyAccountHost)用于修改云数据库账户的主机。ModifyAccountMaxUserConnectionsResponse
CdbClient. ModifyAccountMaxUserConnections(ModifyAccountMaxUserConnectionsRequest req)
本接口(ModifyAccountMaxUserConnections)用于修改云数据库账户最大可用连接数。ModifyAccountPasswordResponse
CdbClient. ModifyAccountPassword(ModifyAccountPasswordRequest req)
本接口(ModifyAccountPassword)用于修改云数据库账户的密码。ModifyAccountPrivilegesResponse
CdbClient. ModifyAccountPrivileges(ModifyAccountPrivilegesRequest req)
本接口(ModifyAccountPrivileges)用于修改云数据库的账户的权限信息。 注意,修改账号权限时,需要传入该账号下的全量权限信息。用户可以先通过 [查询云数据库账户的权限信息 ](https://cloud.tencent.com/document/api/236/17500) 查询该账号下的全量权限信息,然后进行权限修改。ModifyAuditConfigResponse
CdbClient. ModifyAuditConfig(ModifyAuditConfigRequest req)
本接口(ModifyAuditConfig)用于修改云数据库审计策略的服务配置,包括审计日志保存时长等。ModifyAuditRuleResponse
CdbClient. ModifyAuditRule(ModifyAuditRuleRequest req)
本接口(ModifyAuditRule)用于修改用户的审计规则。ModifyAutoRenewFlagResponse
CdbClient. ModifyAutoRenewFlag(ModifyAutoRenewFlagRequest req)
本接口(ModifyAutoRenewFlag)用于修改云数据库实例的自动续费标记。仅支持包年包月的实例设置自动续费标记。ModifyBackupConfigResponse
CdbClient. ModifyBackupConfig(ModifyBackupConfigRequest req)
本接口(ModifyBackupConfig)用于修改数据库备份配置信息。ModifyBackupDownloadRestrictionResponse
CdbClient. ModifyBackupDownloadRestriction(ModifyBackupDownloadRestrictionRequest req)
该接口用于修改用户当前地域的备份文件限制下载来源,可以设置内外网均可下载、仅内网可下载,或内网指定的vpc、ip可以下载。ModifyBackupEncryptionStatusResponse
CdbClient. ModifyBackupEncryptionStatus(ModifyBackupEncryptionStatusRequest req)
本接口(ModifyBackupEncryptionStatus)用于设置实例备份文件是否加密。ModifyCdbProxyAddressDescResponse
CdbClient. ModifyCdbProxyAddressDesc(ModifyCdbProxyAddressDescRequest req)
修改代理地址描述信息ModifyCdbProxyAddressVipAndVPortResponse
CdbClient. ModifyCdbProxyAddressVipAndVPort(ModifyCdbProxyAddressVipAndVPortRequest req)
修改数据库代理地址VPC信息ModifyCdbProxyParamResponse
CdbClient. ModifyCdbProxyParam(ModifyCdbProxyParamRequest req)
配置数据库代理参数ModifyDBInstanceNameResponse
CdbClient. ModifyDBInstanceName(ModifyDBInstanceNameRequest req)
本接口(ModifyDBInstanceName)用于修改云数据库实例的名称。ModifyDBInstanceProjectResponse
CdbClient. ModifyDBInstanceProject(ModifyDBInstanceProjectRequest req)
本接口(ModifyDBInstanceProject)用于修改云数据库实例的所属项目。ModifyDBInstanceSecurityGroupsResponse
CdbClient. ModifyDBInstanceSecurityGroups(ModifyDBInstanceSecurityGroupsRequest req)
本接口(ModifyDBInstanceSecurityGroups)用于修改实例绑定的安全组。ModifyDBInstanceVipVportResponse
CdbClient. ModifyDBInstanceVipVport(ModifyDBInstanceVipVportRequest req)
本接口(ModifyDBInstanceVipVport)用于修改云数据库实例的IP和端口号,也可进行基础网络转 VPC 网络和 VPC 网络下的子网变更。ModifyInstanceParamResponse
CdbClient. ModifyInstanceParam(ModifyInstanceParamRequest req)
本接口(ModifyInstanceParam)用于修改云数据库实例的参数。ModifyInstancePasswordComplexityResponse
CdbClient. ModifyInstancePasswordComplexity(ModifyInstancePasswordComplexityRequest req)
本接口(ModifyInstancePasswordComplexity)用于修改云数据库实例的密码复杂度。ModifyInstanceTagResponse
CdbClient. ModifyInstanceTag(ModifyInstanceTagRequest req)
本接口(ModifyInstanceTag)用于对实例标签进行添加、修改或者删除。ModifyLocalBinlogConfigResponse
CdbClient. ModifyLocalBinlogConfig(ModifyLocalBinlogConfigRequest req)
该接口用于修改实例本地binlog保留策略。ModifyNameOrDescByDpIdResponse
CdbClient. ModifyNameOrDescByDpId(ModifyNameOrDescByDpIdRequest req)
修改置放群组的名称或者描述ModifyParamTemplateResponse
CdbClient. ModifyParamTemplate(ModifyParamTemplateRequest req)
该接口(ModifyParamTemplate)用于修改参数模板,全地域公共参数Region均为ap-guangzhou。ModifyRemoteBackupConfigResponse
CdbClient. ModifyRemoteBackupConfig(ModifyRemoteBackupConfigRequest req)
本接口(ModifyRemoteBackupConfig)用于修改数据库异地备份配置信息。ModifyRoGroupInfoResponse
CdbClient. ModifyRoGroupInfo(ModifyRoGroupInfoRequest req)
本接口(ModifyRoGroupInfo)用于更新云数据库只读组的信息。包括设置实例延迟超限剔除策略,设置只读实例读权重,设置复制延迟时间等。ModifyTimeWindowResponse
CdbClient. ModifyTimeWindow(ModifyTimeWindowRequest req)
本接口(ModifyTimeWindow)用于更新云数据库实例的维护时间窗口。OfflineIsolatedInstancesResponse
CdbClient. OfflineIsolatedInstances(OfflineIsolatedInstancesRequest req)
本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态,即通过 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口查询到 Status 值为 5 的实例。 该接口为异步操作,部分资源的回收可能存在延迟。您可以通过使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口,指定实例 InstanceId 和状态 Status 为 [5,6,7] 进行查询,若返回实例为空,则实例资源已全部释放。 注意,实例下线后,相关资源和数据将无法找回,请谨慎操作。OpenAuditServiceResponse
CdbClient. OpenAuditService(OpenAuditServiceRequest req)
CDB实例开通审计服务OpenDBInstanceEncryptionResponse
CdbClient. OpenDBInstanceEncryption(OpenDBInstanceEncryptionRequest req)
本接口(OpenDBInstanceEncryption)用于启用实例数据存储加密功能,支持用户指定自定义密钥。 注意,启用实例数据存储加密之前,需要进行以下操作: 1、进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作; 2、开启 [KMS服务](https://console.cloud.tencent.com/kms2); 3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role),角色名为MySQL_QCSRole,预设策略名为QcloudAccessForMySQLRole; 该 API 耗时可能到10s,客户端可能超时,如果调用 API 返回 InternalError ,请您调用DescribeDBInstanceInfo 确认后端加密是否开通成功。OpenDBInstanceGTIDResponse
CdbClient. OpenDBInstanceGTID(OpenDBInstanceGTIDRequest req)
本接口(OpenDBInstanceGTID)用于开启云数据库实例的 GTID,只支持版本为 5.6 以及以上的实例。OpenWanServiceResponse
CdbClient. OpenWanService(OpenWanServiceRequest req)
本接口(OpenWanService)用于开通实例外网访问。 注意,实例开通外网访问之前,需要先将实例进行 [实例初始化](https://cloud.tencent.com/document/api/236/15873) 操作。ReleaseIsolatedDBInstancesResponse
CdbClient. ReleaseIsolatedDBInstances(ReleaseIsolatedDBInstancesRequest req)
本接口(ReleaseIsolatedDBInstances)用于恢复已隔离云数据库实例。ReloadBalanceProxyNodeResponse
CdbClient. ReloadBalanceProxyNode(ReloadBalanceProxyNodeRequest req)
重新负载均衡数据库代理RenewDBInstanceResponse
CdbClient. RenewDBInstance(RenewDBInstanceRequest req)
本接口(RenewDBInstance)用于续费云数据库实例,支持付费模式为包年包月的实例。按量计费实例可通过该接口续费为包年包月的实例。ResetRootAccountResponse
CdbClient. ResetRootAccount(ResetRootAccountRequest req)
重置实例ROOT账号,初始化账号权限RestartDBInstancesResponse
CdbClient. RestartDBInstances(RestartDBInstancesRequest req)
本接口(RestartDBInstances)用于重启云数据库实例。 注意: 1、本接口只支持主实例进行重启操作; 2、实例状态必须为正常,并且没有其他异步任务在执行中。StartBatchRollbackResponse
CdbClient. StartBatchRollback(StartBatchRollbackRequest req)
该接口(StartBatchRollback)用于批量回档云数据库实例的库表。StartCpuExpandResponse
CdbClient. StartCpuExpand(StartCpuExpandRequest req)
通过该API,可以开启CPU弹性扩容,包括一次性的手动扩容以及自动弹性扩容。StartReplicationResponse
CdbClient. StartReplication(StartReplicationRequest req)
开启 RO 复制,从主实例同步数据。StopCpuExpandResponse
CdbClient. StopCpuExpand(StopCpuExpandRequest req)
通过该API,可以关闭 CPU 弹性扩容。StopDBImportJobResponse
CdbClient. StopDBImportJob(StopDBImportJobRequest req)
本接口(StopDBImportJob)用于终止数据导入任务。StopReplicationResponse
CdbClient. StopReplication(StopReplicationRequest req)
停止 RO 复制,中断从主实例同步数据。StopRollbackResponse
CdbClient. StopRollback(StopRollbackRequest req)
本接口(StopRollback) 用于撤销实例正在进行的回档任务,该接口返回一个异步任务id。 撤销结果可以通过 DescribeAsyncRequestInfo 查询任务的执行情况。SwitchCDBProxyResponse
CdbClient. SwitchCDBProxy(SwitchCDBProxyRequest req)
数据库代理配置变更或则升级版本后手动发起立即切换SwitchDBInstanceMasterSlaveResponse
CdbClient. SwitchDBInstanceMasterSlave(SwitchDBInstanceMasterSlaveRequest req)
该接口 (SwitchDBInstanceMasterSlave) 支持用户主动切换实例主从角色。SwitchDrInstanceToMasterResponse
CdbClient. SwitchDrInstanceToMaster(SwitchDrInstanceToMasterRequest req)
本接口(SwitchDrInstanceToMaster)用于将云数据库灾备实例切换为主实例,注意请求必须发到灾备实例所在的地域。SwitchForUpgradeResponse
CdbClient. SwitchForUpgrade(SwitchForUpgradeRequest req)
本接口(SwitchForUpgrade)用于切换访问新实例,针对主升级中的实例处于待切换状态时,用户可主动发起该流程。UpgradeCDBProxyVersionResponse
CdbClient. UpgradeCDBProxyVersion(UpgradeCDBProxyVersionRequest req)
升级数据库代理版本UpgradeDBInstanceResponse
CdbClient. UpgradeDBInstance(UpgradeDBInstanceRequest req)
本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置,实例类型支持主实例、灾备实例和只读实例。UpgradeDBInstanceEngineVersionResponse
CdbClient. UpgradeDBInstanceEngineVersion(UpgradeDBInstanceEngineVersionRequest req)
本接口(UpgradeDBInstanceEngineVersion)用于升级云数据库实例版本,实例类型支持主实例、灾备实例和只读实例。VerifyRootAccountResponse
CdbClient. VerifyRootAccount(VerifyRootAccountRequest req)
本接口(VerifyRootAccount)用于校验云数据库实例的 ROOT 账号是否有足够的权限进行授权操作。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cdc.v20201214
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cdn.v20180606
Methods in com.tencentcloudapi.cdn.v20180606 that throw TencentCloudSDKException Modifier and Type Method 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, 将于 **2023年5月31日** 下线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的内容, 将于 **2023年5月31日** 下线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。(注:接口尚在内测中,暂未全量开放;封禁URL并非无限期永久封禁)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访问后各个子任务的简要详情, 将于 **2023年5月31日** 下线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 条。注意:中国境外区域预热,资源默认加载至中国境外边缘节点,所产生的边缘层流量会计入计费流量。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) -
Uses of TencentCloudSDKException in com.tencentcloudapi.cds.v20180420
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cdwch.v20200915
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cfg.v20210820
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cfs.v20190719
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cfw.v20190904
-
Uses of TencentCloudSDKException in com.tencentcloudapi.chdfs.v20190718
Methods in com.tencentcloudapi.chdfs.v20190718 that throw TencentCloudSDKException Modifier and Type Method 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主要用作控制台使用。 修改资源标签列表,全量覆盖。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.chdfs.v20201112
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ciam.v20220331
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cii.v20201210
Methods in com.tencentcloudapi.cii.v20201210 that throw TencentCloudSDKException Modifier and Type Method Description CreateStructureTaskResponse
CiiClient. CreateStructureTask(CreateStructureTaskRequest req)
基于提供的客户及保单信息,启动结构化识别任务。DescribeStructCompareDataResponse
CiiClient. DescribeStructCompareData(DescribeStructCompareDataRequest req)
结构化对比查询接口,对比结构化复核前后数据差异,查询识别正确率,召回率。DescribeStructureTaskResultResponse
CiiClient. DescribeStructureTaskResult(DescribeStructureTaskResultRequest req)
依据任务ID获取结构化结果接口。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cii.v20210408
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cim.v20190318
Methods in com.tencentcloudapi.cim.v20190318 that throw TencentCloudSDKException Modifier and Type Method Description DescribeSdkAppidResponse
CimClient. DescribeSdkAppid(DescribeSdkAppidRequest req)
获取云通信IM中腾讯云账号对应的SDKAppID -
Uses of TencentCloudSDKException in com.tencentcloudapi.cis.v20180408
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ckafka.v20190819
-
Uses of TencentCloudSDKException in com.tencentcloudapi.clb.v20180317
Methods in com.tencentcloudapi.clb.v20180317 that throw TencentCloudSDKException Modifier and Type Method 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网络负载均衡。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发生变化,变化规则不会克隆。 限制说明: 实例属性维度限制 仅支持克隆按量计费实例,不支持包年包月实例。 不支持克隆未关联实例计费项的 CLB。 不支持克隆传统型负载均衡实例和高防 CLB。 不支持克隆基础网络类型的实例。 不支持克隆 IPv6、IPv6 NAT64 版本以及混绑的实例。 个性化配置、重定向配置、安全组默认放通开关的配置将不会被克隆,需重新配置。 执行克隆操作前,请确保实例上没有使用已过期证书,否则会导致克隆失败。 监听器维度限制 不支持克隆监听器为 QUIC 类型和端口段的实例。 不支持监听器为 TCP_SSL 的内网型负载均衡的实例。 不支持克隆七层监听器没有转发规则的实例。 当实例的监听器个数超过50个时,不支持克隆。 后端服务维度限制 不支持克隆绑定的后端服务类型为目标组和 SCF 云函数的实例。 通过接口调用: BGP带宽包必须传带宽包id 独占集群克隆必须传对应的参数,否则按共享型创建 功能内测中,[申请开通](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%20CLB&step=1)。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 接口查询本次任务是否成功。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语义, 绑定操作时,入参需要传入负载均衡实例要绑定的所有安全组(已绑定的+新增绑定的)。 解绑操作时,入参需要传入负载均衡实例执行解绑后所绑定的所有安全组;如果要解绑所有安全组,可不传此参数,或传入空数组。注意:内网负载均衡不支持绑定安全组。SetSecurityGroupForLoadbalancersResponse
ClbClient. SetSecurityGroupForLoadbalancers(SetSecurityGroupForLoadbalancersRequest req)
绑定或解绑一个安全组到多个公网负载均衡实例。注意:内网负载均衡不支持绑定安全组。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cloudaudit.v20190319
Methods in com.tencentcloudapi.cloudaudit.v20190319 that throw TencentCloudSDKException Modifier and Type Method 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属于必填项 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cloudhsm.v20191112
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cloudstudio.v20210524
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cloudstudio.v20230508
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cls.v20201016
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cme.v20191029
Methods in com.tencentcloudapi.cme.v20191029 that throw TencentCloudSDKException Modifier and Type Method 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 存在时候,操作结果为产生新目录 /素材/视频/篮球/NBAMoveResourceResponse
CmeClient. MoveResource(MoveResourceRequest req)
移动资源,支持跨个人或团队移动媒体以及分类。如果填写了Operator,则需要校验用户对媒体和分类资源的访问以及写权限。 当原始资源为媒体时,该接口效果为将该媒体移动到目标分类下面; 当原始资源为分类时,该接口效果为将原始分类移动到目标分类或者是重命名。 如果 SourceResource.Resource.Id = /素材/视频/NBA,DestinationResource.Resource.Id= /素材/视频/篮球 当 DestinationResource.Resource.Id 不存在时候且原始资源与目标资源归属相同,操作结果为重命名原始分类; 当 DestinationResource.Resource.Id 存在时候,操作结果为产生新目录 /素材/视频/篮球/NBAParseEventResponse
CmeClient. ParseEvent(ParseEventRequest req)
该接口接受多媒体创作引擎回调给业务的事件内容,将其转化为对应的 EventContent 结构。请不要实际调用该接口,只需要将接收到的事件内容直接使用 JSON 解析到 EventContent 结构即可使用。RevokeResourceAuthorizationResponse
CmeClient. RevokeResourceAuthorization(RevokeResourceAuthorizationRequest req)
资源所属实体对目标实体撤销目标资源的相应权限,若原本没有相应权限则不产生变更。SearchMaterialResponse
CmeClient. SearchMaterial(SearchMaterialRequest req)
根据检索条件搜索媒体,返回媒体的基本信息。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cmq.v20190304
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cms.v20190321
Methods in com.tencentcloudapi.cms.v20190321 that throw TencentCloudSDKException Modifier and Type Method 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)服务使用了深度学习技术,识别涉黄、涉政、涉恐等有害内容,同时支持用户配置词库,打击自定义的违规文本。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.common
Methods in com.tencentcloudapi.common that throw TencentCloudSDKException Modifier and Type Method 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)
static byte[]
Sign. hmac256(byte[] key, String msg)
protected String
AbstractClient. internalRequest(AbstractModel request, String actionName)
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)
-
Uses of TencentCloudSDKException in com.tencentcloudapi.common.http
Methods in com.tencentcloudapi.common.http that throw TencentCloudSDKException Modifier and Type Method 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)
-
Uses of TencentCloudSDKException in com.tencentcloudapi.common.provider
Methods in com.tencentcloudapi.common.provider that throw TencentCloudSDKException Modifier and Type Method Description Credential
CredentialsProvider. getCredentials()
Credential
DefaultCredentialsProvider. getCredentials()
Credential
EnvironmentVariableCredentialsProvider. getCredentials()
Credential
OIDCRoleArnProvider. getCredentials()
Credential
ProfileCredentialsProvider. getCredentials()
Constructors in com.tencentcloudapi.common.provider that throw TencentCloudSDKException Constructor Description OIDCRoleArnProvider()
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cpdp.v20190820
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cr.v20180321
-
Uses of TencentCloudSDKException in com.tencentcloudapi.csip.v20221121
-
Uses of TencentCloudSDKException in com.tencentcloudapi.csxg.v20230303
Methods in com.tencentcloudapi.csxg.v20230303 that throw TencentCloudSDKException Modifier and Type Method 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入云服务 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cvm.v20170312
Methods in com.tencentcloudapi.cvm.v20170312 that throw TencentCloudSDKException Modifier and Type Method 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”,则代表操作成功。多个安全组绑定至实例后,将以绑定顺序作为优先级顺序依次匹配执行。如需调整安全组优先级,请参见 [调整安全组优先级](https://cloud.tencent.com/document/product/213/42842)。 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创建,版本号递增。默认情况下,在RunInstances中指定实例启动模板,若不指定模板版本号,则使用默认版本。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)获取。 每个地域最多只支持创建50个自定义镜像,删除镜像可以释放账户的配额。 当镜像正在被其它账户分享时,不允许删除。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)。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 镜像格式。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) 用于切换实例的计费模式询价。 只支持从 `POSTPAID_BY_HOUR` 计费模式切换为`PREPAID`计费模式。 关机不收费的实例、`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_BASIC`、`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_BASIC`、`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`表示非弹性)询价,且[数据盘类型](https://cloud.tencent.com/document/product/213/15753#DataDisk)为:`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`。 目前不支持[CDH](https://cloud.tencent.com/document/product/416)实例使用该接口扩容数据盘询价。* 仅支持包年包月实例随机器购买的数据盘。* 目前只支持扩容一块数据盘询价。InquiryPriceRunInstancesResponse
CvmClient. InquiryPriceRunInstances(InquiryPriceRunInstancesRequest req)
本接口(InquiryPriceRunInstances)用于创建实例询价。本接口仅允许针对购买限制范围内的实例配置进行询价, 详见:[创建实例](https://cloud.tencent.com/document/api/213/15730)。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)用于修改镜像共享信息。 共享镜像后,被共享账户可以通过该镜像创建实例。 每个自定义镜像最多可共享给50个账户。 共享镜像无法更改名称,描述,仅可用于创建实例。 只支持共享到对方账户相同地域。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`参数,则使用指定的镜像重装;否则按照当前实例使用的镜像进行重装。 系统盘将会被格式化,并重置;请确保系统盘中无重要文件。 `Linux`和`Windows`系统互相切换时,该实例系统盘`ID`将发生变化,系统盘关联快照将无法回滚、恢复数据。 密码不指定将会通过站内信下发随机密码。 目前只支持[系统盘类型](https://cloud.tencent.com/document/api/213/9452#SystemDisk)是`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`类型的实例使用该接口实现`Linux`和`Windows`操作系统切换。 目前不支持境外地域的实例使用该接口实现`Linux`和`Windows`操作系统切换。 实例操作结果可以通过调用 [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类型的实例使用该接口进行机型调整。 目前不支持[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`表示非弹性),且[数据盘类型](https://cloud.tencent.com/document/api/213/15753#DataDisk)为:`CLOUD_BASIC`、`CLOUD_PREMIUM`、`CLOUD_SSD`和[CDH](https://cloud.tencent.com/document/product/416)实例的`LOCAL_BASIC`、`LOCAL_SSD`类型数据盘。 对于包年包月实例,使用该接口会涉及扣费,请确保账户余额充足。可通过[`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)用于将自定义镜像同步到其它地区。 该接口每次调用只支持同步一个镜像。 该接口支持多个同步地域。 单个账号在每个地域最多支持存在50个自定义镜像。TerminateInstancesResponse
CvmClient. TerminateInstances(TerminateInstancesRequest req)
本接口 (TerminateInstances) 用于主动退还实例。 不再使用的实例,可通过本接口主动退还。 按量计费的实例通过本接口可直接退还;包年包月实例如符合[退还规则](https://cloud.tencent.com/document/product/213/9711),也可通过本接口主动退还。 包年包月实例首次调用本接口,实例将被移至回收站,再次调用本接口,实例将被销毁,且不可恢复。按量计费实例调用本接口将被直接销毁。 包年包月实例首次调用本接口,入参中包含ReleasePrepaidDataDisks时,包年包月数据盘同时也会被移至回收站。 支持批量操作,每次请求批量实例的上限为100。 批量操作时,所有实例的付费类型必须一致。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.cwp.v20180228
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cws.v20180312
-
Uses of TencentCloudSDKException in com.tencentcloudapi.cynosdb.v20190107
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dasb.v20191018
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dataintegration.v20220613
Methods in com.tencentcloudapi.dataintegration.v20220613 that throw TencentCloudSDKException Modifier and Type Method Description SendMessageResponse
DataintegrationClient. SendMessage(SendMessageRequest req)
使用SDK将数据上报到DIP -
Uses of TencentCloudSDKException in com.tencentcloudapi.dayu.v20180709
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dbbrain.v20191016
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dbbrain.v20210527
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dbdc.v20201029
Methods in com.tencentcloudapi.dbdc.v20201029 that throw TencentCloudSDKException Modifier and Type Method 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)
本接口用于修改集群名称 -
Uses of TencentCloudSDKException in com.tencentcloudapi.dc.v20180410
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dcdb.v20180411
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dlc.v20210125
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dnspod.v20210323
-
Uses of TencentCloudSDKException in com.tencentcloudapi.domain.v20180808
-
Uses of TencentCloudSDKException in com.tencentcloudapi.drm.v20181115
Methods in com.tencentcloudapi.drm.v20181115 that throw TencentCloudSDKException Modifier and Type Method 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的所有加密密钥DescribeFairPlayPemResponse
DrmClient. DescribeFairPlayPem(DescribeFairPlayPemRequest req)
该接口用来查询设置的FairPlay私钥校验信息。可用该接口校验设置的私钥与本身的私钥是否一致。DescribeKeysResponse
DrmClient. DescribeKeys(DescribeKeysRequest req)
开发者需要指定使用的DRM类型、和需要加密的Track类型,后台返回加密使用的密钥 如果加密使用的ContentID没有关联的密钥信息,后台会自动生成新的密钥返回ModifyFairPlayPemResponse
DrmClient. ModifyFairPlayPem(ModifyFairPlayPemRequest req)
本接口用来设置fairplay方案所需的私钥、私钥密钥、ask等信息。 如需使用fairplay方案,请务必先设置私钥。StartEncryptionResponse
DrmClient. StartEncryption(StartEncryptionRequest req)
开发者调用该接口,启动一次内容文件的DRM加密工作流。 注意:该接口已下线。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ds.v20180523
Methods in com.tencentcloudapi.ds.v20180523 that throw TencentCloudSDKException Modifier and Type Method 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合同文档按照关键字和坐标进行签署。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.dsgc.v20190723
-
Uses of TencentCloudSDKException in com.tencentcloudapi.dtf.v20200506
Methods in com.tencentcloudapi.dtf.v20200506 that throw TencentCloudSDKException Modifier and Type Method Description DescribeTransactionsResponse
DtfClient. DescribeTransactions(DescribeTransactionsRequest req)
查询主事务列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.dts.v20180330
Methods in com.tencentcloudapi.dts.v20180330 that throw TencentCloudSDKException Modifier and Type Method 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.comCreateSubscribeResponse
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.comModifySubscribeAutoRenewFlagResponse
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)时,才能撤销数据迁移任务。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.dts.v20211206
Methods in com.tencentcloudapi.dts.v20211206 that throw TencentCloudSDKException Modifier and Type Method Description CompleteMigrateJobResponse
DtsClient. CompleteMigrateJob(CompleteMigrateJobRequest req)
本接口(CompleteMigrateJob)用于完成数据迁移任务。 选择采用增量迁移方式的任务, 需要在迁移进度进入准备完成阶段后, 调用本接口, 停止迁移增量数据。 通过DescribeMigrationJobs接口查询到任务的状态为准备完成(Status="readyComplete")时,此时可以调用本接口完成迁移任务。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启动一致性校验任务CreateMigrateCheckJobResponse
DtsClient. CreateMigrateCheckJob(CreateMigrateCheckJobRequest req)
校验迁移任务, 在开始迁移前, 必须调用本接口创建校验迁移任务, 且校验成功后才能开始迁移.CreateMigrationServiceResponse
DtsClient. CreateMigrationService(CreateMigrationServiceRequest req)
购买迁移任务。购买成功后会返回随机生成的迁移任务id列表,也可以通过查询迁移任务任务列表接口`DescribeMigrationJobs`看到购买成功的实例Id。注意,一旦购买成功后源及目标数据库类型,源及目标实例地域不可修改。CreateModifyCheckSyncJobResponse
DtsClient. CreateModifyCheckSyncJob(CreateModifyCheckSyncJobRequest req)
在修改同步任务的配置后、通过该接口校验当前任务是否支持修改对象操作CreateSyncJobResponse
DtsClient. CreateSyncJob(CreateSyncJobRequest req)
创建一个同步任务DeleteCompareTaskResponse
DtsClient. DeleteCompareTask(DeleteCompareTaskRequest req)
删除一致性校验任务。当一致性校验任务状态为success、failed、canceled 时可以执行此操作。DescribeCheckSyncJobResultResponse
DtsClient. DescribeCheckSyncJobResult(DescribeCheckSyncJobResultRequest req)
查询同步校验任务结果,检查必要参数和周边配置DescribeCompareReportResponse
DtsClient. DescribeCompareReport(DescribeCompareReportRequest req)
查询一致性校验任务详情DescribeCompareTasksResponse
DtsClient. DescribeCompareTasks(DescribeCompareTasksRequest req)
查询一致性校验任务列表,调用该接口后可通过接口`DescribeCompareTasks` 查询一致性校验任务列表来获得启动后的状态。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)
在创建修改对象的校验任务后、通过该接口查看校验任务的结果DescribeSyncJobsResponse
DtsClient. DescribeSyncJobs(DescribeSyncJobsRequest req)
查询同步任务信息DestroyMigrateJobResponse
DtsClient. DestroyMigrateJob(DestroyMigrateJobRequest req)
下线数据迁移任务。计费任务必须先调用隔离(IsolateMigrateJob)接口,且只有是**已隔离**状态下,才能调用此接口销毁任务。对于不计费任务,调用隔离(IsolateMigrateJob)接口删除任务操作。DestroySyncJobResponse
DtsClient. DestroySyncJob(DestroySyncJobRequest req)
下线同步任务,任务在已隔离状态下可以通过此操作进行任务下线,即彻底删除任务。下线操作后可通过查询同步任务信息接口DescribeSyncJobs获取任务列表查看状态,此操作成功后无法看到此任务表示下线成功。IsolateMigrateJobResponse
DtsClient. IsolateMigrateJob(IsolateMigrateJobRequest req)
隔离退还数据迁移服务。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。对于计费任务,在任务隔离后可进行解除隔离(RecoverMigrationJob)操作或直接进行下线销毁(DestroyMigrateJob)操作。对于不计费任务,调用此接口会直接销毁任务,无法进行恢复操作。IsolateSyncJobResponse
DtsClient. IsolateSyncJob(IsolateSyncJobRequest req)
隔离同步任务,隔离后可通过查询同步任务信息接口DescribeSyncJobs获取隔离后状态。在任务隔离后可进行解除隔离(RecoverSyncJob)操作或直接进行下线操作。对于不计费任务,调用此接口后会直接删除任务,无法进行恢复操作。ModifyCompareTaskResponse
DtsClient. ModifyCompareTask(ModifyCompareTaskRequest req)
修改一致性校验任务,在任务创建后启动之前,可修改一致性校验参数ModifyCompareTaskNameResponse
DtsClient. ModifyCompareTaskName(ModifyCompareTaskNameRequest req)
修改一致性校验任务名称ModifyMigrateJobSpecResponse
DtsClient. ModifyMigrateJobSpec(ModifyMigrateJobSpecRequest req)
调整实例规格,此接口只支持按量计费任务的调整。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。ModifyMigrateNameResponse
DtsClient. ModifyMigrateName(ModifyMigrateNameRequest req)
修改迁移任务名ModifyMigrateRateLimitResponse
DtsClient. ModifyMigrateRateLimit(ModifyMigrateRateLimitRequest req)
用户在发现迁移任务对用户的数据库的负载影响较大时、可通过该接口限制任务的传输速率ModifyMigrationJobResponse
DtsClient. ModifyMigrationJob(ModifyMigrationJobRequest req)
配置迁移服务,配置成功后可通过`CreateMigrationCheckJob` 创建迁移校验任务接口发起校验任务,只有校验通过才能启动迁移任务。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,获取操作后状态。ResizeSyncJobResponse
DtsClient. ResizeSyncJob(ResizeSyncJobRequest req)
调整同步任务规格,此接口只支持按量计费任务的调整,调用此接口后不会立即生效,后台调整时间大概为3~5分钟。调用此接口后可通过查询同步任务信息接口DescribeSyncJobs,获取变配后的状态。ResumeMigrateJobResponse
DtsClient. ResumeMigrateJob(ResumeMigrateJobRequest req)
重试数据迁移任务,针对异常情况可进行重试,对于redis在失败时也可重试。注意:此操作跳过校验阶段,直接重新发起任务,相当于从StartMigrationJob开始执行。调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。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后、通过该接口开始修改配置流程StartSyncJobResponse
DtsClient. StartSyncJob(StartSyncJobRequest req)
启动同步任务StopCompareResponse
DtsClient. StopCompare(StopCompareRequest req)
终止一致性校验任务StopMigrateJobResponse
DtsClient. StopMigrateJob(StopMigrateJobRequest req)
本接口(StopMigrateJob)用于终止数据迁移任务。 调用此接口后可通过查询迁移服务列表接口`DescribeMigrationJobs`来查询当前任务状态。StopSyncJobResponse
DtsClient. StopSyncJob(StopSyncJobRequest req)
结束同步任务,操作后可通过查询同步任务信息接口DescribeSyncJobs,获取操作后的状态。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.eb.v20210416
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ecc.v20181213
Methods in com.tencentcloudapi.ecc.v20181213 that throw TencentCloudSDKException Modifier and Type Method 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 图像识别批改接口 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ecdn.v20191012
Methods in com.tencentcloudapi.ecdn.v20191012 that throw TencentCloudSDKException Modifier and Type Method 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 进行操作。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ecm.v20190719
-
Uses of TencentCloudSDKException in com.tencentcloudapi.eiam.v20210420
-
Uses of TencentCloudSDKException in com.tencentcloudapi.eis.v20200715
Methods in com.tencentcloudapi.eis.v20200715 that throw TencentCloudSDKException Modifier and Type Method Description DescribeEisConnectorConfigResponse
EisClient. DescribeEisConnectorConfig(DescribeEisConnectorConfigRequest req)
获取连接器配置参数ListEisConnectorOperationsResponse
EisClient. ListEisConnectorOperations(ListEisConnectorOperationsRequest req)
获取连接器操作列表ListEisConnectorsResponse
EisClient. ListEisConnectors(ListEisConnectorsRequest req)
连接器列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.eis.v20210601
Methods in com.tencentcloudapi.eis.v20210601 that throw TencentCloudSDKException Modifier and Type Method Description GetRuntimeMCResponse
EisClient. GetRuntimeMC(GetRuntimeMCRequest req)
获取运行时详情GetRuntimeResourceMonitorMetricMCResponse
EisClient. GetRuntimeResourceMonitorMetricMC(GetRuntimeResourceMonitorMetricMCRequest req)
获取运行时资源监控详情,cpu,memory,bandwidthListDeployableRuntimesMCResponse
EisClient. ListDeployableRuntimesMC(ListDeployableRuntimesMCRequest req)
返回用户可用的运行时列表,发布应用时返回的运行时环境,仅shared和private运行时,无sandbox运行时,并且只有running/scaling状态的ListRuntimeDeployedInstancesMCResponse
EisClient. ListRuntimeDeployedInstancesMC(ListRuntimeDeployedInstancesMCRequest req)
获取运行时部署的应用实例列表ListRuntimesMCResponse
EisClient. ListRuntimesMC(ListRuntimesMCRequest req)
返回用户的运行时列表,运行时管理主页使用,包含沙箱、共享运行时及独立运行时环境,不包含已经删除的运行时 -
Uses of TencentCloudSDKException in com.tencentcloudapi.emr.v20190103
-
Uses of TencentCloudSDKException in com.tencentcloudapi.es.v20180416
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ess.v20201111
Methods in com.tencentcloudapi.ess.v20201111 that throw TencentCloudSDKException Modifier and Type Method Description BindEmployeeUserIdWithClientOpenIdResponse
EssClient. BindEmployeeUserIdWithClientOpenId(BindEmployeeUserIdWithClientOpenIdRequest req)
此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。CancelFlowResponse
EssClient. CancelFlow(CancelFlowRequest req)
用于撤销签署流程
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
`注意:如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同。`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)
注:此接口将会废弃,请使用撤销单个签署流程(CancelFlow)接口。 指定需要批量撤回的签署流程Id,获取批量撤销链接。 客户指定需要撤回的签署流程Id,最多100个,超过100不处理;接口调用成功返回批量撤回合同的链接,通过链接跳转到电子签小程序完成批量撤回。CreateBatchSignUrlResponse
EssClient. CreateBatchSignUrl(CreateBatchSignUrlRequest req)
通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。 注: - 参与人点击链接后需短信验证码才能查看合同内容。 - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。 - 个人批量签署,签名区`仅支持手写签名`。CreateConvertTaskApiResponse
EssClient. CreateConvertTaskApi(CreateConvertTaskApiRequest req)
CreateDocumentResponse
EssClient. CreateDocument(CreateDocumentRequest req)
CreateEmbedWebUrlResponse
EssClient. CreateEmbedWebUrl(CreateEmbedWebUrlRequest req)
本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建: 1.CreateFlowResponse
EssClient. CreateFlow(CreateFlowRequest req)
CreateFlowApproversResponse
EssClient. CreateFlowApprovers(CreateFlowApproversRequest req)
适用场景: 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。 限制条件: 1.CreateFlowByFilesResponse
EssClient. CreateFlowByFiles(CreateFlowByFilesRequest req)
此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。
适用场景1:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
适用场景2:可通过该接口传入制式合同文件,同时在指定位置添加签署控件。可以起到接口创建临时模板的效果。如果是标准的制式文件,建议使用模板功能生成模板ID进行合同流程的生成。
注意事项:该接口需要依赖“多文件上传”接口生成pdf资源编号(FileIds)进行使用。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)可用于通过多个模板创建合同组签署流程。 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。CreateFlowRemindsResponse
EssClient. CreateFlowReminds(CreateFlowRemindsRequest req)
指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办: 1.CreateFlowSignReviewResponse
EssClient. CreateFlowSignReview(CreateFlowSignReviewRequest req)
提交签署流程审批结果的适用场景包括: 1.CreateFlowSignUrlResponse
EssClient. CreateFlowSignUrl(CreateFlowSignUrlRequest req)
该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署
`注意:`
`1.CreateIntegrationDepartmentResponse
EssClient. CreateIntegrationDepartment(CreateIntegrationDepartmentRequest req)
此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。CreateIntegrationEmployeesResponse
EssClient. CreateIntegrationEmployees(CreateIntegrationEmployeesRequest req)
此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。CreateIntegrationRoleResponse
EssClient. CreateIntegrationRole(CreateIntegrationRoleRequest req)
此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。 适用场景1:创建当前企业的自定义SaaS角色或集团角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过控制台编辑角色或通过接口 ModifyIntegrationRole 完成更新。 适用场景2:创建当前企业的自定义SaaS角色或集团角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。 适用场景3:创建集团角色时可同时设置角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。 适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。 注意事项:SaaS角色和集团角色对应的权限树是不一样的。CreateIntegrationUserRolesResponse
EssClient. CreateIntegrationUserRoles(CreateIntegrationUserRolesRequest req)
此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。CreateMultiFlowSignQRCodeResponse
EssClient. CreateMultiFlowSignQRCode(CreateMultiFlowSignQRCodeRequest req)
此接口(CreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。 本接口适用于发起方没有填写控件的 B2C或者单C模板** 若是B2C模板,还要满足以下任意一个条件** - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署 通过一码多扫二维码发起的合同,涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign) 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)CreateOrganizationBatchSignUrlResponse
EssClient. CreateOrganizationBatchSignUrl(CreateOrganizationBatchSignUrlRequest req)
使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
附注: - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方。 - 如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。CreatePersonAuthCertificateImageResponse
EssClient. CreatePersonAuthCertificateImage(CreatePersonAuthCertificateImageRequest req)
获取个人用户认证证书图片下载URL 个人用户认证证书图片样式如下图  注: 只能获取个人用户证明图片, 企业员工的暂不支持 处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。CreatePreparedPersonalEsignResponse
EssClient. CreatePreparedPersonalEsign(CreatePreparedPersonalEsignRequest req)
本接口(CreatePreparedPersonalEsign)用于创建导入个人印章(处方单场景专用,使用此接口请与客户经理确认)。CreatePrepareFlowResponse
EssClient. CreatePrepareFlow(CreatePrepareFlowRequest req)
创建快速发起流程
适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.CreateReleaseFlowResponse
EssClient. CreateReleaseFlow(CreateReleaseFlowRequest req)
发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。 解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。 注意:原合同必须签署完
成后才能发起解除协议。 只有原合同企业类型的参与人才能发起解除协议,个人参与方不能发起解除协议
。 原合同个人类型参与人必须是解除协议的参与人,不能更换其他第三方个人
参与解除协议。 如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的企业员工代为处理
。 发起解除协议同发起其他企业合同一样,也会参与合同扣费
,扣费标准同其他类型合同。 在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。CreateSchemeUrlResponse
EssClient. CreateSchemeUrl(CreateSchemeUrlRequest req)
获取跳转至腾讯电子签小程序的签署链接 适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置 注: `1.CreateSealResponse
EssClient. CreateSeal(CreateSealRequest req)
本接口(CreateSeal)用于创建企业电子印章,支持创建企业公章,合同章,财务专用章和人事专用章创建。CreateSealPolicyResponse
EssClient. CreateSealPolicy(CreateSealPolicyRequest req)
对企业员工进行印章授权CreateUserAutoSignEnableUrlResponse
EssClient. CreateUserAutoSignEnableUrl(CreateUserAutoSignEnableUrlRequest req)
获取个人用户自动签的开通链接。 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`CreateWebThemeConfigResponse
EssClient. CreateWebThemeConfig(CreateWebThemeConfigRequest req)
用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用 创建配置对当前企业全局生效,如果多次调用,会以最后一次的配置为准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)
撤销员工持有的印章权限DescribeExtendedServiceAuthInfosResponse
EssClient. DescribeExtendedServiceAuthInfos(DescribeExtendedServiceAuthInfosRequest req)
查询企业扩展服务的开通和授权情况,当前支持查询以下内容: 1.DescribeFileUrlsResponse
EssClient. DescribeFileUrls(DescribeFileUrlsRequest req)
查询文件下载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)
查询合同详情 适用场景:可用于主动查询某个合同详情信息。DescribeFlowTemplatesResponse
EssClient. DescribeFlowTemplates(DescribeFlowTemplatesRequest req)
本接口用于查询本企业模板列表。 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。 > **适用场景** > > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。 > 一个模板通常会包含以下结构信息 >- 模板基本信息 >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方 >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfosDescribeIntegrationDepartmentsResponse
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则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。DescribeThirdPartyAuthCodeResponse
EssClient. DescribeThirdPartyAuthCode(DescribeThirdPartyAuthCodeRequest req)
通过AuthCode查询个人用户是否实名 注意: 此接口为合作引流场景使用,使用`有白名单限制`,使用前请联系对接的客户经理沟通。 `AuthCode 只能使用一次`,查询一次再次查询会返回错误DescribeUserAutoSignStatusResponse
EssClient. DescribeUserAutoSignStatus(DescribeUserAutoSignStatusRequest req)
通过此接口获取个人用户自动签的开通状态。 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`DisableUserAutoSignResponse
EssClient. DisableUserAutoSign(DisableUserAutoSignRequest req)
通过此接口可以关闭个人用户自动签功能。 无需对应的用户刷脸等方式同意即可关闭。 注意: 处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。GetTaskResultApiResponse
EssClient. GetTaskResultApi(GetTaskResultApiRequest req)
查询转换任务的状态。转换任务Id通过发起转换任务接口(CreateConvertTaskApi)获取。 注意:大文件转换所需的时间可能会比较长。ModifyApplicationCallbackInfoResponse
EssClient. ModifyApplicationCallbackInfo(ModifyApplicationCallbackInfoRequest req)
新增/删除企业应用集成中的回调配置。 新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。 请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)ModifyIntegrationDepartmentResponse
EssClient. ModifyIntegrationDepartment(ModifyIntegrationDepartmentRequest req)
此接口(ModifyIntegrationDepartment)用于更新企业的部门信息,支持更新部门名称、客户系统部门ID和部门序号等信息。ModifyIntegrationRoleResponse
EssClient. ModifyIntegrationRole(ModifyIntegrationRoleRequest req)
此接口(ModifyIntegrationRole)用来更新企业自定义的SaaS角色或集团角色。 适用场景1:更新当前企业的自定义SaaS角色或集团角色,并且更新时不进行角色中权限的更新(PermissionGroups 参数不传)。 适用场景2:更新当前企业的自定义SaaS角色或集团角色,并且更新时进行角色中权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出。 适用场景3:更新集团角色管理的子企业列表,可通过设置 SubOrganizationIds 参数达到此效果。 适用场景4:主企业代理子企业操作的场景,需要设置Agent参数,并且ProxyOrganizationId设置为子企业的id即可。 注意事项:SaaS角色和集团角色对应的权限树是不一样的。StartFlowResponse
EssClient. StartFlow(StartFlowRequest req)
此接口用于启动流程。它是模板发起合同的最后一步。 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。UnbindEmployeeUserIdWithClientOpenIdResponse
EssClient. UnbindEmployeeUserIdWithClientOpenId(UnbindEmployeeUserIdWithClientOpenIdRequest req)
此接口(UnbindEmployeeUserIdWithClientOpenId)用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。 注:`在调用此接口时,需确保OpenId已通过调用`BindEmployeeUserIdWithClientOpenId`接口与电子签系统的UserId绑定过。若OpenId未经过绑定,则无法使用此接口进行解绑操作。`UpdateIntegrationEmployeesResponse
EssClient. UpdateIntegrationEmployees(UpdateIntegrationEmployeesRequest req)
更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。 可进行批量操作,Employees中的userID与openID二选一必填UploadFilesResponse
EssClient. UploadFiles(UploadFilesRequest req)
此接口(UploadFiles)用于文件上传。
适用场景:用于生成pdf资源编号(FileIds)来配合“用PDF创建流程”接口使用,使用场景可详见“用PDF创建流程”接口说明。
其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。
调用时需要设置Domain/接口请求域名为 file.ess.tencent.cn,代码示例:
HttpProfile httpProfile = new HttpProfile();
httpProfile.setEndpoint("file.test.ess.tencent.cn");VerifyPdfResponse
EssClient. VerifyPdf(VerifyPdfRequest req)
对流程的合同文件进行数字签名验证,判断文件是否被篡改。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.essbasic.v20201222
Methods in com.tencentcloudapi.essbasic.v20201222 that throw TencentCloudSDKException Modifier and Type Method 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 + mobileCheckFaceIdentifyResponse
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人脸核身UrlCreatePreviewSignUrlResponse
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来查询对应的电子签流程idDescribeCustomFlowIdsByFlowIdResponse
EssbasicClient. DescribeCustomFlowIdsByFlowId(DescribeCustomFlowIdsByFlowIdRequest req)
此接口(DescribeCustomFlowIdsByFlowId)用于根据流程id反查自定义流程idDescribeFaceIdPhotosResponse
EssbasicClient. DescribeFaceIdPhotos(DescribeFaceIdPhotosRequest req)
该接口为第三方平台向电子签平台获取慧眼人脸核身照片DescribeFaceIdResultsResponse
EssbasicClient. DescribeFaceIdResults(DescribeFaceIdResultsRequest req)
该接口为第三方平台向电子签平台获取慧眼人脸核身结果DescribeFileIdsByCustomIdsResponse
EssbasicClient. DescribeFileIdsByCustomIds(DescribeFileIdsByCustomIdsRequest req)
根据用户自定义id查询文件idDescribeFileUrlsResponse
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)
发送流程并获取签署URLSendSignInnerVerifyCodeResponse
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]与我们联系。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.essbasic.v20210526
Methods in com.tencentcloudapi.essbasic.v20210526 that throw TencentCloudSDKException Modifier and Type Method Description ChannelBatchCancelFlowsResponse
EssbasicClient. ChannelBatchCancelFlows(ChannelBatchCancelFlowsRequest req)
指定需要批量撤销的签署流程Id,批量撤销合同 客户指定需要撤销的签署流程Id,最多100个,超过100不处理; 可以撤回:未全部签署完成 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 满足撤销条件的合同会发起异步撤销流程,不满足撤销条件的合同返回失败原因。** 合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方 [具体可参考回调消息](https://qian.tencent.com/developers/scenes/partner/callback_data_types#-%E5%90%88%E5%90%8C%E7%8A%B6%E6%80%81%E9%80%9A%E7%9F%A5---flowstatuschange)** 注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人**ChannelCancelFlowResponse
EssbasicClient. ChannelCancelFlow(ChannelCancelFlowRequest req)
撤销签署流程接口,可以撤回:未全部签署完成;不可以撤回(终态):已全部签署完成、已拒签、已过期、已撤回。 注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人ChannelCancelMultiFlowSignQRCodeResponse
EssbasicClient. ChannelCancelMultiFlowSignQRCode(ChannelCancelMultiFlowSignQRCodeRequest req)
此接口(ChannelCancelMultiFlowSignQRCode)用于取消一码多扫二维码。该接口对传入的二维码ID,若还在有效期内,可以提前失效。ChannelCancelUserAutoSignEnableUrlResponse
EssbasicClient. ChannelCancelUserAutoSignEnableUrl(ChannelCancelUserAutoSignEnableUrlRequest req)
此接口(ChannelCancelUserAutoSignEnableUrl)用来撤销发送给个人用户的自动签开通链接,撤销后对应的个人用户开通链接失效。若个人用户已经完成开通,将无法撤销。(处方单场景专用,使用此接口请与客户经理确认)ChannelCreateBatchCancelFlowUrlResponse
EssbasicClient. ChannelCreateBatchCancelFlowUrl(ChannelCreateBatchCancelFlowUrlRequest req)
指定需要批量撤销的签署流程Id,获取批量撤销链接 - 不建议使用此接口,可使用ChannelBatchCancelFlows 客户指定需要撤销的签署流程Id,最多100个,超过100不处理; 接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销; 可以撤回:未全部签署完成 不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。 注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人ChannelCreateBatchSignUrlResponse
EssbasicClient. ChannelCreateBatchSignUrl(ChannelCreateBatchSignUrlRequest req)
通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。 注: - 参与人点击链接后需短信验证码才能查看合同内容。 - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。 - 个人批量签署,签名区`仅支持手写签名`。ChannelCreateBoundFlowsResponse
EssbasicClient. ChannelCreateBoundFlows(ChannelCreateBoundFlowsRequest req)
此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。ChannelCreateConvertTaskApiResponse
EssbasicClient. ChannelCreateConvertTaskApi(ChannelCreateConvertTaskApiRequest req)
上传了word、excel、图片文件后,通过该接口发起文件转换任务,将word、excel、图片文件转换为pdf文件。ChannelCreateEmbedWebUrlResponse
EssbasicClient. ChannelCreateEmbedWebUrl(ChannelCreateEmbedWebUrlRequest req)
本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致ChannelCreateFlowByFilesResponse
EssbasicClient. ChannelCreateFlowByFiles(ChannelCreateFlowByFilesRequest req)
接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用ChannelCreateFlowGroupByFilesResponse
EssbasicClient. ChannelCreateFlowGroupByFiles(ChannelCreateFlowGroupByFilesRequest req)
接口(ChannelCreateFlowGroupByFiles)用于通过多文件创建合同组签署流程。ChannelCreateFlowGroupByTemplatesResponse
EssbasicClient. ChannelCreateFlowGroupByTemplates(ChannelCreateFlowGroupByTemplatesRequest req)
接口(ChannelCreateFlowGroupByTemplates)用于通过多模板创建合同组签署流程。ChannelCreateFlowRemindsResponse
EssbasicClient. ChannelCreateFlowReminds(ChannelCreateFlowRemindsRequest req)
指定需要批量催办的签署流程Id,批量催办合同,最多100个;接口失败后返回错误信息 注意: 该接口不可直接调用,请联系客户经理申请使用 仅能催办当前状态为“待签署”的签署人,且只能催办一次ChannelCreateFlowSignReviewResponse
EssbasicClient. ChannelCreateFlowSignReview(ChannelCreateFlowSignReviewRequest req)
提交企业流程审批结果 目前存在两种审核操作,签署审核,发起审核 签署审核:通过接口(CreateFlowsByTemplates或ChannelCreateFlowByFiles或ChannelCreatePrepareFlow)发起签署流程后,若指定了参数 NeedSignReview 为true,则可以调用此接口,指定operate=SignReview,提交企业内部签署审批结果;若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效 发起审核:通过接口ChannelCreatePrepareFlow指定发起后需要审核,则可以通过调用此接口,指定operate=CreateReview,提交企业内部审批结果,可多次提交,当通过后,后续提交结果无效ChannelCreateFlowSignUrlResponse
EssbasicClient. ChannelCreateFlowSignUrl(ChannelCreateFlowSignUrlRequest req)
创建个人签署H5签署链接,请联系客户经理申请使用
该接口用于发起合同后,生成C端签署人的签署链接
注意:该接口目前签署人类型仅支持个人签署方(PERSON)
注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式ChannelCreateMultiFlowSignQRCodeResponse
EssbasicClient. ChannelCreateMultiFlowSignQRCode(ChannelCreateMultiFlowSignQRCodeRequest req)
此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。 本接口适用于发起方没有填写控件的 B2C或者单C模板** 若是B2C模板,还要满足以下任意一个条件** - 模板中配置的签署顺序是无序 - B端企业的签署方式是静默签署 - B端企业是非首位签署 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调 ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign) 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)ChannelCreateOrganizationModifyQrCodeResponse
EssbasicClient. ChannelCreateOrganizationModifyQrCode(ChannelCreateOrganizationModifyQrCodeRequest req)
生成渠道子客编辑企业信息二维码ChannelCreatePreparedPersonalEsignResponse
EssbasicClient. ChannelCreatePreparedPersonalEsign(ChannelCreatePreparedPersonalEsignRequest req)
本接口(ChannelCreatePreparedPersonalEsign)用于创建导入个人印章(处方单场景专用,使用此接口请与客户经理确认)。ChannelCreatePrepareFlowResponse
EssbasicClient. ChannelCreatePrepareFlow(ChannelCreatePrepareFlowRequest req)
创建预发起合同 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起 可指定合同信息不可更改,签署人信息不可更改 合同发起后,填写及签署流程与现有操作流程一致 注意:目前仅支持模板发起ChannelCreateReleaseFlowResponse
EssbasicClient. ChannelCreateReleaseFlow(ChannelCreateReleaseFlowRequest req)
发起解除协议,主要应用场景为:基于一份已经签署的合同,进行解除操作。 合同发起人必须在电子签已经进行实名。ChannelCreateRoleResponse
EssbasicClient. ChannelCreateRole(ChannelCreateRoleRequest req)
此接口(ChannelCreateRole)用来创建企业自定义角色。 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。ChannelCreateSealPolicyResponse
EssbasicClient. ChannelCreateSealPolicy(ChannelCreateSealPolicyRequest req)
将指定印章授权给第三方平台子客企业下的某些员工ChannelCreateUserAutoSignEnableUrlResponse
EssbasicClient. ChannelCreateUserAutoSignEnableUrl(ChannelCreateUserAutoSignEnableUrlRequest req)
企业方可以通过此接口获取个人用户开启自动签的跳转链接ChannelCreateUserRolesResponse
EssbasicClient. ChannelCreateUserRoles(ChannelCreateUserRolesRequest req)
通过此接口,绑定员工角色,支持以电子签userId、客户系统userId两种方式调用。ChannelCreateWebThemeConfigResponse
EssbasicClient. ChannelCreateWebThemeConfig(ChannelCreateWebThemeConfigRequest req)
用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用 创建配置对当前第三方应用全局生效,如果多次调用,会以最后一次的配置为准ChannelDeleteRoleResponse
EssbasicClient. ChannelDeleteRole(ChannelDeleteRoleRequest req)
此接口(ChannelDeleteRole)用来删除企业自定义角色。 注意:系统角色不可删除。ChannelDeleteRoleUsersResponse
EssbasicClient. ChannelDeleteRoleUsers(ChannelDeleteRoleUsersRequest req)
通过此接口,删除员工绑定的角色,支持以电子签userId、客户系统userId两种方式调用。ChannelDeleteSealPoliciesResponse
EssbasicClient. ChannelDeleteSealPolicies(ChannelDeleteSealPoliciesRequest req)
删除指定印章下多个授权信息ChannelDescribeEmployeesResponse
EssbasicClient. ChannelDescribeEmployees(ChannelDescribeEmployeesRequest req)
查询企业员工列表ChannelDescribeFlowComponentsResponse
EssbasicClient. ChannelDescribeFlowComponents(ChannelDescribeFlowComponentsRequest req)
查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。ChannelDescribeOrganizationSealsResponse
EssbasicClient. ChannelDescribeOrganizationSeals(ChannelDescribeOrganizationSealsRequest req)
查询子客企业电子印章,需要操作者具有管理印章权限 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数,只返回启用的印章。ChannelDescribeRolesResponse
EssbasicClient. ChannelDescribeRoles(ChannelDescribeRolesRequest req)
分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列ChannelDescribeUserAutoSignStatusResponse
EssbasicClient. ChannelDescribeUserAutoSignStatus(ChannelDescribeUserAutoSignStatusRequest req)
企业方可以通过此接口查询个人用户自动签开启状态ChannelDisableUserAutoSignResponse
EssbasicClient. ChannelDisableUserAutoSign(ChannelDisableUserAutoSignRequest req)
企业方可以通过此接口关闭个人的自动签功能ChannelGetTaskResultApiResponse
EssbasicClient. ChannelGetTaskResultApi(ChannelGetTaskResultApiRequest req)
查询转换任务的状态。转换任务Id通过发起转换任务接口(ChannelCreateConvertTaskApi)获取。 注意:大文件转换所需的时间可能会比较长。ChannelModifyRoleResponse
EssbasicClient. ChannelModifyRole(ChannelModifyRoleRequest req)
此接口(ChannelModifyRole)用来更新企业自定义角色。 适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。ChannelUpdateSealStatusResponse
EssbasicClient. ChannelUpdateSealStatus(ChannelUpdateSealStatusRequest req)
本接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态ChannelVerifyPdfResponse
EssbasicClient. ChannelVerifyPdf(ChannelVerifyPdfRequest req)
对流程的合同文件进行数字签名验证,判断文件是否被篡改。CreateChannelFlowEvidenceReportResponse
EssbasicClient. CreateChannelFlowEvidenceReport(CreateChannelFlowEvidenceReportRequest req)
创建出证报告,返回报告 ID。需要配合出证套餐才能调用。 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeChannelFlowEvidenceReport进行查询。CreateConsoleLoginUrlResponse
EssbasicClient. CreateConsoleLoginUrl(CreateConsoleLoginUrlRequest req)
此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客控制台的唯一入口。 链接访问后,会根据企业的和员工的状态(企业根据ProxyOrganizationOpenId参数,员工根据OpenId参数判断),进入不同的流程,主要情况分类如下: 1.CreateFlowsByTemplatesResponse
EssbasicClient. CreateFlowsByTemplates(CreateFlowsByTemplatesRequest req)
接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。 如若在模板中配置了动态表格, 上传的附件必须为A4大小 合同发起人必须在电子签已经进行实名。CreateSealByImageResponse
EssbasicClient. CreateSealByImage(CreateSealByImageRequest req)
通过图片为子客企业代创建印章,图片最大5MBCreateSignUrlsResponse
EssbasicClient. CreateSignUrls(CreateSignUrlsRequest req)
创建跳转小程序查看或签署的链接。 跳转小程序的几种方式:主要是设置不同的EndPoint 1.DescribeChannelFlowEvidenceReportResponse
EssbasicClient. DescribeChannelFlowEvidenceReport(DescribeChannelFlowEvidenceReportRequest req)
查询出证报告,返回报告 URL。DescribeExtendedServiceAuthInfoResponse
EssbasicClient. DescribeExtendedServiceAuthInfo(DescribeExtendedServiceAuthInfoRequest req)
查询企业扩展服务授权信息,企业经办人需要是企业超管或者法人DescribeFlowDetailInfoResponse
EssbasicClient. DescribeFlowDetailInfo(DescribeFlowDetailInfoRequest req)
此接口(DescribeFlowDetailInfo)用于查询合同(签署流程)的详细信息。DescribeResourceUrlsByFlowsResponse
EssbasicClient. DescribeResourceUrlsByFlows(DescribeResourceUrlsByFlowsRequest req)
根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。 此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。DescribeTemplatesResponse
EssbasicClient. DescribeTemplates(DescribeTemplatesRequest req)
通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。 > **适用场景** > > 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。 > 一个模板通常会包含以下结构信息 >- 模板基本信息 >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方 >- 填写控件 Components >- 签署控件 SignComponents >- 生成模板的文件基础信息 FileInfosDescribeUsageResponse
EssbasicClient. DescribeUsage(DescribeUsageRequest req)
此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。 注: 此接口每日限频50次,若要扩大限制次数,请提前与客服经理或邮件至[email protected]进行联系。GetDownloadFlowUrlResponse
EssbasicClient. GetDownloadFlowUrl(GetDownloadFlowUrlRequest req)
此接口(GetDownloadFlowUrl)用于创建电子签批量下载地址,让合作企业进入控制台直接下载,支持客户合同(流程)按照自定义文件夹形式 分类下载。 当前接口限制最多合同(流程)50个.ModifyExtendedServiceResponse
EssbasicClient. ModifyExtendedService(ModifyExtendedServiceRequest req)
修改(操作)企业扩展服务 ,企业经办人需要是企业超管或者法人OperateChannelTemplateResponse
EssbasicClient. OperateChannelTemplate(OperateChannelTemplateRequest req)
此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。 > **使用场景** > > 1:查询 OperateType=SELECT > - 查询第三方应用平台模板库的可见性以及授权的子客列表。 > > 2:修改部分子客授权 OperateType=UPDATE > - 对子客企业进行模板库中模板可见性的进行修改操作。 >- 当模板未发布时,可以修改可见性AuthTag(part/all),当模板发布后,不可做此修改 > - 若模板已发布且可见性AuthTag是part,可以通过ProxyOrganizationOpenIds增加子客的授权范围。如果是自动领取的模板,增加授权范围后会自动下发。 > > 3:取消部分子客授权 OperateType=DELETE > - 对子客企业进行模板库中模板可见性的进行删除操作。 > - 主要对于手动领取的模板,去除授权后子客在模板库中看不到,就无法再领取了。但是已经领取过成为自有模板的不会同步删除。 > - 对于自动领取的模板,由于已经下发,更改授权不会影响。 > - 如果要同步删除子客自有模板库中的模板,请使用OperateType=UPDATE+Available参数处理。PrepareFlowsResponse
EssbasicClient. PrepareFlows(PrepareFlowsRequest req)
该接口 (PrepareFlows) 用于创建待发起文件 用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。 目前该接口只支持B2C,不建议使用,将会废弃。SyncProxyOrganizationResponse
EssbasicClient. SyncProxyOrganization(SyncProxyOrganizationRequest req)
此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意: 1.SyncProxyOrganizationOperatorsResponse
EssbasicClient. SyncProxyOrganizationOperators(SyncProxyOrganizationOperatorsRequest req)
此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。 若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。UploadFilesResponse
EssbasicClient. UploadFiles(UploadFilesRequest req)
此接口(UploadFiles)用于文件上传。 其中上传的文件,图片类型(png/jpg/jpeg)大小限制为5M,其他大小限制为60M。 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn。 代码示例: HttpProfile httpProfile = new HttpProfile(); httpProfile.setEndpoint("file.test.ess.tencent.cn"); -
Uses of TencentCloudSDKException in com.tencentcloudapi.facefusion.v20181201
Methods in com.tencentcloudapi.facefusion.v20181201 that throw TencentCloudSDKException Modifier and Type Method Description DescribeMaterialListResponse
FacefusionClient. DescribeMaterialList(DescribeMaterialListRequest req)
通常通过腾讯云人脸融合的控制台可以查看到素材相关的参数数据,可以满足使用。本接口返回活动的素材数据,包括素材状态等。用于用户通过Api查看素材相关数据,方便使用。FaceFusionResponse
FacefusionClient. FaceFusion(FaceFusionRequest req)
本接口用于人脸融合,用户上传人脸图片,获取与模板融合后的人脸图片。未发布的活动请求频率限制为1次/秒,已发布的活动请求频率限制50次/秒。如有需要提高活动的请求频率限制,请在控制台中申请。 > - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。FaceFusionLiteResponse
FacefusionClient. FaceFusionLite(FaceFusionLiteRequest req)
接口不再使用 人脸融合活动专用版,不推荐使用。人脸融合接口建议使用[人脸融合](https://cloud.tencent.com/document/product/670/31061)或[选脸融合](https://cloud.tencent.com/document/product/670/37736)接口FuseFaceResponse
FacefusionClient. FuseFace(FuseFaceRequest req)
本接口用于单脸、多脸融合,用户上传人脸图片,获取与模板融合后的人脸图片。查看 选脸融合接入指引。 未发布的活动请求频率限制为1次/秒,已发布的活动请求频率限制50次/秒。如有需要提高活动的请求频率限制,请在控制台中申请。 > - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.facefusion.v20220927
Methods in com.tencentcloudapi.facefusion.v20220927 that throw TencentCloudSDKException Modifier and Type Method Description DescribeMaterialListResponse
FacefusionClient. DescribeMaterialList(DescribeMaterialListRequest req)
通常通过腾讯云人脸融合的控制台可以查看到素材相关的参数数据,可以满足使用。本接口返回活动的素材数据,包括素材状态等。用于用户通过Api查看素材相关数据,方便使用。FuseFaceResponse
FacefusionClient. FuseFace(FuseFaceRequest req)
本接口用于单脸、多脸、选脸融合,上传人脸图片,得到与素材模板融合后的人脸图片。支持为融合结果图添加标识。查看 融合接入指引。 请求频率限制为20次/秒。 > - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.faceid.v20180301
Methods in com.tencentcloudapi.faceid.v20180301 that throw TencentCloudSDKException Modifier and Type Method 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)
手机号二要素核验接口用于校验手机号和姓名的真实性和一致性,支持的手机号段详情请查阅运营商类文档。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秒)可多次拉取。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)
传入照片和身份信息,判断该照片与权威库的证件照是否属于同一个人。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)
本接口用于校验中国联通手机号、姓名和身份证号的真实性和一致性。中国联通支持的手机号段详情请查阅运营商类文档。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.fmu.v20191213
Methods in com.tencentcloudapi.fmu.v20191213 that throw TencentCloudSDKException Modifier and Type Method 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。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ft.v20200304
Methods in com.tencentcloudapi.ft.v20200304 that throw TencentCloudSDKException Modifier and Type Method 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)
用户上传一张人脸图片,基于人脸编辑与生成算法,输出一张人脸性别转换的图片。男变女可实现美颜、淡妆、加刘海和长发的效果;女变男可实现加胡须、变短发的效果。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.gaap.v20180529
-
Uses of TencentCloudSDKException in com.tencentcloudapi.gme.v20180711
Methods in com.tencentcloudapi.gme.v20180711 that throw TencentCloudSDKException Modifier and Type Method 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个。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)。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.goosefs.v20220519
-
Uses of TencentCloudSDKException in com.tencentcloudapi.gpm.v20200820
Methods in com.tencentcloudapi.gpm.v20200820 that throw TencentCloudSDKException Modifier and Type Method 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正式下架,感谢您的支持 分页查询匹配CodeDescribeMatchesResponse
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。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.gs.v20191118
Methods in com.tencentcloudapi.gs.v20191118 that throw TencentCloudSDKException Modifier and Type Method 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)
尝试锁定机器 -
Uses of TencentCloudSDKException in com.tencentcloudapi.gse.v20191112
Methods in com.tencentcloudapi.gse.v20191112 that throw TencentCloudSDKException Modifier and Type Method 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)用于更新服务器舰队配置。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.habo.v20181203
Methods in com.tencentcloudapi.habo.v20181203 that throw TencentCloudSDKException Modifier and Type Method Description DescribeStatusResponse
HaboClient. DescribeStatus(DescribeStatusRequest req)
查询指定md5样本是否分析完成,并获取分析日志下载地址。StartAnalyseResponse
HaboClient. StartAnalyse(StartAnalyseRequest req)
上传样本到哈勃进行分析,异步生成分析日志。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.hasim.v20210716
-
Uses of TencentCloudSDKException in com.tencentcloudapi.hcm.v20181106
Methods in com.tencentcloudapi.hcm.v20181106 that throw TencentCloudSDKException Modifier and Type Method Description EvaluationResponse
HcmClient. Evaluation(EvaluationRequest req)
速算题目批改接口,根据用户上传的图片或图片的URL识别图片中的数学算式,进而给出算式的正确性评估。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.iai.v20180301
Methods in com.tencentcloudapi.iai.v20180301 that throw TencentCloudSDKException Modifier and Type Method 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的人员库。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.iai.v20200303
Methods in com.tencentcloudapi.iai.v20200303 that throw TencentCloudSDKException Modifier and Type Method 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),人脸质量信息包括整体质量分(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/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的人员库。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ic.v20190307
Methods in com.tencentcloudapi.ic.v20190307 that throw TencentCloudSDKException Modifier and Type Method 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)
发送短信息接口 -
Uses of TencentCloudSDKException in com.tencentcloudapi.icr.v20211014
Methods in com.tencentcloudapi.icr.v20211014 that throw TencentCloudSDKException Modifier and Type Method Description GetIndustryV1HomeMembersResponse
IcrClient. GetIndustryV1HomeMembers(GetIndustryV1HomeMembersRequest req)
获取成员列表接口 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ie.v20200304
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iecp.v20210914
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iir.v20200417
Methods in com.tencentcloudapi.iir.v20200417 that throw TencentCloudSDKException Modifier and Type Method Description RecognizeProductResponse
IirClient. RecognizeProduct(RecognizeProductRequest req)
商品识别,使用微信扫一扫识物同款技术,基于人工智能技术、海量训练图片、亿级商品库,可以实现全覆盖、细粒度、高准确率的商品识别和商品推荐功能。 本服务可以识别出图片中的主体位置、主体商品类型,覆盖亿级SKU,输出具体商品的价格、型号等详细信息。 客户无需自建商品库,即可快速实现商品识别、拍照搜商品等功能。 目前“商品识别”为公测服务,需要申请、开通后方可使用。请在[服务开通申请表](https://cloud.tencent.com/apply/p/y1q2mnf0vdl) 中填写详细信息和需求,如果通过审核,我们将会在2个工作日内与您联系,并开通服务。 公测期间,本服务免费提供最高2QPS,收费模式和标准会在正式版上线前通过站内信、短信通知客户。如果需要提升并发,请与我们联系洽谈。 注意:本文档为公测版本,仅适用于功能体验和测试,正式业务接入请等待正式版。正式版的输入、输出可能会与公测版存在少量差异。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ims.v20200713
Methods in com.tencentcloudapi.ims.v20200713 that throw TencentCloudSDKException Modifier and Type Method Description ImageModerationResponse
ImsClient. ImageModeration(ImageModerationRequest req)
图片同步检测服务(Image Moderation, IM)能自动扫描图片,识别可能令人反感、不安全或不适宜的内容,同时支持用户配置图片黑名单,打击自定义识别类型的图片。 关于版本迭代的描述 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ims.v20201229
Methods in com.tencentcloudapi.ims.v20201229 that throw TencentCloudSDKException Modifier and Type Method 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接口上传调用的时间进行排序; 关于版本迭代的描述 -
Uses of TencentCloudSDKException in com.tencentcloudapi.iot.v20180123
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iotcloud.v20180614
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iotcloud.v20210408
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iotexplorer.v20190423
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iottid.v20190411
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iotvideo.v20191126
Methods in com.tencentcloudapi.iotvideo.v20191126 that throw TencentCloudSDKException Modifier and Type Method Description ClearDeviceActiveCodeResponse
IotvideoClient. ClearDeviceActiveCode(ClearDeviceActiveCodeRequest req)
清除设备激活码CreateAnonymousAccessTokenResponse
IotvideoClient. CreateAnonymousAccessToken(CreateAnonymousAccessTokenRequest req)
创建匿名访问TokenCreateAppUsrResponse
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)接收上传到控制台的固件版本信息。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.iotvideo.v20201215
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iotvideo.v20211125
-
Uses of TencentCloudSDKException in com.tencentcloudapi.iotvideoindustry.v20201201
-
Uses of TencentCloudSDKException in com.tencentcloudapi.irp.v20220324
Methods in com.tencentcloudapi.irp.v20220324 that throw TencentCloudSDKException Modifier and Type Method Description RecommendContentResponse
IrpClient. RecommendContent(RecommendContentRequest req)
获取推荐结果ReportActionResponse
IrpClient. ReportAction(ReportActionRequest req)
上报行为ReportMaterialResponse
IrpClient. ReportMaterial(ReportMaterialRequest req)
上报物料ReportPortraitResponse
IrpClient. ReportPortrait(ReportPortraitRequest req)
上报用户画像 -
Uses of TencentCloudSDKException in com.tencentcloudapi.irp.v20220805
Methods in com.tencentcloudapi.irp.v20220805 that throw TencentCloudSDKException Modifier and Type Method 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)
上报电商类商品信息 -
Uses of TencentCloudSDKException in com.tencentcloudapi.iss.v20230517
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ivld.v20210903
Methods in com.tencentcloudapi.ivld.v20210903 that throw TencentCloudSDKException Modifier and Type Method 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)
更新自定义人物信息,包括姓名,简要信息,分类信息等 -
Uses of TencentCloudSDKException in com.tencentcloudapi.keewidb.v20220308
-
Uses of TencentCloudSDKException in com.tencentcloudapi.kms.v20190118
-
Uses of TencentCloudSDKException in com.tencentcloudapi.lcic.v20220817
-
Uses of TencentCloudSDKException in com.tencentcloudapi.lighthouse.v20200324
Methods in com.tencentcloudapi.lighthouse.v20200324 that throw TencentCloudSDKException Modifier and Type Method 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)用于挂载一个或多个云硬盘。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)用于修改云硬盘属性。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”,则代表操作成功。 注意:强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏。RestartDockerContainersResponse
LighthouseClient. RestartDockerContainers(RestartDockerContainersRequest req)
重启实例内的Docker容器,之后可以通过返回的ActivityId调用DescribeDockerActivities接口查询重启情况。RunDockerContainersResponse
LighthouseClient. RunDockerContainers(RunDockerContainersRequest req)
创建并运行多个Docker容器,之后可以通过返回的ActivityIds调用DescribeDockerActivities接口查询创建情况。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”,则代表操作成功。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.live.v20180801
-
Uses of TencentCloudSDKException in com.tencentcloudapi.lowcode.v20210108
Methods in com.tencentcloudapi.lowcode.v20210108 that throw TencentCloudSDKException Modifier and Type Method Description DescribeDataSourceListResponse
LowcodeClient. DescribeDataSourceList(DescribeDataSourceListRequest req)
获取数据源详情列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.lp.v20200224
Methods in com.tencentcloudapi.lp.v20200224 that throw TencentCloudSDKException Modifier and Type Method Description QueryLoginProtectionResponse
LpClient. QueryLoginProtection(QueryLoginProtectionRequest req)
登录保护服务(LoginProtection,LP)针对网站和 APP 的用户登录场景,实时检测是否存在盗号、撞库等恶意登录行为,帮助开发者发现异常登录,降低恶意用户登录给业务带来的风险。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.mall.v20230518
Methods in com.tencentcloudapi.mall.v20230518 that throw TencentCloudSDKException Modifier and Type Method Description DescribeDrawResourceListResponse
MallClient. DescribeDrawResourceList(DescribeDrawResourceListRequest req)
依据客户的Uin查询开通的资源列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.mariadb.v20170312
-
Uses of TencentCloudSDKException in com.tencentcloudapi.market.v20191010
Methods in com.tencentcloudapi.market.v20191010 that throw TencentCloudSDKException Modifier and Type Method Description FlowProductRemindResponse
MarketClient. FlowProductRemind(FlowProductRemindRequest req)
计量商品用量提醒,用于服务商调用云服务,云服务向客户发送提醒信息GetUsagePlanUsageAmountResponse
MarketClient. GetUsagePlanUsageAmount(GetUsagePlanUsageAmountRequest req)
该接口可以根据InstanceId查询实例的api的使用情况。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.memcached.v20190318
Methods in com.tencentcloudapi.memcached.v20190318 that throw TencentCloudSDKException Modifier and Type Method Description DescribeInstancesResponse
MemcachedClient. DescribeInstances(DescribeInstancesRequest req)
获取Cmem实例列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.mgobe.v20190929
Methods in com.tencentcloudapi.mgobe.v20190929 that throw TencentCloudSDKException Modifier and Type Method Description DismissRoomResponse
MgobeClient. DismissRoom(DismissRoomRequest req)
通过game_id、room_id解散房间 -
Uses of TencentCloudSDKException in com.tencentcloudapi.mgobe.v20201014
Methods in com.tencentcloudapi.mgobe.v20201014 that throw TencentCloudSDKException Modifier and Type Method 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正式下架,感谢您的支持 踢出房间玩家 -
Uses of TencentCloudSDKException in com.tencentcloudapi.mmps.v20200710
-
Uses of TencentCloudSDKException in com.tencentcloudapi.mna.v20210119
-
Uses of TencentCloudSDKException in com.tencentcloudapi.mongodb.v20180408
Methods in com.tencentcloudapi.mongodb.v20180408 that throw TencentCloudSDKException Modifier and Type Method Description AssignProjectResponse
MongodbClient. AssignProject(AssignProjectRequest req)
本接口(AssignProject)用于指定云数据库实例的所属项目。CreateDBInstanceResponse
MongodbClient. CreateDBInstance(CreateDBInstanceRequest req)
本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。CreateDBInstanceHourResponse
MongodbClient. CreateDBInstanceHour(CreateDBInstanceHourRequest req)
本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例(包括主实例、灾备实例和只读实例),可通过传入实例规格、实例类型、MongoDB版本、购买时长和数量等信息创建云数据库实例。DescribeClientConnectionsResponse
MongodbClient. DescribeClientConnections(DescribeClientConnectionsRequest req)
本接口(DescribeClientConnections)用于查询实例客户端连接信息,包括连接IP和连接数量。目前只支持3.2版本的MongoDB实例。DescribeDBInstancesResponse
MongodbClient. DescribeDBInstances(DescribeDBInstancesRequest req)
本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目ID、实例ID、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。DescribeSlowLogResponse
MongodbClient. DescribeSlowLog(DescribeSlowLogRequest req)
本接口(DescribeSlowLogs)用于获取云数据库实例的慢查询日志。DescribeSpecInfoResponse
MongodbClient. DescribeSpecInfo(DescribeSpecInfoRequest req)
本接口(DescribeSpecInfo)用于查询实例的售卖规格。RenameInstanceResponse
MongodbClient. RenameInstance(RenameInstanceRequest req)
本接口(RenameInstance)用于修改云数据库实例的名称。SetAutoRenewResponse
MongodbClient. SetAutoRenew(SetAutoRenewRequest req)
本接口(SetAutoRenew)用于设置包年包月云数据库实例的续费选项。SetPasswordResponse
MongodbClient. SetPassword(SetPasswordRequest req)
本接口(SetPassword)用于设置云数据库账户的密码。TerminateDBInstanceResponse
MongodbClient. TerminateDBInstance(TerminateDBInstanceRequest req)
本接口(TerminateDBInstance)用于销毁按量计费的MongoDB云数据库实例UpgradeDBInstanceResponse
MongodbClient. UpgradeDBInstance(UpgradeDBInstanceRequest req)
本接口(UpgradeDBInstance)用于升级包年包月的MongoDB云数据库实例,可以扩容内存、存储以及OplogUpgradeDBInstanceHourResponse
MongodbClient. UpgradeDBInstanceHour(UpgradeDBInstanceHourRequest req)
本接口(UpgradeDBInstanceHour)用于升级按量计费的MongoDB云数据库实例,可以扩容内存、存储以及oplog -
Uses of TencentCloudSDKException in com.tencentcloudapi.mongodb.v20190725
-
Uses of TencentCloudSDKException in com.tencentcloudapi.monitor.v20180724
-
Uses of TencentCloudSDKException in com.tencentcloudapi.mps.v20190612
-
Uses of TencentCloudSDKException in com.tencentcloudapi.mrs.v20200910
Methods in com.tencentcloudapi.mrs.v20200910 that throw TencentCloudSDKException Modifier and Type Method Description ImageToClassResponse
MrsClient. ImageToClass(ImageToClassRequest req)
图片分类ImageToObjectResponse
MrsClient. ImageToObject(ImageToObjectRequest req)
图片转结构化对象TextToClassResponse
MrsClient. TextToClass(TextToClassRequest req)
文本分类TextToObjectResponse
MrsClient. TextToObject(TextToObjectRequest req)
文本转结构化对象。 适用场景:经过腾讯医疗专用 OCR 从图片识别之后的文本,可以调用此接口。通过其它 OCR 识别的文本可能不适配。医院的 XML 格式文本也不适配,XML 文件需要经过特殊转换才能直接调用此接口。单次调用传入的文本不宜超过 2000 字。TurnPDFToObjectResponse
MrsClient. TurnPDFToObject(TurnPDFToObjectRequest req)
将PDF格式的体检报告文件结构化,解析关键信息。 注意:该接口是按照体检报告 PDF 页面数量统计次数,不是按照 PDF 文件数量统计次数。通过该接口传入的报告必须是体检报告,非体检报告可能无法正确解析。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ms.v20180408
-
Uses of TencentCloudSDKException in com.tencentcloudapi.msp.v20180319
Methods in com.tencentcloudapi.msp.v20180319 that throw TencentCloudSDKException Modifier and Type Method 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)
注册迁移任务 -
Uses of TencentCloudSDKException in com.tencentcloudapi.mvj.v20190926
Methods in com.tencentcloudapi.mvj.v20190926 that throw TencentCloudSDKException Modifier and Type Method Description MarketingValueJudgementResponse
MvjClient. MarketingValueJudgement(MarketingValueJudgementRequest req)
欢迎使用营销价值判断(Marketing Value Judgement,简称 MVJ)。 营销价值判断(MVJ)是针对零售场景的风控服务,通过识别高价值顾客,以帮助零售商保障营销资金 -
Uses of TencentCloudSDKException in com.tencentcloudapi.nlp.v20190408
Methods in com.tencentcloudapi.nlp.v20190408 that throw TencentCloudSDKException Modifier and Type Method 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)
通过自动补全文本片段,帮助用户快速生成高质量、连贯的完整文本,提高创作效率。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.npp.v20190823
Methods in com.tencentcloudapi.npp.v20190823 that throw TencentCloudSDKException Modifier and Type Method 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 使用方发起) -
Uses of TencentCloudSDKException in com.tencentcloudapi.oceanus.v20190422
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ocr.v20181119
Methods in com.tencentcloudapi.ocr.v20181119 that throw TencentCloudSDKException Modifier and Type Method Description AdvertiseOCRResponse
OcrClient. AdvertiseOCR(AdvertiseOCRRequest req)
本接口支持广告商品图片内文字的检测和识别,返回文本框位置与文字内容。 产品优势:针对广告商品图片普遍存在较多繁体字、艺术字的特点,进行了识别能力的增强。支持中英文、横排、竖排以及倾斜场景文字识别。文字识别的召回率和准确率能达到96%以上。ArithmeticOCRResponse
OcrClient. ArithmeticOCR(ArithmeticOCRRequest req)
本接口支持作业算式题目的自动识别和判分,目前覆盖 K12 学力范围内的 11 种题型,包括加减乘除四则、加减乘除已知结果求运算因子、判断大小、约等于估算、带余数除法、分数四则运算、单位换算、竖式加减法、竖式乘除法、脱式计算和解方程,平均识别精度达到93%以上。 默认接口请求频率限制:10次/秒。BankCardOCRResponse
OcrClient. BankCardOCR(BankCardOCRRequest req)
本接口支持对中国大陆主流银行卡正反面关键字段的检测与识别,包括卡号、卡类型、卡名字、银行信息、有效期。支持竖排异形卡识别、多角度旋转图片识别。支持对复印件、翻拍件、边框遮挡的银行卡进行告警,可应用于各种银行卡信息有效性校验场景,如金融行业身份认证、第三方支付绑卡等场景。 默认接口请求频率限制:10次/秒。BankSlipOCRResponse
OcrClient. BankSlipOCR(BankSlipOCRRequest req)
本接口支持银行回单全字段的识别,包括付款开户行、收款开户行、付款账号、收款账号、回单类型、回单编号、币种、流水号、凭证号码、交易机构、交易金额、手续费、日期等字段信息。 默认接口请求频率限制:10次/秒。BizLicenseOCRResponse
OcrClient. BizLicenseOCR(BizLicenseOCRRequest req)
本接口支持快速精准识别营业执照上的字段,包括统一社会信用代码、公司名称、主体类型、法定代表人、注册资本、组成形式、成立日期、营业期限和经营范围等字段。 默认接口请求频率限制:10次/秒。BusinessCardOCRResponse
OcrClient. BusinessCardOCR(BusinessCardOCRRequest req)
本接口支持中英文名片各字段的自动定位与识别,包含姓名、电话、手机号、邮箱、公司、部门、职位、网址、地址、QQ、微信、MSN等。 默认接口请求频率限制:10次/秒。BusInvoiceOCRResponse
OcrClient. BusInvoiceOCR(BusInvoiceOCRRequest req)
本接口支持识别公路汽车客票关键字段的识别,包括发票代码、发票号码、日期、票价、始发地、目的地、姓名、时间、发票消费类型、身份证号、省、市、开票日期、乘车地点、检票口、客票类型、车型、座位号、车次等。 默认接口请求频率限制:5次/秒。CarInvoiceOCRResponse
OcrClient. CarInvoiceOCR(CarInvoiceOCRRequest req)
本接口支持机动车销售统一发票和二手车销售统一发票的识别,包括发票号码、发票代码、合计金额、合计税额等二十多个字段。 默认接口请求频率限制:5次/秒。ClassifyDetectOCRResponse
OcrClient. ClassifyDetectOCR(ClassifyDetectOCRRequest req)
支持身份证、护照、名片、银行卡、行驶证、驾驶证、港澳台通行证、户口本、港澳台来往内地通行证、港澳台居住证、不动产证、营业执照的智能分类。 默认接口请求频率限制:20次/秒。CreateAIFormTaskResponse
OcrClient. CreateAIFormTask(CreateAIFormTaskRequest req)
本接口可创建智能表单录入任务,支持多个识别图片和PDF的URL上传,返回含有识别内容的操作页面URL。 智能表单录入产品提供高准确率的表单识别技术和人工核对工具,支持自定义字段,将识别结果自动填入到自定义条目中,并提供人工操作工具,完成整个表单识别过程。适用性强,可对票据、合同、货单等文件的识别,适用于金融、货代、保险、档案等领域。本产品免费公测中,您可以点击demo(超链接:https://ocr.smartform.cloud.tencent.com/)试用,如需购买请与商务团队联系。DriverLicenseOCRResponse
OcrClient. DriverLicenseOCR(DriverLicenseOCRRequest req)
本接口支持驾驶证主页和副页所有字段的自动定位与识别,重点字段的识别准确度达到99%以上。 驾驶证主页:包括证号、姓名、性别、国籍、住址、出生日期、初次领证日期、准驾车型、有效期限、发证单位 驾驶证副页:包括证号、姓名、档案编号、记录。 另外,本接口还支持复印件、翻拍告警功能。同时支持识别交管12123 APP发放的电子驾驶证正页。 电子驾驶证正页:包括证号、姓名、性别、国籍、出生日期、初次领证日期、准驾车型、有效期开始时间、有效期截止时间、档案编号、状态、累积记分。 默认接口请求频率限制:10次/秒。DutyPaidProofOCRResponse
OcrClient. DutyPaidProofOCR(DutyPaidProofOCRRequest req)
本接口支持对完税证明的税号、纳税人识别号、纳税人名称、金额合计大写、金额合计小写、填发日期、税务机关、填票人等关键字段的识别。 默认接口请求频率限制:5次/秒。EduPaperOCRResponse
OcrClient. EduPaperOCR(EduPaperOCRRequest req)
本接口支持数学试题内容的识别和结构化输出,包括通用文本解析和小学/初中/高中数学公式解析能力(包括91种题型,180种符号),公式返回格式为 Latex 格式文本。 默认接口请求频率限制:5次/秒。EnglishOCRResponse
OcrClient. EnglishOCR(EnglishOCRRequest req)
本接口支持图像英文文字的检测和识别,返回文字框位置与文字内容。支持多场景、任意版面下的英文、字母、数字和常见字符的识别,同时覆盖英文印刷体和英文手写体识别。 默认接口请求频率限制:10次/秒。EnterpriseLicenseOCRResponse
OcrClient. EnterpriseLicenseOCR(EnterpriseLicenseOCRRequest req)
本接口支持智能化识别各类企业登记证书、许可证书、企业执照、三证合一类证书,结构化输出统一社会信用代码、公司名称、法定代表人、公司地址、注册资金、企业类型、经营范围、成立日期、有效期、开办资金、经费来源、举办单位等关键字段。 默认接口请求频率限制:5次/秒。EstateCertOCRResponse
OcrClient. EstateCertOCR(EstateCertOCRRequest req)
本接口支持不动产权证关键字段的识别,包括使用期限、面积、用途、权利性质、权利类型、坐落、共有情况、权利人、权利其他状况等。 默认接口请求频率限制:5次/秒。FinanBillOCRResponse
OcrClient. FinanBillOCR(FinanBillOCRRequest req)
本接口支持常见银行票据的自动分类和识别。整单识别包括支票(含现金支票、普通支票、转账支票),承兑汇票(含银行承兑汇票、商业承兑汇票)以及进账单等,适用于中国人民银行印发的 2010 版银行票据凭证版式(银发[2010]299 号)。 默认接口请求频率限制:5次/秒。FinanBillSliceOCRResponse
OcrClient. FinanBillSliceOCR(FinanBillSliceOCRRequest req)
本接口支持常见银行票据的自动分类和识别。切片识别包括金融行业常见票据的重要切片字段识别,包括金额、账号、日期、凭证号码等。(金融票据切片:金融票据中待识别字段及其周围局部区域的裁剪图像。) 默认接口请求频率限制:5次/秒。FlightInvoiceOCRResponse
OcrClient. FlightInvoiceOCR(FlightInvoiceOCRRequest req)
本接口支持机票行程单关键字段的识别,包括旅客姓名、有效身份证件号码、电子客票号码、验证码、填开单位、其他税费、燃油附加费、民航发展基金、保险费、销售单位代号、始发地、目的地、航班号、时间、日期、座位等级、承运人、发票消费类型、票价、合计金额、填开日期、国内国际标签、印刷序号、客票级别/类别、客票生效日期、有效期截止日期、免费行李等字段,支持航班信息多行明细输出。 默认接口请求频率限制:5次/秒。FormulaOCRResponse
OcrClient. FormulaOCR(FormulaOCRRequest req)
本接口支持识别主流初高中数学符号和公式,返回公式的 Latex 格式文本。 默认接口请求频率限制:5次/秒。GeneralAccurateOCRResponse
OcrClient. GeneralAccurateOCR(GeneralAccurateOCRRequest req)
本接口支持图像整体文字的检测和识别。支持中文、英文、中英文、数字和特殊字符号的识别,并返回文字框位置和文字内容。 适用于文字较多、版式复杂、对识别准召率要求较高的场景,如试卷试题、网络图片、街景店招牌、法律卷宗等场景。 产品优势:与通用印刷体识别相比,提供更高精度的文字识别服务,在文字较多、长串数字、小字、模糊字、倾斜文本等困难场景下,高精度版的准确率和召回率更高。 通用印刷体识别不同版本的差异如下: 【荐】通用印刷体识别(高精度版) 【荐】通用印刷体识别 通用印刷体识别(精简版) 适用场景 适用于文字较多、长串数字、小字、模糊字、倾斜文本等困难场景 适用于所有通用场景的印刷体识别 适用于快速文本识别场景,准召率有一定损失,价格更优惠 识别准确率 99% 96% 91% 价格 高 中 低 支持的语言 中文、英文、中英文 中文、英文、中英文、日语、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语 中文、英文、中英文 自动语言检测 支持 支持 支持 返回文本行坐标 支持 支持 支持 自动旋转纠正 支持旋转识别,返回角度信息 支持旋转识别,返回角度信息 支持旋转识别,返回角度信息 默认接口请求频率限制:10次/秒。GeneralBasicOCRResponse
OcrClient. GeneralBasicOCR(GeneralBasicOCRRequest req)
本接口支持图像整体文字的检测和识别。可以识别中文、英文、中英文、日语、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语,阿拉伯语20种语言,且各种语言均支持与英文混合的文字识别。 适用于印刷文档识别、网络图片识别、广告图文字识别、街景店招牌识别、菜单识别、视频标题识别、头像文字识别等场景。 产品优势:支持自动识别语言类型,可返回文本框坐标信息,对于倾斜文本支持自动旋转纠正。 通用印刷体识别不同版本的差异如下: 【荐】通用印刷体识别 【荐】通用印刷体识别(高精度版) 通用印刷体识别(精简版) 适用场景 适用于所有通用场景的印刷体识别 适用于文字较多、长串数字、小字、模糊字、倾斜文本等困难场景 适用于快速文本识别场景,准召率有一定损失,价格更优惠 识别准确率 96% 99% 91% 价格 中 高 低 支持的语言 中文、英文、中英文、日语、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语 中文、英文、中英文 中文、英文、中英文 自动语言检测 支持 支持 支持 返回文本行坐标 支持 支持 支持 自动旋转纠正 支持旋转识别,返回角度信息 支持旋转识别,返回角度信息 支持旋转识别,返回角度信息 默认接口请求频率限制:20次/秒。GeneralEfficientOCRResponse
OcrClient. GeneralEfficientOCR(GeneralEfficientOCRRequest req)
本接口支持图像整体文字的检测和识别。支持中文、英文、中英文、数字和特殊字符号的识别,并返回文字框位置和文字内容。 适用于快速文本识别场景。 产品优势:与通用印刷体识别接口相比,精简版虽然在准确率和召回率上有一定损失,但价格更加优惠。 通用印刷体识别不同版本的差异如下: 通用印刷体识别(精简版) 【荐】通用印刷体识别 【荐】通用印刷体识别(高精度版) 适用场景 适用于快速文本识别场景,准召率有一定损失,价格更优惠 适用于所有通用场景的印刷体识别 适用于文字较多、长串数字、小字、模糊字、倾斜文本等困难场景 识别准确率 91% 96% 99% 价格 低 中 高 支持的语言 中文、英文、中英文 中文、英文、中英文、日语、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语 中文、英文、中英文 自动语言检测 支持 支持 支持 返回文本行坐标 支持 支持 支持 自动旋转纠正 支持旋转识别,返回角度信息 支持旋转识别,返回角度信息 支持旋转识别,返回角度信息 默认接口请求频率限制:10次/秒。GeneralFastOCRResponse
OcrClient. GeneralFastOCR(GeneralFastOCRRequest req)
本接口支持图片中整体文字的检测和识别,返回文字框位置与文字内容。相比通用印刷体识别接口,识别速度更快。 默认接口请求频率限制:10次/秒。GeneralHandwritingOCRResponse
OcrClient. GeneralHandwritingOCR(GeneralHandwritingOCRRequest req)
本接口支持图片内手写体文字的检测和识别,针对手写字体无规则、字迹潦草、模糊等特点进行了识别能力的增强。 默认接口请求频率限制:10次/秒。GetTaskStateResponse
OcrClient. GetTaskState(GetTaskStateRequest req)
支持查询智能表单录入任务的状态。本产品免费公测中,您可以点击demo(超链接:https://ocr.smartform.cloud.tencent.com/)试用,如需购买请与商务团队联系。HKIDCardOCRResponse
OcrClient. HKIDCardOCR(HKIDCardOCRRequest req)
本接口支持中国香港身份证人像面中关键字段的识别,包括中文姓名、英文姓名、姓名电码、出生日期、性别、证件符号、首次签发日期、最近领用日期、身份证号、是否是永久性居民身份证;具备人像照片裁剪等扩展功能。 默认接口请求频率限制:5次/秒。HmtResidentPermitOCRResponse
OcrClient. HmtResidentPermitOCR(HmtResidentPermitOCRRequest req)
港澳台居住证OCR支持港澳台居住证正反面全字段内容检测识别功能,包括姓名、性别、出生日期、地址、身份证号、签发机关、有效期限、签发次数、通行证号码关键字段识别。可以应用于港澳台居住证信息识别场景,例如银行开户、用户注册等。 默认接口请求频率限制:20次/秒。IDCardOCRResponse
OcrClient. IDCardOCR(IDCardOCRRequest req)
本接口支持中国大陆居民二代身份证正反面所有字段的识别,包括姓名、性别、民族、出生日期、住址、公民身份证号、签发机关、有效期限,识别准确度达到99%以上。 另外,本接口还支持多种增值能力,满足不同场景的需求。如身份证照片、人像照片的裁剪功能,同时具备9种告警功能,如下表所示。 增值能力 能力项 裁剪功能 身份证照片裁剪(去掉证件外多余的边缘、自动矫正拍摄角度) 人像照片裁剪(自动抠取身份证头像区域) 告警功能 身份证有效日期不合法,即有效日期不符合5年、10年、20年、长期期限 身份证边框不完整告警 身份证复印件告警 身份证翻拍告警 身份证框内遮挡告警 临时身份证告警 身份证疑似存在PS痕迹告警 图片模糊告警(可根据图片质量分数判断) 默认接口请求频率限制:20次/秒。ImageEnhancementResponse
OcrClient. ImageEnhancement(ImageEnhancementRequest req)
文本图像增强是面向文档类图片提供的图像增强处理能力,包括切边增强、图像矫正、阴影去除、摩尔纹去除等;可以有效优化文档类的图片质量,提升文字的清晰度。 默认接口请求频率限制:10次/秒。InstitutionOCRResponse
OcrClient. InstitutionOCR(InstitutionOCRRequest req)
本接口支持事业单位法人证书关键字段识别,包括注册号、有效期、住所、名称、法定代表人等。 默认接口请求频率限制:5次/秒。InsuranceBillOCRResponse
OcrClient. InsuranceBillOCR(InsuranceBillOCRRequest req)
本接口支持病案首页、费用清单、结算单、医疗发票四种保险理赔单据的文本识别和结构化输出。 默认接口请求频率限制:1次/秒。InvoiceGeneralOCRResponse
OcrClient. InvoiceGeneralOCR(InvoiceGeneralOCRRequest req)
本接口支持对通用机打发票的发票代码、发票号码、日期、合计金额(小写)、合计金额(大写)、购买方识别号、销售方识别号、校验码、购买方名称、销售方名称、时间、种类、发票消费类型、省、市、是否有公司印章、发票名称、购买方地址、电话、销售方地址、电话、购买方开户行及账号、销售方开户行及账号、经办人取票用户、经办人支付信息、经办人商户号、经办人订单号、货物或应税劳务、服务名称、数量、单价、税率、税额、金额、单位、规格型号、合计税额、合计金额、备注、收款人、复核、开票人、密码区、行业分类等字段的识别。 默认接口请求频率限制:5次/秒。LicensePlateOCRResponse
OcrClient. LicensePlateOCR(LicensePlateOCRRequest req)
本接口支持对中国大陆机动车车牌的自动定位和识别,返回地域编号和车牌号码与车牌颜色信息。 默认接口请求频率限制:10次/秒。MainlandPermitOCRResponse
OcrClient. MainlandPermitOCR(MainlandPermitOCRRequest req)
智能识别并结构化港澳台居民来往内地通行证正面全部字段,包含中文姓名、英文姓名、性别、出生日期、签发机关、有效期限、证件号、签发地点、签发次数、证件类别。 默认接口请求频率限制:20次/秒。MixedInvoiceDetectResponse
OcrClient. MixedInvoiceDetect(MixedInvoiceDetectRequest req)
本接口支持多张、多类型票据的混合检测和自动分类,返回对应票据类型。目前已支持增值税发票、增值税发票(卷票)、定额发票、通用机打发票、购车发票、火车票、出租车发票、机票行程单、汽车票、轮船票、过路过桥费发票、酒店账单、客运限额发票、购物小票、完税证明共15种票据。 默认接口请求频率限制:5次/秒。MixedInvoiceOCRResponse
OcrClient. MixedInvoiceOCR(MixedInvoiceOCRRequest req)
本接口支持 单张、多张、多类型 票据的混合识别,同时支持自选需要识别的票据类型,已支持票种包括:增值税发票(专票、普票、卷票)、全电发票、非税发票、定额发票、通用机打发票、购车发票、火车票、出租车发票、机票行程单、汽车票、轮船票、过路过桥费发票共14种标准报销发票,并支持其他类发票的识别。 默认接口请求频率限制:5次/秒。MLIDCardOCRResponse
OcrClient. MLIDCardOCR(MLIDCardOCRRequest req)
本接口支持马来西亚身份证识别,识别字段包括身份证号、姓名、性别、地址;具备身份证人像照片的裁剪功能和翻拍、复印件告警功能。 本接口暂未完全对外开放,如需咨询,请[联系商务](https://cloud.tencent.com/about/connect)MLIDPassportOCRResponse
OcrClient. MLIDPassportOCR(MLIDPassportOCRRequest req)
本接口支持中国港澳台地区以及其他国家、地区的护照识别。识别字段包括护照ID、姓名、出生日期、性别、有效期、发行国、国籍、国家地区代码,具备护照人像照片的裁剪功能和翻拍、复印件告警功能。 默认接口请求频率限制:5次/秒。OrgCodeCertOCRResponse
OcrClient. OrgCodeCertOCR(OrgCodeCertOCRRequest req)
本接口支持组织机构代码证关键字段的识别,包括代码、有效期、地址、机构名称等。 默认接口请求频率限制:5次/秒。PassportOCRResponse
OcrClient. PassportOCR(PassportOCRRequest req)
本接口支持中国大陆地区护照个人资料页多个字段的检测与识别。已支持字段包括英文姓名、中文姓名、国家码、护照号、出生地、出生日期、国籍英文、性别英文、有效期、签发地点英文、签发日期、持证人签名、护照机读码(MRZ码)等。 默认接口请求频率限制:10次/秒。PermitOCRResponse
OcrClient. PermitOCR(PermitOCRRequest req)
本接口支持对卡式港澳台通行证的识别,包括签发地点、签发机关、有效期限、性别、出生日期、英文姓名、姓名、证件号等字段。 默认接口请求频率限制:10次/秒。PropOwnerCertOCRResponse
OcrClient. PropOwnerCertOCR(PropOwnerCertOCRRequest req)
本接口支持房产证关键字段的识别,包括房地产权利人、共有情况、登记时间、规划用途、房屋性质、房屋坐落等。 目前接口对合肥、成都、佛山三个城市的房产证版式识别较好。 默认接口请求频率限制:5次/秒。QrcodeOCRResponse
OcrClient. QrcodeOCR(QrcodeOCRRequest req)
本接口支持条形码和二维码的识别(包括 DataMatrix 和 PDF417)。 默认接口请求频率限制:5次/秒。QuotaInvoiceOCRResponse
OcrClient. QuotaInvoiceOCR(QuotaInvoiceOCRRequest req)
本接口支持定额发票的发票号码、发票代码、金额(大小写)、发票消费类型、地区及是否有公司印章等关键字段的识别。 默认接口请求频率限制:5次/秒。RecognizeContainerOCRResponse
OcrClient. RecognizeContainerOCR(RecognizeContainerOCRRequest req)
本接口支持集装箱箱门信息识别,识别字段包括集装箱箱号、类型、总重量、有效承重、容量、自身重量,具备集装箱箱号、类型不完整或者不清晰的告警功能。 默认接口请求频率限制:5次/秒。RecognizeGeneralInvoiceResponse
OcrClient. RecognizeGeneralInvoice(RecognizeGeneralInvoiceRequest req)
本接口支持 PDF多页(最多30页)、一页中单张、多张、类型票据的混合识别,同时支持单选识别某类票据,已支持票种包括:增值税发票(专票、普票、卷票、区块链发票、通行费发票)、全电发票(专票、普票)、非税发票(通用票据、统一缴纳书)、定额发票、通用机打发票、购车发票(机动车销售发票、二手车发票)、火车票、出租车发票、机票行程单、汽车票、轮船票、过路过桥费发票共14种标准报销发票,并支持非上述类型的其他发票的智能识别,点击[立即试用](https://cloud.tencent.com/product/ocr)。 默认接口请求频率限制:5次/秒。 支持返回的细项目子票种SubType、子票种中文TypeDescription、以及对应所属大类票种Type 的说明如下列表: SubType 子票种英文 TypeDescription子票种中文 Type 所属大类票种 VatSpecialInvoice 增值税专用发票 3 VatCommonInvoice 增值税普通发票 3 VatElectronicCommonInvoice 增值税电子普通发票 3 VatElectronicSpecialInvoice 增值税电子专用发票 3 VatElectronicInvoiceBlockchain 区块链电子发票 3 VatElectronicInvoiceToll 增值税电子普通发票(通行费) 3 VatSalesList 增值税销货清单 3 VatElectronicSpecialInvoiceFull 电子发票(专用发票) 16 VatElectronicInvoiceFull 电子发票(普通发票) 16 MotorVehicleSaleInvoice 机动车销售统一发票 12 UsedCarPurchaseInvoice 二手车销售统一发票 12 VatInvoiceRoll 增值税普通发票(卷票) 11 TaxiTicket 出租车发票 0 QuotaInvoice 定额发票 1 TrainTicket 火车票 2 AirTransport 机票行程单 5 MachinePrintedInvoice 通用机打发票 8 BusInvoice 汽车票 9 ShippingInvoice 轮船票 10 NonTaxIncomeGeneralBill 非税收入通用票据 15 NonTaxIncomeElectronicBill 非税收入一般缴款书(电子) 15 TollInvoice 过路过桥费发票 13 MedicalOutpatientInvoice 医疗门诊收费票据(电子) 17 MedicalHospitalizedInvoice 医疗住院收费票据(电子) 17 OtherInvoice 其他发票 -1RecognizeHealthCodeOCRResponse
OcrClient. RecognizeHealthCodeOCR(RecognizeHealthCodeOCRRequest req)
本接口支持北京、上海、广东、江苏、吉林、黑龙江、天津、辽宁、浙江、河南、四川、贵州、山东、安徽、福建、江西、湖北、湖南等省份健康码的识别,包括持码人姓名、持码人身份证号、健康码更新时间、健康码颜色、核酸检测结果、核酸检测间隔时长、核酸检测时间,疫苗接种信息,八个字段的识别结果输出。不同省市健康码显示的字段信息有所不同,上述字段的识别结果可能为空,以图片上具体展示的信息为准。 默认接口请求频率限制:10次/秒。RecognizeIndonesiaIDCardOCRResponse
OcrClient. RecognizeIndonesiaIDCardOCR(RecognizeIndonesiaIDCardOCRRequest req)
印尼身份证识别 默认接口请求频率限制:20次/秒。RecognizeMedicalInvoiceOCRResponse
OcrClient. RecognizeMedicalInvoiceOCR(RecognizeMedicalInvoiceOCRRequest req)
医疗发票识别目前支持全国统一门诊发票、全国统一住院发票、以及部分地方的门诊和住院发票的识别。 默认接口请求频率限制:5次/秒。RecognizeOnlineTaxiItineraryOCRResponse
OcrClient. RecognizeOnlineTaxiItineraryOCR(RecognizeOnlineTaxiItineraryOCRRequest req)
本接口支持网约车行程单关键字段的识别,包括行程起止日期、上车时间、起点、终点、里程、金额等字段。 默认接口请求频率限制:20次/秒。RecognizePhilippinesDrivingLicenseOCRResponse
OcrClient. RecognizePhilippinesDrivingLicenseOCR(RecognizePhilippinesDrivingLicenseOCRRequest req)
菲律宾驾驶证识别RecognizePhilippinesSssIDOCRResponse
OcrClient. RecognizePhilippinesSssIDOCR(RecognizePhilippinesSssIDOCRRequest req)
菲律宾SSSID/UMID识别RecognizePhilippinesTinIDOCRResponse
OcrClient. RecognizePhilippinesTinIDOCR(RecognizePhilippinesTinIDOCRRequest req)
菲律宾TinID识别RecognizePhilippinesUMIDOCRResponse
OcrClient. RecognizePhilippinesUMIDOCR(RecognizePhilippinesUMIDOCRRequest req)
菲律宾UMID识别RecognizePhilippinesVoteIDOCRResponse
OcrClient. RecognizePhilippinesVoteIDOCR(RecognizePhilippinesVoteIDOCRRequest req)
本接口支持菲律宾VoteID识别,识别字段包括姓名、姓氏、出生日期、婚姻状况、国籍、地址、地区、菲律宾VoteID的VIN等。 默认接口请求频率限制:20次/秒。RecognizeTableAccurateOCRResponse
OcrClient. RecognizeTableAccurateOCR(RecognizeTableAccurateOCRRequest req)
本接口支持中英文图片/PDF内常规表格、无线表格、多表格的检测和识别,返回每个单元格的文字内容,支持旋转的表格图片识别,且支持将识别结果保存为 Excel 格式。识别效果比表格识别V2更好,覆盖场景更加广泛,对表格难例场景,如无线表格、嵌套表格(有线表格中包含无线表格)的识别效果均优于表格识别V2。点击[立即体验](https://cloud.tencent.com/act/event/ocrdemo)。 默认接口请求频率限制:2次/秒。RecognizeTableOCRResponse
OcrClient. RecognizeTableOCR(RecognizeTableOCRRequest req)
本接口支持中英文图片/ PDF内常规表格、无线表格、多表格的检测和识别,支持日文有线表格识别,返回每个单元格的文字内容,支持旋转的表格图片识别,且支持将识别结果保存为 Excel 格式。 默认接口请求频率限制:10次/秒。RecognizeThaiIDCardOCRResponse
OcrClient. RecognizeThaiIDCardOCR(RecognizeThaiIDCardOCRRequest req)
本接口支持泰国身份证识别,识别字段包括泰文姓名、英文姓名、地址、出生日期、身份证号码、首次领用日期、签发日期等字段。 本接口暂未完全对外开放,如需咨询,请[联系商务](https://cloud.tencent.com/about/connect) 默认接口请求频率限制:10次/秒RecognizeTravelCardOCRResponse
OcrClient. RecognizeTravelCardOCR(RecognizeTravelCardOCRRequest req)
本接口支持通信大数据行程卡识别,包括行程卡颜色、更新时间、途经地、存在中高风险地区的城市、电话号码,五个字段的识别结果输出。 默认接口请求频率限制:20次/秒。ResidenceBookletOCRResponse
OcrClient. ResidenceBookletOCR(ResidenceBookletOCRRequest req)
本接口支持居民户口簿户主页及成员页关键字段的识别,包括姓名、户别、地址、籍贯、身份证号码等。 默认接口请求频率限制:5次/秒。RideHailingDriverLicenseOCRResponse
OcrClient. RideHailingDriverLicenseOCR(RideHailingDriverLicenseOCRRequest req)
本接口支持网约车驾驶证关键字段的识别,包括姓名、证号、起始日期、截止日期、发证日期。 默认接口请求频率限制:5次/秒。RideHailingTransportLicenseOCRResponse
OcrClient. RideHailingTransportLicenseOCR(RideHailingTransportLicenseOCRRequest req)
本接口支持网约车运输证关键字段的识别,包括交运管许可字号、车辆所有人、车辆号牌、起始日期、截止日期、发证日期。 默认接口请求频率限制:5次/秒。SealOCRResponse
OcrClient. SealOCR(SealOCRRequest req)
本接口支持各类印章主体内容、印章其他内容及形状识别,支持单图多印章识别,包括发票章、财务章等,适用于公文票据等场景。 默认接口请求频率限制:5次/秒。ShipInvoiceOCRResponse
OcrClient. ShipInvoiceOCR(ShipInvoiceOCRRequest req)
本接口支持识别轮船票的发票代码、发票号码、日期、姓名、票价、始发地、目的地、姓名、时间、发票消费类型、省、市、币种字段。 默认接口请求频率限制:5次/秒。SmartStructuralOCRResponse
OcrClient. SmartStructuralOCR(SmartStructuralOCRRequest req)
本接口支持识别并提取各类证照、票据、表单、合同等结构化场景的字段信息。无需任何配置,灵活高效。适用于各类结构化信息录入场景。 默认接口请求频率限制:5次/秒。SmartStructuralOCRV2Response
OcrClient. SmartStructuralOCRV2(SmartStructuralOCRV2Request req)
本接口支持智能提取各类证照、票据、表单、合同等结构化场景的key:value字段信息,并支持提取表格信息的key:value组的结构化,灵活高效,适用于各类非标准材料的信息录入场景,点击[立即体验](https://cloud.tencent.com/product/smart-ocr)。 默认接口请求频率限制:10次/秒。TableOCRResponse
OcrClient. TableOCR(TableOCRRequest req)
此接口为表格识别的旧版本服务,不再进行服务升级,建议您使用识别能力更强、服务性能更优的新版表格识别。 本接口支持图片内表格文档的检测和识别,返回每个单元格的文字内容,支持将识别结果保存为 Excel 格式。 默认接口请求频率限制:10次/秒。TaxiInvoiceOCRResponse
OcrClient. TaxiInvoiceOCR(TaxiInvoiceOCRRequest req)
本接口支持出租车发票关键字段的识别,包括发票号码、发票代码、金额、日期、上下车时间、里程、车牌号、发票类型及所属地区等字段。 默认接口请求频率限制:5次/秒。TextDetectResponse
OcrClient. TextDetect(TextDetectRequest req)
本接口通过检测图片中的文字信息特征,快速判断图片中有无文字并返回判断结果,帮助用户过滤无文字的图片。TollInvoiceOCRResponse
OcrClient. TollInvoiceOCR(TollInvoiceOCRRequest req)
本接口支持过路过桥费发票关键字段的识别,包括发票代码、发票号码、日期、金额、入口、出口、时间、发票消费类型、高速标志等。 默认接口请求频率限制:5次/秒。TrainTicketOCRResponse
OcrClient. TrainTicketOCR(TrainTicketOCRRequest req)
本接口支持火车票全字段的识别,包括编号、出发站、到达站、出发时间、车次、座位号、姓名、票价、席别、身份证号、发票消费类型、序列号、加收票价、手续费、大写金额、售票站、原票价、发票类型、收据号码、是否仅供报销使用等字段的识别。 默认接口请求频率限制:5次/秒。VatInvoiceOCRResponse
OcrClient. VatInvoiceOCR(VatInvoiceOCRRequest req)
本接口支持增值税专用发票、增值税普通发票、增值税电子专票、增值税电子普票、电子发票(普通发票)、电子发票(增值税专用发票)全字段的内容检测和识别,包括发票代码、发票号码、打印发票代码、打印发票号码、开票日期、合计金额、校验码、税率、合计税额、价税合计、购买方识别号、复核、销售方识别号、开票人、密码区1、密码区2、密码区3、密码区4、发票名称、购买方名称、销售方名称、服务名称、备注、规格型号、数量、单价、金额、税额、收款人等字段,点击[立即试用](https://cloud.tencent.com/product/ocr)。 默认接口请求频率限制:10次/秒。VatInvoiceVerifyResponse
OcrClient. VatInvoiceVerify(VatInvoiceVerifyRequest req)
本接口支持增值税发票的准确性核验,您可以通过输入增值税发票的关键字段提供所需的验证信息,接口返回真实的票面相关信息,包括发票代码、发票号码、开票日期、金额、消费类型、购方名称、购方税号、销方名称、销方税号等多个常用字段。支持多种发票类型核验,包括增值税专用发票、增值税普通发票(含电子普通发票、卷式发票、通行费发票)、全电发票、机动车销售统一发票、货物运输业增值税专用发票、二手车销售统一发票。 默认接口请求频率限制:20次/秒。VatInvoiceVerifyNewResponse
OcrClient. VatInvoiceVerifyNew(VatInvoiceVerifyNewRequest req)
本接口支持增值税发票的准确性核验,您可以通过输入增值税发票的关键字段提供所需的验证信息,接口返回真实的票面相关信息,包括发票代码、发票号码、开票日期、金额、消费类型、购方名称、购方税号、销方名称、销方税号等多个常用字段。支持多种发票类型核验,包括增值税专用发票、增值税普通发票(含电子普通发票、卷式发票、通行费发票)、全电发票、机动车销售统一发票、货物运输业增值税专用发票、二手车销售统一发票、通用机打电子发票(广东和浙江)。 默认接口请求频率限制:20次/秒。VatRollInvoiceOCRResponse
OcrClient. VatRollInvoiceOCR(VatRollInvoiceOCRRequest req)
本接口支持对增值税发票(卷票)关键字段的识别,包括的发票代码、合计金额(小写)、合计金额(大写)、开票日期、发票号码、购买方识别号、销售方识别号、校验码、销售方名称、购买方名称、发票消费类型、省、市、是否有公司印章、单价、金额、数量、服务类型、品名、种类等。 默认接口请求频率限制:5次/秒。VehicleLicenseOCRResponse
OcrClient. VehicleLicenseOCR(VehicleLicenseOCRRequest req)
本接口支持行驶证主页和副页所有字段的自动定位与识别。 行驶证主页:车牌号码、车辆类型、所有人、住址、使用性质、品牌型号、识别代码、发动机号、注册日期、发证日期、发证单位。 行驶证副页:号牌号码、档案编号、核定载人数、总质量、整备质量、核定载质量、外廓尺寸、准牵引总质量、备注、检验记录。 另外,本接口还支持复印件、翻拍告警功能。 默认接口请求频率限制:10次/秒。VehicleRegCertOCRResponse
OcrClient. VehicleRegCertOCR(VehicleRegCertOCRRequest req)
本接口支持国内机动车登记证书主要字段的结构化识别,包括机动车所有人、身份证明名称、号码、车辆型号、车辆识别代号、发动机号、制造厂名称等。 默认接口请求频率限制:5次/秒。VerifyOfdVatInvoiceOCRResponse
OcrClient. VerifyOfdVatInvoiceOCR(VerifyOfdVatInvoiceOCRRequest req)
本接口支持OFD格式的 增值税电子普通发票、增值税电子专用发票、电子发票(普通发票)、电子发票(增值税专用发票)识别,返回发票代码、发票号码、开票日期、验证码、机器编号、密码区,购买方和销售方信息,包括名称、纳税人识别号、地址电话、开户行及账号,以及价税合计、开票人、收款人、复核人、税额、不含税金额等字段信息。VinOCRResponse
OcrClient. VinOCR(VinOCRRequest req)
本接口支持图片内车辆识别代号(VIN)的检测和识别。WaybillOCRResponse
OcrClient. WaybillOCR(WaybillOCRRequest req)
本接口支持市面上主流版式电子运单的识别,包括收件人和寄件人的姓名、电话、地址以及运单号等字段。 默认接口请求频率限制:10次/秒。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.omics.v20221128
-
Uses of TencentCloudSDKException in com.tencentcloudapi.organization.v20181225
-
Uses of TencentCloudSDKException in com.tencentcloudapi.organization.v20210331
-
Uses of TencentCloudSDKException in com.tencentcloudapi.partners.v20180321
-
Uses of TencentCloudSDKException in com.tencentcloudapi.pds.v20210701
Methods in com.tencentcloudapi.pds.v20210701 that throw TencentCloudSDKException Modifier and Type Method Description DescribeNewUserAcquisitionResponse
PdsClient. DescribeNewUserAcquisition(DescribeNewUserAcquisitionRequest req)
判断新用户信誉值DescribeStockEstimationResponse
PdsClient. DescribeStockEstimation(DescribeStockEstimationRequest req)
查询存量判断服务 -
Uses of TencentCloudSDKException in com.tencentcloudapi.postgres.v20170312
-
Uses of TencentCloudSDKException in com.tencentcloudapi.privatedns.v20201028
-
Uses of TencentCloudSDKException in com.tencentcloudapi.pts.v20210728
-
Uses of TencentCloudSDKException in com.tencentcloudapi.rce.v20201103
Methods in com.tencentcloudapi.rce.v20201103 that throw TencentCloudSDKException Modifier and Type Method Description DescribeRiskAssessmentResponse
RceClient. DescribeRiskAssessment(DescribeRiskAssessmentRequest req)
此接口用于查询风险评估结果DescribeRiskTrendsResponse
RceClient. DescribeRiskTrends(DescribeRiskTrendsRequest req)
以图表形式展示三种请求状态的趋势变化ManageMarketingRiskResponse
RceClient. ManageMarketingRisk(ManageMarketingRiskRequest req)
全栈式风控引擎(RiskControlEngine,RCE)是基于人工智能技术和腾讯20年风控实战沉淀,依托腾讯海量业务构建的风控引擎,以轻量级的 SaaS 服务方式接入,帮助您快速解决注册、登录、营销活动等关键场景遇到的欺诈问题,实时防御黑灰产作恶。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.redis.v20180412
-
Uses of TencentCloudSDKException in com.tencentcloudapi.region.v20220627
Methods in com.tencentcloudapi.region.v20220627 that throw TencentCloudSDKException Modifier and Type Method Description DescribeProductsResponse
RegionClient. DescribeProducts(DescribeProductsRequest req)
本接口(DescribeProducts)用于查询各个支持地域列表查询的产品信息。DescribeRegionsResponse
RegionClient. DescribeRegions(DescribeRegionsRequest req)
本接口(DescribeRegions)用于查询各个产品支持地域信息。DescribeZonesResponse
RegionClient. DescribeZones(DescribeZonesRequest req)
本接口(DescribeZones)用于查询产品可用区信息。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.rkp.v20191209
Methods in com.tencentcloudapi.rkp.v20191209 that throw TencentCloudSDKException Modifier and Type Method Description GetOpenIdResponse
RkpClient. GetOpenId(GetOpenIdRequest req)
根据DevicceToken查询OpenID。GetTokenResponse
RkpClient. GetToken(GetTokenRequest req)
获取token接口。QueryDevAndRiskResponse
RkpClient. QueryDevAndRisk(QueryDevAndRiskRequest req)
腾讯天御设备风险查询接口,输入由客户应用自主采集的设备信息, 通过腾讯大数据风控能力,可以准确根据输入设备信息,还原设备库中的设备ID,并且识别设备的风险,解决客户业务过程中的设备风险,降低企业损失。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.rp.v20200224
Methods in com.tencentcloudapi.rp.v20200224 that throw TencentCloudSDKException Modifier and Type Method Description QueryRegisterProtectionResponse
RpClient. QueryRegisterProtection(QueryRegisterProtectionRequest req)
注册保护服务(RegisterProtection,RP)针对网站、APP 的线上注册场景,遇到 “恶意注册” 、“小号注册” 、“注册器注册” 等恶意行为,提供基于天御 DNA 算法的恶意防护引擎,从账号、设备、行为三个维度有效识别 “恶意注册”,从“源头”上防范业务风险。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.rum.v20210622
-
Uses of TencentCloudSDKException in com.tencentcloudapi.scf.v20180416
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ses.v20201002
Methods in com.tencentcloudapi.ses.v20201002 that throw TencentCloudSDKException Modifier and Type Method Description BatchSendEmailResponse
SesClient. BatchSendEmail(BatchSendEmailRequest req)
您可以通过此API批量发送TEXT或者HTML邮件,适用于营销类、通知类邮件。默认仅支持使用模板发送邮件。批量发送之前,需先创建收件人列表,和收件人地址,并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送,定时发送需传TimedParam,周期重复发送需传CycleParamCreateEmailAddressResponse
SesClient. CreateEmailAddress(CreateEmailAddressRequest req)
在验证了发信域名之后,您需要一个发信地址来发送邮件。例如发信域名是mail.qcloud.com,那么发信地址可以为 [email protected]。如果您想要收件人在收件箱列表中显示您的别名,例如"腾讯云邮件通知"。那么发信地址为: 别名 空格 尖括号 邮箱地址。请注意中间需要有空格CreateEmailIdentityResponse
SesClient. CreateEmailIdentity(CreateEmailIdentityRequest req)
在使用身份发送电子邮件之前,您需要有一个电子邮件域名,该域名可以是您的网站或者移动应用的域名。您首先必须进行验证,证明自己是该域名的所有者,并且授权给腾讯云SES发送许可,才可以从该域名发送电子邮件。CreateEmailTemplateResponse
SesClient. CreateEmailTemplate(CreateEmailTemplateRequest req)
创建模板,该模板可以是TXT或者HTML,请注意如果HTML不要包含外部文件的CSS。模板中的变量使用 {{变量名}} 表示。 注意:模板需要审核通过才可以使用。CreateReceiverResponse
SesClient. CreateReceiver(CreateReceiverRequest req)
创建收件人列表,收件人列表是发送批量邮件的目标邮件地址列表。创建列表后,需要上传收件人邮箱地址。之后创建发送任务,关联列表,便可以实现批量发送邮件的功能CreateReceiverDetailResponse
SesClient. CreateReceiverDetail(CreateReceiverDetailRequest req)
在创建完收件人列表后,向这个收件人列表中批量增加收件人邮箱地址,一次最大支持2万,异步完成处理。数据量比较大的时候,上传可能需要一点时间,可以通过查询收件人列表了解上传状态和上传数量。本接口与接口CreateReceiverDetailWithData的功能特性基本一致,只是不支持上传发信时的模板参数。用户首先调用创建收件人列表接口-CreateReceiver后,然后调用本接口传入收件人地址,最后使用批量发送邮件接口-BatchSendEmail,即可完成批量发信。本接口也支持追加收件人地址,也不支持去重,需要用户自己保证收件人地址不重复。本接口一次请求的收件人地址数量限制为2W条,但收件人列表中收件人地址的总量不能超过一定的数量,目前是限制5万条。CreateReceiverDetailWithDataResponse
SesClient. CreateReceiverDetailWithData(CreateReceiverDetailWithDataRequest req)
添加收件人地址附带模板参数,使用本接口在添加收件人地址的同时传入模板参数,使每一个收件人地址在发信的时候使用的模板变量取值不同。用户首先调用创建收件人列表接口-CreateReceiver后,然后调用本接口传入收件人地址和发信时的模板参数,最后使用批量发送邮件接口-BatchSendEmail,即可完成批量发信。需要注意的是在使用本接口后BatchSendEmail接口中的Template参数不需再传。用户也可以在控制台上邮件发送-收件人列表菜单中,通过导入文件的方式,导入收件人地址和模板变量和参数值。本接口一次请求的收件人地址数量限制为2W条,本接口同时也可以用来向已经上传完成的收件人列表追加收件人地址,但收件人列表中收件人地址的总量不能超过一定的数量,目前是限制5万条。本接口不支持去除重复的收件人地址,用户需要自己保证上传和追加地址不重复,不与之前上传的地址重复。DeleteBlackListResponse
SesClient. DeleteBlackList(DeleteBlackListRequest req)
邮箱被拉黑之后,用户如果确认收件邮箱有效或者已经处于激活状态,可以从腾讯云地址库中删除该黑名单之后继续投递。DeleteEmailAddressResponse
SesClient. DeleteEmailAddress(DeleteEmailAddressRequest req)
删除发信人地址DeleteEmailIdentityResponse
SesClient. DeleteEmailIdentity(DeleteEmailIdentityRequest req)
删除发信域名,删除后,将不可再使用该域名进行发信DeleteEmailTemplateResponse
SesClient. DeleteEmailTemplate(DeleteEmailTemplateRequest req)
删除发信模板DeleteReceiverResponse
SesClient. DeleteReceiver(DeleteReceiverRequest req)
根据收件id删除收件人列表,同时删除列表中的所有收件邮箱GetEmailIdentityResponse
SesClient. GetEmailIdentity(GetEmailIdentityRequest req)
获取某个发信域名的配置详情GetEmailTemplateResponse
SesClient. GetEmailTemplate(GetEmailTemplateRequest req)
根据模板ID获取模板详情GetSendEmailStatusResponse
SesClient. GetSendEmailStatus(GetSendEmailStatusRequest req)
获取邮件发送状态。仅支持查询30天之内的数据 默认接口请求频率限制:1次/秒GetStatisticsReportResponse
SesClient. GetStatisticsReport(GetStatisticsReportRequest req)
获取近期发送的统计情况,包含发送量、送达率、打开率、退信率等一系列数据。ListBlackEmailAddressResponse
SesClient. ListBlackEmailAddress(ListBlackEmailAddressRequest req)
腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce),腾讯云会拉黑该地址,并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判,可以从黑名单中删除。ListEmailAddressResponse
SesClient. ListEmailAddress(ListEmailAddressRequest req)
获取发信地址列表ListEmailIdentitiesResponse
SesClient. ListEmailIdentities(ListEmailIdentitiesRequest req)
获取当前发信域名列表,包含已验证通过与未验证的域名ListEmailTemplatesResponse
SesClient. ListEmailTemplates(ListEmailTemplatesRequest req)
获取当前邮件模板列表ListReceiverDetailsResponse
SesClient. ListReceiverDetails(ListReceiverDetailsRequest req)
根据收件人列表id查询收件人列表中的所有收件人邮箱地址,分页查询,可以根据收件邮箱地址来过滤查询ListReceiversResponse
SesClient. ListReceivers(ListReceiversRequest req)
根据条件查询收件人列表,支持分页,模糊查询,状态查询ListSendTasksResponse
SesClient. ListSendTasks(ListSendTasksRequest req)
分页查询批量发送邮件任务,包含即时发送任务,定时发送任务,周期重复发送任务,查询发送情况,包括请求数量,已发数量,缓存数量,任务状态等信息SendEmailResponse
SesClient. SendEmail(SendEmailRequest req)
您可以通过此API发送HTML或者TEXT邮件,适用于触发类邮件(验证码、交易类)。默认仅支持使用模板发送邮件。UpdateEmailIdentityResponse
SesClient. UpdateEmailIdentity(UpdateEmailIdentityRequest req)
您已经成功配置好了您的DNS,接下来请求腾讯云验证您的DNS配置是否正确UpdateEmailSmtpPassWordResponse
SesClient. UpdateEmailSmtpPassWord(UpdateEmailSmtpPassWordRequest req)
设置邮箱的smtp密码。若要通过smtp发送邮件,必须为邮箱设置smtp密码。初始时,邮箱没有设置smtp密码,不能使用smtp的方式发送邮件。设置smtp密码后,可以修改密码。UpdateEmailTemplateResponse
SesClient. UpdateEmailTemplate(UpdateEmailTemplateRequest req)
更新邮件模板,更新后需再次审核 -
Uses of TencentCloudSDKException in com.tencentcloudapi.smh.v20210712
-
Uses of TencentCloudSDKException in com.tencentcloudapi.smop.v20201203
Methods in com.tencentcloudapi.smop.v20201203 that throw TencentCloudSDKException Modifier and Type Method Description SubmitTaskEventResponse
SmopClient. SubmitTaskEvent(SubmitTaskEventRequest req)
提交任务事件接口 -
Uses of TencentCloudSDKException in com.tencentcloudapi.smpn.v20190822
Methods in com.tencentcloudapi.smpn.v20190822 that throw TencentCloudSDKException Modifier and Type Method Description CreateSmpnEpaResponse
SmpnClient. CreateSmpnEpa(CreateSmpnEpaRequest req)
企业号码认证DescribeSmpnChpResponse
SmpnClient. DescribeSmpnChp(DescribeSmpnChpRequest req)
查询号码的标记和标记次数DescribeSmpnFnrResponse
SmpnClient. DescribeSmpnFnr(DescribeSmpnFnrRequest req)
虚假号码识别DescribeSmpnMhmResponse
SmpnClient. DescribeSmpnMhm(DescribeSmpnMhmRequest req)
号码营销监控DescribeSmpnMrlResponse
SmpnClient. DescribeSmpnMrl(DescribeSmpnMrlRequest req)
查询号码恶意标记等级 -
Uses of TencentCloudSDKException in com.tencentcloudapi.sms.v20190711
Methods in com.tencentcloudapi.sms.v20190711 that throw TencentCloudSDKException Modifier and Type Method Description AddSmsSignResponse
SmsClient. AddSmsSign(AddSmsSignRequest req)
1.AddSmsTemplateResponse
SmsClient. AddSmsTemplate(AddSmsTemplateRequest req)
1.CallbackStatusStatisticsResponse
SmsClient. CallbackStatusStatistics(CallbackStatusStatisticsRequest req)
统计用户回执的数据。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。DeleteSmsSignResponse
SmsClient. DeleteSmsSign(DeleteSmsSignRequest req)
⚠️注意:个人认证用户不支持使用 API 删除短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信签名。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。DeleteSmsTemplateResponse
SmsClient. DeleteSmsTemplate(DeleteSmsTemplateRequest req)
⚠️注意:个人认证用户不支持使用 API 删除短信正文模板,请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信正文模板,如需了解请参阅 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。DescribeSmsSignListResponse
SmsClient. DescribeSmsSignList(DescribeSmsSignListRequest req)
⚠️注意:个人认证用户不支持使用 API 查询短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 查询短信签名。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。DescribeSmsTemplateListResponse
SmsClient. DescribeSmsTemplateList(DescribeSmsTemplateListRequest req)
⚠️注意:个人认证用户不支持使用 API 查询短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。ModifySmsSignResponse
SmsClient. ModifySmsSign(ModifySmsSignRequest req)
1.ModifySmsTemplateResponse
SmsClient. ModifySmsTemplate(ModifySmsTemplateRequest req)
1.PullSmsReplyStatusResponse
SmsClient. PullSmsReplyStatus(PullSmsReplyStatusRequest req)
拉取短信回复状态。 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。 >- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。PullSmsReplyStatusByPhoneNumberResponse
SmsClient. PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)
拉取单个号码短信回复状态。 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。PullSmsSendStatusResponse
SmsClient. PullSmsSendStatus(PullSmsSendStatusRequest req)
拉取短信下发状态。 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。 >- 注:此接口需要联系 [sms helper](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。PullSmsSendStatusByPhoneNumberResponse
SmsClient. PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)
拉取单个号码短信下发状态。 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。SendSmsResponse
SmsClient. SendSms(SendSmsRequest req)
短信发送接口,用于给用户发短信验证码、通知类短信或营销短信。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。SendStatusStatisticsResponse
SmsClient. SendStatusStatistics(SendStatusStatisticsRequest req)
统计用户发送短信的数据。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。SmsPackagesStatisticsResponse
SmsClient. SmsPackagesStatistics(SmsPackagesStatisticsRequest req)
用户套餐包信息统计。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.sms.v20210111
Methods in com.tencentcloudapi.sms.v20210111 that throw TencentCloudSDKException Modifier and Type Method Description AddSmsSignResponse
SmsClient. AddSmsSign(AddSmsSignRequest req)
1.AddSmsTemplateResponse
SmsClient. AddSmsTemplate(AddSmsTemplateRequest req)
1.CallbackStatusStatisticsResponse
SmsClient. CallbackStatusStatistics(CallbackStatusStatisticsRequest req)
统计用户回执的数据。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。DeleteSmsSignResponse
SmsClient. DeleteSmsSign(DeleteSmsSignRequest req)
⚠️注意:个人认证用户不支持使用 API 删除短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信签名。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。DeleteSmsTemplateResponse
SmsClient. DeleteSmsTemplate(DeleteSmsTemplateRequest req)
⚠️注意:个人认证用户不支持使用 API 删除短信正文模板,请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信正文模板,如需了解请参阅 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。DescribePhoneNumberInfoResponse
SmsClient. DescribePhoneNumberInfo(DescribePhoneNumberInfoRequest req)
提供电话号码的信息查询,包括国家(或地区)码、规范的 E.164 格式号码等。 >- 例如:查询号码 +86018845720123,可以得到国家码 86、规范的 E.164 号码 +8618845720123 等信息。DescribeSmsSignListResponse
SmsClient. DescribeSmsSignList(DescribeSmsSignListRequest req)
⚠️注意:个人认证用户不支持使用 API 查询短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 查询短信签名。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。DescribeSmsTemplateListResponse
SmsClient. DescribeSmsTemplateList(DescribeSmsTemplateListRequest req)
⚠️注意:个人认证用户不支持使用 API 查询短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。ModifySmsSignResponse
SmsClient. ModifySmsSign(ModifySmsSignRequest req)
1.ModifySmsTemplateResponse
SmsClient. ModifySmsTemplate(ModifySmsTemplateRequest req)
1.PullSmsReplyStatusResponse
SmsClient. PullSmsReplyStatus(PullSmsReplyStatusRequest req)
拉取短信回复状态。 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。 >- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。PullSmsReplyStatusByPhoneNumberResponse
SmsClient. PullSmsReplyStatusByPhoneNumber(PullSmsReplyStatusByPhoneNumberRequest req)
拉取单个号码短信回复状态。 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。PullSmsSendStatusResponse
SmsClient. PullSmsSendStatus(PullSmsSendStatusRequest req)
拉取短信下发状态。 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。 >- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。PullSmsSendStatusByPhoneNumberResponse
SmsClient. PullSmsSendStatusByPhoneNumber(PullSmsSendStatusByPhoneNumberRequest req)
拉取单个号码短信下发状态。 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。ReportConversionResponse
SmsClient. ReportConversion(ReportConversionRequest req)
短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。 >- 注:当前接口以白名单方式对外开放,如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。SendSmsResponse
SmsClient. SendSms(SendSmsRequest req)
短信发送接口,用于给用户发短信验证码、通知类短信或营销短信。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。 >- 注:您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。 >- 注:当前接口属于 2021-01-11 版本,如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778),建议您使用当前最新版本的接口,版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。SendStatusStatisticsResponse
SmsClient. SendStatusStatistics(SendStatusStatisticsRequest req)
统计用户发送短信的数据。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。SmsPackagesStatisticsResponse
SmsClient. SmsPackagesStatistics(SmsPackagesStatisticsRequest req)
用户套餐包信息统计。 >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。 >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.soe.v20180724
Methods in com.tencentcloudapi.soe.v20180724 that throw TencentCloudSDKException Modifier and Type Method Description InitOralProcessResponse
SoeClient. InitOralProcess(InitOralProcessRequest req)
初始化发音评估过程,每一轮评估前进行调用。语音输入模式分为流式模式和非流式模式,流式模式支持数据分片传输,可以加快评估响应速度。评估模式分为词模式和句子模式,词模式会标注每个音节的详细信息;句子模式会有完整度和流利度的评估。KeywordEvaluateResponse
SoeClient. KeywordEvaluate(KeywordEvaluateRequest req)
指定主题关键词词汇评估,分析语音与关键词的切合程度,可指定多个关键词,支持中文英文同时评测。分片传输时,尽量保证纯异步调用,即不等待上一个分片的传输结果边录边传,这样可以尽可能早的提供音频数据。音频源目前仅支持16k采样率16bit单声道编码方式,如有不一致可能导致评估不准确或失败。TransmitOralProcessResponse
SoeClient. TransmitOralProcess(TransmitOralProcessRequest req)
本接口可用于中英文发音评测数据传输。在使用本接口时需要注意:传输音频数据,必须在完成发音评估初始化接口之后调用,且SessonId要与初始化接口保持一致。分片传输时,尽量保证SeqId顺序传输(请确认SeqId由1开始)。音频源目前仅支持16k采样率16bit单声道编码方式,如有不一致可能导致评估不准确或失败。TransmitOralProcessWithInitResponse
SoeClient. TransmitOralProcessWithInit(TransmitOralProcessWithInitRequest req)
本接口可用于中英文发音评测。在使用本接口时需要注意:初始化并传输音频数据,分片传输时,尽量保证SeqId顺序传输(请确认SeqId由1开始)。音频源目前仅支持16k采样率16bit单声道编码方式,如有不一致可能导致评估不准确或失败。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.solar.v20181011
-
Uses of TencentCloudSDKException in com.tencentcloudapi.sqlserver.v20180328
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ssa.v20180608
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ssl.v20191205
-
Uses of TencentCloudSDKException in com.tencentcloudapi.sslpod.v20190605
-
Uses of TencentCloudSDKException in com.tencentcloudapi.ssm.v20190923
Methods in com.tencentcloudapi.ssm.v20190923 that throw TencentCloudSDKException Modifier and Type Method Description CreateProductSecretResponse
SsmClient. CreateProductSecret(CreateProductSecretRequest req)
创建云产品凭据CreateSecretResponse
SsmClient. CreateSecret(CreateSecretRequest req)
创建新的凭据信息,通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。CreateSSHKeyPairSecretResponse
SsmClient. CreateSSHKeyPairSecret(CreateSSHKeyPairSecretRequest req)
创建用于托管SSH密钥对的凭据DeleteSecretResponse
SsmClient. DeleteSecret(DeleteSecretRequest req)
删除指定的凭据信息,可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据,在删除日期到达之前状态为 PendingDelete,并可以通过RestoreSecret 进行恢复,超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行(计划)删除操作。DeleteSecretVersionResponse
SsmClient. DeleteSecretVersion(DeleteSecretVersionRequest req)
该接口用于直接删除指定凭据下的单个版本凭据,删除操作立即生效,对所有状态下的凭据版本都可以删除。 本接口仅适用于用户自定义凭据,本接口不能对云产品凭据进行操作。DescribeAsyncRequestInfoResponse
SsmClient. DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
查询异步任务的执行结果DescribeRotationDetailResponse
SsmClient. DescribeRotationDetail(DescribeRotationDetailRequest req)
查询凭据轮转策略详情。 本接口只适用于云产品凭据。DescribeRotationHistoryResponse
SsmClient. DescribeRotationHistory(DescribeRotationHistoryRequest req)
查询凭据轮转历史版本。 本接口仅适用于云产品凭据。DescribeSecretResponse
SsmClient. DescribeSecret(DescribeSecretRequest req)
获取凭据的详细属性信息。DescribeSupportedProductsResponse
SsmClient. DescribeSupportedProducts(DescribeSupportedProductsRequest req)
查询支持的云产品列表DisableSecretResponse
SsmClient. DisableSecret(DisableSecretRequest req)
停用指定的凭据,停用后状态为 Disabled,无法通过接口获取该凭据的明文。EnableSecretResponse
SsmClient. EnableSecret(EnableSecretRequest req)
该接口用于开启凭据,状态为Enabled。可以通过 GetSecretValue 接口获取凭据明文。处于PendingDelete状态的凭据不能直接开启,需要通过RestoreSecret 恢复后再开启使用。GetRegionsResponse
SsmClient. GetRegions(GetRegionsRequest req)
获取控制台展示region列表GetSecretValueResponse
SsmClient. GetSecretValue(GetSecretValueRequest req)
对于用户自定义凭据,通过指定凭据名称和版本来获取凭据的明文信息; 对于云产品凭据如Mysql凭据,通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息,如果要获取当前正在使用的凭据版本的明文,需要将版本号指定为:SSM_Current。GetServiceStatusResponse
SsmClient. GetServiceStatus(GetServiceStatusRequest req)
该接口用户获取用户SecretsManager服务开通状态。GetSSHKeyPairValueResponse
SsmClient. GetSSHKeyPairValue(GetSSHKeyPairValueRequest req)
获取SSH密钥对凭据明文信息。ListSecretsResponse
SsmClient. ListSecrets(ListSecretsRequest req)
该接口用于获取所有凭据的详细列表,可以指定过滤字段、排序方式等。ListSecretVersionIdsResponse
SsmClient. ListSecretVersionIds(ListSecretVersionIdsRequest req)
该接口用于获取指定凭据下的版本列表信息PutSecretValueResponse
SsmClient. PutSecretValue(PutSecretValueRequest req)
该接口在指定名称的凭据下增加新版本的凭据内容,一个凭据下最多可以支持10个版本。只能对处于Enabled 和 Disabled 状态的凭据添加新的版本。 本接口仅适用于用户自定义凭据,对云产品凭据不能操作。RestoreSecretResponse
SsmClient. RestoreSecret(RestoreSecretRequest req)
该接口用于恢复计划删除(PendingDelete状态)中的凭据,取消计划删除。取消计划删除的凭据将处于Disabled 状态,如需恢复使用,通过EnableSecret 接口开启凭据。RotateProductSecretResponse
SsmClient. RotateProductSecret(RotateProductSecretRequest req)
轮转云产品凭据或云API密钥对凭据。 该接口仅适用于处于Enabled状态的云产品凭据或处于Enable状态的云API密钥对凭据,对于其他状态的云产品凭据或云API密钥对凭据或用户自定义凭据不适用。UpdateDescriptionResponse
SsmClient. UpdateDescription(UpdateDescriptionRequest req)
该接口用于修改指定凭据的描述信息,仅能修改Enabled 和 Disabled 状态的凭据。UpdateRotationStatusResponse
SsmClient. UpdateRotationStatus(UpdateRotationStatusRequest req)
设置云产品凭据轮转策略,可以设置: 是否开启轮转 轮转周期 轮转开始时间UpdateSecretResponse
SsmClient. UpdateSecret(UpdateSecretRequest req)
该接口用于更新指定凭据名称和版本号的内容,调用该接口会对新的凭据内容加密后覆盖旧的内容。仅允许更新Enabled 和 Disabled 状态的凭据。 本接口仅适用于用户自定义凭据,不能对云产品凭据操作。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.sts.v20180813
Methods in com.tencentcloudapi.sts.v20180813 that throw TencentCloudSDKException Modifier and Type Method Description AssumeRoleResponse
StsClient. AssumeRole(AssumeRoleRequest req)
申请扮演角色临时访问凭证。AssumeRoleWithSAMLResponse
StsClient. AssumeRoleWithSAML(AssumeRoleWithSAMLRequest req)
本接口(AssumeRoleWithSAML)用于根据 SAML 断言申请角色临时访问凭证。 注意:当使用签名方法 V3 调用本接口时,请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。AssumeRoleWithWebIdentityResponse
StsClient. AssumeRoleWithWebIdentity(AssumeRoleWithWebIdentityRequest req)
申请OIDC角色临时访问凭证。 注意:当使用签名方法 V3 调用本接口时,请求头无须传入 X-TC-Token, 但 Authorization 需要传入值 SKIP。GetCallerIdentityResponse
StsClient. GetCallerIdentity(GetCallerIdentityRequest req)
获取当前调用者的身份信息。 接口支持主账号,子账号长期密钥以及AssumeRole,GetFederationToken生成的临时访问凭证身份获取。GetFederationTokenResponse
StsClient. GetFederationToken(GetFederationTokenRequest req)
使用说明** 返回一组临时访问凭证,典型的应用场景是代理应用程序集中申请临时访问凭证,下发给企业网络内其他分布式终端应用,比如终端应用上传文件到COS场景,本接口仅支持永久密钥调用。 最佳实践** 1.QueryApiKeyResponse
StsClient. QueryApiKey(QueryApiKeyRequest req)
拉取API密钥列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.taf.v20200210
Methods in com.tencentcloudapi.taf.v20200210 that throw TencentCloudSDKException Modifier and Type Method Description RecognizeCustomizedAudienceResponse
TafClient. RecognizeCustomizedAudience(RecognizeCustomizedAudienceRequest req)
流量反欺诈-流量验准定制版RecognizePreciseTargetAudienceResponse
TafClient. RecognizePreciseTargetAudience(RecognizePreciseTargetAudienceRequest req)
流量反欺诈-流量验准高级版RecognizeTargetAudienceResponse
TafClient. RecognizeTargetAudience(RecognizeTargetAudienceRequest req)
流量反欺诈-流量验准 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tag.v20180813
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tan.v20220420
Methods in com.tencentcloudapi.tan.v20220420 that throw TencentCloudSDKException Modifier and Type Method Description CreateBlockNodeRecordsResponse
TanClient. CreateBlockNodeRecords(CreateBlockNodeRecordsRequest req)
推送节点数据 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tat.v20201028
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tav.v20190118
Methods in com.tencentcloudapi.tav.v20190118 that throw TencentCloudSDKException Modifier and Type Method Description GetLocalEngineResponse
TavClient. GetLocalEngine(GetLocalEngineRequest req)
获取TAV本地引擎GetScanResultResponse
TavClient. GetScanResult(GetScanResultRequest req)
tav文件上传扫描结果查询ScanFileResponse
TavClient. ScanFile(ScanFileRequest req)
tav文件上传扫描ScanFileHashResponse
TavClient. ScanFileHash(ScanFileHashRequest req)
通过文件哈希值获取文件黑白属性 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tbaas.v20180416
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tbm.v20180129
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tbp.v20190311
Methods in com.tencentcloudapi.tbp.v20190311 that throw TencentCloudSDKException Modifier and Type Method Description CreateBotResponse
TbpClient. CreateBot(CreateBotRequest req)
创建机器人ResetResponse
TbpClient. Reset(ResetRequest req)
对当前机器人的会话状态进行复位TextProcessResponse
TbpClient. TextProcess(TextProcessRequest req)
接收调用侧的文本输入,返回应答文本。已废弃,推荐使用最新版TextProcess接口。TextResetResponse
TbpClient. TextReset(TextResetRequest req)
会话重置接口。已废弃,推荐使用最新版TextReset接口。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tbp.v20190627
Methods in com.tencentcloudapi.tbp.v20190627 that throw TencentCloudSDKException Modifier and Type Method Description TextProcessResponse
TbpClient. TextProcess(TextProcessRequest req)
接收调用侧的文本输入,返回应答文本。TextResetResponse
TbpClient. TextReset(TextResetRequest req)
会话重置接口。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tcaplusdb.v20190823
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tcb.v20180608
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tcbr.v20220217
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tcex.v20200727
Methods in com.tencentcloudapi.tcex.v20200727 that throw TencentCloudSDKException Modifier and Type Method Description DescribeInvocationResultResponse
TcexClient. DescribeInvocationResult(DescribeInvocationResultRequest req)
产品控制台已经下线 获取服务调用结果。和InvokeService接口配置合适,其InvokeId参数为InvokeService接口返回的RequestId。InvokeServiceResponse
TcexClient. InvokeService(InvokeServiceRequest req)
产品控制台已经下线 通过传入文档url,测试服务算法。此接口需要和DescribeInvocationResult接口配置使用,该接口使用InvokeService返回的RequestId作为InvokeId参数,用于查询调用结果。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tchd.v20230306
Methods in com.tencentcloudapi.tchd.v20230306 that throw TencentCloudSDKException Modifier and Type Method Description DescribeEventsResponse
TchdClient. DescribeEvents(DescribeEventsRequest req)
本接口用于查询腾讯云健康看板的可用性事件信息,可以通过产品列表、地域列表和事件发生日期进行过滤查询。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tci.v20190318
Methods in com.tencentcloudapi.tci.v20190318 that throw TencentCloudSDKException Modifier and Type Method Description AIAssistantResponse
TciClient. AIAssistant(AIAssistantRequest req)
提供 AI 助教基础版本功能接口CancelTaskResponse
TciClient. CancelTask(CancelTaskRequest req)
用于取消已经提交的任务,目前只支持图像任务。CheckFacePhotoResponse
TciClient. CheckFacePhoto(CheckFacePhotoRequest req)
检查人脸图片是否合法CreateFaceResponse
TciClient. CreateFace(CreateFaceRequest req)
创建人脸CreateLibraryResponse
TciClient. CreateLibrary(CreateLibraryRequest req)
创建人员库CreatePersonResponse
TciClient. CreatePerson(CreatePersonRequest req)
创建人员CreateVocabResponse
TciClient. CreateVocab(CreateVocabRequest req)
创建词汇CreateVocabLibResponse
TciClient. CreateVocabLib(CreateVocabLibRequest req)
建立词汇库DeleteFaceResponse
TciClient. DeleteFace(DeleteFaceRequest req)
删除人脸DeleteLibraryResponse
TciClient. DeleteLibrary(DeleteLibraryRequest req)
删除人员库DeletePersonResponse
TciClient. DeletePerson(DeletePersonRequest req)
删除人员DeleteVocabResponse
TciClient. DeleteVocab(DeleteVocabRequest req)
删除词汇DeleteVocabLibResponse
TciClient. DeleteVocabLib(DeleteVocabLibRequest req)
删除词汇库DescribeAITaskResultResponse
TciClient. DescribeAITaskResult(DescribeAITaskResultRequest req)
获取标准化接口任务结果DescribeAttendanceResultResponse
TciClient. DescribeAttendanceResult(DescribeAttendanceResultRequest req)
人脸考勤查询结果DescribeAudioTaskResponse
TciClient. DescribeAudioTask(DescribeAudioTaskRequest req)
音频评估任务信息查询接口,异步查询客户提交的请求的结果。DescribeConversationTaskResponse
TciClient. DescribeConversationTask(DescribeConversationTaskRequest req)
音频对话任务评估任务信息查询接口,异步查询客户提交的请求的结果。DescribeHighlightResultResponse
TciClient. DescribeHighlightResult(DescribeHighlightResultRequest req)
视频精彩集锦结果查询接口,异步查询客户提交的请求的结果。DescribeImageTaskResponse
TciClient. DescribeImageTask(DescribeImageTaskRequest req)
拉取任务详情DescribeImageTaskStatisticResponse
TciClient. DescribeImageTaskStatistic(DescribeImageTaskStatisticRequest req)
获取图像任务统计信息DescribeLibrariesResponse
TciClient. DescribeLibraries(DescribeLibrariesRequest req)
获取人员库列表DescribePersonResponse
TciClient. DescribePerson(DescribePersonRequest req)
获取人员详情DescribePersonsResponse
TciClient. DescribePersons(DescribePersonsRequest req)
拉取人员列表DescribeVocabResponse
TciClient. DescribeVocab(DescribeVocabRequest req)
查询词汇DescribeVocabLibResponse
TciClient. DescribeVocabLib(DescribeVocabLibRequest req)
查询词汇库ModifyLibraryResponse
TciClient. ModifyLibrary(ModifyLibraryRequest req)
修改人员库信息ModifyPersonResponse
TciClient. ModifyPerson(ModifyPersonRequest req)
修改人员信息SubmitAudioTaskResponse
TciClient. SubmitAudioTask(SubmitAudioTaskRequest req)
音频任务提交接口SubmitCheckAttendanceTaskResponse
TciClient. SubmitCheckAttendanceTask(SubmitCheckAttendanceTaskRequest req)
提交人员考勤任务,支持包括点播和直播资源;支持通过DescribeAttendanceResult查询结果,也支持通过NoticeUrl设置考勤回调结果,回调结果结构如下: ##### 回调事件结构 | 参数名称 | 类型 | 描述 | | ---- | --- | ------ | | jobid | Integer | 任务ID | | person_info | array of PersonInfo | 识别到的人员列表 | #####子结构PersonInfo | 参数名称 | 类型 | 描述 | | ---- | --- | ------ | | traceid | String | 可用于区分同一路视频流下的不同陌生人 | | personid | String | 识别到的人员ID,如果是陌生人则返回空串 | | libid | String | 识别到的人员所在的库ID,如果是陌生人则返回空串 | | timestamp | uint64 | 识别到人脸的绝对时间戳,单位ms | | image_url | string | 识别到人脸的事件抓图的下载地址,不长期保存,需要请及时下载 |SubmitCheckAttendanceTaskPlusResponse
TciClient. SubmitCheckAttendanceTaskPlus(SubmitCheckAttendanceTaskPlusRequest req)
支持多路视频流,提交高级人员考勤任务SubmitConversationTaskResponse
TciClient. SubmitConversationTask(SubmitConversationTaskRequest req)
对话任务分析接口SubmitDoubleVideoHighlightsResponse
TciClient. SubmitDoubleVideoHighlights(SubmitDoubleVideoHighlightsRequest req)
发起双路视频生成精彩集锦接口。该接口可以通过客户传入的学生音视频及老师视频两路Url,自动生成一堂课程的精彩集锦。需要通过DescribeHighlightResult 接口获取生成结果。SubmitFullBodyClassTaskResponse
TciClient. SubmitFullBodyClassTask(SubmitFullBodyClassTaskRequest req)
传统课堂授课任务**:在此场景中,老师为站立授课,有白板或投影供老师展示课程内容,摄像头可以拍摄到老师的半身或者全身。拍摄视频为一路全局画面,且背景不动,要求画面稳定清晰。通过此接口可分析老师授课的行为及语音,以支持AI评教。 提供的功能接口有:**老师人脸识别、老师表情识别、老师肢体动作识别、语音识别。 可分析的指标维度包括:身份识别、正脸、侧脸、人脸坐标、人脸尺寸、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、正面讲解、写板书、指黑板、语音转文字、发音时长、非发音时长、音量、语速、指定关键词的使用等 对场景的要求为:**真实场景老师1人出现在画面中,全局画面且背景不动;人脸上下角度在20度以内,左右角度在15度以内,歪头角度在15度以内;光照均匀,无遮挡,人脸清晰可见;像素最好在 100X100 像素以上,但是图像整体质量不能超过1080p。 结果查询方式:**图像任务直接返回结果,点播及直播任务通过DescribeAITaskResult查询结果。SubmitHighlightsResponse
TciClient. SubmitHighlights(SubmitHighlightsRequest req)
发起视频生成精彩集锦接口。该接口可以通过客户传入的课程音频数据及相关策略(如微笑抽取,专注抽取等),自动生成一堂课程的精彩集锦。需要通过QueryHighlightResult接口获取生成结果。SubmitImageTaskResponse
TciClient. SubmitImageTask(SubmitImageTaskRequest req)
提交图像分析任务SubmitImageTaskPlusResponse
TciClient. SubmitImageTaskPlus(SubmitImageTaskPlusRequest req)
高级图像分析任务,开放了图像任务里的所有开关,可以根据场景深度定制图像分析任务。支持的图像类别有,图片链接、图片二进制数据、点播链接和直播链接。SubmitOneByOneClassTaskResponse
TciClient. SubmitOneByOneClassTask(SubmitOneByOneClassTaskRequest req)
提交在线1对1课堂任务** 对于在线1对1课堂,老师通过视频向学生授课,并且学生人数为1人。通过上传学生端的图像信息,可以获取学生的听课情况分析。 具体指一路全局画面且背景不动,有1位学生的头像或上半身的画面,要求画面稳定清晰。 提供的功能接口有:**学生人脸识别、学生表情识别、语音识别。可分析的指标维度包括:学生身份识别、正脸、侧脸、抬头、低头、人脸坐标、人脸尺寸、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、语音转文字、发音时长、非发音时长、音量、语速等。 对场景的要求为:**真实常规1v1授课场景,学生2人以下,全局画面且背景不动;人脸上下角度在20度以内,左右角度在15度以内,歪头角度在15度以内;光照均匀,无遮挡,人脸清晰可见;像素最好在 100X100 像素以上,但是图像整体质量不能超过1080p。 结果查询方式:**图像任务直接返回结果,点播及直播任务通过DescribeAITaskResult查询结果。SubmitOpenClassTaskResponse
TciClient. SubmitOpenClassTask(SubmitOpenClassTaskRequest req)
提交线下小班(无课桌)课任务** 线下小班课是指有学生无课桌的课堂,满座15人以下,全局画面且背景不动,能清晰看到。 提供的功能接口有:**学生人脸识别、学生表情识别、学生肢体动作识别。 可分析的指标维度包括:身份识别、正脸、侧脸、抬头、低头、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、站立、举手、坐着等。 对场景的要求为:**真实常规教室,满座15人以下,全局画面且背景不动;人脸上下角度在20度以内,左右角度在15度以内,歪头角度在15度以内;光照均匀,无遮挡,人脸清晰可见;像素最好在 100X100 像素以上但是图像整体质量不能超过1080p。 结果查询方式:**图像任务直接返回结果,点播及直播任务通过DescribeAITaskResult查询结果。SubmitPartialBodyClassTaskResponse
TciClient. SubmitPartialBodyClassTask(SubmitPartialBodyClassTaskRequest req)
在线小班课任务**:此场景是在线授课场景,老师一般为坐着授课,摄像头可以拍摄到老师的头部及上半身。拍摄视频为一路全局画面,且背景不动,要求画面稳定清晰。通过此接口可分析老师授课的行为及语音,以支持AI评教。 提供的功能接口有:**老师人脸识别、老师表情识别、老师手势识别、光线识别、语音识别。 可分析的指标维度包括:身份识别、正脸、侧脸、人脸坐标、人脸尺寸、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、点赞手势、听你说手势、听我说手势、拿教具行为、语音转文字、发音时长、非发音时长、音量、语速、指定关键词的使用等 对场景的要求为:**在线常规授课场景,全局画面且背景不动;人脸上下角度在20度以内,左右角度在15度以内,歪头角度在15度以内;光照均匀,无遮挡,人脸清晰可见;像素最好在 100X100 像素以上,但是图像整体质量不能超过1080p。 结果查询方式:**图像任务直接返回结果,点播及直播任务通过DescribeAITaskResult查询结果。SubmitTraditionalClassTaskResponse
TciClient. SubmitTraditionalClassTask(SubmitTraditionalClassTaskRequest req)
提交线下传统面授大班课(含课桌)任务。** 传统教室课堂是指有学生课堂有课桌的课堂,满座20-50人,全局画面且背景不动。 提供的功能接口有:**学生人脸识别、学生表情识别、学生肢体动作识别。可分析的指标维度包括:学生身份识别、正脸、侧脸、抬头、低头、高兴、中性、高兴、中性、惊讶、厌恶、恐惧、愤怒、蔑视、悲伤、举手、站立、坐着、趴桌子、玩手机等 对场景的要求为:**传统的学生上课教室,满座20-50人,全局画面且背景不动;人脸上下角度在20度以内,左右角度在15度以内,歪头角度在15度以内;光照均匀,无遮挡,人脸清晰可见;像素最好在 100X100 像素以上,但是图像整体质量不能超过1080p。 结果查询方式:**图像任务直接返回结果,点播及直播任务通过DescribeAITaskResult查询结果。TransmitAudioStreamResponse
TciClient. TransmitAudioStream(TransmitAudioStreamRequest req)
分析音频信息 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tcm.v20210413
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tcr.v20190924
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tcss.v20201101
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tdcpg.v20211118
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tdid.v20210519
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tdmq.v20200217
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tds.v20220801
Methods in com.tencentcloudapi.tds.v20220801 that throw TencentCloudSDKException Modifier and Type Method Description DescribeFraudBaseResponse
TdsClient. DescribeFraudBase(DescribeFraudBaseRequest req)
查询设备风险DescribeFraudPremiumResponse
TdsClient. DescribeFraudPremium(DescribeFraudPremiumRequest req)
查询设备标识及风险DescribeFraudUltimateResponse
TdsClient. DescribeFraudUltimate(DescribeFraudUltimateRequest req)
查询设备标识及风险(旗舰版)DescribeTrustedIDResponse
TdsClient. DescribeTrustedID(DescribeTrustedIDRequest req)
查询设备标识 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tem.v20201221
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tem.v20210701
-
Uses of TencentCloudSDKException in com.tencentcloudapi.teo.v20220106
Methods in com.tencentcloudapi.teo.v20220106 that throw TencentCloudSDKException Modifier and Type Method Description CreatePrefetchTaskResponse
TeoClient. CreatePrefetchTask(CreatePrefetchTaskRequest req)
创建预热任务CreatePurgeTaskResponse
TeoClient. CreatePurgeTask(CreatePurgeTaskRequest req)
创建清除缓存任务DescribePrefetchTasksResponse
TeoClient. DescribePrefetchTasks(DescribePrefetchTasksRequest req)
查询预热任务状态DescribePurgeTasksResponse
TeoClient. DescribePurgeTasks(DescribePurgeTasksRequest req)
查询清除缓存历史记录DescribeZonesResponse
TeoClient. DescribeZones(DescribeZonesRequest req)
用户查询用户站点信息列表,支持分页 -
Uses of TencentCloudSDKException in com.tencentcloudapi.teo.v20220901
-
Uses of TencentCloudSDKException in com.tencentcloudapi.thpc.v20211109
Methods in com.tencentcloudapi.thpc.v20211109 that throw TencentCloudSDKException Modifier and Type Method Description BindAutoScalingGroupResponse
ThpcClient. BindAutoScalingGroup(BindAutoScalingGroupRequest req)
本接口(BindAutoScalingGroup)用于为集群队列绑定弹性伸缩组CreateClusterResponse
ThpcClient. CreateCluster(CreateClusterRequest req)
本接口 (CreateCluster) 用于创建并启动集群。DeleteClusterResponse
ThpcClient. DeleteCluster(DeleteClusterRequest req)
本接口(DeleteCluster)用于删除一个指定的集群。DescribeClustersResponse
ThpcClient. DescribeClusters(DescribeClustersRequest req)
本接口(DescribeClusters)用于查询集群列表。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.thpc.v20220401
Methods in com.tencentcloudapi.thpc.v20220401 that throw TencentCloudSDKException Modifier and Type Method Description AddClusterStorageOptionResponse
ThpcClient. AddClusterStorageOption(AddClusterStorageOptionRequest req)
本接口(AddClusterStorageOption)用于添加集群存储选项信息。AddNodesResponse
ThpcClient. AddNodes(AddNodesRequest req)
本接口(AddNodes)用于添加一个或者多个计算节点或者登录节点到指定集群。AddQueueResponse
ThpcClient. AddQueue(AddQueueRequest req)
本接口(AddQueue)用于添加队列到指定集群。 本接口为目前只支持SchedulerType为SLURM的集群。 单个集群中队列数量上限为10个。BindAutoScalingGroupResponse
ThpcClient. BindAutoScalingGroup(BindAutoScalingGroupRequest req)
本接口(BindAutoScalingGroup)用于为集群队列绑定弹性伸缩组CreateClusterResponse
ThpcClient. CreateCluster(CreateClusterRequest req)
本接口 (CreateCluster) 用于创建并启动集群。 本接口为异步接口, 当创建集群请求下发成功后会返回一个集群`ID`和一个`RequestId`,此时创建集群操作并未立即完成。在此期间集群的状态将会处于“PENDING”或者“INITING”,集群创建结果可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/1527/72100) 接口查询,如果集群状态(ClusterStatus)变为“RUNNING(运行中)”,则代表集群创建成功,“ INIT_FAILED”代表集群创建失败。DeleteClusterResponse
ThpcClient. DeleteCluster(DeleteClusterRequest req)
本接口(DeleteCluster)用于删除一个指定的集群。DeleteClusterStorageOptionResponse
ThpcClient. DeleteClusterStorageOption(DeleteClusterStorageOptionRequest req)
本接口 (DeleteClusterStorageOption) 用于删除集群存储选项信息。DeleteNodesResponse
ThpcClient. DeleteNodes(DeleteNodesRequest req)
本接口(DeleteNodes)用于删除指定集群中一个或者多个计算节点或者登录节点。DeleteQueueResponse
ThpcClient. DeleteQueue(DeleteQueueRequest req)
本接口(DeleteQueue)用于从指定集群删除队列。 本接口为目前只支持SchedulerType为SLURM的集群。 删除队列时,需要保证队列内不存在节点。DescribeAutoScalingConfigurationResponse
ThpcClient. DescribeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest req)
本接口(DescribeAutoScalingConfiguration)用于查询集群弹性伸缩配置信息。本接口仅适用于弹性伸缩类型为THPC_AS的集群。DescribeClusterActivitiesResponse
ThpcClient. DescribeClusterActivities(DescribeClusterActivitiesRequest req)
本接口(DescribeClusterActivities)用于查询集群活动历史记录列表。DescribeClustersResponse
ThpcClient. DescribeClusters(DescribeClustersRequest req)
本接口(DescribeClusters)用于查询集群列表。DescribeClusterStorageOptionResponse
ThpcClient. DescribeClusterStorageOption(DescribeClusterStorageOptionRequest req)
本接口 (DescribeClusterStorageOption) 用于查询集群存储选项信息。DescribeNodesResponse
ThpcClient. DescribeNodes(DescribeNodesRequest req)
本接口 (DescribeNodes) 用于查询指定集群节点概览信息列表。DescribeQueuesResponse
ThpcClient. DescribeQueues(DescribeQueuesRequest req)
本接口(DescribeQueues)用于查询指定集群队列概览信息列表。SetAutoScalingConfigurationResponse
ThpcClient. SetAutoScalingConfiguration(SetAutoScalingConfigurationRequest req)
本接口(SetAutoScalingConfiguration)用于为集群设置集群弹性伸缩配置信息。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.thpc.v20230321
Methods in com.tencentcloudapi.thpc.v20230321 that throw TencentCloudSDKException Modifier and Type Method Description AddClusterStorageOptionResponse
ThpcClient. AddClusterStorageOption(AddClusterStorageOptionRequest req)
本接口(AddClusterStorageOption)用于添加集群存储选项信息。AddNodesResponse
ThpcClient. AddNodes(AddNodesRequest req)
本接口(AddNodes)用于添加一个或者多个计算节点或者登录节点到指定集群。AddQueueResponse
ThpcClient. AddQueue(AddQueueRequest req)
本接口(AddQueue)用于添加队列到指定集群。 本接口为目前只支持SchedulerType为SLURM的集群。 单个集群中队列数量上限为10个。CreateClusterResponse
ThpcClient. CreateCluster(CreateClusterRequest req)
本接口 (CreateCluster) 用于创建并启动集群。 本接口为异步接口, 当创建集群请求下发成功后会返回一个集群`ID`和一个`RequestId`,此时创建集群操作并未立即完成。在此期间集群的状态将会处于“PENDING”或者“INITING”,集群创建结果可以通过调用 [DescribeClusters](https://cloud.tencent.com/document/product/1527/72100) 接口查询,如果集群状态(ClusterStatus)变为“RUNNING(运行中)”,则代表集群创建成功,“ INIT_FAILED”代表集群创建失败。DeleteClusterResponse
ThpcClient. DeleteCluster(DeleteClusterRequest req)
本接口(DeleteCluster)用于删除一个指定的集群。DeleteClusterStorageOptionResponse
ThpcClient. DeleteClusterStorageOption(DeleteClusterStorageOptionRequest req)
本接口 (DeleteClusterStorageOption) 用于删除集群存储选项信息。DeleteNodesResponse
ThpcClient. DeleteNodes(DeleteNodesRequest req)
本接口(DeleteNodes)用于删除指定集群中一个或者多个计算节点或者登录节点。DeleteQueueResponse
ThpcClient. DeleteQueue(DeleteQueueRequest req)
本接口(DeleteQueue)用于从指定集群删除队列。 本接口为目前只支持SchedulerType为SLURM的集群。 删除队列时,需要保证队列内不存在节点。DescribeAutoScalingConfigurationResponse
ThpcClient. DescribeAutoScalingConfiguration(DescribeAutoScalingConfigurationRequest req)
本接口(DescribeAutoScalingConfiguration)用于查询集群弹性伸缩配置信息。本接口仅适用于弹性伸缩类型为THPC_AS的集群。DescribeClusterActivitiesResponse
ThpcClient. DescribeClusterActivities(DescribeClusterActivitiesRequest req)
本接口(DescribeClusterActivities)用于查询集群活动历史记录列表。DescribeClustersResponse
ThpcClient. DescribeClusters(DescribeClustersRequest req)
本接口(DescribeClusters)用于查询集群列表。DescribeClusterStorageOptionResponse
ThpcClient. DescribeClusterStorageOption(DescribeClusterStorageOptionRequest req)
本接口 (DescribeClusterStorageOption) 用于查询集群存储选项信息。DescribeInitNodeScriptsResponse
ThpcClient. DescribeInitNodeScripts(DescribeInitNodeScriptsRequest req)
本接口 (DescribeInitNodeScripts) 用于查询节点初始化脚本列表。DescribeNodesResponse
ThpcClient. DescribeNodes(DescribeNodesRequest req)
本接口 (DescribeNodes) 用于查询指定集群节点概览信息列表。DescribeQueuesResponse
ThpcClient. DescribeQueues(DescribeQueuesRequest req)
本接口(DescribeQueues)用于查询指定集群队列概览信息列表。ModifyInitNodeScriptsResponse
ThpcClient. ModifyInitNodeScripts(ModifyInitNodeScriptsRequest req)
本接口 (ModifyInitNodeScripts) 用于修改节点初始化脚本。SetAutoScalingConfigurationResponse
ThpcClient. SetAutoScalingConfiguration(SetAutoScalingConfigurationRequest req)
本接口(SetAutoScalingConfiguration)用于为集群设置集群弹性伸缩配置信息。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tia.v20180226
Methods in com.tencentcloudapi.tia.v20180226 that throw TencentCloudSDKException Modifier and Type Method Description CreateJobResponse
TiaClient. CreateJob(CreateJobRequest req)
创建训练任务CreateModelResponse
TiaClient. CreateModel(CreateModelRequest req)
部署模型,用以对外提供服务。有两种部署模式:`无服务器模式` 和 `集群模式`。`无服务器模式` 下,模型文件被部署到无服务器云函数,即 [SCF](https://cloud.tencent.com/product/scf),用户可以在其控制台上进一步操作。`集群模式` 下,模型文件被部署到 TI-A 的计算集群中。DeleteJobResponse
TiaClient. DeleteJob(DeleteJobRequest req)
删除训练任务DeleteModelResponse
TiaClient. DeleteModel(DeleteModelRequest req)
删除指定的部署模型。模型有两种部署模式:`无服务器模式` 和 `集群模式`。`无服务器模式` 下,模型文件被部署到无服务器云函数,即 [SCF](https://cloud.tencent.com/product/scf),用户可以在其控制台上进一步操作。`集群模式` 下,模型文件被部署到 TI-A 的计算集群中。DescribeJobResponse
TiaClient. DescribeJob(DescribeJobRequest req)
获取训练任务详情DescribeModelResponse
TiaClient. DescribeModel(DescribeModelRequest req)
描述已经部署的某个模型。而模型部署有两种模式:`无服务器模式` 和 `集群模式`。`无服务器模式` 下,模型文件被部署到无服务器云函数,即 [SCF](https://cloud.tencent.com/product/scf),用户可以在其控制台上进一步操作。`集群模式` 下,模型文件被部署到 TI-A 的计算集群中。InstallAgentResponse
TiaClient. InstallAgent(InstallAgentRequest req)
安装agentListJobsResponse
TiaClient. ListJobs(ListJobsRequest req)
列举训练任务ListModelsResponse
TiaClient. ListModels(ListModelsRequest req)
用以列举已经部署的模型。而部署有两种模式:`无服务器模式` 和 `集群模式`。`无服务器模式` 下,模型文件被部署到无服务器云函数,即 [SCF](https://cloud.tencent.com/product/scf),用户可以在其控制台上进一步操作。`集群模式` 下,模型文件被部署到 TI-A 的计算集群中。不同部署模式下的模型分开列出。QueryLogsResponse
TiaClient. QueryLogs(QueryLogsRequest req)
查询 TI-A 训练任务的日志 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tic.v20201117
Methods in com.tencentcloudapi.tic.v20201117 that throw TencentCloudSDKException Modifier and Type Method Description ApplyStackResponse
TicClient. ApplyStack(ApplyStackRequest req)
本接口(ApplyStack)用于触发资源栈下某个版本的Apply事件。 - 当版本处于PLAN_IN_PROGRESS或APPLY_IN_PROGRESS状态时,将无法再执行本操作 - 当版本处于APPLY_COMPLETED状态时,本操作无法执行CreateStackResponse
TicClient. CreateStack(CreateStackRequest req)
本接口(CreateStack)用于通过传递一个COS的terraform zip模版URL来创建一个资源栈。创建资源栈后仍需要用户调用对应的plan, apply, destory执行对应的事件。CreateStackVersionResponse
TicClient. CreateStackVersion(CreateStackVersionRequest req)
本接口(CreateStackVersion)用于给资源栈新增一个HCL模版版本,仅限COS链接,且为zip格式。DeleteStackResponse
TicClient. DeleteStack(DeleteStackRequest req)
本接口(DeleteStack)用于删除一个资源栈(配置、版本、事件信息)。但不会销毁资源管理的云资源。如果需要销毁资源栈管理的云资源,请调用 DestoryStack 接口销毁云资源。DeleteStackVersionResponse
TicClient. DeleteStackVersion(DeleteStackVersionRequest req)
本接口(DeleteStackVersion)用于删除一个版本,处于PLAN_IN_PROGRESS和APPLY_IN_PROGRESS状态中的版本无法删除。DescribeStackEventResponse
TicClient. DescribeStackEvent(DescribeStackEventRequest req)
本接口(DescribeStackEvent)用于获取单个事件详情,尤其是可以得到事件的详细控制台输出文本。DescribeStackEventsResponse
TicClient. DescribeStackEvents(DescribeStackEventsRequest req)
本接口(DescribeStackEvents)用于查看一个或多个事件详细信息。 - 可以根据事件ID过滤感兴趣的事件 - 也可以根据版本ID,资源栈ID,事件类型,事件状态过滤事件,过滤信息详细请见过滤器Filter - 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的事件DescribeStacksResponse
TicClient. DescribeStacks(DescribeStacksRequest req)
本接口(DescribeStacks)用于查询一个或多个资源栈的详细信息。 - 可以根据资源栈ID来查询感兴趣的资源栈信息 - 若参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的资源栈DescribeStackVersionsResponse
TicClient. DescribeStackVersions(DescribeStackVersionsRequest req)
本接口(DescribeStackVersions)用于查询一个或多个版本的详细信息。 - 可以根据版本ID查询感兴趣的版本 - 可以根据版本名字和状态来过滤版本,详见过滤器Filter - 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的版本DestroyStackResponse
TicClient. DestroyStack(DestroyStackRequest req)
本接口(DestroyStack)用于删除资源栈下的某个版本所创建的资源。PlanStackResponse
TicClient. PlanStack(PlanStackRequest req)
本接口(PlanStack)用于触发资源栈下某个版本的PLAN事件。 - 当版本处于PLAN_IN_PROGRESS或APPLY_IN_PROGRESS状态时,将无法再执行本操作 - 当版本处于APPLY_COMPLETED状态时,本操作无法执行UpdateStackResponse
TicClient. UpdateStack(UpdateStackRequest req)
本接口(UpdateStack)用于更新资源栈的名称和描述。UpdateStackVersionResponse
TicClient. UpdateStackVersion(UpdateStackVersionRequest req)
本接口(UpdateStackVersion)用于更新一个版本的模版内容,名称或描述,模版仅限COS URL,且为zip格式。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ticm.v20181127
Methods in com.tencentcloudapi.ticm.v20181127 that throw TencentCloudSDKException Modifier and Type Method Description DescribeVideoTaskResponse
TicmClient. DescribeVideoTask(DescribeVideoTaskRequest req)
提交完视频审核任务后,可以通过本接口来获取当前处理的进度和结果ImageModerationResponse
TicmClient. ImageModeration(ImageModerationRequest req)
本接口提供多种维度的图像审核能力,支持色情和性感内容识别,政治人物和涉政敏感场景识别,以及暴恐人物、场景、旗帜标识等违禁内容的识别。VideoModerationResponse
TicmClient. VideoModeration(VideoModerationRequest req)
本接口提供多种维度的视频审核能力,支持色情和性感内容识别,政治人物和涉政敏感场景识别,以及暴恐人物、场景、旗帜标识等违禁内容的识别。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tics.v20181115
Methods in com.tencentcloudapi.tics.v20181115 that throw TencentCloudSDKException Modifier and Type Method Description DescribeDomainInfoResponse
TicsClient. DescribeDomainInfo(DescribeDomainInfoRequest req)
提供域名相关的基础信息以及与攻击事件(团伙、家族)、恶意文件等相关联信息。DescribeFileInfoResponse
TicsClient. DescribeFileInfo(DescribeFileInfoRequest req)
提供文件相关的基础信息以及与攻击事件(团伙、家族)、恶意文件等相关联信息。DescribeIpInfoResponse
TicsClient. DescribeIpInfo(DescribeIpInfoRequest req)
提供IP相关的基础信息以及与攻击事件(团伙、家族)、恶意文件等相关联信息。DescribeThreatInfoResponse
TicsClient. DescribeThreatInfo(DescribeThreatInfoRequest req)
提供IP和域名相关威胁情报信息查询,这些信息可以辅助检测失陷主机、帮助SIEM/SOC等系统做研判决策、帮助运营团队对设备报警的编排处理。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tiems.v20190416
Methods in com.tencentcloudapi.tiems.v20190416 that throw TencentCloudSDKException Modifier and Type Method Description CreateJobResponse
TiemsClient. CreateJob(CreateJobRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 创建任务CreateRsgAsGroupResponse
TiemsClient. CreateRsgAsGroup(CreateRsgAsGroupRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 创建资源组的伸缩组。当前一个资源组仅允许创建一个伸缩组。CreateRuntimeResponse
TiemsClient. CreateRuntime(CreateRuntimeRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 创建运行环境CreateServiceResponse
TiemsClient. CreateService(CreateServiceRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 创建服务CreateServiceConfigResponse
TiemsClient. CreateServiceConfig(CreateServiceConfigRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 创建服务配置DeleteInstanceResponse
TiemsClient. DeleteInstance(DeleteInstanceRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 删除资源组中的节点。目前仅支持删除已经到期的预付费节点,和按量付费节点。DeleteJobResponse
TiemsClient. DeleteJob(DeleteJobRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 删除任务DeleteResourceGroupResponse
TiemsClient. DeleteResourceGroup(DeleteResourceGroupRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 删除资源组DeleteRsgAsGroupResponse
TiemsClient. DeleteRsgAsGroup(DeleteRsgAsGroupRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 伸缩DeleteRuntimeResponse
TiemsClient. DeleteRuntime(DeleteRuntimeRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 删除运行环境DeleteServiceResponse
TiemsClient. DeleteService(DeleteServiceRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 删除服务DeleteServiceConfigResponse
TiemsClient. DeleteServiceConfig(DeleteServiceConfigRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 删除服务配置DescribeInstancesResponse
TiemsClient. DescribeInstances(DescribeInstancesRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 获取节点列表DescribeResourceGroupsResponse
TiemsClient. DescribeResourceGroups(DescribeResourceGroupsRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 获取资源组列表DescribeRsgAsGroupActivitiesResponse
TiemsClient. DescribeRsgAsGroupActivities(DescribeRsgAsGroupActivitiesRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 查询伸缩组活动DescribeRsgAsGroupsResponse
TiemsClient. DescribeRsgAsGroups(DescribeRsgAsGroupsRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 查询资源组的伸缩组信息DescribeRuntimesResponse
TiemsClient. DescribeRuntimes(DescribeRuntimesRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 描述服务运行环境DescribeServiceConfigsResponse
TiemsClient. DescribeServiceConfigs(DescribeServiceConfigsRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 描述服务配置DescribeServicesResponse
TiemsClient. DescribeServices(DescribeServicesRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 描述服务DisableRsgAsGroupResponse
TiemsClient. DisableRsgAsGroup(DisableRsgAsGroupRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 停用资源组的伸缩组EnableRsgAsGroupResponse
TiemsClient. EnableRsgAsGroup(EnableRsgAsGroupRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 启用资源组的伸缩组ExposeServiceResponse
TiemsClient. ExposeService(ExposeServiceRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 暴露服务UpdateJobResponse
TiemsClient. UpdateJob(UpdateJobRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 更新任务UpdateRsgAsGroupResponse
TiemsClient. UpdateRsgAsGroup(UpdateRsgAsGroupRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 更新资源组的伸缩组UpdateServiceResponse
TiemsClient. UpdateService(UpdateServiceRequest req)
因业务策略调整,腾讯云TI平台TI-EMS已经于2022年6月30日下线并停止提供服务。若您有新增的业务需求,可前往TI-ONE(https://cloud.tencent.com/document/product/851)使用。 更新服务 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tiia.v20190529
Methods in com.tencentcloudapi.tiia.v20190529 that throw TencentCloudSDKException Modifier and Type Method Description AssessQualityResponse
TiiaClient. AssessQuality(AssessQualityRequest req)
评估输入图片在视觉上的质量,从多个方面评估,并同时给出综合的、客观的清晰度评分,和主观的美观度评分。 > - 可前往 [图像处理](https://cloud.tencent.com/document/product/1590) 产品文档中查看更多产品信息。 - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。CreateGroupResponse
TiiaClient. CreateGroup(CreateGroupRequest req)
本接口用于创建一个空的图片库,图片库主要用于存储在创建图片时提取的图片特征数据,如果图片库已存在则返回错误。不同的图片库类型对应不同的图像搜索服务类型,根据输入参数GroupType区分。 服务类型GroupType功能描述 通用图像搜索 4 通用图像搜索1.0版。
在自建图片库中搜索相同原图或相似图片集,并给出相似度打分,可支持裁剪、翻转、调色、加水印等二次编辑后的图片搜索。适用于图片版权保护、原图查询等场景。 商品图像搜索 8 商品图像搜索3.0升级版(推荐)。
在自建图库中搜索同款或相似商品,并给出相似度打分。对于服饰类商品可支持识别服饰类别、属性等信息。适用于商品分类、检索、推荐等电商场景。 7 商品图像搜索2.0版。
功能和3.0升级版类似。 5 商品图像搜索1.0版。
功能和3.0升级版类似。 图案花纹搜索6图案花纹搜索1.0版。
在自建图库中搜索相似的图案、logo、纹理等图像元素或主体,并给出相似度打分。 - 可前往 [图像搜索](https://cloud.tencent.com/document/product/1589) 产品文档中查看更多产品信息。CreateImageResponse
TiiaClient. CreateImage(CreateImageRequest req)
创建图片,并添加对应图片的自定义信息。模型将在创建图片时自动提取图像特征并存储到指定的图片库中,每创建一张图片会对应提取和存储一条图片特征数据。 > - 可前往 [图像搜索](https://cloud.tencent.com/document/product/1589) 产品文档中查看更多产品信息。CropImageResponse
TiiaClient. CropImage(CropImageRequest req)
根据输入的裁剪比例,智能判断一张图片的最佳裁剪区域,确保原图的主体区域不受影响,以适应不同平台、设备的展示要求,避免简单拉伸带来的变形。 > - 可前往 [图像处理](https://cloud.tencent.com/document/product/1590) 产品文档中查看更多产品信息。 - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DeleteImagesResponse
TiiaClient. DeleteImages(DeleteImagesRequest req)
删除图片。 > - 可前往 [图像搜索](https://cloud.tencent.com/document/product/1589) 产品文档中查看更多产品信息。DescribeGroupsResponse
TiiaClient. DescribeGroups(DescribeGroupsRequest req)
查询所有的图库信息。 > - 可前往 [图像搜索](https://cloud.tencent.com/document/product/1589) 产品文档中查看更多产品信息。DescribeImagesResponse
TiiaClient. DescribeImages(DescribeImagesRequest req)
获取指定图片库中的图片列表。 > - 可前往 [图像搜索](https://cloud.tencent.com/document/product/1589) 产品文档中查看更多产品信息。DetectChefDressResponse
TiiaClient. DetectChefDress(DetectChefDressRequest req)
可对图片中厨师穿戴进行识别,支持厨师服识别,厨师帽识别,赤膊识别和口罩识别,可应用于明厨亮灶场景。 "被优选过滤"标签值在人体优选开关开启时才会返回。 厨师服:厨师服定义为白色上衣 厨师服识别(酒店版):厨师服定义为红色,白色,黑色上衣 |序号 | 标签名称 | 标签值 | | :-----| :---------- |:----------------- | | 1 | 厨师服识别 |无厨师服、有厨师服、被优选过滤| | 2 | 厨师服识别(酒店版) |无厨师服、有厨师服、被优选过滤| | 3 | 厨师帽识别 |无厨师帽、有厨师帽、被优选过滤 | | 4 | 赤膊识别 |非赤膊、赤膊、被优选过滤| | 5 | 口罩识别 |无口罩、有口罩、口罩不确定、被优选过滤 |DetectDisgustResponse
TiiaClient. DetectDisgust(DetectDisgustRequest req)
输入一张图片,返回AI针对一张图片是否是恶心的一系列判断值。 通过恶心图片识别, 可以判断一张图片是否令人恶心, 同时给出它属于的潜在类别, 让您能够过滤掉使人不愉快的图片。 > - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectEnvelopeResponse
TiiaClient. DetectEnvelope(DetectEnvelopeRequest req)
文件封识别可检测图片中是否包含符合文件封(即文件、单据、资料等的袋状包装)特征的物品,覆盖顺丰快递文件封、文件袋、档案袋等多种文件封类型,可应用于物流行业对文件快递的包装审核等场景。 >? - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectLabelResponse
TiiaClient. DetectLabel(DetectLabelRequest req)
图像标签利用深度学习技术,可以对图片进行智能分类、物体识别等。 目前支持八个大类、六十多个子类、数千个标签,涵盖各种日常场景、动植物、物品、美食等。 图像标签提供四个版本供选择: • 摄像头版:针对搜索、手机摄像头照片进行优化,涵盖大量卡证、日常物品、二维码条形码。 • 相册版:针对手机相册、网盘进行优化,去除相册和网盘中不常见的标签,针对相册常见图片类型(人像、日常活动、日常物品等)识别效果更好。 • 网络版:针对网络图片进行优化,涵盖标签更多,满足长尾识别需求。 • 新闻版:针对新闻、资讯、广电等行业进行优化,增加定制识别,支持万级图像标签。 为了方便使用、减少图片传输次数,图像标签将不同版本包装成多合一接口,实际上是多个服务,分别计费。建议在接入初期,对四个版本进行对比评估后选择合适的版本使用。 >? - 图像标签已升级服务,建议使用新版接口[通用图像标签](https://cloud.tencent.com/document/product/865/75196)。 - 图像标签摄像头版、相册版、网络版、新闻版分别按照各自的实际使用次数进行收费,例如一张图片同时使用相册版、摄像头版,则按照两次调用计费。建议测试对比后从中选择一个最合适的版本使用即可。 > - 可前往 [图像标签](https://cloud.tencent.com/document/product/1588) 产品文档中查看更多产品信息。 - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectLabelBetaResponse
TiiaClient. DetectLabelBeta(DetectLabelBetaRequest req)
图像标签测试接口 > - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectLabelProResponse
TiiaClient. DetectLabelPro(DetectLabelProRequest req)
通用图像标签可识别数千种常见物体或场景,覆盖日常物品、场景、动物、植物、食物、饮品、交通工具等多个大类,返回主体的标签名称和所属细分类目等。 > - 可前往 [图像标签](https://cloud.tencent.com/document/product/1588) 产品文档中查看更多产品信息。 - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectMisbehaviorResponse
TiiaClient. DetectMisbehavior(DetectMisbehaviorRequest req)
可以识别输入的图片中是否包含不良行为,例如打架斗殴、赌博、抽烟等,可以应用于广告图、直播截图、短视频截图等审核,减少不良行为对平台内容质量的影响,维护健康向上的互联网环境。 > - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectPetResponse
TiiaClient. DetectPet(DetectPetRequest req)
传入一张图片,识别出图片中是否存在宠物 > - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectProductResponse
TiiaClient. DetectProduct(DetectProductRequest req)
本接口支持识别图片中包含的商品,能够输出商品的品类名称、类别,还可以输出商品在图片中的位置。支持一张图片多个商品的识别。 >? - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectProductBetaResponse
TiiaClient. DetectProductBeta(DetectProductBetaRequest req)
商品识别-微信识物版,基于人工智能技术、海量训练图片、亿级商品库,可以实现全覆盖、细粒度、高准确率的商品识别和商品推荐功能。 本服务可以识别出图片中的主体位置、主体商品类型,覆盖亿级SKU,输出具体商品的价格、型号等详细信息。 客户无需自建商品库,即可快速实现商品识别、拍照搜商品等功能。 >? - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。DetectSecurityResponse
TiiaClient. DetectSecurity(DetectSecurityRequest req)
安全属性识别可对图片中人体安全防护属性进行识别,支持识别安全帽,反光衣,护目镜,工服,手套,工地安全带,口罩,抽烟,玩手机等多种属性。 "被优选过滤"标签值在人体优选开关开启时才会返回。 |序号 | 标签名称 | 标签值 | | :-----| :---------- |:----------------- | | 1 | 安全帽识别 |无安全帽、有安全帽、被优选过滤| | 2 | 玩手机识别 |没有电话、打电话、玩手机、被优选过滤| | 3 | 抽烟识别 |没有抽烟、抽烟、被优选过滤 | | 4 | 口罩识别 |无口罩、有口罩、口罩不确定、被优选过滤| | 5 | 工地安全带识别 |无工地安全带、工地安全带、被优选过滤 | | 6 | 手套识别 |无手套、有手套、手套不确定、被优选过滤 | | 7 | 工服识别 |无工服、有工服、被优选过滤| | 8 | 护目镜识别 |无护目镜、有护目镜、被优选过滤| | 9 | 反光衣识别 |无反光衣、有反光衣、被优选过滤|EnhanceImageResponse
TiiaClient. EnhanceImage(EnhanceImageRequest req)
传入一张图片,输出清晰度提升后的图片。 可以消除图片有损压缩导致的噪声,和使用滤镜、拍摄失焦导致的模糊。让图片的边缘和细节更加清晰自然。 > - 可前往 [图像处理](https://cloud.tencent.com/document/product/1590) 产品文档中查看更多产品信息。 - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。RecognizeCarResponse
TiiaClient. RecognizeCar(RecognizeCarRequest req)
车辆识别可对图片中车辆的车型进行识别,输出车辆的品牌(如路虎)、车系(如神行者2)、类型(如中型SUV)、颜色和车辆在图中的坐标等信息,覆盖轿车、SUV、大型客车等市面常见车,支持三千多种车辆型号。如果图片中存在多辆车,会分别输出每辆车的车型和坐标。 >? - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。RecognizeCarProResponse
TiiaClient. RecognizeCarPro(RecognizeCarProRequest req)
车辆识别(增强版)在车辆识别的基础上**增加了车牌识别的功能,并升级了车型识别的效果**。可对图片中车辆的车型和车牌进行同时识别,输出车辆的车牌信息,以及车辆品牌(如路虎)、车系(如神行者2)、类型(如中型SUV)、颜色和车辆在图中的坐标等信息,覆盖轿车、SUV、大型客车等市面常见车,支持三千多种车辆型号。如果图片中存在多辆车,会分别输出每辆车的车型、车牌和坐标。 >? - 公共参数中的签名方式必须指定为V3版本,即配置SignatureMethod参数为TC3-HMAC-SHA256。SearchImageResponse
TiiaClient. SearchImage(SearchImageRequest req)
本接口用于对一张图片,在指定图片库中检索出与之相似的图片列表。 > - 可前往 [图像搜索](https://cloud.tencent.com/document/product/1589) 产品文档中查看更多产品信息。UpdateImageResponse
TiiaClient. UpdateImage(UpdateImageRequest req)
本接口支持根据图库ID、物品ID、图片名称来修改图片信息(暂仅支持修改Tags) > - 可前往 [图像搜索](https://cloud.tencent.com/document/product/1589) 产品文档中查看更多产品信息。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tione.v20191022
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tione.v20211111
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tiw.v20190919
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tke.v20180525
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tkgdq.v20190411
Methods in com.tencentcloudapi.tkgdq.v20190411 that throw TencentCloudSDKException Modifier and Type Method Description DescribeEntityResponse
TkgdqClient. DescribeEntity(DescribeEntityRequest req)
输入实体名称,返回实体相关的信息如实体别名、实体英文名、实体详细信息、相关实体等DescribeRelationResponse
TkgdqClient. DescribeRelation(DescribeRelationRequest req)
输入两个实体,返回两个实体间的关系,例如马化腾与腾讯公司不仅是相关实体,二者还存在隶属关系(马化腾属于腾讯公司)。DescribeTripleResponse
TkgdqClient. DescribeTriple(DescribeTripleRequest req)
三元组查询,主要分为两类,SP查询和PO查询。SP查询表示已知主语和谓语查询宾语,PO查询表示已知宾语和谓语查询主语。每一个SP或PO查询都是一个可独立执行的查询,TQL支持SP查询的嵌套查询,即主语可以是一个嵌套的子查询。其他复杂的三元组查询方法,请参考官网API文档示例。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tms.v20200713
Methods in com.tencentcloudapi.tms.v20200713 that throw TencentCloudSDKException Modifier and Type Method Description AccountTipoffAccessResponse
TmsClient. AccountTipoffAccess(AccountTipoffAccessRequest req)
举报恶意账号DescribeTextLibResponse
TmsClient. DescribeTextLib(DescribeTextLibRequest req)
控制台获取用户词库列表DescribeTextStatResponse
TmsClient. DescribeTextStat(DescribeTextStatRequest req)
控制台识别统计TextModerationResponse
TmsClient. TextModeration(TextModerationRequest req)
文本内容检测(Text Moderation)服务使用了深度学习技术,识别可能令人反感、不安全或不适宜的文本内容,同时支持用户配置词库黑白名单,打击自定义识别类型的图片。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tms.v20201229
Methods in com.tencentcloudapi.tms.v20201229 that throw TencentCloudSDKException Modifier and Type Method Description TextModerationResponse
TmsClient. TextModeration(TextModerationRequest req)
本接口(Text Moderation)用于提交文本内容进行智能审核任务。使用前请您使用腾讯云主账号登录控制台 [开通文本内容安全服务](https://console.cloud.tencent.com/cms/text/package) 并调整好对应的业务配置。 ### 接口使用说明 - 前往“[内容安全控制台-文本内容安全](https://console.cloud.tencent.com/cms/text/package)”开启使用文本内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含**1万条**文本识别额度,有效期为1个月。 - 该接口为收费接口,计费方式敬请参见 [腾讯云文本内容安全定价](https://cloud.tencent.com/product/tms/pricing)。 ### 接口功能说明: - 支持对文本文件进行检测,通过深度学习技术,识别可能令人反感、不安全或不适宜的违规文本内容; - 支持识别多种违规场景,包括:低俗、谩骂、色情、广告等场景; - 支持根据不同的业务场景配置自定义的审核策略,可在控制台文本内容安全-策略管理中配置; - 支持用户自定义配置词库黑白名单,打击自定义识别类型的违规文本(目前仅支持黑名单配置); - 支持在审核文本内容时同时关联账号或设备信息,可识别违规风险账号或设备。 ### 接口调用说明: - 文本内容大小支持:文本原文长度不能超过unicode编码长度10000个字符; - 文本审核语言支持:目前支持中文、英文、阿拉伯数字的检测; - 默认接口请求频率限制:**1000次/秒**,超过该频率限制则接口会报错。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tmt.v20180321
Methods in com.tencentcloudapi.tmt.v20180321 that throw TencentCloudSDKException Modifier and Type Method Description FileTranslateResponse
TmtClient. FileTranslate(FileTranslateRequest req)
提交文档原文内容,输出任务ID, 支持原文为单一语种文档(如出现多语言文档,仅支持以选定的源语言相关内容翻译),文件格式有pdf、docx、pptx、xlsx,支持的文本格式有txt、xml、html、markdown、properties。任务翻译数据可保存7天,7天后不再返回任务数据。请注意保存。GetFileTranslateResponse
TmtClient. GetFileTranslate(GetFileTranslateRequest req)
在调用文档翻译请求接口后,有回调和轮询两种方式获取识别结果。 •当采用回调方式时,翻译完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL,具体请参见文档翻译结果回调。 • 当采用轮询方式时,需要主动提交任务ID来轮询识别结果,共有任务成功、等待、执行中和失败四种结果,具体信息请参见参数说明。ImageTranslateResponse
TmtClient. ImageTranslate(ImageTranslateRequest req)
提供13种语言的图片翻译服务,可自动识别图片中的文本内容并翻译成目标语言,识别后的文本按行翻译,后续会提供可按段落翻译的版本。
提示:对于一般开发者,我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5.LanguageDetectResponse
TmtClient. LanguageDetect(LanguageDetectRequest req)
可自动识别文本内容的语言种类,轻量高效,无需额外实现判断方式,使面向客户的服务体验更佳。
提示:对于一般开发者,我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5.SpeechTranslateResponse
TmtClient. SpeechTranslate(SpeechTranslateRequest req)
本接口提供上传音频,将音频进行语音识别并翻译成文本的服务,目前开放中英互译的语音翻译服务。 待识别和翻译的音频文件可以是 pcm、mp3和speex 格式,pcm采样率要求16kHz、位深16bit、单声道,音频内语音清晰。
如果采用流式传输的方式,要求每个分片时长200ms~500ms;如果采用非流式的传输方式,要求音频时长不超过8s。注意最后一个分片的IsEnd参数设置为1。
提示:对于一般开发者,我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5.TextTranslateResponse
TmtClient. TextTranslate(TextTranslateRequest req)
提供中文到英文、英文到中文的等多种语言的文本内容翻译服务, 经过大数据语料库、多种解码算法、翻译引擎深度优化,在新闻文章、生活口语等不同语言场景中都有深厚积累,翻译结果专业评价处于行业领先水平。
提示:对于一般开发者,我们建议优先使用SDK接入简化开发。SDK使用介绍请直接查看 5.TextTranslateBatchResponse
TmtClient. TextTranslateBatch(TextTranslateBatchRequest req)
文本翻译的批量接口 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tourism.v20230215
Methods in com.tencentcloudapi.tourism.v20230215 that throw TencentCloudSDKException Modifier and Type Method Description DescribeDrawResourceListResponse
TourismClient. DescribeDrawResourceList(DescribeDrawResourceListRequest req)
依据客户的Uin查询开通的资源列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.trdp.v20220726
Methods in com.tencentcloudapi.trdp.v20220726 that throw TencentCloudSDKException Modifier and Type Method Description EvaluateUserRiskResponse
TrdpClient. EvaluateUserRisk(EvaluateUserRiskRequest req)
用户风险质量接口 -
Uses of TencentCloudSDKException in com.tencentcloudapi.trocket.v20230308
-
Uses of TencentCloudSDKException in com.tencentcloudapi.trp.v20210515
-
Uses of TencentCloudSDKException in com.tencentcloudapi.trro.v20220325
-
Uses of TencentCloudSDKException in com.tencentcloudapi.trtc.v20190722
Methods in com.tencentcloudapi.trtc.v20190722 that throw TencentCloudSDKException Modifier and Type Method Description CreateCloudRecordingResponse
TrtcClient. CreateCloudRecording(CreateCloudRecordingRequest req)
接口说明: 启动云端录制功能,完成房间内的音视频录制,并上传到指定的云存储。您可以通过此 API 接口把TRTC 房间中的每一路音视频流做单独的录制又或者多路视频画面混流一路。 您可以通过此接口实现如下目标: 指定订阅流参数(RecordParams)来指定需要录制的主播的黑名单或者白名单。 指定第三方存储的参数(StorageParams)来指定上传到您希望的云存储,目前支持云点播VOD和对象存储COS 指定混流模式下的音视频转码详细参数(MixTranscodeParams),包括视频分辨率、视频码率、视频帧率、以及声音质量等 指定混流模式各路画面的位置和布局或者也可以指定自动模板的方式来配置。 关键名词: 单流录制:分别录制房间的订阅UserId的音频和视频,录制服务会实时将录制文件上传至您指定的云存储。 合流录制:将房间内订阅UserId的音视频混录成一个视频文件,并将录制文件上传至您指定的云存储。(录制结束后可前往云点播控制台https://console.cloud.tencent.com/vod/media 或 对象存储COS控制台https://console.cloud.tencent.com/cos/bucket查看文件)。CreatePictureResponse
TrtcClient. CreatePicture(CreatePictureRequest req)
如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。DeleteCloudRecordingResponse
TrtcClient. DeleteCloudRecording(DeleteCloudRecordingRequest req)
成功开启录制后,可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成,如果未完成后台将会继续上传文件,成功后通过事件回调通知客户文件全部传输完成状态。DeletePictureResponse
TrtcClient. DeletePicture(DeletePictureRequest req)
如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。DescribeCallDetailInfoResponse
TrtcClient. DescribeCallDetailInfo(DescribeCallDetailInfoRequest req)
查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。(同老接口DescribeCallDetail) 注意**: 1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。 2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735DescribeCloudRecordingResponse
TrtcClient. DescribeCloudRecording(DescribeCloudRecordingRequest req)
成功开启录制后,可以使用此接口来查询录制状态。仅在录制任务进行时有效,录制退出后查询将会返回错误。 录制文件上传到云点播VOD时,StorageFileList中不会返回录制文件信息,请订阅相关录制文件回调事件,获取录制文件信息。DescribeMixTranscodingUsageResponse
TrtcClient. DescribeMixTranscodingUsage(DescribeMixTranscodingUsageRequest req)
获取TRTC混流转码的用量明细。 - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。 - 默认接口请求频率限制:5次/秒。DescribePictureResponse
TrtcClient. DescribePicture(DescribePictureRequest req)
如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。DescribeRecordingUsageResponse
TrtcClient. DescribeRecordingUsage(DescribeRecordingUsageRequest req)
获取TRTC录制的用量明细。 - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。 - 默认接口请求频率限制:5次/秒。DescribeRecordStatisticResponse
TrtcClient. DescribeRecordStatistic(DescribeRecordStatisticRequest req)
查询云端录制计费时长。 - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。DescribeRelayUsageResponse
TrtcClient. DescribeRelayUsage(DescribeRelayUsageRequest req)
获取TRTC旁路转推的用量明细。 - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。 - 默认接口请求频率限制:5次/秒。DescribeRoomInfoResponse
TrtcClient. DescribeRoomInfo(DescribeRoomInfoRequest req)
查询SdkAppId下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。(同老接口DescribeRoomInformation) 注意**: 1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。 2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735DescribeScaleInfoResponse
TrtcClient. DescribeScaleInfo(DescribeScaleInfoRequest req)
可查询SdkAppId每天的房间数和用户数,按天统计,可查询最近14天的数据。当天未结束,数据未统计完成,无法查到当天的房间数与用户数。(同老接口DescribeHistoryScale)DescribeTRTCMarketQualityDataResponse
TrtcClient. DescribeTRTCMarketQualityData(DescribeTRTCMarketQualityDataRequest req)
查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标) joinSuccessRate:加入频道成功率。 joinSuccessIn5sRate:5s内加入频道成功率。 audioFreezeRate:音频卡顿率。 videoFreezeRate:视频卡顿率。 networkDelay :网络延迟率。 注意: 1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。 2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。DescribeTRTCMarketQualityMetricDataResponse
TrtcClient. DescribeTRTCMarketQualityMetricData(DescribeTRTCMarketQualityMetricDataRequest req)
查询TRTC监控仪表盘-数据大盘质量指标(包括下列指标) joinSuccessRate:加入频道成功率。 joinSuccessIn5sRate:5s内加入频道成功率。 audioFreezeRate:音频卡顿率。 videoFreezeRate:视频卡顿率。 networkDelay :网络延迟率。 注意: 1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。 2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。DescribeTRTCMarketScaleDataResponse
TrtcClient. DescribeTRTCMarketScaleData(DescribeTRTCMarketScaleDataRequest req)
查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数) userCount:通话人数, roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。 peakCurrentChannels:峰值同时在线频道数。 peakCurrentUsers:峰值同时在线人数。 注意: 1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。 2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。DescribeTRTCMarketScaleMetricDataResponse
TrtcClient. DescribeTRTCMarketScaleMetricData(DescribeTRTCMarketScaleMetricDataRequest req)
查询TRTC监控仪表盘-数据大盘规模指标(会返回通话人数,通话房间数,峰值同时在线人数,峰值同时在线频道数) userCount:通话人数, roomCount:通话房间数,从有用户加入频道到所有用户离开频道计为一个通话频道。 peakCurrentChannels:峰值同时在线频道数。 peakCurrentUsers:峰值同时在线人数。 注意: 1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。 2.查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天。DescribeTrtcMcuTranscodeTimeResponse
TrtcClient. DescribeTrtcMcuTranscodeTime(DescribeTrtcMcuTranscodeTimeRequest req)
查询旁路转码计费时长。 - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。DescribeTRTCRealTimeQualityDataResponse
TrtcClient. DescribeTRTCRealTimeQualityData(DescribeTRTCRealTimeQualityDataRequest req)
查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标) -视频卡顿率 -音频卡顿率 注意: 1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。 2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。DescribeTRTCRealTimeQualityMetricDataResponse
TrtcClient. DescribeTRTCRealTimeQualityMetricData(DescribeTRTCRealTimeQualityMetricDataRequest req)
查询TRTC监控仪表盘-实时监控质量指标(会返回下列指标) -视频卡顿率 -音频卡顿率 注意: 1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。 2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。DescribeTRTCRealTimeScaleDataResponse
TrtcClient. DescribeTRTCRealTimeScaleData(DescribeTRTCRealTimeScaleDataRequest req)
查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标) -userCount(在线用户数) -roomCount(在线房间数) 注意: 1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。 2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。 xa0 3.除此之外您也可以通过订阅TRTC包月套餐(https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口的调用能力,请在开通包月套餐后,请提交工单联系售后解锁调用能力https://console.cloud.tencent.com/workorder/categoryDescribeTRTCRealTimeScaleMetricDataResponse
TrtcClient. DescribeTRTCRealTimeScaleMetricData(DescribeTRTCRealTimeScaleMetricDataRequest req)
查询TRTC监控仪表盘-实时监控规模指标(会返回下列指标) -userCount(在线用户数) -roomCount(在线房间数) 注意: 1.调用接口需开通监控仪表盘【基础版】和【进阶版】,监控仪表盘【免费版】不支持调用,监控仪表盘版本功能和计费说明:https://cloud.tencent.com/document/product/647/81331。 2.查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时。 xa0 3.除此之外您也可以通过订阅TRTC包月套餐(https://buy.cloud.tencent.com/trtc)尊享版或旗舰版解锁此接口(DescribeTRTCRealTimeScaleMetricData)的调用能力,请在开通包月套餐后,请提交工单联系售后解锁调用能力https://console.cloud.tencent.com/workorder/categoryDescribeTrtcRoomUsageResponse
TrtcClient. DescribeTrtcRoomUsage(DescribeTrtcRoomUsageRequest req)
查询TRTC音视频房间维度用量。 - 单次只能查询一天数据,返回查询时间段内的汇总数据;通过多次查询可以查不同天数据。若查询跨天用量,由于统计延迟等原因,返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用,不可用于账单核对,如需对账请使用账号/应用维度用量API:DescribeTrtcUsage。 - 默认接口请求频率限制:1次/15秒。 - 数据最早可查日期为2023年4月1日0点,最大可查范围近3个月。DescribeTrtcUsageResponse
TrtcClient. DescribeTrtcUsage(DescribeTrtcUsageRequest req)
获取TRTC音视频互动的用量明细。 - 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 - 单次查询统计区间最多不能超过31天。 - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 - 该接口只用于历史用量数据统计或核对数据使用,关键业务逻辑不能使用。 - 默认接口请求频率限制:5次/秒。DescribeUnusualEventResponse
TrtcClient. DescribeUnusualEvent(DescribeUnusualEventRequest req)
查询SdkAppId下任意20条异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询14天内数据,查询起止时间不超过1个小时。支持跨天查询。(同老接口DescribeAbnormalEvent) 异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916DescribeUserEventResponse
TrtcClient. DescribeUserEvent(DescribeUserEventRequest req)
查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。(同接口DescribeDetailEvent)DescribeUserInfoResponse
TrtcClient. DescribeUserInfo(DescribeUserInfoRequest req)
查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。(同老接口DescribeUserInformation) 注意**: 1.该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。 2.该接口目前免费提供中,监控仪表盘商业化计费后该接口需要订阅付费版后方可调用,仪表盘商业化说明请见:https://cloud.tencent.com/document/product/647/77735DismissRoomResponse
TrtcClient. DismissRoom(DismissRoomRequest req)
接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。DismissRoomByStrRoomIdResponse
TrtcClient. DismissRoomByStrRoomId(DismissRoomByStrRoomIdRequest req)
接口说明:把房间所有用户从房间移出,解散房间。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。ModifyCloudRecordingResponse
TrtcClient. ModifyCloudRecording(ModifyCloudRecordingRequest req)
成功开启录制后,可以使用此接口来更新录制任务。仅在录制任务进行时有效,录制退出后更新将会返回错误。更新操作是全量覆盖,并不是增量更新的模式,也就是说每次更新都需要携带全量的信息。ModifyPictureResponse
TrtcClient. ModifyPicture(ModifyPictureRequest req)
如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。RemoveUserResponse
TrtcClient. RemoveUser(RemoveUserRequest req)
接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。RemoveUserByStrRoomIdResponse
TrtcClient. RemoveUserByStrRoomId(RemoveUserByStrRoomIdRequest req)
接口说明:将用户从房间移出,适用于主播/房主/管理员踢人等场景。支持所有平台,Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。StartMCUMixTranscodeResponse
TrtcClient. StartMCUMixTranscode(StartMCUMixTranscodeRequest req)
接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。 TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。 您可以通过此接口实现如下目标: - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。 - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。 - 设置录制文件名,用于二次回放。 - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。 目前已经支持了如下几种布局模板: - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。 - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。 - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。 - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。 - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会为该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。 注意: 1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。** 2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。 3、客户端混流和服务端混流不能混用。StartMCUMixTranscodeByStrRoomIdResponse
TrtcClient. StartMCUMixTranscodeByStrRoomId(StartMCUMixTranscodeByStrRoomIdRequest req)
接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。 TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。 您可以通过此接口实现如下目标: - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。 - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。 - 设置录制文件名,用于二次回放。 - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。 目前已经支持了如下几种布局模板: - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。 - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。 - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。 - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。 - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会为该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。 注意: 1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。** 2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。 3、客户端混流和服务端混流不能混用。StartPublishCdnStreamResponse
TrtcClient. StartPublishCdnStream(StartPublishCdnStreamRequest req)
TRTC房间中可能会同时存在多路音视频流,您可以通过混流转推API,通知腾讯云服务端将同个房间或者多个房间的多路视频画面混合到一起,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看,同时可以支持将这一路音视频的混流回推到TRTC房间内部。 云api混流转推功能包含三个接口: 1、StartPublishCdnStream:启动一个混流转推任务,此接口会发起一个新的混流转推任务,启动成功后会返回一个sdkappid维度唯一的任务id(TaskId)。您需要保存该TaskId,后续需要依赖此TaskId更新任务和结束任务。 2、UpdatePublishCdnStream:更新指定的混流转推任务,包括:更新视频画面的布局、更新混音列表、更新转推cdn的地址列表以及更新回推房间列表。 3、StopPublishCdnStream:停止指定的混流转推任务。 您可以通过此套接口实现目标: 1、设置最终混流的画质和音质,包括视频分辨率、视频帧率、视频码率,和音频质量。 2、设置每一路画面的布局位置,您只需要设置一次,后续您指定的混流用户进房上行音视频时,排版引擎会自动将该用户的画面混合到您指定的布局位置。同时您可以使用更新接口调整画面的布局位置。 3、设置多个cdn转推的目的地址,一个转推任务最多可以同时设置10个cdn转推地址,如果您需要转推非腾讯云的cdn地址时,需要联系腾讯云开通能力。 4、设置多个回推房间列表,一个转推任务最多可以同时将混流回推到10个TRTC房间。 目前已经支持如下几种布局模版,其中动态布局模版(悬浮模板、九宫格模板、屏幕分享模板)只支持单个TRTC房间,自定义模版支持混合多个TRTC房间内的音视频流。具体说明如下: 1、悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频默认不占布局配置,也支持设置。每个子画面默认采用居中裁剪的方式进行渲染,也支持统一设置子画面的渲染方式。 2、九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,默认不占布局配置,也支持设置。每个子画面默认采用居中裁剪的方式进行渲染,也支持统一设置子画面的渲染方式。 3、屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,需要您明确设置占据大画面的混流用户信息。其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理,也支持统一设置子画面的渲染方式。 4、自定义布局模版:支持您主动根据业务需要设置布局位置,每个预设的布局位置支持具名设置(具名设置需要明确指定房间号和用户名)和不具名设置。当一个子画面具名设置时,该位置就为该用户预留,用户进房且上行音视频数据时会自动占据该位置,其它用户不会占据该位置。当预设的布局位置未具名时,排版引擎会根据进房间顺序自动填充,预设位置填满时,不再混合其它用户的画面和声音。每个子画面位置支持设置占位图(BackgroundImageUrl),当用户未进房或者只上行音频数据时,该位置画面可显示对应的占位图画面。 您可以控制台开通旁路转推回调功能实现转推cdn状态的事件监控,具体说明请参考官网文档:[旁路转推回调说明](https://cloud.tencent.com/document/product/647/88552) 您使用转推api时根据使用特性可能会产生如下费用: MCU混流转码费用请参考文档:[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446) 转推非腾讯云CDN费用请参考文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155) 参数的使用说明: 1、AgentParams:每个转推任务会拉起一个机器人用户进入TRTC房间进行拉流,您需要通过AgentParams.UserId参数进行设置,这个机器人id不能和房间中的普通用户id冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。您可以通过设置AgentParams.MaxIdleTime控制转推任务的自动结束,当设置此参数时,所有参与混流转推的主播持续离开TRTC房间超过MaxIdleTime的时长,自动停止转推任务。注意:参与混流转推的主播仅是停止音视频上行,转推任务不会自动停止。 2、WithTranscoding:如果需要将多路音视频流混合到一路时,WithTranscoding必须设置为1。 3、AudioParams:转推任务音频参数和视频参数是分开设置的,若您想要将指定的用户音频进行混音时,需要明确设置AudioParams.SubscribeAudioList。若您不设置AudioParams.SubscribeAudioList,混音引擎会自动将TRTC房间中所有用户的音频混合。若您想要混合TRTC房间除指定用户之外的所有用户的声音,可以通过AudioParams.UnSubscribeAudioList设置音频黑名单列表。 4、VideoParams:若您想要将用户的视频混合,可以通过VideoParams设置,若只想要混纯音频,则不用设置VideoParams参数。您可以通过VideoParams.LayoutParams.MixLayoutMode设置画面的布局模式,包括:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局)和自定义布局。动态布局模式由排版引擎按照固定的布局自动混合,不需要设置VideoParams.LayoutParams.MixLayoutList。当使用悬浮布局和屏幕分享布局时,您可以通过设置VideoParams.LayoutParams.MaxVideoUser参数指定大画面用户。自定义布局模式提供给您自主布局画面的能力,可以通过VideoParams.LayoutParams.MixLayoutList参数指定每个用户所在的布局位置。在每个布局参数中,您可以通过用户媒体流参数(UserMediaStream)指定这个布局位置为指定的用户预留,也可以不设置UserMediaStream,由排版引擎按照用户进入TRTC房间的顺序自动填充,另外您也可以设置每个布局位置的渲染方式(RenderMode)和裁剪方式(CustomCrop)。 5、VideoParams.WaterMarkList:若您想要混流画面中叠加水印,可以通过VideoParams.WaterMarkList参数设置,支持图片水印和文字水印,支持透明通道。 6、SingleSubscribeParams:若您想要将TRTC房间中的一路单流推到CDN,可以使用SingleSubscribeParams参数设置,此时需要将WithTranscoding参数设置为0。 7、PublishCdnParams.N:若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1;若您有转推非腾讯云CDN的需求时,请联系腾讯云技术支持开通,转推非腾讯云会产生转推费用,费用说明请参考官网文档:[云端转推计费说明](https://cloud.tencent.com/document/product/647/82155)。 8、FeedBackRoomParams.N:若您想要将混合的音视频流回推到TRTC房间,可以使用FeedBackRoomParams.N参数设置,支持最多同时推10路流回TRTC房间。您需要指定回推的TRTC房间号和机器人ID(UserId),机器人ID不能与普通用户ID冲突,否则会导致转推任务由于机器人用户被踢出TRTC房间而异常结束,您可以通过增加特殊前缀的方式规避。 9、SeiParams:若您想要混合的音视频流中增加SEI信息时,可以使用SeiParams参数设置,支持音量布局SEI和叠加转推请求中的SEI,其中音量布局SEI的内容是固定的json结构,具体请看本章节后续的SEI说明。您可以通过FollowIdr参数设置SEI跟随关键帧一起发送。音量布局sei的说明如下: 如果您的CDN观众端需要识别到参与混流的主播位置,以及需要识别到参与混流的主播的音量信息,可以通过音量布局sei实现。音量布局sei的payload内容及参数说明如下: ``` { "app_data":"", "canvas":{ "w":1080, "h":960 }, "regions":[ { "uid":"65949987242835883c", "zorder":2, "volume":45, "x":270, "y":480, "w":540, "h":480 }, { "uid":"659c9d8d242b328d31", "zorder":2, "volume":0, "x":0, "y":0, "w":540, "h":480 }, { "uid":"64989a82272b308c", "zorder":2, "volume":91, "x":540, "y":0, "w":540, "h":480 } ], "ver":"1.0", "ts":1648544726 } ``` canvas:这个是混流信令中VideoEncode设置的宽高,即:混流输出的整个画布宽高。 regions:里面是真实混入的用户id和对应的子画面位置,若参与混流的用户未进入TRTC房间或者未开启视频上行,regions中不会包含该用户。 uid:代表参与混流的用户ID。 zorder:参与混流userid在混流输出的层级。 x/y:参与混流userid的子画面在画布的坐标。 w/h:参与混流userid的子画面的大小。 volume:代表混流用户的音量,取值范围为0-100,值越大,代表该用户参与混流时的音量越大。 ts:是输出sei的服务器本地秒级时戳。 ver:可以忽略。 其它使用注意事项: 1、使用混流转推接口时,您需要先调用启动转推任务接口(StartPublishCdnStream),获取启动转推任务响应中的任务ID标识(TaskId)。后续传入任务ID标识(TaskId)来更新转推任务(UpdatePublishCdnStream)和停止转推任务(StopPublishCdnStream)。 2、转推API不支持发起到TRTC控制台配置的自动旁路任务,以及通过TRTC SDK进房接口中设置的自定义流ID的旁路任务。 3、为了确保转推链接的稳定,同一个转推任务不支持纯音频、音视频、纯视频之间的切换。 4、为了确保转推链接的稳定,不支持update时更新视频参数(codec)和音频参数(codec、采样率、码率、声道数)。 5、发起单流旁路任务时,AudioParams和VideoParams都填写表示音视频旁路,如果仅填写AudioParams表示纯音频旁路,任务进行过程中不支持纯音频到音视频的切换。音视频旁路时,VideoParams中的Width、Height、Fps、BitRate、Gop需要按照真实上行参数填写。 6、更新请求中必须携带SequenceNumber参数,用于防止请求乱序。客户保证对同一个任务更新时的SequenceNumber参数递增,否则会导致混流任务更新失败。 7、调用api时region选择说明:如果应用id是1400xxx时,region可填北京、上海、广州、香港,如果您的cdn观众主要在海外,请选择香港;如果应用id是200xxx或400xxx时,region请选择新加坡。 8、回推到TRTC房间的流不会参与其他回推房间任务的混流,满足下面条件之一时,可以参与其他转推cdn任务的混流: (1) 转推cdn任务在视频参数中通过具名方式指定推流机器人参与混流;(2) 转推cdn任务在音频参数中通过白名单方式指定推流机器人参与混流;(3) 转推cdn任务参与混流用户的房间号与回推机器人对应混流用户的房间号完全不同。 9、您可以在主播进房前,提前创建转推任务,结束转推任务时需要主动调用停止接口。如果您没有调用停止转推任务接口时,腾讯云后台会按照所有参与混流的用户没有任何数据上行的时间算起,直到超过启动转推任务时设置的超时时间(AgentParams.MaxIdleTime)为止,自动停止混流转推任务。StopMCUMixTranscodeResponse
TrtcClient. StopMCUMixTranscode(StopMCUMixTranscodeRequest req)
接口说明:结束云端混流StopMCUMixTranscodeByStrRoomIdResponse
TrtcClient. StopMCUMixTranscodeByStrRoomId(StopMCUMixTranscodeByStrRoomIdRequest req)
接口说明:结束云端混流StopPublishCdnStreamResponse
TrtcClient. StopPublishCdnStream(StopPublishCdnStreamRequest req)
停止转推任务。UpdatePublishCdnStreamResponse
TrtcClient. UpdatePublishCdnStream(UpdatePublishCdnStreamRequest req)
更新转推任务。 注:请参见启动转推任务的接口说明和使用说明。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tse.v20201207
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tsf.v20180326
-
Uses of TencentCloudSDKException in com.tencentcloudapi.tsw.v20200924
Methods in com.tencentcloudapi.tsw.v20200924 that throw TencentCloudSDKException Modifier and Type Method Description DescribeAgentShellResponse
TswClient. DescribeAgentShell(DescribeAgentShellRequest req)
获取服务接入信息 -
Uses of TencentCloudSDKException in com.tencentcloudapi.tsw.v20210412
Methods in com.tencentcloudapi.tsw.v20210412 that throw TencentCloudSDKException Modifier and Type Method Description DescribeComponentAlertObjectResponse
TswClient. DescribeComponentAlertObject(DescribeComponentAlertObjectRequest req)
获取告警对象-组件告警DescribeServiceAlertObjectResponse
TswClient. DescribeServiceAlertObject(DescribeServiceAlertObjectRequest req)
获取告警对象-服务告警表DescribeTokenResponse
TswClient. DescribeToken(DescribeTokenRequest req)
查询token -
Uses of TencentCloudSDKException in com.tencentcloudapi.tts.v20190823
Methods in com.tencentcloudapi.tts.v20190823 that throw TencentCloudSDKException Modifier and Type Method Description CreateTtsTaskResponse
TtsClient. CreateTtsTask(CreateTtsTaskRequest req)
本接口服务对10万字符以内的文本进行语音合成,异步返回音频结果。满足一次性合成较长文本的客户需求,如阅读播报、新闻媒体等场景。 支持音频格式:mp3,wav,pcm 支持音频采样率:16000 Hz, 8000 Hz 支持中文普通话、英文、中英文混读、粤语合成 支持语速、音量设置 支持回调或轮询的方式获取结果,结果获取请参考 长文本语音合成结果查询。 提交长文本语音合成请求后,合成结果在3小时内完成,音频文件在服务端可保存24小时DescribeTtsTaskStatusResponse
TtsClient. DescribeTtsTaskStatus(DescribeTtsTaskStatusRequest req)
在调用长文本语音合成请求接口后,有回调和轮询两种方式获取识别结果。 当采用回调方式时,合成完毕后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL,具体请参见 长文本语音合成结果查询 。 当采用轮询方式时,需要主动提交任务ID来轮询识别结果,共有任务成功、等待、执行中和失败四种结果,具体信息请参见下文说明。TextToVoiceResponse
TtsClient. TextToVoice(TextToVoiceRequest req)
腾讯云语音合成技术(TTS)可以将任意文本转化为语音,实现让机器和应用张口说话。 腾讯TTS技术可以应用到很多场景,比如,移动APP语音播报新闻;智能设备语音提醒;依靠网上现有节目或少量录音,快速合成明星语音,降低邀约成本;支持车载导航语音合成的个性化语音播报。 基础合成支持 SSML,语法详见 [SSML 标记语言](https://cloud.tencent.com/document/product/1073/49575)。 默认接口请求频率限制:20次/秒。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.ump.v20200918
-
Uses of TencentCloudSDKException in com.tencentcloudapi.vm.v20200709
Methods in com.tencentcloudapi.vm.v20200709 that throw TencentCloudSDKException Modifier and Type Method Description CancelTaskResponse
VmClient. CancelTask(CancelTaskRequest req)
取消任务CreateBizConfigResponse
VmClient. CreateBizConfig(CreateBizConfigRequest req)
创建业务配置,1个账号最多可以创建20个配置,可定义音频审核的场景,如色情、谩骂等, 在创建业务配置之前,你需要以下步骤: 1.CreateVideoModerationTaskResponse
VmClient. CreateVideoModerationTask(CreateVideoModerationTaskRequest req)
通过URL或存储桶创建审核任务DescribeTaskDetailResponse
VmClient. DescribeTaskDetail(DescribeTaskDetailRequest req)
查看任务详情DescribeTaskDetailDescribeVideoStatResponse
VmClient. DescribeVideoStat(DescribeVideoStatRequest req)
控制台识别统计 -
Uses of TencentCloudSDKException in com.tencentcloudapi.vm.v20201229
Methods in com.tencentcloudapi.vm.v20201229 that throw TencentCloudSDKException Modifier and Type Method Description CancelTaskResponse
VmClient. CancelTask(CancelTaskRequest req)
可使用该接口取消审核任务,成功取消后,该接口返回已取消任务的TaskId。
默认接口请求频率限制:**20次/秒**。CreateVideoModerationTaskResponse
VmClient. CreateVideoModerationTask(CreateVideoModerationTaskRequest req)
本接口(Video Moderation System,VM)用于提交视频文件或视频流进行智能审核任务。使用前请您使用腾讯云主账号登录控制台[开通视频内容安全服务](https://console.cloud.tencent.com/cms)并调整好对应的业务配置。
### 功能使用说明: - 前往“[内容安全控制台-视频内容安全](https://console.cloud.tencent.com/cms)”开启使用视频内容安全服务,首次开通服务的用户可免费领用试用套餐包,包含200分钟的处理量(换算1s每帧截图,赠送**12000张图**、**200分钟的音频**处理量),有效期为15天。 - 该接口为收费接口,计费方式敬请参见[腾讯云视频内容安全定价](https://cloud.tencent.com/product/vm/pricing)。 - 默认接口请求频率限制:**20次/秒**,对于异步审核任务(点播视频),超出频率限制的请求会自动排入待审核队列,对于同步审核任务(直播视频),超出频率限制将会报错。 - 默认并发审核路数限制:点播默认10路,异步审核任务(点播视频)数量超过并发审核路数时,将会进入排队;直播默认100路,同步审核任务(直播视频)超过并发审核路数,接口会返回错误。 ### 接口功能说明: - 支持对视频文件或视频流进行自动检测,从 OCR文本识别、物体检测(实体、广告台标、二维码等)、图像识别及音频审核四个维度,通过深度学习技术识别视频中的违规内容; - 支持设置回调地址 Callback 获取检测结果,或通过接口(查看任务详情)主动轮询获取检测结果详情;对于正常审核中的视频任务,如含有违规内容,则截帧图片最长会在**3s**内回调,音频片段会在用户配置的**切片时长 + 2s**内回调;对于在队列中的待审核任务,回调时间为正常审核回调时间+等待时间; - 支持通过接口(查看审核任务列表)查询任务队列,用户可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表; - 支持识别多种违规场景,包括:低俗、谩骂、色情、广告等场景; - 支持根据不同的业务场景配置自定义的审核策略; - 支持用户自定义配置黑白词库及图片库,打击自定义违规内容(目前仅支持黑名单配置); - 支持用户自定义配置审核任务优先级,当有多个任务排队时,可根据用户配置自动调整任务优先级; - 支持批量提交检测任务,**最多可同时创建10个任务**; ### 视频文件调用说明: - 视频文件大小支持:**4K视频文件 < 10GB**;**低于4K视频文件 < 5GB** - 视频文件分辨率支持:**最佳分辨率为1920x1080 (1080p)**,如果视频文件小于300MB,则分辨率可以大于1080p,分辨率最大支持4K,更大视频可以调用[云转码服务](https://cloud.tencent.com/product/mps/details)转码后再送审; - 视频文件支持格式:flv、mkv 、mp4 、rmvb 、avi 、wmv、3gp、ts、mov、rm、mpeg、wmf等。 - 视频文件支持的访问方式:链接地址(支持HTTP/HTTPS)、腾讯云COS存储; - 若传入视频文件的访问链接,则需要注意视频**头文件的读取时间限制为3秒**,为保障被检测视频的稳定性和可靠性,建议您使用腾讯云COS存储或者CDN缓存等; - 支持用户配置是否需要开启音频审核,若不开启则将仅对视频文件图像内容进行审核。 ### 视频流调用说明: - 视频流时长支持:**8小时以内** - 视频流分辨率支持:支持**1920x1080 (1080p)**,更高分辨率视频可以调用[直播云转码服务](https://cloud.tencent.com/document/product/267/39889)转码后再送审; - 视频流支持格式:rmtp,flv 等主流视频流编码格式。 - 视频文件支持的传输协议:HTTP/HTTPS/RTMP; - 支持用户配置是否需要开启音频审核,若不开启则将仅对视频流图像内容进行审核。DescribeTaskDetailResponse
VmClient. DescribeTaskDetail(DescribeTaskDetailRequest req)
通过查看任务详情 DescribeTaskDetail 接口,可主动轮询获取检测结果详情。
默认接口请求频率限制:**200次/秒**。DescribeTasksResponse
VmClient. DescribeTasks(DescribeTasksRequest req)
通过查看审核任务列表接口,可查询任务队列;您可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表。
默认接口请求频率限制:**20次/秒**。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.vm.v20210922
Methods in com.tencentcloudapi.vm.v20210922 that throw TencentCloudSDKException Modifier and Type Method Description CancelTaskResponse
VmClient. CancelTask(CancelTaskRequest req)
取消任务CreateVideoModerationTaskResponse
VmClient. CreateVideoModerationTask(CreateVideoModerationTaskRequest req)
通过URL或存储桶创建审核任务。 ### 直播断流处理说明: - 请确认已对接[取消任务](https://cloud.tencent.com/document/product/1265/80018)。 - 如果直播任务取消/结束,则终止直播拉流并退出审核。 - 如果直播任务没有取消/结束,直播视频推流因故中断,产品将在将在10分钟内持续拉流重试。如果10分钟检测到图片截帧/音频切片数据,则恢复正常审核,反之,则终止拉流并退出审核。在拉流终止后,用户如有审核需求,需重新送审。 默认接口请求频率限制:20次/秒。DescribeTaskDetailResponse
VmClient. DescribeTaskDetail(DescribeTaskDetailRequest req)
查看任务详情DescribeTaskDetailDescribeTasksResponse
VmClient. DescribeTasks(DescribeTasksRequest req)
通过查看审核任务列表接口,可查询任务队列;您可根据多种业务信息(业务类型、审核结果、任务状态等)筛选审核任务列表。
默认接口请求频率限制:**20次/秒**。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.vms.v20200902
Methods in com.tencentcloudapi.vms.v20200902 that throw TencentCloudSDKException Modifier and Type Method Description SendCodeVoiceResponse
VmsClient. SendCodeVoice(SendCodeVoiceRequest req)
给用户发语音验证码(仅支持数字)。SendTtsVoiceResponse
VmsClient. SendTtsVoice(SendTtsVoiceRequest req)
给用户发送指定模板的语音通知。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.vod.v20180717
Methods in com.tencentcloudapi.vod.v20180717 that throw TencentCloudSDKException Modifier and Type Method Description ApplyUploadResponse
VodClient. ApplyUpload(ApplyUploadRequest req)
我们强烈建议您使用云点播提供的 [服务端上传 SDK](/document/product/266/9759#1.-.E5.8F.91.E8.B5.B7.E4.B8.8A.E4.BC.A0) 来上传文件。直接调用 API 进行上传的难度和工作量都显著大于使用 SDK。 该接口用于申请媒体文件(和封面文件)的上传,获取文件上传到云点播的元信息(包括上传路径、上传签名等),用于后续上传接口。 上传流程请参考 [服务端上传综述](/document/product/266/9759)。AttachMediaSubtitlesResponse
VodClient. AttachMediaSubtitles(AttachMediaSubtitlesRequest req)
关联媒资字幕,将指定的字幕关联到转自适应码流模板号对应的媒体输出文件中(或解除关联)。CommitUploadResponse
VodClient. CommitUpload(CommitUploadRequest req)
该接口用于确认媒体文件(和封面文件)上传到腾讯云点播的结果,并存储媒体信息,返回文件的播放地址和文件 ID。ComposeMediaResponse
VodClient. ComposeMedia(ComposeMediaRequest req)
该接口用于合成媒体文件,可以达到以下效果: 1.ConfirmEventsResponse
VodClient. ConfirmEvents(ConfirmEventsRequest req)
开发者调用拉取事件通知,获取到事件后,必须调用该接口来确认消息已经收到; 开发者获取到事件句柄后,等待确认的有效时间为 30 秒,超出 30 秒会报参数错误(4000); 更多参考事件通知的[可靠回调](https://cloud.tencent.com/document/product/266/33779#.E5.8F.AF.E9.9D.A0.E5.9B.9E.E8.B0.83)。CreateAdaptiveDynamicStreamingTemplateResponse
VodClient. CreateAdaptiveDynamicStreamingTemplate(CreateAdaptiveDynamicStreamingTemplateRequest req)
创建转自适应码流模板,数量上限:100。CreateAIAnalysisTemplateResponse
VodClient. CreateAIAnalysisTemplate(CreateAIAnalysisTemplateRequest req)
创建用户自定义音视频内容分析模板,数量上限:50。CreateAIRecognitionTemplateResponse
VodClient. CreateAIRecognitionTemplate(CreateAIRecognitionTemplateRequest req)
创建用户自定义音视频内容识别模板,数量上限:50。CreateAnimatedGraphicsTemplateResponse
VodClient. CreateAnimatedGraphicsTemplate(CreateAnimatedGraphicsTemplateRequest req)
创建用户自定义转动图模板,数量上限:16。CreateClassResponse
VodClient. CreateClass(CreateClassRequest req)
用于对媒体进行分类管理; 该接口不影响既有媒体的分类,如需修改媒体分类,请调用[修改媒体文件属性](/document/product/266/31762)接口。 分类层次不可超过 4 层。 每个分类的子类数量不可超过 500 个。CreateContentReviewTemplateResponse
VodClient. CreateContentReviewTemplate(CreateContentReviewTemplateRequest req)
该 API 已经不再维护,新版审核模板支持音视频审核和图片审核,详细请参考 [创建审核模板](https://cloud.tencent.com/document/api/266/84391)。 创建用户自定义音视频内容审核模板,数量上限:50。CreateDomainVerifyRecordResponse
VodClient. CreateDomainVerifyRecord(CreateDomainVerifyRecordRequest req)
该接口用于生成一条子域名解析,提示客户添加到域名解析上,用于泛域名及域名取回校验归属权。CreateEnhanceMediaTemplateResponse
VodClient. CreateEnhanceMediaTemplate(CreateEnhanceMediaTemplateRequest req)
创建音画质重生模板。CreateHeadTailTemplateResponse
VodClient. CreateHeadTailTemplate(CreateHeadTailTemplateRequest req)
创建片头片尾模板。CreateImageProcessingTemplateResponse
VodClient. CreateImageProcessingTemplate(CreateImageProcessingTemplateRequest req)
创建一个用户自定义的图片处理模板,数量上限:16。最多支持十次操作,例如:裁剪-缩略-裁剪-模糊-缩略-裁剪-缩略-裁剪-模糊-缩略。CreateImageSpriteTemplateResponse
VodClient. CreateImageSpriteTemplate(CreateImageSpriteTemplateRequest req)
创建用户自定义雪碧图模板,数量上限:16。CreatePersonSampleResponse
VodClient. CreatePersonSample(CreatePersonSampleRequest req)
该接口用于创建素材样本,用于通过五官定位等技术,进行内容识别、不适宜视频识别等视频处理。CreateProcedureTemplateResponse
VodClient. CreateProcedureTemplate(CreateProcedureTemplateRequest req)
创建用户自定义的任务流模板,模板上限:50。CreateQualityInspectTemplateResponse
VodClient. CreateQualityInspectTemplate(CreateQualityInspectTemplateRequest req)
创建音画质检测模板。CreateRebuildMediaTemplateResponse
VodClient. CreateRebuildMediaTemplate(CreateRebuildMediaTemplateRequest req)
创建视频重生模板。CreateReviewTemplateResponse
VodClient. CreateReviewTemplate(CreateReviewTemplateRequest req)
创建用户自定义审核模板,数量上限:50。 >模板仅适用于 [音视频审核(ReviewAudioVideo)](https://cloud.tencent.com/document/api/266/80283) 和 [图片审核(ReviewImage)](https://cloud.tencent.com/document/api/266/73217) 接口。CreateRoundPlayResponse
VodClient. CreateRoundPlay(CreateRoundPlayRequest req)
该接口用于创建轮播播单,数量上限:100。 轮播播单的每个文件可以指定源文件,也可以指定某个转码文件。 指定的文件必须是hls格式,所有的播单文件最好保持相同的码率和分辨率。CreateSampleSnapshotTemplateResponse
VodClient. CreateSampleSnapshotTemplate(CreateSampleSnapshotTemplateRequest req)
创建用户自定义采样截图模板,数量上限:16。CreateSnapshotByTimeOffsetTemplateResponse
VodClient. CreateSnapshotByTimeOffsetTemplate(CreateSnapshotByTimeOffsetTemplateRequest req)
创建用户自定义指定时间点截图模板,数量上限:16。CreateStorageRegionResponse
VodClient. CreateStorageRegion(CreateStorageRegionRequest req)
该接口用于开通某地域的存储。 1.CreateSubAppIdResponse
VodClient. CreateSubAppId(CreateSubAppIdRequest req)
该接口用于创建点播子应用。CreateSuperPlayerConfigResponse
VodClient. CreateSuperPlayerConfig(CreateSuperPlayerConfigRequest req)
该 API 已经不再维护,新版播放器签名不再使用播放器配置模板,详细请参考 [播放器签名](https://cloud.tencent.com/document/product/266/45554)。 创建播放器配置,数量上限:100。CreateTranscodeTemplateResponse
VodClient. CreateTranscodeTemplate(CreateTranscodeTemplateRequest req)
创建用户自定义转码模板,数量上限:100。CreateVodDomainResponse
VodClient. CreateVodDomain(CreateVodDomainRequest req)
该接口用于将加速域名添加到点播,一个用户最多添加20个加速域名。 1.域名添加成功后点播会进行域名的部署,域名由部署状态变为在线状态大概需要2分钟的时间。CreateWatermarkTemplateResponse
VodClient. CreateWatermarkTemplate(CreateWatermarkTemplateRequest req)
创建用户自定义水印模板,数量上限:1000。CreateWordSamplesResponse
VodClient. CreateWordSamples(CreateWordSamplesRequest req)
该接口用于批量创建关键词样本,样本用于通过OCR、ASR技术,进行不适宜内容识别、内容识别等视频处理。DeleteAdaptiveDynamicStreamingTemplateResponse
VodClient. DeleteAdaptiveDynamicStreamingTemplate(DeleteAdaptiveDynamicStreamingTemplateRequest req)
删除转自适应码流模板DeleteAIAnalysisTemplateResponse
VodClient. DeleteAIAnalysisTemplate(DeleteAIAnalysisTemplateRequest req)
删除用户自定义音视频内容分析模板。 注意:模板 ID 为 10000 以下的为系统预置模板,不允许删除。DeleteAIRecognitionTemplateResponse
VodClient. DeleteAIRecognitionTemplate(DeleteAIRecognitionTemplateRequest req)
删除用户自定义音视频内容识别模板。DeleteAnimatedGraphicsTemplateResponse
VodClient. DeleteAnimatedGraphicsTemplate(DeleteAnimatedGraphicsTemplateRequest req)
删除用户自定义转动图模板。DeleteClassResponse
VodClient. DeleteClass(DeleteClassRequest req)
仅当待删分类无子分类且无媒体关联情况下,可删除分类; 否则,请先执行[删除媒体](/document/product/266/31764)及子分类,再删除该分类;DeleteContentReviewTemplateResponse
VodClient. DeleteContentReviewTemplate(DeleteContentReviewTemplateRequest req)
该 API 已经不再维护,新版审核模板支持音视频审核和图片审核,详细请参考 [删除审核模板](https://cloud.tencent.com/document/api/266/84390)。 删除用户自定义音视频内容审核模板。DeleteEnhanceMediaTemplateResponse
VodClient. DeleteEnhanceMediaTemplate(DeleteEnhanceMediaTemplateRequest req)
删除音画质重生模板。DeleteHeadTailTemplateResponse
VodClient. DeleteHeadTailTemplate(DeleteHeadTailTemplateRequest req)
删除片头片尾模板。DeleteImageProcessingTemplateResponse
VodClient. DeleteImageProcessingTemplate(DeleteImageProcessingTemplateRequest req)
删除用户自定义图片处理模板。DeleteImageSpriteTemplateResponse
VodClient. DeleteImageSpriteTemplate(DeleteImageSpriteTemplateRequest req)
删除雪碧图模板。DeleteMediaResponse
VodClient. DeleteMedia(DeleteMediaRequest req)
删除媒体及其对应的视频处理文件(原始文件、如转码视频、雪碧图、截图、微信发布视频等); 可单独删除指定 ID 的视频文件下的原文件、转码视频、微信发布视频等; 注意:原文件删除后,无法发起转码、微信发布等任何视频处理操作。DeletePersonSampleResponse
VodClient. DeletePersonSample(DeletePersonSampleRequest req)
该接口用于根据人物 ID,删除素材样本。DeleteProcedureTemplateResponse
VodClient. DeleteProcedureTemplate(DeleteProcedureTemplateRequest req)
删除用户自定义的任务流模板。DeleteQualityInspectTemplateResponse
VodClient. DeleteQualityInspectTemplate(DeleteQualityInspectTemplateRequest req)
删除音画质检测模板。DeleteRebuildMediaTemplateResponse
VodClient. DeleteRebuildMediaTemplate(DeleteRebuildMediaTemplateRequest req)
删除视频重生模板。DeleteReviewTemplateResponse
VodClient. DeleteReviewTemplate(DeleteReviewTemplateRequest req)
删除用户自定义审核模板。 >模板仅适用于 [音视频审核(ReviewAudioVideo)](https://cloud.tencent.com/document/api/266/80283) 和 [图片审核(ReviewImage)](https://cloud.tencent.com/document/api/266/73217) 接口。DeleteRoundPlayResponse
VodClient. DeleteRoundPlay(DeleteRoundPlayRequest req)
该接口用于删除轮播播单。DeleteSampleSnapshotTemplateResponse
VodClient. DeleteSampleSnapshotTemplate(DeleteSampleSnapshotTemplateRequest req)
删除用户自定义采样截图模板。DeleteSnapshotByTimeOffsetTemplateResponse
VodClient. DeleteSnapshotByTimeOffsetTemplate(DeleteSnapshotByTimeOffsetTemplateRequest req)
删除用户自定义指定时间点截图模板。DeleteSuperPlayerConfigResponse
VodClient. DeleteSuperPlayerConfig(DeleteSuperPlayerConfigRequest req)
该 API 已经不再维护,新版播放器签名不再使用播放器配置模板,详细请参考 [播放器签名](https://cloud.tencent.com/document/product/266/45554)。 删除播放器配置。 注:系统预置播放器配置不允许删除。*DeleteTranscodeTemplateResponse
VodClient. DeleteTranscodeTemplate(DeleteTranscodeTemplateRequest req)
删除用户自定义转码模板。DeleteVodDomainResponse
VodClient. DeleteVodDomain(DeleteVodDomainRequest req)
该接口用于删除点播加速域名。 1、域名删除前需要先关闭所有区域的加速。DeleteWatermarkTemplateResponse
VodClient. DeleteWatermarkTemplate(DeleteWatermarkTemplateRequest req)
删除用户自定义水印模板。DeleteWordSamplesResponse
VodClient. DeleteWordSamples(DeleteWordSamplesRequest req)
该接口用于批量删除关键词样本。DescribeAdaptiveDynamicStreamingTemplatesResponse
VodClient. DescribeAdaptiveDynamicStreamingTemplates(DescribeAdaptiveDynamicStreamingTemplatesRequest req)
查询转自适应码流模板,支持根据条件,分页查询。DescribeAIAnalysisTemplatesResponse
VodClient. DescribeAIAnalysisTemplates(DescribeAIAnalysisTemplatesRequest req)
根据音视频内容分析模板唯一标识,获取音视频内容分析模板详情列表。返回结果包含符合条件的所有用户自定义音视频内容分析模板及[系统预置音视频内容分析模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.A7.86.E9.A2.91.E5.86.85.E5.AE.B9.E5.88.86.E6.9E.90.E6.A8.A1.E6.9D.BF)。DescribeAIRecognitionTemplatesResponse
VodClient. DescribeAIRecognitionTemplates(DescribeAIRecognitionTemplatesRequest req)
根据音视频内容识别模板唯一标识,获取音视频内容识别模板详情列表。返回结果包含符合条件的所有用户自定义音视频内容识别模板及[系统预置音视频内容识别模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.A7.86.E9.A2.91.E5.86.85.E5.AE.B9.E8.AF.86.E5.88.AB.E6.A8.A1.E6.9D.BF)。DescribeAllClassResponse
VodClient. DescribeAllClass(DescribeAllClassRequest req)
获得用户的所有分类信息。DescribeAnimatedGraphicsTemplatesResponse
VodClient. DescribeAnimatedGraphicsTemplates(DescribeAnimatedGraphicsTemplatesRequest req)
查询转动图模板列表,支持根据条件,分页查询。DescribeCdnLogsResponse
VodClient. DescribeCdnLogs(DescribeCdnLogsRequest req)
查询点播域名的 CDN 访问日志的下载链接。 1.DescribeCDNStatDetailsResponse
VodClient. DescribeCDNStatDetails(DescribeCDNStatDetailsRequest req)
该接口用于查询点播域名的 CDN 带宽、流量等统计数据。 查询的起始时间和结束时间跨度不超过90天。 可以查询不同服务区域的数据。 中国境内的数据支持查询指定地区、运营商的统计数据。DescribeCDNUsageDataResponse
VodClient. DescribeCDNUsageData(DescribeCDNUsageDataRequest req)
该接口用于查询点播 CDN 的流量、带宽等统计数据。 1.DescribeClientUploadAccelerationUsageDataResponse
VodClient. DescribeClientUploadAccelerationUsageData(DescribeClientUploadAccelerationUsageDataRequest req)
该接口返回查询时间范围内客户端上传加速统计信息。 1.DescribeContentReviewTemplatesResponse
VodClient. DescribeContentReviewTemplates(DescribeContentReviewTemplatesRequest req)
该 API 已经不再维护,新版审核模板支持音视频审核和图片审核,详细请参考 [获取审核模板列表](https://cloud.tencent.com/document/api/266/84389)。 根据音视频内容审核模板唯一标识,获取音视频内容审核模板详情列表。返回结果包含符合条件的所有用户自定义模板及[系统预置内容审核模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.A7.86.E9.A2.91.E5.86.85.E5.AE.B9.E5.AE.A1.E6.A0.B8.E6.A8.A1.E6.9D.BF)。DescribeDailyMediaPlayStatResponse
VodClient. DescribeDailyMediaPlayStat(DescribeDailyMediaPlayStatRequest req)
该接口用于查询指定日期范围内每天的播放统计数据。 可以查询最近一年的播放统计数据。 结束日期和起始日期的时间跨度最大为90天。DescribeDailyMostPlayedStatResponse
VodClient. DescribeDailyMostPlayedStat(DescribeDailyMostPlayedStatRequest req)
该接口用于查询每日播放Top100 的媒体文件的播放统计数据。 可以查询最近一年的播放统计数据。 可以按播放次数或者播放流量查询。 播放次数统计说明: 1.DescribeDailyPlayStatFileListResponse
VodClient. DescribeDailyPlayStatFileList(DescribeDailyPlayStatFileListRequest req)
该接口用于查询播放统计文件的下载地址。 可以查询最近一年的播放统计文件下载地址,查询的起始日期和结束日期的时间跨度不超过90天。 云点播每天对前一天的 CDN 请求日志进行分析处理,生成播放统计文件。 播放统计文件内容包含媒体文件的播放次数、播放流量等统计信息。 播放次数统计说明: 1.DescribeDrmDataKeyResponse
VodClient. DescribeDrmDataKey(DescribeDrmDataKeyRequest req)
本 API 是 [旧版本加密](https://cloud.tencent.com/document/product/266/9638) 中 [DescribeDrmDataKey 的 API 2017 接口](https://cloud.tencent.com/document/product/266/9643) 的升级版本。 如果您是新接入点播加密的用户,不要使用该 API,请参考 [视频加密综述](https://cloud.tencent.com/document/product/266/45552) 使用推荐的加密方式。DescribeDrmKeyProviderInfoResponse
VodClient. DescribeDrmKeyProviderInfo(DescribeDrmKeyProviderInfoRequest req)
查询 DRM 密钥提供商信息。DescribeEnhanceMediaTemplatesResponse
VodClient. DescribeEnhanceMediaTemplates(DescribeEnhanceMediaTemplatesRequest req)
获取音画质重生模板列表。DescribeEventConfigResponse
VodClient. DescribeEventConfig(DescribeEventConfigRequest req)
腾讯云点播为客户提供了媒体上传、媒体管理、媒体处理等等服务,在这些服务执行过程或执行结束时,腾讯云点播也提供各种对应的事件通知,方便开发者感知服务处理状态,并做下一步的业务操作。 开发者可以通过本接口来查询当前配置事件通知的接收方式、接收地址以及哪些事件开启了接收回调通知。 默认接口请求频率限制:100次/秒。DescribeEventsStateResponse
VodClient. DescribeEventsState(DescribeEventsStateRequest req)
该接口用于业务服务器获取 [可靠回调](https://cloud.tencent.com/document/product/266/33779#.E5.8F.AF.E9.9D.A0.E5.9B.9E.E8.B0.83) 事件通知的状态。DescribeFileAttributesResponse
VodClient. DescribeFileAttributes(DescribeFileAttributesRequest req)
用于异步获取文件属性。 - 当前仅支持获取源文件的 Md5。 - 对输入文件为 HLS 或 DASH 的情况,仅获取索引文件的属性。DescribeHeadTailTemplatesResponse
VodClient. DescribeHeadTailTemplates(DescribeHeadTailTemplatesRequest req)
获取片头片尾模板列表。DescribeImageProcessingTemplatesResponse
VodClient. DescribeImageProcessingTemplates(DescribeImageProcessingTemplatesRequest req)
获取图片处理模板列表,支持根据条件,分页查询。DescribeImageReviewUsageDataResponse
VodClient. DescribeImageReviewUsageData(DescribeImageReviewUsageDataRequest req)
该接口返回查询时间范围内每天使用的图片审核用量信息。 1.DescribeImageSpriteTemplatesResponse
VodClient. DescribeImageSpriteTemplates(DescribeImageSpriteTemplatesRequest req)
查询雪碧图模板,支持根据条件,分页查询。DescribeLicenseUsageDataResponse
VodClient. DescribeLicenseUsageData(DescribeLicenseUsageDataRequest req)
该接口返回查询时间范围内每天 License 请求次数信息。 1.DescribeMediaInfosResponse
VodClient. DescribeMediaInfos(DescribeMediaInfosRequest req)
1.DescribeMediaPlayStatDetailsResponse
VodClient. DescribeMediaPlayStatDetails(DescribeMediaPlayStatDetailsRequest req)
该接口用于查询媒体文件按指定时间粒度统计的播放数据 可以查询最近一年的播放统计数据。 时间粒度为小时,结束时间和起始时间的跨度最大为7天。 时间粒度为天,结束时间和起始时间的跨度最大为90天。DescribeMediaProcessUsageDataResponse
VodClient. DescribeMediaProcessUsageData(DescribeMediaProcessUsageDataRequest req)
该接口返回查询时间范围内每天使用的视频处理用量信息。 1.DescribePersonSamplesResponse
VodClient. DescribePersonSamples(DescribePersonSamplesRequest req)
该接口用于查询素材样本信息,支持根据素材 ID、名称、标签,分页查询。DescribePrepaidProductsResponse
VodClient. DescribePrepaidProducts(DescribePrepaidProductsRequest req)
该接口可以查询用户已经购买的预付费商品的信息,包括: 1.DescribeProcedureTemplatesResponse
VodClient. DescribeProcedureTemplates(DescribeProcedureTemplatesRequest req)
根据任务流模板名字,获取任务流模板详情列表。DescribeQualityInspectTemplatesResponse
VodClient. DescribeQualityInspectTemplates(DescribeQualityInspectTemplatesRequest req)
获取音画质检测模板列表。DescribeRebuildMediaTemplatesResponse
VodClient. DescribeRebuildMediaTemplates(DescribeRebuildMediaTemplatesRequest req)
获取视频重生模板列表。DescribeReviewDetailsResponse
VodClient. DescribeReviewDetails(DescribeReviewDetailsRequest req)
本接口已不推荐使用,用 [DescribeMediaProcessUsageData](/document/product/266/41464) 替代 该接口返回查询时间范围内每天使用的视频内容智能识别时长数据,单位: 秒。 1.DescribeReviewTemplatesResponse
VodClient. DescribeReviewTemplates(DescribeReviewTemplatesRequest req)
获取审核模板列表。 >模板仅适用于 [音视频审核(ReviewAudioVideo)](https://cloud.tencent.com/document/api/266/80283) 和 [图片审核(ReviewImage)](https://cloud.tencent.com/document/api/266/73217) 接口。DescribeRoundPlaysResponse
VodClient. DescribeRoundPlays(DescribeRoundPlaysRequest req)
该接口用于获取轮播播单列表。DescribeSampleSnapshotTemplatesResponse
VodClient. DescribeSampleSnapshotTemplates(DescribeSampleSnapshotTemplatesRequest req)
查询采样截图模板,支持根据条件,分页查询。DescribeSnapshotByTimeOffsetTemplatesResponse
VodClient. DescribeSnapshotByTimeOffsetTemplates(DescribeSnapshotByTimeOffsetTemplatesRequest req)
查询指定时间点截图模板,支持根据条件,分页查询。DescribeStorageDataResponse
VodClient. DescribeStorageData(DescribeStorageDataRequest req)
查询存储空间使用情况和文件数量。DescribeStorageDetailsResponse
VodClient. DescribeStorageDetails(DescribeStorageDetailsRequest req)
该接口返回查询时间范围内使用的点播存储空间,单位:字节。 1.DescribeStorageRegionsResponse
VodClient. DescribeStorageRegions(DescribeStorageRegionsRequest req)
该接口用于: 1.DescribeSubAppIdsResponse
VodClient. DescribeSubAppIds(DescribeSubAppIdsRequest req)
该接口用于获取当前账号的子应用列表,包含主应用。DescribeSuperPlayerConfigsResponse
VodClient. DescribeSuperPlayerConfigs(DescribeSuperPlayerConfigsRequest req)
该 API 已经不再维护,新版播放器签名不再使用播放器配置模板,详细请参考 [播放器签名](https://cloud.tencent.com/document/product/266/45554)。 查询播放器配置,支持根据条件,分页查询。DescribeTaskDetailResponse
VodClient. DescribeTaskDetail(DescribeTaskDetailRequest req)
通过任务 ID 查询任务的执行状态和结果的详细信息(最多可以查询3天之内提交的任务)。DescribeTasksResponse
VodClient. DescribeTasks(DescribeTasksRequest req)
该接口用于查询任务列表; 当列表数据比较多时,单次接口调用无法拉取整个列表,可通过 ScrollToken 参数,分批拉取; 只能查询到最近三天(72 小时)内的任务。DescribeTranscodeTemplatesResponse
VodClient. DescribeTranscodeTemplates(DescribeTranscodeTemplatesRequest req)
根据转码模板唯一标识,获取转码模板详情列表。返回结果包含符合条件的所有用户自定义模板及[系统预置转码模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.BD.AC.E7.A0.81.E6.A8.A1.E6.9D.BF)。DescribeVodDomainsResponse
VodClient. DescribeVodDomains(DescribeVodDomainsRequest req)
该接口用于查询点播域名信息列表。DescribeWatermarkTemplatesResponse
VodClient. DescribeWatermarkTemplates(DescribeWatermarkTemplatesRequest req)
查询用户自定义水印模板,支持根据条件,分页查询。DescribeWordSamplesResponse
VodClient. DescribeWordSamples(DescribeWordSamplesRequest req)
该接口用于根据应用场景、关键词、标签,分页查询关键词样本信息。EditMediaResponse
VodClient. EditMedia(EditMediaRequest req)
对视频进行编辑(剪辑、拼接等),生成一个新的点播视频。编辑的功能包括: 1.EnhanceMediaByTemplateResponse
VodClient. EnhanceMediaByTemplate(EnhanceMediaByTemplateRequest req)
使用模板发起音画质重生。ExecuteFunctionResponse
VodClient. ExecuteFunction(ExecuteFunctionRequest req)
本接口仅用于定制开发的特殊场景,除非云点播客服人员主动告知您需要使用本接口,其它情况请勿调用。ExtractCopyRightWatermarkResponse
VodClient. ExtractCopyRightWatermark(ExtractCopyRightWatermarkRequest req)
提取版权水印信息。ExtractTraceWatermarkResponse
VodClient. ExtractTraceWatermark(ExtractTraceWatermarkRequest req)
用于提取溯源水印。ForbidMediaDistributionResponse
VodClient. ForbidMediaDistribution(ForbidMediaDistributionRequest req)
对媒体禁播后,除了点播控制台预览,其他场景访问视频各种资源的 URL(原始文件、转码输出文件、截图等)均会返回 403。 禁播/解禁操作全网生效时间约 5~10 分钟。InspectMediaQualityResponse
VodClient. InspectMediaQuality(InspectMediaQualityRequest req)
对点播中的音视频媒体发起音画质检测任务。LiveRealTimeClipResponse
VodClient. LiveRealTimeClip(LiveRealTimeClipRequest req)
直播即时剪辑,是指在直播过程中(即直播尚未结束时),客户可以在过往直播内容中选择一段,实时生成一个新的视频(HLS 格式),开发者可以将其立即分享出去,或者长久保存起来。 腾讯云点播支持两种即时剪辑模式: - 剪辑固化:将剪辑出来的视频保存成独立的视频,拥有独立 FileId;适用于将精彩片段**长久保存**的场景; - 剪辑不固化:剪辑得到的视频附属于直播录制文件,没有独立 FileId;适用于将精彩片段**临时分享**的场景。 注意: - 使用直播即时剪辑功能的前提是:目标直播流开启了[时移回看](https://cloud.tencent.com/document/product/267/32742)功能。 - 直播即时剪辑是基于直播录制生成的 m3u8 文件进行的,故而其最小剪辑精度为一个 ts 切片,无法实现秒级或者更为精确的剪辑精度。 - 由于直播过程中可能存在断流的情况,所以有可能导致剪辑生成的实际视频时长与期望不一致。例如剪辑某个直播流的时间区间为 2018-09-20T10:30:00Z 到 2018-09-20T10:40:00Z ,如果在该时间区间中发生过断流,那么返回的媒资文件的时长将少于 10 分钟,在这种情况下,可以通过输出参数 SegmentSet 感知到。 ### 剪辑固化 所谓剪辑固化,是指将剪辑出来的视频是保存成一个独立的视频(拥有独立的 FileId)。其生命周期不受原始直播录制视频影响(即使原始录制视频被删除,剪辑结果也不会受到任何影响);也可以对其进行转码、微信发布等二次处理。 举例如下:一场完整的足球比赛,直播录制出来的原始视频可能长达 2 个小时,客户出于节省成本的目的可以对这个视频存储 2 个月,但对于直播即时剪辑的「精彩时刻」视频却可以指定存储更长时间,同时可以单独对「精彩时刻」视频进行转码、微信发布等额外的点播操作,这时候可以选择直播即时剪辑并且固化的方案。 剪辑固化的优势在于其生命周期与原始录制视频相互独立,可以独立管理、长久保存。 ### 剪辑不固化 所谓剪辑不固化,是指剪辑所得到的结果(m3u8 文件)与直播录制视频共享相同的 ts 分片,新生成的视频不是一个独立完整的视频(没有独立 FileId,只有播放 URL),其有效期与直播录制的完整视频有效期是一致的。一旦直播录制出来的视频被删除,也会导致该片段无法播放。 剪辑不固化,由于其剪辑结果不是一个独立的视频,因而也不会纳入点播媒资视频管理(例如控制台的视频总数不会统计这一片段)中,也无法单独针对这个片段做转码、微信发布等任何视频处理操作。 剪辑不固化的优势在于其剪辑操作十分“轻量化”,不会产生额外的存储开销。但其不足之处在于生命周期与原始录制视频相同,且无法进一步进行转码等视频处理。ManageTaskResponse
VodClient. ManageTask(ManageTaskRequest req)
对已发起的任务进行管理。ModifyAdaptiveDynamicStreamingTemplateResponse
VodClient. ModifyAdaptiveDynamicStreamingTemplate(ModifyAdaptiveDynamicStreamingTemplateRequest req)
修改转自适应码流模板ModifyAIAnalysisTemplateResponse
VodClient. ModifyAIAnalysisTemplate(ModifyAIAnalysisTemplateRequest req)
修改用户自定义音视频内容分析模板。 注意:模板 ID 10000 以下的为系统预置模板,不允许修改。ModifyAIRecognitionTemplateResponse
VodClient. ModifyAIRecognitionTemplate(ModifyAIRecognitionTemplateRequest req)
修改用户自定义音视频内容识别模板。ModifyAnimatedGraphicsTemplateResponse
VodClient. ModifyAnimatedGraphicsTemplate(ModifyAnimatedGraphicsTemplateRequest req)
修改用户自定义转动图模板。ModifyClassResponse
VodClient. ModifyClass(ModifyClassRequest req)
修改媒体分类属性。ModifyContentReviewTemplateResponse
VodClient. ModifyContentReviewTemplate(ModifyContentReviewTemplateRequest req)
该 API 已经不再维护,新版审核模板支持音视频审核和图片审核,详细请参考 [修改审核模板](https://cloud.tencent.com/document/api/266/84388)。 修改用户自定义音视频内容审核模板。ModifyDefaultStorageRegionResponse
VodClient. ModifyDefaultStorageRegion(ModifyDefaultStorageRegionRequest req)
该接口用于设置默认的存储地域。上传文件时如果没有指定地域,将上传到默认地域。ModifyEnhanceMediaTemplateResponse
VodClient. ModifyEnhanceMediaTemplate(ModifyEnhanceMediaTemplateRequest req)
修改音画质重生模板。ModifyEventConfigResponse
VodClient. ModifyEventConfig(ModifyEventConfigRequest req)
腾讯云点播为客户提供了媒体上传、媒体管理、媒体处理等等服务,在这些服务执行过程或执行结束时,腾讯云点播也提供各种对应的事件通知,方便开发者感知服务处理状态,并做下一步的业务操作。 开发者可以通过调用本接口来实现: - 设置接收回调通知的类型,目前有[ HTTP 回调通知](https://cloud.tencent.com/document/product/266/33779) 和 [基于消息队列的可靠通知](https://cloud.tencent.com/document/product/266/33779) 两种类型。 - 对于[ HTTP 回调通知](https://cloud.tencent.com/document/product/266/33779),可设置 3.0 格式回调的地址。3.0 格式回调的说明参见 [历史格式回调](https://cloud.tencent.com/document/product/266/33796)。 - 对具体事件服务的通知事件选择设置接收或者忽略。ModifyHeadTailTemplateResponse
VodClient. ModifyHeadTailTemplate(ModifyHeadTailTemplateRequest req)
修改片头片尾模板。ModifyImageSpriteTemplateResponse
VodClient. ModifyImageSpriteTemplate(ModifyImageSpriteTemplateRequest req)
修改用户自定义雪碧图模板。ModifyMediaInfoResponse
VodClient. ModifyMediaInfo(ModifyMediaInfoRequest req)
修改媒体文件的属性,包括分类、名称、描述、标签、过期时间、打点信息、视频封面、字幕信息等。ModifyMediaStorageClassResponse
VodClient. ModifyMediaStorageClass(ModifyMediaStorageClassRequest req)
修改媒体文件的存储类型。 当媒体文件的存储类型为标准存储时,可以修改为以下类型: 低频存储 归档存储 深度归档存储 当媒体文件的当前存储类型为低频存储时,可以修改为以下类型: 标准存储 归档存储 深度归档存储 当媒体文件的当前存储类型为归档存储时,可以修改为以下类型: 标准存储 当媒体文件的当前存储类型为深度归档存储时,可以修改为以下类型: 标准存储ModifyPersonSampleResponse
VodClient. ModifyPersonSample(ModifyPersonSampleRequest req)
该接口用于根据素材 ID,修改素材样本信息,包括名称、描述的修改,以及五官、标签的添加、删除、重置操作。五官删除操作需保证至少剩余 1 张图片,否则,请使用重置操作。ModifyQualityInspectTemplateResponse
VodClient. ModifyQualityInspectTemplate(ModifyQualityInspectTemplateRequest req)
修改音画质检测模板。ModifyRebuildMediaTemplateResponse
VodClient. ModifyRebuildMediaTemplate(ModifyRebuildMediaTemplateRequest req)
修改视频重生模板。ModifyReviewTemplateResponse
VodClient. ModifyReviewTemplate(ModifyReviewTemplateRequest req)
修改用户自定义审核模板。 >模板仅适用于 [音视频审核(ReviewAudioVideo)](https://cloud.tencent.com/document/api/266/80283) 和 [图片审核(ReviewImage)](https://cloud.tencent.com/document/api/266/73217) 接口。ModifyRoundPlayResponse
VodClient. ModifyRoundPlay(ModifyRoundPlayRequest req)
该接口用于修改轮播播单。 修改后只有新的播放请求会生效,已经在播放中的用户在七天之内还可以播放修改前的播单。ModifySampleSnapshotTemplateResponse
VodClient. ModifySampleSnapshotTemplate(ModifySampleSnapshotTemplateRequest req)
修改用户自定义采样截图模板。ModifySnapshotByTimeOffsetTemplateResponse
VodClient. ModifySnapshotByTimeOffsetTemplate(ModifySnapshotByTimeOffsetTemplateRequest req)
修改用户自定义指定时间点截图模板。ModifySubAppIdInfoResponse
VodClient. ModifySubAppIdInfo(ModifySubAppIdInfoRequest req)
该接口用于修改子应用信息,但不允许修改主应用信息。ModifySubAppIdStatusResponse
VodClient. ModifySubAppIdStatus(ModifySubAppIdStatusRequest req)
该接口用于启用、停用子应用。被停用的子应用将封停对应域名,并限制控制台访问。ModifySuperPlayerConfigResponse
VodClient. ModifySuperPlayerConfig(ModifySuperPlayerConfigRequest req)
该 API 已经不再维护,新版播放器签名不再使用播放器配置模板,详细请参考 [播放器签名](https://cloud.tencent.com/document/product/266/45554)。 修改播放器配置。ModifyTranscodeTemplateResponse
VodClient. ModifyTranscodeTemplate(ModifyTranscodeTemplateRequest req)
修改用户自定义转码模板信息。ModifyVodDomainAccelerateConfigResponse
VodClient. ModifyVodDomainAccelerateConfig(ModifyVodDomainAccelerateConfigRequest req)
该接口用于修改点播域名的加速区域。 1、域名部署状态为 Online 状态时才允许修改加速区域。ModifyVodDomainConfigResponse
VodClient. ModifyVodDomainConfig(ModifyVodDomainConfigRequest req)
该接口用于修改域名配置,可以修改域名的防盗链配置。 1、域名部署状态为 Online 状态时才允许修改域名的配置。ModifyWatermarkTemplateResponse
VodClient. ModifyWatermarkTemplate(ModifyWatermarkTemplateRequest req)
修改用户自定义水印模板,水印类型不允许修改。ModifyWordSampleResponse
VodClient. ModifyWordSample(ModifyWordSampleRequest req)
该接口用于修改关键词的应用场景、标签,关键词本身不可修改,如需修改,可删除重建。ParseStreamingManifestResponse
VodClient. ParseStreamingManifest(ParseStreamingManifestRequest req)
上传 HLS 视频时,解析索引文件内容,返回待上传的分片文件列表。分片文件路径必须是当前目录或子目录的相对路径,不能是 URL,不能是绝对路径。ProcessImageResponse
VodClient. ProcessImage(ProcessImageRequest req)
该 API 已经不再维护,智能识别任务请使用图片智能识别 [ReviewImage](https://cloud.tencent.com/document/api/266/73217) 接口。 对点播中的图片文件发起处理任务,功能包括: 1.ProcessMediaResponse
VodClient. ProcessMedia(ProcessMediaRequest req)
对点播中的音视频媒体发起处理任务,功能包括: 1.ProcessMediaByProcedureResponse
VodClient. ProcessMediaByProcedure(ProcessMediaByProcedureRequest req)
使用任务流模板,对点播中的视频发起处理任务。 有两种方式创建任务流模板: 1.ProcessMediaByUrlResponse
VodClient. ProcessMediaByUrl(ProcessMediaByUrlRequest req)
该 API 已经不再维护,请使用 MPS 产品的 [ProcessMedia](https://cloud.tencent.com/document/product/862/37578) 接口,在入参 InputInfo.UrlInputInfo.Url 中指定视频 URL。PullEventsResponse
VodClient. PullEvents(PullEventsRequest req)
该接口用于业务服务器以 [可靠回调](https://cloud.tencent.com/document/product/266/33779#.E5.8F.AF.E9.9D.A0.E5.9B.9E.E8.B0.83) 的方式获取事件通知; 接口为长轮询模式,即:如果服务端存在未消费事件,则立即返回给请求方;如果服务端没有未消费事件,则后台会将请求挂起,直到有新的事件产生为止; 请求最多挂起5秒,建议请求方将超时时间设置为10秒; 未被拉取的事件通知最多保留4天,超过该时限的事件通知可能会被清除; 若该接口有事件返回,调用方必须在30秒内调用 [确认事件通知](https://cloud.tencent.com/document/product/266/33434) 接口,确认事件通知已经处理,否则该事件通知在30秒后会再次被拉取到。 当前,API 每次最多可以获取16个事件通知。PullUploadResponse
VodClient. PullUpload(PullUploadRequest req)
该接口用于将一个网络上的视频拉取到云点播平台。PushUrlCacheResponse
VodClient. PushUrlCache(PushUrlCacheRequest req)
1.RebuildMediaResponse
VodClient. RebuildMedia(RebuildMediaRequest req)
发起音画质重生RebuildMediaByTemplateResponse
VodClient. RebuildMediaByTemplate(RebuildMediaByTemplateRequest req)
使用模板发起视频重生。RefreshUrlCacheResponse
VodClient. RefreshUrlCache(RefreshUrlCacheRequest req)
1.RemoveWatermarkResponse
VodClient. RemoveWatermark(RemoveWatermarkRequest req)
智能去除水印ResetProcedureTemplateResponse
VodClient. ResetProcedureTemplate(ResetProcedureTemplateRequest req)
重新设置用户自定义任务流模板的内容。RestoreMediaResponse
VodClient. RestoreMedia(RestoreMediaRequest req)
当媒体文件的存储类型是归档存储或深度归档存储时,是不可访问的。如需访问,则需要调用本接口进行解冻,解冻后可访问的媒体文件是临时的,在有效期过后,则不可访问。ReviewAudioVideoResponse
VodClient. ReviewAudioVideo(ReviewAudioVideoRequest req)
对点播中的音视频媒体发起审核任务,智能检测视频画面、画面中的文字、语音中的文字、声音出现的违规内容。 如使用事件通知,事件通知的类型为 [音视频审核完成](https://cloud.tencent.com/document/product/266/81258)。ReviewImageResponse
VodClient. ReviewImage(ReviewImageRequest req)
对点播中的图片文件发起审核(令人反感的信息、不安全的信息、不适宜的信息)任务。 >图片文件大小支持:文件 < 5M; >图片文件分辨率支持:建议分辨率大于256x256,否则可能会影响审核效果; >图片文件支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP格式。SearchMediaResponse
VodClient. SearchMedia(SearchMediaRequest req)
搜索媒体信息,支持多种条件筛选,以及支持对返回结果排序、过滤等功能,具体包括: - 指定文件 ID 集合 FileIds ,返回匹配集合中任意 ID 的媒体。 - 根据多个媒体文件名 Names 或描述信息 Descriptions 进行模糊搜索。 - 根据多个文件名前缀 NamePrefixes 进行搜索。 - 指定分类集合 ClassIds(见输入参数),返回满足集合中任意分类的媒体。例如:媒体分类有电影、电视剧、综艺等,其中电影分类下又有子分类历史片、动作片、言情片。如果 ClassIds 指定了电影、电视剧,那么电影和电视剧下的所有子分类都会返回;而如果 ClassIds 指定的是历史片、动作片,那么只有这2个子分类下的媒体才会返回。 - 指定标签集合 Tags(见输入参数),返回满足集合中任意标签的媒体。例如:媒体标签有二次元、宫斗、鬼畜,如果 Tags 指定了二次元、鬼畜2个标签,那么只要符合这2个标签中任意一个的媒体都会被检索出来。 - 指定文件类型集合 Categories(见输入参数),返回满足集合中任意类型的媒体。例如:文件类型有 Video(视频)、 Audio (音频)、 Image (图片)。如果Categories指定了 Video 和 Audio 2个文件类型,那么符合这些类型的媒体都会被检索出来。 - 指定来源集合 SourceTypes(见输入参数),返回满足集合中任意来源的媒体。例如:媒体来源有 Record (直播录制)、Upload (上传)等。如果 SourceTypes 指定了 Record 和 Upload ,那么符合这些来源的媒体都会被检索出来。 - 指定文件封装格式集合 MediaTypes(见输入参数),返回满足集合中任意封装格式的媒体。例如:封装格式有 MP4、AVI、MP3 等。如果 MediaTypes 指定了 MP4 和 MP3,那么符合这些封装格式的媒体都会被检索出来。 - 指定文件状态集合 Status(见输入参数),返回满足集合中任意状态的媒体。例如:文件状态有 Normal(正常)、SystemForbidden(平台封禁)、Forbidden(主动封禁)。如果 Status 指定了 Normal 和 Forbidden 2种文件状态,那么符合这些状态的媒体都会被检索出来。 - 指定文件审核结果集合 ReviewResults(见输入参数),返回满足集合中任意状态的媒体。例如:文件审核结果有 pass(通过)、block(违规)等。如果 ReviewResults 指定了 pass 和 block 2种审核结果,那么符合这些审核结果的媒体都会被检索出来。 - 指定直播推流码集合 StreamIds(见输入参数)筛选直播录制的媒体。 - 指定媒体的创建时间范围筛选媒体。 - 指定 TRTC 应用 ID 集合筛选媒体。 - 指定 TRTC 房间 ID 集合筛选媒体。 - 以上参数之间可以任意组合进行检索。例如:筛选创建时间在2018年12月1日12:00:00到2018年12月8日12:00:00之间、分类为电影或电视剧、带有宫斗和悬疑标签的媒体。注意,任何支持数组输入的参数,其元素之间的搜索逻辑为‘或’。所有参数之间的逻辑关系为‘与’。 - 允许通过 Filters 控制返回的媒体信息种类(默认返回所有信息)。可选输入包括: 1.SetDrmKeyProviderInfoResponse
VodClient. SetDrmKeyProviderInfo(SetDrmKeyProviderInfoRequest req)
设置 DRM 密钥提供商信息。SimpleHlsClipResponse
VodClient. SimpleHlsClip(SimpleHlsClipRequest req)
对 HLS 视频进行按时间段裁剪,实时生成一个新的视频(HLS 格式),开发者可以将其立即分享出去,或者长久保存起来。 腾讯云点播支持两种剪辑模式: - 剪辑固化:将剪辑出来的视频保存成独立的视频,拥有独立 FileId;适用于将精彩片段长久保存的场景; - 剪辑不固化:剪辑得到的视频附属于输入文件,没有独立 FileId;适用于将精彩片段临时分享的场景。 注意: - 剪辑是基于输入 m3u8 文件进行的,故而其最小剪辑精度为一个 ts 切片,无法实现秒级或者更为精确的剪辑精度。 ### 剪辑固化 所谓剪辑固化,是指将剪辑出来的视频保存成一个独立的视频(拥有独立的 FileId)。其生命周期不受原始输入视频影响(即使原始输入视频被删除,剪辑结果也不会受到任何影响);也可以对其进行转码、微信发布等二次处理。 举例如下:一场完整的足球比赛,原始视频可能长达 2 个小时,客户出于节省成本的目的可以对这个视频存储 2 个月,但对于剪辑的「精彩时刻」视频却可以指定存储更长时间,同时可以单独对「精彩时刻」视频进行转码、微信发布等额外的点播操作,这时候可以选择剪辑并且固化的方案。 剪辑固化的优势在于其生命周期与原始输入视频相互独立,可以独立管理、长久保存。 ### 剪辑不固化 所谓剪辑不固化,是指剪辑所得到的结果(m3u8 文件)与原始输入视频共享相同的 ts 分片,新生成的视频不是一个独立完整的视频(没有独立 FileId,只有播放 URL),其有效期与原始输入的完整视频有效期是一致的。一旦原始输入的视频被删除,也会导致该片段无法播放。 剪辑不固化,由于其剪辑结果不是一个独立的视频,因而也不会纳入点播媒资视频管理(例如控制台的视频总数不会统计这一片段)中,也无法单独针对这个片段做转码、微信发布等任何视频处理操作。 剪辑不固化的优势在于其剪辑操作十分“轻量化”,不会产生额外的存储开销。但其不足之处在于生命周期与原始录制视频相同,且无法进一步进行转码等视频处理。SplitMediaResponse
VodClient. SplitMedia(SplitMediaRequest req)
对点播视频进行拆条,生成多个新的点播视频。VerifyDomainRecordResponse
VodClient. VerifyDomainRecord(VerifyDomainRecordRequest req)
该接口用于验证域名解析值。WeChatMiniProgramPublishResponse
VodClient. WeChatMiniProgramPublish(WeChatMiniProgramPublishRequest req)
将点播视频发布到微信小程序,供微信小程序播放器播放。 本接口支持发布原始视频和转码后视频,暂不支持发布自适应码流。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.vpc.v20170312
Methods in com.tencentcloudapi.vpc.v20170312 that throw TencentCloudSDKException Modifier and Type Method Description AcceptAttachCcnInstancesResponse
VpcClient. AcceptAttachCcnInstances(AcceptAttachCcnInstancesRequest req)
本接口(AcceptAttachCcnInstances)用于跨账号关联实例时,云联网所有者接受并同意关联操作。AcceptVpcPeeringConnectionResponse
VpcClient. AcceptVpcPeeringConnection(AcceptVpcPeeringConnectionRequest req)
本接口(AcceptVpcPeeringConnection)用于接受对等连接请求。AddBandwidthPackageResourcesResponse
VpcClient. AddBandwidthPackageResources(AddBandwidthPackageResourcesRequest req)
接口用于添加带宽包资源,包括[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)和[负载均衡](https://cloud.tencent.com/document/product/214/517)等AddIp6RulesResponse
VpcClient. AddIp6Rules(AddIp6RulesRequest req)
1.AddTemplateMemberResponse
VpcClient. AddTemplateMember(AddTemplateMemberRequest req)
增加模板对象中的IP地址、协议端口、IP地址组、协议端口组。当前仅支持北京、泰国、北美地域请求。AdjustPublicAddressResponse
VpcClient. AdjustPublicAddress(AdjustPublicAddressRequest req)
本接口 (AdjustPublicAddress) 用于更换IP地址,支持更换CVM实例的普通公网IP和包月带宽的EIP。AllocateAddressesResponse
VpcClient. AllocateAddresses(AllocateAddressesRequest req)
本接口 (AllocateAddresses) 用于申请一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称 EIP)。 EIP 是专为动态云计算设计的静态 IP 地址。借助 EIP,您可以快速将 EIP 重新映射到您的另一个实例上,从而屏蔽实例故障。 您的 EIP 与腾讯云账户相关联,而不是与某个实例相关联。在您选择显式释放该地址,或欠费超过24小时之前,它会一直与您的腾讯云账户保持关联。 一个腾讯云账户在每个地域能申请的 EIP 最大配额有所限制,可参见 [EIP 产品简介](https://cloud.tencent.com/document/product/213/5733),上述配额可通过 DescribeAddressQuota 接口获取。AllocateIp6AddressesBandwidthResponse
VpcClient. AllocateIp6AddressesBandwidth(AllocateIp6AddressesBandwidthRequest req)
该接口用于给IPv6地址初次分配公网带宽AssignIpv6AddressesResponse
VpcClient. AssignIpv6Addresses(AssignIpv6AddressesRequest req)
本接口(AssignIpv6Addresses)用于弹性网卡申请`IPv6`地址。
本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制。 可以指定`IPv6`地址申请,地址类型不能为主`IP`,`IPv6`地址暂时只支持作为辅助`IP`。 地址必须要在弹性网卡所在子网内,而且不能被占用。 在弹性网卡上申请一个到多个辅助`IPv6`地址,接口会在弹性网卡所在子网段内返回指定数量的辅助`IPv6`地址。AssignIpv6CidrBlockResponse
VpcClient. AssignIpv6CidrBlock(AssignIpv6CidrBlockRequest req)
本接口(AssignIpv6CidrBlock)用于分配IPv6网段。 使用本接口前,您需要已有VPC实例,如果没有可通过接口CreateVpc创建。 每个VPC只能申请一个IPv6网段。AssignIpv6SubnetCidrBlockResponse
VpcClient. AssignIpv6SubnetCidrBlock(AssignIpv6SubnetCidrBlockRequest req)
本接口(AssignIpv6SubnetCidrBlock)用于分配IPv6子网段。 给子网分配 `IPv6` 网段,要求子网所属 `VPC` 已获得 `IPv6` 网段。如果尚未分配,请先通过接口 `AssignIpv6CidrBlock` 给子网所属 `VPC` 分配一个 `IPv6` 网段。否则无法分配 `IPv6` 子网段。 每个子网只能分配一个IPv6网段。AssignPrivateIpAddressesResponse
VpcClient. AssignPrivateIpAddresses(AssignPrivateIpAddressesRequest req)
本接口(AssignPrivateIpAddresses)用于弹性网卡申请内网 IP。 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制。 可以指定内网IP地址申请,内网IP地址类型不能为主IP,主IP已存在,不能修改,内网IP必须要弹性网卡所在子网内,而且不能被占用。 在弹性网卡上申请一个到多个辅助内网IP,接口会在弹性网卡所在子网网段内返回指定数量的辅助内网IP。 >?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >AssociateAddressResponse
VpcClient. AssociateAddress(AssociateAddressRequest req)
本接口 (AssociateAddress) 用于将[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称 EIP)绑定到实例或弹性网卡的指定内网 IP 上。 将 EIP 绑定到实例(CVM)上,其本质是将 EIP 绑定到实例上主网卡的主内网 IP 上。 将 EIP 绑定到主网卡的主内网IP上,绑定过程会把其上绑定的普通公网 IP 自动解绑并释放。 将 EIP 绑定到指定网卡的内网 IP上(非主网卡的主内网IP),则必须先解绑该 EIP,才能再绑定新的。 将 EIP 绑定到内网型CLB实例的功能处于内测阶段,如需使用,请提交内测申请。 将 EIP 绑定到NAT网关,请使用接口[AssociateNatGatewayAddress](https://cloud.tencent.com/document/product/215/36722) EIP 如果欠费或被封堵,则不能被绑定。 只有状态为 UNBIND 的 EIP 才能够被绑定。AssociateDhcpIpWithAddressIpResponse
VpcClient. AssociateDhcpIpWithAddressIp(AssociateDhcpIpWithAddressIpRequest req)
本接口(AssociateDhcpIpWithAddressIp)用于DhcpIp绑定弹性公网IP(EIP)。
>?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >AssociateDirectConnectGatewayNatGatewayResponse
VpcClient. AssociateDirectConnectGatewayNatGateway(AssociateDirectConnectGatewayNatGatewayRequest req)
将专线网关与NAT网关绑定,专线网关默认路由指向NAT网关AssociateNatGatewayAddressResponse
VpcClient. AssociateNatGatewayAddress(AssociateNatGatewayAddressRequest req)
本接口(AssociateNatGatewayAddress)用于NAT网关绑定弹性IP(EIP)。AssociateNetworkAclSubnetsResponse
VpcClient. AssociateNetworkAclSubnets(AssociateNetworkAclSubnetsRequest req)
本接口(AssociateNetworkAclSubnets)用于网络ACL关联VPC下的子网。AssociateNetworkInterfaceSecurityGroupsResponse
VpcClient. AssociateNetworkInterfaceSecurityGroups(AssociateNetworkInterfaceSecurityGroupsRequest req)
本接口(AssociateNetworkInterfaceSecurityGroups)用于弹性网卡绑定安全组(SecurityGroup)。AttachCcnInstancesResponse
VpcClient. AttachCcnInstances(AttachCcnInstancesRequest req)
本接口(AttachCcnInstances)用于将网络实例加载到云联网实例中,网络实例包括VPC和专线网关。
每个云联网能够关联的网络实例个数是有限的,详情请参考产品文档。如果需要扩充请联系在线客服。AttachClassicLinkVpcResponse
VpcClient. AttachClassicLinkVpc(AttachClassicLinkVpcRequest req)
本接口(AttachClassicLinkVpc)用于创建私有网络和基础网络设备互通。 私有网络和基础网络设备必须在同一个地域。 私有网络和基础网络的区别详见vpc产品文档-私有网络与基础网络。 >?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >AttachNetworkInterfaceResponse
VpcClient. AttachNetworkInterface(AttachNetworkInterfaceRequest req)
本接口(AttachNetworkInterface)用于弹性网卡绑定云服务器。 一个弹性网卡请至少绑定一个安全组,如需绑定请参见弹性网卡绑定安全组。 一个云服务器可以绑定多个弹性网卡,但只能绑定一个主网卡。更多限制信息详见弹性网卡使用限制。 一个弹性网卡只能同时绑定一个云服务器。 只有运行中或者已关机状态的云服务器才能绑定弹性网卡,查看云服务器状态详见腾讯云服务器信息。 弹性网卡绑定的云服务器必须是私有网络的,而且云服务器所在可用区必须和弹性网卡子网的可用区相同。 本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。AttachSnapshotInstancesResponse
VpcClient. AttachSnapshotInstances(AttachSnapshotInstancesRequest req)
本接口(AttachSnapshotInstances)用于快照策略关联实例。AuditCrossBorderComplianceResponse
VpcClient. AuditCrossBorderCompliance(AuditCrossBorderComplianceRequest req)
本接口(AuditCrossBorderCompliance)用于服务商操作合规化资质审批。 服务商只能操作提交到本服务商的审批单,后台会校验身份。即只授权给服务商的`APPID` 调用本接口。 `APPROVED` 状态的审批单,可以再次操作为 `DENY`;`DENY` 状态的审批单,也可以再次操作为 `APPROVED`。CheckAssistantCidrResponse
VpcClient. CheckAssistantCidr(CheckAssistantCidrRequest req)
本接口(CheckAssistantCidr)用于检查辅助CIDR是否与存量路由、对等连接(对端VPC的CIDR)等资源存在冲突。如果存在重叠,则返回重叠的资源。 检测辅助CIDR是否与当前VPC的主CIDR和辅助CIDR存在重叠。 检测辅助CIDR是否与当前VPC的路由的目的端存在重叠。 检测辅助CIDR是否与当前VPC的对等连接,对端VPC下的主CIDR或辅助CIDR存在重叠。CheckDefaultSubnetResponse
VpcClient. CheckDefaultSubnet(CheckDefaultSubnetRequest req)
本接口(CheckDefaultSubnet)用于预判是否可建默认子网。CheckNetDetectStateResponse
VpcClient. CheckNetDetectState(CheckNetDetectStateRequest req)
本接口(CheckNetDetectState)用于验证网络探测。CloneSecurityGroupResponse
VpcClient. CloneSecurityGroup(CloneSecurityGroupRequest req)
本接口(CloneSecurityGroup)用于根据存量的安全组,克隆创建出同样规则配置的安全组。仅克隆安全组及其规则信息,不会克隆安全组标签信息。CreateAddressTemplateResponse
VpcClient. CreateAddressTemplate(CreateAddressTemplateRequest req)
本接口(CreateAddressTemplate)用于创建IP地址模板。CreateAddressTemplateGroupResponse
VpcClient. CreateAddressTemplateGroup(CreateAddressTemplateGroupRequest req)
本接口(CreateAddressTemplateGroup)用于创建IP地址模板集合。CreateAndAttachNetworkInterfaceResponse
VpcClient. CreateAndAttachNetworkInterface(CreateAndAttachNetworkInterfaceRequest req)
本接口(CreateAndAttachNetworkInterface)用于创建弹性网卡并绑定云服务器。 创建弹性网卡时可以指定内网IP,并且可以指定一个主IP,指定的内网IP必须在弹性网卡所在子网内,而且不能被占用。 创建弹性网卡时可以指定需要申请的内网IP数量,系统会随机生成内网IP地址。 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制。 创建弹性网卡同时可以绑定已有安全组。 创建弹性网卡同时可以绑定标签, 应答里的标签列表代表添加成功的标签。 >?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >CreateAssistantCidrResponse
VpcClient. CreateAssistantCidr(CreateAssistantCidrRequest req)
本接口(CreateAssistantCidr)用于批量创建辅助CIDR。CreateBandwidthPackageResponse
VpcClient. CreateBandwidthPackage(CreateBandwidthPackageRequest req)
本接口 (CreateBandwidthPackage) 支持创建[设备带宽包](https://cloud.tencent.com/document/product/684/15245#bwptype)和[IP带宽包](https://cloud.tencent.com/document/product/684/15245#bwptype)。CreateCcnResponse
VpcClient. CreateCcn(CreateCcnRequest req)
本接口(CreateCcn)用于创建云联网(CCN)。
创建云联网同时可以绑定标签, 应答里的标签列表代表添加成功的标签。 每个账号能创建的云联网实例个数是有限的,详请参考产品文档。如果需要扩充请联系在线客服。CreateCustomerGatewayResponse
VpcClient. CreateCustomerGateway(CreateCustomerGatewayRequest req)
本接口(CreateCustomerGateway)用于创建对端网关。CreateDefaultSecurityGroupResponse
VpcClient. CreateDefaultSecurityGroup(CreateDefaultSecurityGroupRequest req)
本接口(CreateDefaultSecurityGroup)用于创建(如果项目下未存在默认安全组,则创建;已存在则获取。)默认安全组(SecurityGroup)。 每个账户下每个地域的每个项目的安全组数量限制。 默认安全组会放通所有IPv4规则,在创建后通常您需要再调用CreateSecurityGroupPolicies将安全组的规则设置为需要的规则。 创建安全组同时可以绑定标签, 应答里的标签列表代表添加成功的标签。CreateDefaultVpcResponse
VpcClient. CreateDefaultVpc(CreateDefaultVpcRequest req)
本接口(CreateDefaultVpc)用于创建默认私有网络(VPC)。 默认VPC适用于快速入门和启动公共实例,您可以像使用任何其他VPC一样使用默认VPC。如果您想创建标准VPC,即指定VPC名称、VPC网段、子网网段、子网可用区,请使用常规创建VPC接口(CreateVpc) 正常情况,本接口并不一定生产默认VPC,而是根据用户账号的网络属性(DescribeAccountAttributes)来决定的 支持基础网络、VPC,返回VpcId为0 只支持VPC,返回默认VPC信息 您也可以通过 Force 参数,强制返回默认VPC。CreateDhcpIpResponse
VpcClient. CreateDhcpIp(CreateDhcpIpRequest req)
本接口(CreateDhcpIp)用于创建DhcpIp。CreateDirectConnectGatewayResponse
VpcClient. CreateDirectConnectGateway(CreateDirectConnectGatewayRequest req)
本接口(CreateDirectConnectGateway)用于创建专线网关。CreateDirectConnectGatewayCcnRoutesResponse
VpcClient. CreateDirectConnectGatewayCcnRoutes(CreateDirectConnectGatewayCcnRoutesRequest req)
本接口(CreateDirectConnectGatewayCcnRoutes)用于创建专线网关的云联网路由(IDC网段)CreateFlowLogResponse
VpcClient. CreateFlowLog(CreateFlowLogRequest req)
本接口(CreateFlowLog)用于创建网络流日志。CreateHaVipResponse
VpcClient. CreateHaVip(CreateHaVipRequest req)
本接口(CreateHaVip)用于创建高可用虚拟IP(HAVIP)。CreateIp6TranslatorsResponse
VpcClient. CreateIp6Translators(CreateIp6TranslatorsRequest req)
1.CreateLocalGatewayResponse
VpcClient. CreateLocalGateway(CreateLocalGatewayRequest req)
本接口(CreateLocalGateway)用于创建用于CDC的本地网关。CreateNatGatewayResponse
VpcClient. CreateNatGateway(CreateNatGatewayRequest req)
本接口(CreateNatGateway)用于创建NAT网关。 在对新建的NAT网关做其他操作前,需先确认此网关已被创建完成(DescribeNatGateway接口返回的实例State字段为AVAILABLE)。CreateNatGatewayDestinationIpPortTranslationNatRuleResponse
VpcClient. CreateNatGatewayDestinationIpPortTranslationNatRule(CreateNatGatewayDestinationIpPortTranslationNatRuleRequest req)
本接口(CreateNatGatewayDestinationIpPortTranslationNatRule)用于创建NAT网关端口转发规则。CreateNatGatewaySourceIpTranslationNatRuleResponse
VpcClient. CreateNatGatewaySourceIpTranslationNatRule(CreateNatGatewaySourceIpTranslationNatRuleRequest req)
本接口(CreateNatGatewaySourceIpTranslationNatRule)用于创建NAT网关SNAT规则CreateNetDetectResponse
VpcClient. CreateNetDetect(CreateNetDetectRequest req)
本接口(CreateNetDetect)用于创建网络探测。CreateNetworkAclResponse
VpcClient. CreateNetworkAcl(CreateNetworkAclRequest req)
本接口(CreateNetworkAcl)用于创建新的网络ACL。 新建的网络ACL的入站和出站规则默认都是全部拒绝,在创建后通常您需要再调用ModifyNetworkAclEntries将网络ACL的规则设置为需要的规则。CreateNetworkAclEntriesResponse
VpcClient. CreateNetworkAclEntries(CreateNetworkAclEntriesRequest req)
本接口(CreateNetworkAclEntries)用于增量添加网络ACL三元组的入站规则和出站规则。CreateNetworkAclQuintupleEntriesResponse
VpcClient. CreateNetworkAclQuintupleEntries(CreateNetworkAclQuintupleEntriesRequest req)
本接口(CreateNetworkAclQuintupleEntries)用于增量网络ACL五元组的入站规则和出站规则。CreateNetworkInterfaceResponse
VpcClient. CreateNetworkInterface(CreateNetworkInterfaceRequest req)
本接口(CreateNetworkInterface)用于创建弹性网卡。 创建弹性网卡时可以指定内网IP,并且可以指定一个主IP,指定的内网IP必须在弹性网卡所在子网内,而且不能被占用。 创建弹性网卡时可以指定需要申请的内网IP数量,系统会随机生成内网IP地址。 一个弹性网卡支持绑定的IP地址是有限制的,更多资源限制信息详见弹性网卡使用限制。 创建弹性网卡同时可以绑定已有安全组。 创建弹性网卡同时可以绑定标签, 应答里的标签列表代表添加成功的标签。 >?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >CreateRoutesResponse
VpcClient. CreateRoutes(CreateRoutesRequest req)
本接口(CreateRoutes)用于创建路由策略。 向指定路由表批量新增路由策略。CreateRouteTableResponse
VpcClient. CreateRouteTable(CreateRouteTableRequest req)
本接口(CreateRouteTable)用于创建路由表。 创建了VPC后,系统会创建一个默认路由表,所有新建的子网都会关联到默认路由表。默认情况下您可以直接使用默认路由表来管理您的路由策略。当您的路由策略较多时,您可以调用创建路由表接口创建更多路由表管理您的路由策略。 创建路由表同时可以绑定标签, 应答里的标签列表代表添加成功的标签。CreateSecurityGroupResponse
VpcClient. CreateSecurityGroup(CreateSecurityGroupRequest req)
本接口(CreateSecurityGroup)用于创建新的安全组(SecurityGroup)。 每个账户下每个地域的每个项目的安全组数量限制。 新建的安全组的入站和出站规则默认都是全部拒绝,在创建后通常您需要再调用CreateSecurityGroupPolicies将安全组的规则设置为需要的规则。 创建安全组同时可以绑定标签, 应答里的标签列表代表添加成功的标签。CreateSecurityGroupPoliciesResponse
VpcClient. CreateSecurityGroupPolicies(CreateSecurityGroupPoliciesRequest req)
本接口(CreateSecurityGroupPolicies)用于创建安全组规则(SecurityGroupPolicy)。 在 SecurityGroupPolicySet 参数中: Version 安全组规则版本号,用户每次更新安全规则版本会自动加1,防止您更新的路由规则已过期,不填不考虑冲突。 在创建出站和入站规则(Egress 和 Ingress)时: Protocol 字段支持输入TCP, UDP, ICMP, ICMPV6, GRE, ALL。 CidrBlock 字段允许输入符合cidr格式标准的任意字符串。在基础网络中,如果 CidrBlock 包含您的账户内的云服务器之外的设备在腾讯云的内网 IP,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。 Ipv6CidrBlock 字段允许输入符合IPv6 cidr格式标准的任意字符串。在基础网络中,如果Ipv6CidrBlock 包含您的账户内的云服务器之外的设备在腾讯云的内网 IPv6,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。 SecurityGroupId 字段允许输入与待修改的安全组位于相同项目中的安全组 ID,包括这个安全组 ID 本身,代表安全组下所有云服务器的内网 IP。使用这个字段时,这条规则用来匹配网络报文的过程中会随着被使用的这个 ID 所关联的云服务器变化而变化,不需要重新修改。 Port 字段允许输入一个单独端口号,或者用减号分隔的两个端口号代表端口范围,例如80或8000-8010。只有当 Protocol 字段是 TCP 或 UDP 时,Port 字段才被接受,即 Protocol 字段不是 TCP 或 UDP 时,Protocol 和 Port 是排他关系,不允许同时输入,否则会接口报错。 Action 字段只允许输入 ACCEPT 或 DROP。 CidrBlock, Ipv6CidrBlock, SecurityGroupId, AddressTemplate 四者是排他关系,不允许同时输入,Protocol + Port 和 ServiceTemplate 二者是排他关系,不允许同时输入。IPv6CidrBlock和ICMP是排他关系,如需使用,请输入ICMPV6。 一次请求中只能创建单个方向的规则, 如果需要指定索引(PolicyIndex)参数, 多条规则的索引必须一致。如想在规则最前面插入一条,则填0即可,如果想在最后追加,该字段可不填。CreateSecurityGroupWithPoliciesResponse
VpcClient. CreateSecurityGroupWithPolicies(CreateSecurityGroupWithPoliciesRequest req)
本接口(CreateSecurityGroupWithPolicies)用于创建新的安全组(SecurityGroup),并且可以同时添加安全组规则(SecurityGroupPolicy)。 每个账户下每个地域的每个项目的安全组数量限制。 新建的安全组的入站和出站规则默认都是全部拒绝,在创建后通常您需要再调用CreateSecurityGroupPolicies 将安全组的规则设置为需要的规则。 安全组规则说明: Version安全组规则版本号,用户每次更新安全规则版本会自动加1,防止您更新的路由规则已过期,不填不考虑冲突。 Protocol字段支持输入TCP, UDP, ICMP, ICMPV6, GRE, ALL。 CidrBlock字段允许输入符合cidr格式标准的任意字符串。(展开)在基础网络中,如果CidrBlock包含您的账户内的云服务器之外的设备在腾讯云的内网IP,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。 Ipv6CidrBlock字段允许输入符合IPv6 cidr格式标准的任意字符串。(展开)在基础网络中,如果Ipv6CidrBlock包含您的账户内的云服务器之外的设备在腾讯云的内网IPv6,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。 SecurityGroupId字段允许输入与待修改的安全组位于相同项目中的安全组ID,包括这个安全组ID本身,代表安全组下所有云服务器的内网IP。使用这个字段时,这条规则用来匹配网络报文的过程中会随着被使用的这个ID所关联的云服务器变化而变化,不需要重新修改。 Port字段允许输入一个单独端口号,或者用减号分隔的两个端口号代表端口范围,例如80或8000-8010。只有当Protocol字段是TCP或UDP时,Port字段才被接受,即Protocol字段不是TCP或UDP时,Protocol和Port是排他关系,不允许同时输入,否则会接口报错。 Action字段只允许输入ACCEPT或DROP。 CidrBlock, Ipv6CidrBlock, SecurityGroupId, AddressTemplate四者是排他关系,不允许同时输入,Protocol + Port和ServiceTemplate二者是排他关系,不允许同时输入。 一次请求中只能创建单个方向的规则, 如果需要指定索引(PolicyIndex)参数, 多条规则的索引必须一致。CreateServiceTemplateResponse
VpcClient. CreateServiceTemplate(CreateServiceTemplateRequest req)
本接口(CreateServiceTemplate)用于创建协议端口模板。CreateServiceTemplateGroupResponse
VpcClient. CreateServiceTemplateGroup(CreateServiceTemplateGroupRequest req)
本接口(CreateServiceTemplateGroup)用于创建协议端口模板集合。CreateSnapshotPoliciesResponse
VpcClient. CreateSnapshotPolicies(CreateSnapshotPoliciesRequest req)
本接口(CreateSnapshotPolicies)用于创建快照策略。CreateSubnetResponse
VpcClient. CreateSubnet(CreateSubnetRequest req)
本接口(CreateSubnet)用于创建子网。 创建子网前必须创建好 VPC。 子网创建成功后,子网网段不能修改。子网网段必须在VPC网段内,可以和VPC网段相同(VPC有且只有一个子网时),建议子网网段在VPC网段内,预留网段给其他子网使用。 您可以创建的最小网段子网掩码为28(有16个IP地址),最大网段子网掩码为16(65,536个IP地址)。 同一个VPC内,多个子网的网段不能重叠。 子网创建后会自动关联到默认路由表。 创建子网同时可以绑定标签, 应答里的标签列表代表添加成功的标签。CreateSubnetsResponse
VpcClient. CreateSubnets(CreateSubnetsRequest req)
本接口(CreateSubnets)用于批量创建子网。 创建子网前必须创建好 VPC。 子网创建成功后,子网网段不能修改。子网网段必须在VPC网段内,可以和VPC网段相同(VPC有且只有一个子网时),建议子网网段在VPC网段内,预留网段给其他子网使用。 您可以创建的最小网段子网掩码为28(有16个IP地址),最大网段子网掩码为16(65,536个IP地址)。 同一个VPC内,多个子网的网段不能重叠。 子网创建后会自动关联到默认路由表。 创建子网同时可以绑定标签, 应答里的标签列表代表添加成功的标签。CreateTrafficPackagesResponse
VpcClient. CreateTrafficPackages(CreateTrafficPackagesRequest req)
本接口 (CreateTrafficPackages) 用于创建共享流量包。CreateVpcResponse
VpcClient. CreateVpc(CreateVpcRequest req)
本接口(CreateVpc)用于创建私有网络(VPC)。 用户可以创建的最小网段子网掩码为28(有16个IP地址),10.0.0.0/12,172.16.0.0/12最大网段子网掩码为12(1,048,576个IP地址),192.168.0.0/16最大网段子网掩码为16(65,536个IP地址)如果需要规划VPC网段请参见[网络规划](https://cloud.tencent.com/document/product/215/30313)。 同一个地域能创建的VPC资源个数也是有限制的,详见 VPC使用限制,如果需要申请更多资源,请提交[工单申请](https://console.cloud.tencent.com/workorder/category)。 创建VPC同时可以绑定标签, 应答里的标签列表代表添加成功的标签。CreateVpcEndPointResponse
VpcClient. CreateVpcEndPoint(CreateVpcEndPointRequest req)
本接口(CreateVpcEndPoint)用于创建终端节点。CreateVpcEndPointServiceResponse
VpcClient. CreateVpcEndPointService(CreateVpcEndPointServiceRequest req)
本接口(CreateVpcEndPointService)用于创建终端节点服务。CreateVpcEndPointServiceWhiteListResponse
VpcClient. CreateVpcEndPointServiceWhiteList(CreateVpcEndPointServiceWhiteListRequest req)
本接口(CreateVpcEndPointServiceWhiteList)创建终端服务白名单。CreateVpcPeeringConnectionResponse
VpcClient. CreateVpcPeeringConnection(CreateVpcPeeringConnectionRequest req)
本接口(CreateVpcPeeringConnection)用于创建私有网络对等连接。CreateVpnConnectionResponse
VpcClient. CreateVpnConnection(CreateVpnConnectionRequest req)
本接口(CreateVpnConnection)用于创建VPN通道。 >?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >CreateVpnGatewayResponse
VpcClient. CreateVpnGateway(CreateVpnGatewayRequest req)
本接口(CreateVpnGateway)用于创建VPN网关。CreateVpnGatewayRoutesResponse
VpcClient. CreateVpnGatewayRoutes(CreateVpnGatewayRoutesRequest req)
创建路由型VPN网关的目的路由CreateVpnGatewaySslClientResponse
VpcClient. CreateVpnGatewaySslClient(CreateVpnGatewaySslClientRequest req)
创建SSL-VPN-CLIENTCreateVpnGatewaySslServerResponse
VpcClient. CreateVpnGatewaySslServer(CreateVpnGatewaySslServerRequest req)
本接口(CreateVpnGatewaySslServer)用于创建SSL-VPN Server端。DeleteAddressTemplateResponse
VpcClient. DeleteAddressTemplate(DeleteAddressTemplateRequest req)
本接口(DeleteAddressTemplate)用于删除IP地址模板。DeleteAddressTemplateGroupResponse
VpcClient. DeleteAddressTemplateGroup(DeleteAddressTemplateGroupRequest req)
本接口(DeleteAddressTemplateGroup)用于删除IP地址模板集合。DeleteAssistantCidrResponse
VpcClient. DeleteAssistantCidr(DeleteAssistantCidrRequest req)
本接口(DeleteAssistantCidr)用于删除辅助CIDR。DeleteBandwidthPackageResponse
VpcClient. DeleteBandwidthPackage(DeleteBandwidthPackageRequest req)
接口支持删除共享带宽包,包括[设备带宽包](https://cloud.tencent.com/document/product/684/15246#.E8.AE.BE.E5.A4.87.E5.B8.A6.E5.AE.BD.E5.8C.85)和[IP带宽包](https://cloud.tencent.com/document/product/684/15246#ip-.E5.B8.A6.E5.AE.BD.E5.8C.85)DeleteCcnResponse
VpcClient. DeleteCcn(DeleteCcnRequest req)
本接口(DeleteCcn)用于删除云联网。 删除后,云联网关联的所有实例间路由将被删除,网络将会中断,请务必确认 删除云联网是不可逆的操作,请谨慎处理。DeleteCustomerGatewayResponse
VpcClient. DeleteCustomerGateway(DeleteCustomerGatewayRequest req)
本接口(DeleteCustomerGateway)用于删除对端网关。DeleteDhcpIpResponse
VpcClient. DeleteDhcpIp(DeleteDhcpIpRequest req)
本接口(DeleteDhcpIp)用于删除DhcpIp。 >?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >DeleteDirectConnectGatewayResponse
VpcClient. DeleteDirectConnectGateway(DeleteDirectConnectGatewayRequest req)
本接口(DeleteDirectConnectGateway)用于删除专线网关。 如果是 NAT 网关,删除专线网关后,NAT 规则以及 ACL 策略都被清理了。 删除专线网关后,系统会删除路由表中跟该专线网关相关的路由策略。 本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`QueryTask`接口DeleteDirectConnectGatewayCcnRoutesResponse
VpcClient. DeleteDirectConnectGatewayCcnRoutes(DeleteDirectConnectGatewayCcnRoutesRequest req)
本接口(DeleteDirectConnectGatewayCcnRoutes)用于删除专线网关的云联网路由(IDC网段)DeleteFlowLogResponse
VpcClient. DeleteFlowLog(DeleteFlowLogRequest req)
本接口(DeleteFlowLog)用于删除流日志。DeleteHaVipResponse
VpcClient. DeleteHaVip(DeleteHaVipRequest req)
本接口(DeleteHaVip)用于删除高可用虚拟IP(HAVIP)。
本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。DeleteIp6TranslatorsResponse
VpcClient. DeleteIp6Translators(DeleteIp6TranslatorsRequest req)
1.DeleteLocalGatewayResponse
VpcClient. DeleteLocalGateway(DeleteLocalGatewayRequest req)
本接口(DeleteLocalGateway)用于删除CDC的本地网关。DeleteNatGatewayResponse
VpcClient. DeleteNatGateway(DeleteNatGatewayRequest req)
本接口(DeleteNatGateway)用于删除NAT网关。 删除 NAT 网关后,系统会自动删除路由表中包含此 NAT 网关的路由项,同时也会解绑弹性公网IP(EIP)。DeleteNatGatewayDestinationIpPortTranslationNatRuleResponse
VpcClient. DeleteNatGatewayDestinationIpPortTranslationNatRule(DeleteNatGatewayDestinationIpPortTranslationNatRuleRequest req)
本接口(DeleteNatGatewayDestinationIpPortTranslationNatRule)用于删除NAT网关端口转发规则。DeleteNatGatewaySourceIpTranslationNatRuleResponse
VpcClient. DeleteNatGatewaySourceIpTranslationNatRule(DeleteNatGatewaySourceIpTranslationNatRuleRequest req)
本接口(DeleteNatGatewaySourceIpTranslationNatRule)用于删除NAT网关端口SNAT转发规则。DeleteNetDetectResponse
VpcClient. DeleteNetDetect(DeleteNetDetectRequest req)
本接口(DeleteNetDetect)用于删除网络探测实例。DeleteNetworkAclResponse
VpcClient. DeleteNetworkAcl(DeleteNetworkAclRequest req)
本接口(DeleteNetworkAcl)用于删除网络ACL。DeleteNetworkAclEntriesResponse
VpcClient. DeleteNetworkAclEntries(DeleteNetworkAclEntriesRequest req)
本接口(DeleteNetworkAclEntries)用于删除三元组网络ACL的入站规则和出站规则。在NetworkAclEntrySet参数中: 删除IPv4规则,需要传入NetworkAclIpv4EntryId。 删除IPv6规则,需要传入NetworkAclIpv6EntryId。DeleteNetworkAclQuintupleEntriesResponse
VpcClient. DeleteNetworkAclQuintupleEntries(DeleteNetworkAclQuintupleEntriesRequest req)
本接口(DeleteNetworkAclQuintupleEntries)用于删除网络ACL五元组指定的入站规则和出站规则(但不是全量删除该ACL下的所有条目)。在NetworkAclQuintupleEntrySet参数中:NetworkAclQuintupleEntry需要提供NetworkAclQuintupleEntryId。DeleteNetworkInterfaceResponse
VpcClient. DeleteNetworkInterface(DeleteNetworkInterfaceRequest req)
本接口(DeleteNetworkInterface)用于删除弹性网卡。 弹性网卡上绑定了云服务器时,不能被删除。 删除指定弹性网卡,弹性网卡必须先和子机解绑才能删除。删除之后弹性网卡上所有内网IP都将被退还。 本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。DeleteRoutesResponse
VpcClient. DeleteRoutes(DeleteRoutesRequest req)
本接口(DeleteRoutes)用于对某个路由表批量删除路由策略(Route)。DeleteRouteTableResponse
VpcClient. DeleteRouteTable(DeleteRouteTableRequest req)
本接口(DeleteRouteTable)用于删除路由表。DeleteSecurityGroupResponse
VpcClient. DeleteSecurityGroup(DeleteSecurityGroupRequest req)
本接口(DeleteSecurityGroup)用于删除安全组(SecurityGroup)。 只有当前账号下的安全组允许被删除。 安全组实例ID如果在其他安全组的规则中被引用,则无法直接删除。这种情况下,需要先进行规则修改,再删除安全组。 删除的安全组无法再找回,请谨慎调用。DeleteSecurityGroupPoliciesResponse
VpcClient. DeleteSecurityGroupPolicies(DeleteSecurityGroupPoliciesRequest req)
本接口(DeleteSecurityGroupPolicies)用于用于删除安全组规则(SecurityGroupPolicy)。 SecurityGroupPolicySet.Version 用于指定要操作的安全组的版本。传入 Version 版本号若不等于当前安全组的最新版本,将返回失败;若不传 Version 则直接删除指定PolicyIndex的规则。DeleteServiceTemplateResponse
VpcClient. DeleteServiceTemplate(DeleteServiceTemplateRequest req)
本接口(DeleteServiceTemplate)用于删除协议端口模板。DeleteServiceTemplateGroupResponse
VpcClient. DeleteServiceTemplateGroup(DeleteServiceTemplateGroupRequest req)
本接口(DeleteServiceTemplateGroup)用于删除协议端口模板集合。DeleteSnapshotPoliciesResponse
VpcClient. DeleteSnapshotPolicies(DeleteSnapshotPoliciesRequest req)
本接口(DeleteSnapshotPolicies)用于删除快照策略。DeleteSubnetResponse
VpcClient. DeleteSubnet(DeleteSubnetRequest req)
本接口(DeleteSubnet)用于删除子网(Subnet)。 删除子网前,请清理该子网下所有资源,包括云服务器、负载均衡、云数据、NoSQL、弹性网卡等资源。DeleteTemplateMemberResponse
VpcClient. DeleteTemplateMember(DeleteTemplateMemberRequest req)
删除模板对象中的IP地址、协议端口、IP地址组、协议端口组。当前仅支持北京、泰国、北美地域请求。DeleteTrafficPackagesResponse
VpcClient. DeleteTrafficPackages(DeleteTrafficPackagesRequest req)
删除共享带宽包(仅非活动状态的流量包可删除)。DeleteVpcResponse
VpcClient. DeleteVpc(DeleteVpcRequest req)
本接口(DeleteVpc)用于删除私有网络。 删除前请确保 VPC 内已经没有相关资源,例如云服务器、云数据库、NoSQL、VPN网关、专线网关、负载均衡、对等连接、与之互通的基础网络设备等。 删除私有网络是不可逆的操作,请谨慎处理。DeleteVpcEndPointResponse
VpcClient. DeleteVpcEndPoint(DeleteVpcEndPointRequest req)
本接口(DeleteVpcEndPoint)用于删除终端节点。DeleteVpcEndPointServiceResponse
VpcClient. DeleteVpcEndPointService(DeleteVpcEndPointServiceRequest req)
本接口(DeleteVpcEndPointService)用于删除终端节点服务。DeleteVpcEndPointServiceWhiteListResponse
VpcClient. DeleteVpcEndPointServiceWhiteList(DeleteVpcEndPointServiceWhiteListRequest req)
本接口(DeleteVpcEndPointServiceWhiteList)用于删除终端节点服务白名单。DeleteVpcPeeringConnectionResponse
VpcClient. DeleteVpcPeeringConnection(DeleteVpcPeeringConnectionRequest req)
本接口(DeleteVpcPeeringConnection)用于删除私有网络对等连接。DeleteVpnConnectionResponse
VpcClient. DeleteVpnConnection(DeleteVpnConnectionRequest req)
本接口(DeleteVpnConnection)用于删除VPN通道。DeleteVpnGatewayResponse
VpcClient. DeleteVpnGateway(DeleteVpnGatewayRequest req)
本接口(DeleteVpnGateway)用于删除VPN网关。目前只支持删除运行中的按量计费的IPSEC网关实例。DeleteVpnGatewayRoutesResponse
VpcClient. DeleteVpnGatewayRoutes(DeleteVpnGatewayRoutesRequest req)
本接口(DeleteVpnGatewayRoutes)用于删除VPN网关路由DeleteVpnGatewaySslClientResponse
VpcClient. DeleteVpnGatewaySslClient(DeleteVpnGatewaySslClientRequest req)
本接口(DeleteVpnGatewaySslClient)用于删除SSL-VPN-CLIENT。DeleteVpnGatewaySslServerResponse
VpcClient. DeleteVpnGatewaySslServer(DeleteVpnGatewaySslServerRequest req)
删除SSL-VPN-SERVER 实例DescribeAccountAttributesResponse
VpcClient. DescribeAccountAttributes(DescribeAccountAttributesRequest req)
本接口(DescribeAccountAttributes)用于查询用户账号私有属性。DescribeAddressesResponse
VpcClient. DescribeAddresses(DescribeAddressesRequest req)
本接口 (DescribeAddresses) 用于查询一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称 EIP)的详细信息。 如果参数为空,返回当前用户一定数量(Limit所指定的数量,默认为20)的 EIP。DescribeAddressQuotaResponse
VpcClient. DescribeAddressQuota(DescribeAddressQuotaRequest req)
本接口 (DescribeAddressQuota) 用于查询您账户的[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称 EIP)在当前地域的配额信息。配额详情可参见 [EIP 产品简介](https://cloud.tencent.com/document/product/213/5733)。DescribeAddressTemplateGroupsResponse
VpcClient. DescribeAddressTemplateGroups(DescribeAddressTemplateGroupsRequest req)
本接口(DescribeAddressTemplateGroups)用于查询IP地址模板集合。DescribeAddressTemplatesResponse
VpcClient. DescribeAddressTemplates(DescribeAddressTemplatesRequest req)
本接口(DescribeAddressTemplates)用于查询IP地址模板。DescribeAssistantCidrResponse
VpcClient. DescribeAssistantCidr(DescribeAssistantCidrRequest req)
本接口(DescribeAssistantCidr)用于查询辅助CIDR列表。DescribeBandwidthPackageBillUsageResponse
VpcClient. DescribeBandwidthPackageBillUsage(DescribeBandwidthPackageBillUsageRequest req)
本接口 (DescribeBandwidthPackageBillUsage) 用于查询后付费共享带宽包当前的计费用量.DescribeBandwidthPackageQuotaResponse
VpcClient. DescribeBandwidthPackageQuota(DescribeBandwidthPackageQuotaRequest req)
接口用于查询账户在当前地域的带宽包上限数量以及使用数量DescribeBandwidthPackageResourcesResponse
VpcClient. DescribeBandwidthPackageResources(DescribeBandwidthPackageResourcesRequest req)
本接口 (DescribeBandwidthPackageResources) 用于根据共享带宽包唯一ID查询共享带宽包内的资源列表,支持按条件过滤查询结果和分页查询。DescribeBandwidthPackagesResponse
VpcClient. DescribeBandwidthPackages(DescribeBandwidthPackagesRequest req)
接口用于查询带宽包详细信息,包括带宽包唯一标识ID,类型,计费模式,名称,资源信息等DescribeCcnAttachedInstancesResponse
VpcClient. DescribeCcnAttachedInstances(DescribeCcnAttachedInstancesRequest req)
本接口(DescribeCcnAttachedInstances)用于查询云联网实例下已关联的网络实例。DescribeCcnRegionBandwidthLimitsResponse
VpcClient. DescribeCcnRegionBandwidthLimits(DescribeCcnRegionBandwidthLimitsRequest req)
本接口(DescribeCcnRegionBandwidthLimits)用于查询云联网各地域出带宽上限,该接口只返回已关联网络实例包含的地域。DescribeCcnRoutesResponse
VpcClient. DescribeCcnRoutes(DescribeCcnRoutesRequest req)
本接口(DescribeCcnRoutes)用于查询已加入云联网(CCN)的路由。DescribeCcnsResponse
VpcClient. DescribeCcns(DescribeCcnsRequest req)
本接口(DescribeCcns)用于查询云联网(CCN)列表。DescribeClassicLinkInstancesResponse
VpcClient. DescribeClassicLinkInstances(DescribeClassicLinkInstancesRequest req)
本接口(DescribeClassicLinkInstances)用于查询私有网络和基础网络设备互通列表。DescribeCrossBorderCcnRegionBandwidthLimitsResponse
VpcClient. DescribeCrossBorderCcnRegionBandwidthLimits(DescribeCrossBorderCcnRegionBandwidthLimitsRequest req)
本接口(DescribeCrossBorderCcnRegionBandwidthLimits)用于获取要锁定的限速实例列表。 该接口一般用来封禁地域间限速的云联网实例下的限速实例, 目前联通内部运营系统通过云API调用, 如果是出口限速, 一般使用更粗的云联网实例粒度封禁(DescribeTenantCcns) 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统DescribeCrossBorderComplianceResponse
VpcClient. DescribeCrossBorderCompliance(DescribeCrossBorderComplianceRequest req)
本接口(DescribeCrossBorderCompliance)用于查询用户创建的合规化资质审批单。 服务商可以查询服务名下的任意 `APPID` 创建的审批单;非服务商,只能查询自己审批单。DescribeCrossBorderFlowMonitorResponse
VpcClient. DescribeCrossBorderFlowMonitor(DescribeCrossBorderFlowMonitorRequest req)
本接口(DescribeCrossBorderFlowMonitor)用于查询跨境带宽监控数据,该接口目前只提供给服务商联通使用。DescribeCustomerGatewaysResponse
VpcClient. DescribeCustomerGateways(DescribeCustomerGatewaysRequest req)
本接口(DescribeCustomerGateways)用于查询对端网关列表。DescribeCustomerGatewayVendorsResponse
VpcClient. DescribeCustomerGatewayVendors(DescribeCustomerGatewayVendorsRequest req)
本接口(DescribeCustomerGatewayVendors)用于查询可支持的对端网关厂商信息。DescribeDhcpIpsResponse
VpcClient. DescribeDhcpIps(DescribeDhcpIpsRequest req)
本接口(DescribeDhcpIps)用于查询DhcpIp列表DescribeDirectConnectGatewayCcnRoutesResponse
VpcClient. DescribeDirectConnectGatewayCcnRoutes(DescribeDirectConnectGatewayCcnRoutesRequest req)
本接口(DescribeDirectConnectGatewayCcnRoutes)用于查询专线网关的云联网路由(IDC网段)DescribeDirectConnectGatewaysResponse
VpcClient. DescribeDirectConnectGateways(DescribeDirectConnectGatewaysRequest req)
本接口(DescribeDirectConnectGateways)用于查询专线网关。DescribeFlowLogResponse
VpcClient. DescribeFlowLog(DescribeFlowLogRequest req)
本接口(DescribeFlowLog)用于查询流日志实例信息。DescribeFlowLogsResponse
VpcClient. DescribeFlowLogs(DescribeFlowLogsRequest req)
本接口(DescribeFlowLogs)用于查询获取流日志集合。DescribeGatewayFlowMonitorDetailResponse
VpcClient. DescribeGatewayFlowMonitorDetail(DescribeGatewayFlowMonitorDetailRequest req)
本接口(DescribeGatewayFlowMonitorDetail)用于查询网关流量监控明细。 只支持单个网关实例查询。即入参 `VpnId`、 `DirectConnectGatewayId`、 `PeeringConnectionId`、 `NatId` 最多只支持传一个,且必须传一个。 如果网关有流量,但调用本接口没有返回数据,请在控制台对应网关详情页确认是否开启网关流量监控。DescribeGatewayFlowQosResponse
VpcClient. DescribeGatewayFlowQos(DescribeGatewayFlowQosRequest req)
本接口(DescribeGatewayFlowQos)用于查询网关来访IP流控带宽。DescribeHaVipsResponse
VpcClient. DescribeHaVips(DescribeHaVipsRequest req)
本接口(DescribeHaVips)用于查询高可用虚拟IP(HAVIP)列表。DescribeIp6AddressesResponse
VpcClient. DescribeIp6Addresses(DescribeIp6AddressesRequest req)
该接口用于查询IPV6地址信息DescribeIp6TranslatorQuotaResponse
VpcClient. DescribeIp6TranslatorQuota(DescribeIp6TranslatorQuotaRequest req)
查询账户在指定地域IPV6转换实例和规则的配额DescribeIp6TranslatorsResponse
VpcClient. DescribeIp6Translators(DescribeIp6TranslatorsRequest req)
1.DescribeIpGeolocationDatabaseUrlResponse
VpcClient. DescribeIpGeolocationDatabaseUrl(DescribeIpGeolocationDatabaseUrlRequest req)
本接口(DescribeIpGeolocationDatabaseUrl)用于获取IP地理位置库下载链接。 本接口即将下线,仅供存量用户使用,暂停新增用户。DescribeIpGeolocationInfosResponse
VpcClient. DescribeIpGeolocationInfos(DescribeIpGeolocationInfosRequest req)
本接口(DescribeIpGeolocationInfos)用于查询IP地址信息,包括地理位置信息和网络信息。 本接口即将下线,仅供存量客户使用,暂停新增用户。DescribeLocalGatewayResponse
VpcClient. DescribeLocalGateway(DescribeLocalGatewayRequest req)
本接口(DescribeLocalGateway)用于查询CDC的本地网关。DescribeNatGatewayDestinationIpPortTranslationNatRulesResponse
VpcClient. DescribeNatGatewayDestinationIpPortTranslationNatRules(DescribeNatGatewayDestinationIpPortTranslationNatRulesRequest req)
本接口(DescribeNatGatewayDestinationIpPortTranslationNatRules)用于查询NAT网关端口转发规则对象数组。DescribeNatGatewayDirectConnectGatewayRouteResponse
VpcClient. DescribeNatGatewayDirectConnectGatewayRoute(DescribeNatGatewayDirectConnectGatewayRouteRequest req)
查询专线绑定NAT的路由DescribeNatGatewaysResponse
VpcClient. DescribeNatGateways(DescribeNatGatewaysRequest req)
本接口(DescribeNatGateways)用于查询 NAT 网关。DescribeNatGatewaySourceIpTranslationNatRulesResponse
VpcClient. DescribeNatGatewaySourceIpTranslationNatRules(DescribeNatGatewaySourceIpTranslationNatRulesRequest req)
本接口(DescribeNatGatewaySourceIpTranslationNatRules)用于查询NAT网关SNAT转发规则对象数组。DescribeNetDetectsResponse
VpcClient. DescribeNetDetects(DescribeNetDetectsRequest req)
本接口(DescribeNetDetects)用于查询网络探测列表。DescribeNetDetectStatesResponse
VpcClient. DescribeNetDetectStates(DescribeNetDetectStatesRequest req)
本接口(DescribeNetDetectStates)用于查询网络探测验证结果列表。DescribeNetworkAccountTypeResponse
VpcClient. DescribeNetworkAccountType(DescribeNetworkAccountTypeRequest req)
判断用户在网络侧的用户类型,如标准(带宽上移),传统(非上移)。DescribeNetworkAclQuintupleEntriesResponse
VpcClient. DescribeNetworkAclQuintupleEntries(DescribeNetworkAclQuintupleEntriesRequest req)
本接口(DescribeNetworkAclQuintupleEntries)查询入方向或出方向网络ACL五元组条目列表。DescribeNetworkAclsResponse
VpcClient. DescribeNetworkAcls(DescribeNetworkAclsRequest req)
本接口(DescribeNetworkAcls)用于查询网络ACL列表。DescribeNetworkInterfaceLimitResponse
VpcClient. DescribeNetworkInterfaceLimit(DescribeNetworkInterfaceLimitRequest req)
本接口(DescribeNetworkInterfaceLimit)根据CVM实例ID或弹性网卡ID查询弹性网卡配额,返回该CVM实例或弹性网卡能绑定的弹性网卡配额,以及弹性网卡可以分配的IP配额。DescribeNetworkInterfacesResponse
VpcClient. DescribeNetworkInterfaces(DescribeNetworkInterfacesRequest req)
本接口(DescribeNetworkInterfaces)用于查询弹性网卡列表。DescribeProductQuotaResponse
VpcClient. DescribeProductQuota(DescribeProductQuotaRequest req)
本接口(DescribeProductQuota)用于查询网络产品的配额信息。DescribeRouteConflictsResponse
VpcClient. DescribeRouteConflicts(DescribeRouteConflictsRequest req)
本接口(DescribeRouteConflicts)用于查询自定义路由策略与云联网路由策略冲突列表。DescribeRouteTablesResponse
VpcClient. DescribeRouteTables(DescribeRouteTablesRequest req)
本接口(DescribeRouteTables)用于查询路由表。DescribeSecurityGroupAssociationStatisticsResponse
VpcClient. DescribeSecurityGroupAssociationStatistics(DescribeSecurityGroupAssociationStatisticsRequest req)
本接口(DescribeSecurityGroupAssociationStatistics)用于查询安全组关联的实例统计。DescribeSecurityGroupLimitsResponse
VpcClient. DescribeSecurityGroupLimits(DescribeSecurityGroupLimitsRequest req)
本接口(DescribeSecurityGroupLimits)用于查询用户安全组配额。DescribeSecurityGroupPoliciesResponse
VpcClient. DescribeSecurityGroupPolicies(DescribeSecurityGroupPoliciesRequest req)
本接口(DescribeSecurityGroupPolicies)用于查询安全组规则。DescribeSecurityGroupReferencesResponse
VpcClient. DescribeSecurityGroupReferences(DescribeSecurityGroupReferencesRequest req)
本接口(DescribeSecurityGroupReferences)用于查询安全组被引用信息。DescribeSecurityGroupsResponse
VpcClient. DescribeSecurityGroups(DescribeSecurityGroupsRequest req)
本接口(DescribeSecurityGroups)用于查询安全组。DescribeServiceTemplateGroupsResponse
VpcClient. DescribeServiceTemplateGroups(DescribeServiceTemplateGroupsRequest req)
本接口(DescribeServiceTemplateGroups)用于查询协议端口模板集合。DescribeServiceTemplatesResponse
VpcClient. DescribeServiceTemplates(DescribeServiceTemplatesRequest req)
本接口(DescribeServiceTemplates)用于查询协议端口模板。DescribeSgSnapshotFileContentResponse
VpcClient. DescribeSgSnapshotFileContent(DescribeSgSnapshotFileContentRequest req)
本接口(DescribeSgSnapshotFileContent)用于查询安全组快照文件内容。DescribeSnapshotAttachedInstancesResponse
VpcClient. DescribeSnapshotAttachedInstances(DescribeSnapshotAttachedInstancesRequest req)
本接口(DescribeSnapshotAttachedInstances)用于查询快照策略关联实例列表。DescribeSnapshotFilesResponse
VpcClient. DescribeSnapshotFiles(DescribeSnapshotFilesRequest req)
本接口(DescribeSnapshotFiles)用于查询快照文件。DescribeSnapshotPoliciesResponse
VpcClient. DescribeSnapshotPolicies(DescribeSnapshotPoliciesRequest req)
本接口(DescribeSnapshotPolicies)用于查询快照策略。DescribeSpecificTrafficPackageUsedDetailsResponse
VpcClient. DescribeSpecificTrafficPackageUsedDetails(DescribeSpecificTrafficPackageUsedDetailsRequest req)
本接口 (DescribeSpecificTrafficPackageUsedDetails) 用于查询指定 共享流量包 的用量明细。DescribeSubnetResourceDashboardResponse
VpcClient. DescribeSubnetResourceDashboard(DescribeSubnetResourceDashboardRequest req)
本接口(DescribeSubnetResourceDashboard)用于查看Subnet资源信息。DescribeSubnetsResponse
VpcClient. DescribeSubnets(DescribeSubnetsRequest req)
本接口(DescribeSubnets)用于查询子网列表。DescribeTaskResultResponse
VpcClient. DescribeTaskResult(DescribeTaskResultRequest req)
查询EIP异步任务执行结果DescribeTemplateLimitsResponse
VpcClient. DescribeTemplateLimits(DescribeTemplateLimitsRequest req)
本接口(DescribeTemplateLimits)用于查询参数模板配额列表。DescribeTenantCcnsResponse
VpcClient. DescribeTenantCcns(DescribeTenantCcnsRequest req)
本接口(DescribeTenantCcns)用于获取要锁定的云联网实例列表。 该接口一般用来封禁出口限速的云联网实例, 目前联通内部运营系统通过云API调用, 因为出口限速无法按地域间封禁, 只能按更粗的云联网实例粒度封禁, 如果是地域间限速, 一般可以通过更细的限速实例粒度封禁(DescribeCrossBorderCcnRegionBandwidthLimits) 如有需要, 可以封禁任意云联网实例, 可接入到内部运营系统DescribeTrafficPackagesResponse
VpcClient. DescribeTrafficPackages(DescribeTrafficPackagesRequest req)
本接口 (DescribeTrafficPackages) 用于查询共享流量包详细信息,包括共享流量包唯一标识ID,名称,流量使用信息等DescribeUsedIpAddressResponse
VpcClient. DescribeUsedIpAddress(DescribeUsedIpAddressRequest req)
本接口(DescribeUsedIpAddress)用于查询Subnet或者Vpc内的ip的使用情况, 如ip被占用,返回占用ip的资源类别与id;如未被占用,返回空值DescribeVpcEndPointResponse
VpcClient. DescribeVpcEndPoint(DescribeVpcEndPointRequest req)
本接口(DescribeVpcEndPoint)用于查询终端节点列表。DescribeVpcEndPointServiceResponse
VpcClient. DescribeVpcEndPointService(DescribeVpcEndPointServiceRequest req)
查询终端节点服务列表。DescribeVpcEndPointServiceWhiteListResponse
VpcClient. DescribeVpcEndPointServiceWhiteList(DescribeVpcEndPointServiceWhiteListRequest req)
本接口(DescribeVpcEndPointServiceWhiteList)用于查询终端节点服务的服务白名单列表。DescribeVpcInstancesResponse
VpcClient. DescribeVpcInstances(DescribeVpcInstancesRequest req)
本接口(DescribeVpcInstances)用于查询VPC下的云主机实例列表。DescribeVpcIpv6AddressesResponse
VpcClient. DescribeVpcIpv6Addresses(DescribeVpcIpv6AddressesRequest req)
本接口(DescribeVpcIpv6Addresses)用于查询 `VPC` `IPv6` 信息。 只能查询已使用的`IPv6`信息,当查询未使用的IP时,本接口不会报错,但不会出现在返回结果里。DescribeVpcLimitsResponse
VpcClient. DescribeVpcLimits(DescribeVpcLimitsRequest req)
本接口(DescribeVpcLimits)用于获取私有网络配额,部分私有网络的配额有地域属性。 LimitTypes取值范围: appid-max-vpcs (每个开发商每个地域可创建的VPC数)。 vpc-max-subnets(每个VPC可创建的子网数)。 vpc-max-route-tables(每个VPC可创建的路由表数)。 route-table-max-policies(每个路由表可添加的策略数)。 vpc-max-vpn-gateways(每个VPC可创建的VPN网关数)。 appid-max-custom-gateways(每个开发商可创建的对端网关数)。 appid-max-vpn-connections(每个开发商可创建的VPN通道数)。 custom-gateway-max-vpn-connections(每个对端网关可创建的VPN通道数)。 vpn-gateway-max-custom-gateways(每个VPNGW可以创建的通道数)。 vpc-max-network-acls(每个VPC可创建的网络ACL数)。 network-acl-max-inbound-policies(每个网络ACL可添加的入站规则数)。 network-acl-max-outbound-policies(每个网络ACL可添加的出站规则数)。 vpc-max-vpcpeers(每个VPC可创建的对等连接数)。 vpc-max-available-vpcpeers(每个VPC可创建的有效对等连接数)。 vpc-max-basic-network-interconnections(每个VPC可创建的基础网络云主机与VPC互通数)。 direct-connection-max-snats(每个专线网关可创建的SNAT数)。 direct-connection-max-dnats(每个专线网关可创建的DNAT数)。 direct-connection-max-snapts(每个专线网关可创建的SNAPT数)。 direct-connection-max-dnapts(每个专线网关可创建的DNAPT数)。 vpc-max-nat-gateways(每个VPC可创建的NAT网关数)。 nat-gateway-max-eips(每个NAT可以购买的外网IP数量)。 vpc-max-enis(每个VPC可创建弹性网卡数)。 vpc-max-havips(每个VPC可创建HAVIP数)。 eni-max-private-ips(每个ENI可以绑定的内网IP数(ENI未绑定子机))。 nat-gateway-max-dnapts(每个NAT网关可创建的DNAPT数)。 vpc-max-ipv6s(每个VPC可分配的IPv6地址数)。 eni-max-ipv6s(每个ENI可分配的IPv6地址数)。 vpc-max-assistant_cidrs(每个VPC可分配的辅助CIDR数)。 appid-max-end-point-services (每个开发商每个地域可创建的终端节点服务个数)。 appid-max-end-point-service-white-lists (每个开发商每个地域可创建的终端节点服务白名单个数)。DescribeVpcPeeringConnectionsResponse
VpcClient. DescribeVpcPeeringConnections(DescribeVpcPeeringConnectionsRequest req)
查询私有网络对等连接。DescribeVpcPrivateIpAddressesResponse
VpcClient. DescribeVpcPrivateIpAddresses(DescribeVpcPrivateIpAddressesRequest req)
本接口(DescribeVpcPrivateIpAddresses)用于查询VPC内网IP信息。
只能查询已使用的IP信息,当查询未使用的IP时,本接口不会报错,但不会出现在返回结果里。DescribeVpcResourceDashboardResponse
VpcClient. DescribeVpcResourceDashboard(DescribeVpcResourceDashboardRequest req)
本接口(DescribeVpcResourceDashboard)用于查看VPC资源信息。DescribeVpcsResponse
VpcClient. DescribeVpcs(DescribeVpcsRequest req)
本接口(DescribeVpcs)用于查询私有网络列表。DescribeVpcTaskResultResponse
VpcClient. DescribeVpcTaskResult(DescribeVpcTaskResultRequest req)
本接口(DescribeVpcTaskResult)用于查询VPC任务执行结果。DescribeVpnConnectionsResponse
VpcClient. DescribeVpnConnections(DescribeVpnConnectionsRequest req)
本接口(DescribeVpnConnections)用于查询VPN通道列表。DescribeVpnGatewayCcnRoutesResponse
VpcClient. DescribeVpnGatewayCcnRoutes(DescribeVpnGatewayCcnRoutesRequest req)
本接口(DescribeVpnGatewayCcnRoutes)用于查询VPN网关云联网路由。DescribeVpnGatewayRoutesResponse
VpcClient. DescribeVpnGatewayRoutes(DescribeVpnGatewayRoutesRequest req)
本接口(DescribeVpnGatewayRoutes)用于查询VPN网关路由。DescribeVpnGatewaysResponse
VpcClient. DescribeVpnGateways(DescribeVpnGatewaysRequest req)
本接口(DescribeVpnGateways)用于查询VPN网关列表。DescribeVpnGatewaySslClientsResponse
VpcClient. DescribeVpnGatewaySslClients(DescribeVpnGatewaySslClientsRequest req)
本接口(DescribeVpnGatewaySslClients)用于查询SSL-VPN-CLIENT 列表。DescribeVpnGatewaySslServersResponse
VpcClient. DescribeVpnGatewaySslServers(DescribeVpnGatewaySslServersRequest req)
本接口(DescribeVpnGatewaySslServers)用于查询SSL-VPN SERVER 列表信息。DetachCcnInstancesResponse
VpcClient. DetachCcnInstances(DetachCcnInstancesRequest req)
本接口(DetachCcnInstances)用于从云联网实例中解关联指定的网络实例。
解关联网络实例后,相应的路由策略会一并删除。DetachClassicLinkVpcResponse
VpcClient. DetachClassicLinkVpc(DetachClassicLinkVpcRequest req)
本接口(DetachClassicLinkVpc)用于删除私有网络和基础网络设备互通。 >?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >DetachNetworkInterfaceResponse
VpcClient. DetachNetworkInterface(DetachNetworkInterfaceRequest req)
本接口(DetachNetworkInterface)用于弹性网卡解绑云服务器。 本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。DetachSnapshotInstancesResponse
VpcClient. DetachSnapshotInstances(DetachSnapshotInstancesRequest req)
本接口(DetachSnapshotInstances)用于快照策略解关联实例。DisableCcnRoutesResponse
VpcClient. DisableCcnRoutes(DisableCcnRoutesRequest req)
本接口(DisableCcnRoutes)用于禁用已经启用的云联网(CCN)路由。DisableFlowLogsResponse
VpcClient. DisableFlowLogs(DisableFlowLogsRequest req)
本接口(DisableFlowLogs)用于停止流日志。DisableGatewayFlowMonitorResponse
VpcClient. DisableGatewayFlowMonitor(DisableGatewayFlowMonitorRequest req)
本接口(DisableGatewayFlowMonitor)用于关闭网关流量监控。DisableRoutesResponse
VpcClient. DisableRoutes(DisableRoutesRequest req)
本接口(DisableRoutes)用于禁用已启用的子网路由DisableSnapshotPoliciesResponse
VpcClient. DisableSnapshotPolicies(DisableSnapshotPoliciesRequest req)
本接口(DisableSnapshotPolicies)用于停用快照策略。DisableVpnGatewaySslClientCertResponse
VpcClient. DisableVpnGatewaySslClientCert(DisableVpnGatewaySslClientCertRequest req)
禁用SSL-VPN-CLIENT 证书DisassociateAddressResponse
VpcClient. DisassociateAddress(DisassociateAddressRequest req)
本接口 (DisassociateAddress) 用于解绑[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称 EIP)。 支持CVM实例,弹性网卡上的EIP解绑 不支持NAT上的EIP解绑。NAT上的EIP解绑请参考[DisassociateNatGatewayAddress](https://cloud.tencent.com/document/api/215/36716) 只有状态为 BIND 和 BIND_ENI 的 EIP 才能进行解绑定操作。 EIP 如果被封堵,则不能进行解绑定操作。DisassociateDhcpIpWithAddressIpResponse
VpcClient. DisassociateDhcpIpWithAddressIp(DisassociateDhcpIpWithAddressIpRequest req)
本接口(DisassociateDhcpIpWithAddressIp)用于将DhcpIp已绑定的弹性公网IP(EIP)解除绑定。
>?本接口为异步接口,可调用 [DescribeVpcTaskResult](https://cloud.tencent.com/document/api/215/59037) 接口查询任务执行结果,待任务执行成功后再进行其他操作。 >DisassociateDirectConnectGatewayNatGatewayResponse
VpcClient. DisassociateDirectConnectGatewayNatGateway(DisassociateDirectConnectGatewayNatGatewayRequest req)
将专线网关与NAT网关解绑,解绑之后,专线网关将不能通过NAT网关访问公网DisassociateNatGatewayAddressResponse
VpcClient. DisassociateNatGatewayAddress(DisassociateNatGatewayAddressRequest req)
本接口(DisassociateNatGatewayAddress)用于NAT网关解绑弹性IP。DisassociateNetworkAclSubnetsResponse
VpcClient. DisassociateNetworkAclSubnets(DisassociateNetworkAclSubnetsRequest req)
本接口(DisassociateNetworkAclSubnets)用于网络ACL解关联VPC下的子网。DisassociateNetworkInterfaceSecurityGroupsResponse
VpcClient. DisassociateNetworkInterfaceSecurityGroups(DisassociateNetworkInterfaceSecurityGroupsRequest req)
本接口(DisassociateNetworkInterfaceSecurityGroups)用于弹性网卡解绑安全组。支持弹性网卡完全解绑安全组。DisassociateVpcEndPointSecurityGroupsResponse
VpcClient. DisassociateVpcEndPointSecurityGroups(DisassociateVpcEndPointSecurityGroupsRequest req)
本接口(DisassociateVpcEndPointSecurityGroups)用于终端节点解绑安全组。DownloadCustomerGatewayConfigurationResponse
VpcClient. DownloadCustomerGatewayConfiguration(DownloadCustomerGatewayConfigurationRequest req)
本接口(DownloadCustomerGatewayConfiguration)用于下载VPN通道配置。DownloadVpnGatewaySslClientCertResponse
VpcClient. DownloadVpnGatewaySslClientCert(DownloadVpnGatewaySslClientCertRequest req)
本接口(DownloadVpnGatewaySslClientCert)用于下载SSL-VPN-CLIENT 客户端证书。EnableCcnRoutesResponse
VpcClient. EnableCcnRoutes(EnableCcnRoutesRequest req)
本接口(EnableCcnRoutes)用于启用已经加入云联网(CCN)的路由。
本接口会校验启用后,是否与已有路由冲突,如果冲突,则无法启用,失败处理。路由冲突时,需要先禁用与之冲突的路由,才能启用该路由。EnableFlowLogsResponse
VpcClient. EnableFlowLogs(EnableFlowLogsRequest req)
本接口(EnableFlowLogs)用于启动流日志。EnableGatewayFlowMonitorResponse
VpcClient. EnableGatewayFlowMonitor(EnableGatewayFlowMonitorRequest req)
本接口(EnableGatewayFlowMonitor)用于开启网关流量监控。EnableRoutesResponse
VpcClient. EnableRoutes(EnableRoutesRequest req)
本接口(EnableRoutes)用于启用已禁用的子网路由。
本接口会校验启用后,是否与已有路由冲突,如果冲突,则无法启用,失败处理。路由冲突时,需要先禁用与之冲突的路由,才能启用该路由。EnableSnapshotPoliciesResponse
VpcClient. EnableSnapshotPolicies(EnableSnapshotPoliciesRequest req)
本接口(EnableSnapshotPolicies)用于启用快照策略。EnableVpcEndPointConnectResponse
VpcClient. EnableVpcEndPointConnect(EnableVpcEndPointConnectRequest req)
本接口(EnableVpcEndPointConnect)用于是否接受终端节点连接请求。EnableVpnGatewaySslClientCertResponse
VpcClient. EnableVpnGatewaySslClientCert(EnableVpnGatewaySslClientCertRequest req)
本接口(EnableVpnGatewaySslClientCert)用于启用SSL-VPN-CLIENT 证书。GenerateVpnConnectionDefaultHealthCheckIpResponse
VpcClient. GenerateVpnConnectionDefaultHealthCheckIp(GenerateVpnConnectionDefaultHealthCheckIpRequest req)
本接口(GenerateVpnConnectionDefaultHealthCheckIp)用于获取一对VPN通道健康检查地址。GetCcnRegionBandwidthLimitsResponse
VpcClient. GetCcnRegionBandwidthLimits(GetCcnRegionBandwidthLimitsRequest req)
本接口(GetCcnRegionBandwidthLimits)用于查询云联网相关地域带宽信息,其中预付费模式的云联网仅支持地域间限速,后付费模式的云联网支持地域间限速和地域出口限速。HaVipAssociateAddressIpResponse
VpcClient. HaVipAssociateAddressIp(HaVipAssociateAddressIpRequest req)
本接口(HaVipAssociateAddressIp)用于高可用虚拟IP(HAVIP)绑定弹性公网IP(EIP)。
本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。HaVipDisassociateAddressIpResponse
VpcClient. HaVipDisassociateAddressIp(HaVipDisassociateAddressIpRequest req)
本接口(HaVipDisassociateAddressIp)用于将高可用虚拟IP(HAVIP)已绑定的弹性公网IP(EIP)解除绑定。
本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。InquirePriceCreateDirectConnectGatewayResponse
VpcClient. InquirePriceCreateDirectConnectGateway(InquirePriceCreateDirectConnectGatewayRequest req)
本接口(DescribePriceCreateDirectConnectGateway)用于创建专线网关询价。InquiryPriceCreateVpnGatewayResponse
VpcClient. InquiryPriceCreateVpnGateway(InquiryPriceCreateVpnGatewayRequest req)
本接口(InquiryPriceCreateVpnGateway)用于创建VPN网关询价。InquiryPriceRenewVpnGatewayResponse
VpcClient. InquiryPriceRenewVpnGateway(InquiryPriceRenewVpnGatewayRequest req)
本接口(InquiryPriceRenewVpnGateway)用于续费VPN网关询价。目前仅支持IPSEC类型网关的询价。InquiryPriceResetVpnGatewayInternetMaxBandwidthResponse
VpcClient. InquiryPriceResetVpnGatewayInternetMaxBandwidth(InquiryPriceResetVpnGatewayInternetMaxBandwidthRequest req)
本接口(InquiryPriceResetVpnGatewayInternetMaxBandwidth)调整VPN网关带宽上限询价。LockCcnBandwidthsResponse
VpcClient. LockCcnBandwidths(LockCcnBandwidthsRequest req)
本接口(LockCcnBandwidths)用户锁定云联网限速实例。 该接口一般用来封禁地域间限速的云联网实例下的限速实例, 目前联通内部运营系统通过云API调用, 如果是出口限速, 一般使用更粗的云联网实例粒度封禁(LockCcns)。 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统。LockCcnsResponse
VpcClient. LockCcns(LockCcnsRequest req)
本接口(LockCcns)用于锁定云联网实例 该接口一般用来封禁出口限速的云联网实例, 目前联通内部运营系统通过云API调用, 因为出口限速无法按地域间封禁, 只能按更粗的云联网实例粒度封禁, 如果是地域间限速, 一般可以通过更细的限速实例粒度封禁(LockCcnBandwidths) 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统MigrateNetworkInterfaceResponse
VpcClient. MigrateNetworkInterface(MigrateNetworkInterfaceRequest req)
本接口(MigrateNetworkInterface)用于弹性网卡迁移。 本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。MigratePrivateIpAddressResponse
VpcClient. MigratePrivateIpAddress(MigratePrivateIpAddressRequest req)
本接口(MigratePrivateIpAddress)用于弹性网卡内网IP迁移。 该接口用于将一个内网IP从一个弹性网卡上迁移到另外一个弹性网卡,主IP地址不支持迁移。 迁移前后的弹性网卡必须在同一个子网内。 本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。ModifyAddressAttributeResponse
VpcClient. ModifyAddressAttribute(ModifyAddressAttributeRequest req)
本接口 (ModifyAddressAttribute) 用于修改[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称 EIP)的名称。ModifyAddressesBandwidthResponse
VpcClient. ModifyAddressesBandwidth(ModifyAddressesBandwidthRequest req)
本接口(ModifyAddressesBandwidth)用于调整[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称EIP)带宽,支持后付费EIP, 预付费EIP和带宽包EIPModifyAddressInternetChargeTypeResponse
VpcClient. ModifyAddressInternetChargeType(ModifyAddressInternetChargeTypeRequest req)
该接口用于调整具有带宽属性弹性公网IP的网络计费模式 支持BANDWIDTH_PREPAID_BY_MONTH和TRAFFIC_POSTPAID_BY_HOUR两种网络计费模式之间的切换。 每个弹性公网IP支持调整两次,次数超出则无法调整。ModifyAddressTemplateAttributeResponse
VpcClient. ModifyAddressTemplateAttribute(ModifyAddressTemplateAttributeRequest req)
本接口(ModifyAddressTemplateAttribute)用于修改IP地址模板。ModifyAddressTemplateGroupAttributeResponse
VpcClient. ModifyAddressTemplateGroupAttribute(ModifyAddressTemplateGroupAttributeRequest req)
本接口(ModifyAddressTemplateGroupAttribute)用于修改IP地址模板集合。ModifyAssistantCidrResponse
VpcClient. ModifyAssistantCidr(ModifyAssistantCidrRequest req)
本接口(ModifyAssistantCidr)用于批量修改辅助CIDR,支持新增和删除。ModifyBandwidthPackageAttributeResponse
VpcClient. ModifyBandwidthPackageAttribute(ModifyBandwidthPackageAttributeRequest req)
接口用于修改带宽包属性,包括带宽包名字等ModifyCcnAttachedInstancesAttributeResponse
VpcClient. ModifyCcnAttachedInstancesAttribute(ModifyCcnAttachedInstancesAttributeRequest req)
修改CCN关联实例属性,目前仅修改备注descriptionModifyCcnAttributeResponse
VpcClient. ModifyCcnAttribute(ModifyCcnAttributeRequest req)
本接口(ModifyCcnAttribute)用于修改云联网(CCN)的相关属性。ModifyCcnRegionBandwidthLimitsTypeResponse
VpcClient. ModifyCcnRegionBandwidthLimitsType(ModifyCcnRegionBandwidthLimitsTypeRequest req)
本接口(ModifyCcnRegionBandwidthLimitsType)用于修改后付费云联网实例修改带宽限速策略。ModifyCustomerGatewayAttributeResponse
VpcClient. ModifyCustomerGatewayAttribute(ModifyCustomerGatewayAttributeRequest req)
本接口(ModifyCustomerGatewayAttribute)用于修改对端网关信息。ModifyDhcpIpAttributeResponse
VpcClient. ModifyDhcpIpAttribute(ModifyDhcpIpAttributeRequest req)
本接口(ModifyDhcpIpAttribute)用于修改DhcpIp属性ModifyDirectConnectGatewayAttributeResponse
VpcClient. ModifyDirectConnectGatewayAttribute(ModifyDirectConnectGatewayAttributeRequest req)
本接口(ModifyDirectConnectGatewayAttribute)用于修改专线网关属性ModifyFlowLogAttributeResponse
VpcClient. ModifyFlowLogAttribute(ModifyFlowLogAttributeRequest req)
本接口(ModifyFlowLogAttribute)用于修改流日志属性。ModifyGatewayFlowQosResponse
VpcClient. ModifyGatewayFlowQos(ModifyGatewayFlowQosRequest req)
本接口(ModifyGatewayFlowQos)用于调整网关流控带宽。ModifyHaVipAttributeResponse
VpcClient. ModifyHaVipAttribute(ModifyHaVipAttributeRequest req)
本接口(ModifyHaVipAttribute)用于修改高可用虚拟IP(HAVIP)属性。ModifyIp6AddressesBandwidthResponse
VpcClient. ModifyIp6AddressesBandwidth(ModifyIp6AddressesBandwidthRequest req)
该接口用于修改IPV6地址访问internet的带宽ModifyIp6RuleResponse
VpcClient. ModifyIp6Rule(ModifyIp6RuleRequest req)
该接口用于修改IPV6转换规则,当前仅支持修改转换规则名称,IPV4地址和IPV4端口号ModifyIp6TranslatorResponse
VpcClient. ModifyIp6Translator(ModifyIp6TranslatorRequest req)
该接口用于修改IP6转换实例属性,当前仅支持修改实例名称。ModifyIpv6AddressesAttributeResponse
VpcClient. ModifyIpv6AddressesAttribute(ModifyIpv6AddressesAttributeRequest req)
本接口(ModifyIpv6AddressesAttribute)用于修改弹性网卡内网IPv6地址属性。ModifyLocalGatewayResponse
VpcClient. ModifyLocalGateway(ModifyLocalGatewayRequest req)
本接口(ModifyLocalGateway)用于修改CDC的本地网关。ModifyNatGatewayAttributeResponse
VpcClient. ModifyNatGatewayAttribute(ModifyNatGatewayAttributeRequest req)
本接口(ModifyNatGatewayAttribute)用于修改NAT网关的属性。ModifyNatGatewayDestinationIpPortTranslationNatRuleResponse
VpcClient. ModifyNatGatewayDestinationIpPortTranslationNatRule(ModifyNatGatewayDestinationIpPortTranslationNatRuleRequest req)
本接口(ModifyNatGatewayDestinationIpPortTranslationNatRule)用于修改NAT网关端口转发规则。ModifyNatGatewaySourceIpTranslationNatRuleResponse
VpcClient. ModifyNatGatewaySourceIpTranslationNatRule(ModifyNatGatewaySourceIpTranslationNatRuleRequest req)
本接口(ModifyNatGatewaySourceIpTranslationNatRule)用于修改NAT网关SNAT转发规则。ModifyNetDetectResponse
VpcClient. ModifyNetDetect(ModifyNetDetectRequest req)
本接口(ModifyNetDetect)用于修改网络探测参数。ModifyNetworkAclAttributeResponse
VpcClient. ModifyNetworkAclAttribute(ModifyNetworkAclAttributeRequest req)
本接口(ModifyNetworkAclAttribute)用于修改网络ACL属性。ModifyNetworkAclEntriesResponse
VpcClient. ModifyNetworkAclEntries(ModifyNetworkAclEntriesRequest req)
本接口(ModifyNetworkAclEntries)用于修改(包括添加和删除)网络ACL的入站规则和出站规则。在NetworkAclEntrySet参数中: 若同时传入入站规则和出站规则,则重置原有的入站规则和出站规则,并分别导入传入的规则。 若仅传入入站规则,则仅重置原有的入站规则,并导入传入的规则,不影响原有的出站规则(若仅传入出站规则,处理方式类似入站方向)。ModifyNetworkAclQuintupleEntriesResponse
VpcClient. ModifyNetworkAclQuintupleEntries(ModifyNetworkAclQuintupleEntriesRequest req)
本接口(ModifyNetworkAclQuintupleEntries)用于修改网络ACL五元组的入站规则和出站规则。在NetworkAclQuintupleEntrySet参数中:NetworkAclQuintupleEntry需要提供NetworkAclQuintupleEntryId。ModifyNetworkInterfaceAttributeResponse
VpcClient. ModifyNetworkInterfaceAttribute(ModifyNetworkInterfaceAttributeRequest req)
本接口(ModifyNetworkInterfaceAttribute)用于修改弹性网卡属性。ModifyNetworkInterfaceQosResponse
VpcClient. ModifyNetworkInterfaceQos(ModifyNetworkInterfaceQosRequest req)
本接口(ModifyNetworkInterfaceQos)用于修改弹性网卡服务质量。ModifyPrivateIpAddressesAttributeResponse
VpcClient. ModifyPrivateIpAddressesAttribute(ModifyPrivateIpAddressesAttributeRequest req)
本接口(ModifyPrivateIpAddressesAttribute)用于修改弹性网卡内网IP属性。ModifyRouteTableAttributeResponse
VpcClient. ModifyRouteTableAttribute(ModifyRouteTableAttributeRequest req)
本接口(ModifyRouteTableAttribute)用于修改路由表(RouteTable)属性。ModifySecurityGroupAttributeResponse
VpcClient. ModifySecurityGroupAttribute(ModifySecurityGroupAttributeRequest req)
本接口(ModifySecurityGroupAttribute)用于修改安全组(SecurityGroupPolicy)属性。ModifySecurityGroupPoliciesResponse
VpcClient. ModifySecurityGroupPolicies(ModifySecurityGroupPoliciesRequest req)
本接口(ModifySecurityGroupPolicies)用于重置安全组出站和入站规则(SecurityGroupPolicy)。 该接口不支持自定义索引 PolicyIndex。 在 SecurityGroupPolicySet 参数中: 如果指定 SecurityGroupPolicySet.Version 为0, 表示清空所有规则,并忽略 Egress 和 Ingress。 如果指定 SecurityGroupPolicySet.Version 不为0, 在添加出站和入站规则(Egress 和 Ingress)时: Protocol 字段支持输入 TCP, UDP, ICMP, ICMPV6, GRE, ALL。 CidrBlock 字段允许输入符合 cidr 格式标准的任意字符串。在基础网络中,如果 CidrBlock 包含您的账户内的云服务器之外的设备在腾讯云的内网 IP,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。 Ipv6CidrBlock 字段允许输入符合 IPv6 cidr 格式标准的任意字符串。在基础网络中,如果Ipv6CidrBlock 包含您的账户内的云服务器之外的设备在腾讯云的内网 IPv6,并不代表此规则允许您访问这些设备,租户之间网络隔离规则优先于安全组中的内网规则。 SecurityGroupId 字段允许输入与待修改的安全组位于相同项目中的安全组 ID,包括这个安全组 ID 本身,代表安全组下所有云服务器的内网 IP。使用这个字段时,这条规则用来匹配网络报文的过程中会随着被使用的这个ID所关联的云服务器变化而变化,不需要重新修改。 Port 字段允许输入一个单独端口号,或者用减号分隔的两个端口号代表端口范围,例如80或8000-8010。只有当 Protocol 字段是 TCP 或 UDP 时,Port 字段才被接受。 Action 字段只允许输入 ACCEPT 或 DROP。 CidrBlock, Ipv6CidrBlock, SecurityGroupId, AddressTemplate 四者是排他关系,不允许同时输入,Protocol + Port 和 ServiceTemplate 二者是排他关系,不允许同时输入。ModifyServiceTemplateAttributeResponse
VpcClient. ModifyServiceTemplateAttribute(ModifyServiceTemplateAttributeRequest req)
本接口(ModifyServiceTemplateAttribute)用于修改协议端口模板。ModifyServiceTemplateGroupAttributeResponse
VpcClient. ModifyServiceTemplateGroupAttribute(ModifyServiceTemplateGroupAttributeRequest req)
本接口(ModifyServiceTemplateGroupAttribute)用于修改协议端口模板集合。ModifySnapshotPoliciesResponse
VpcClient. ModifySnapshotPolicies(ModifySnapshotPoliciesRequest req)
本接口(ModifySnapshotPolicies)用于修改快照策略。ModifySubnetAttributeResponse
VpcClient. ModifySubnetAttribute(ModifySubnetAttributeRequest req)
本接口(ModifySubnetAttribute)用于修改子网属性。ModifyTemplateMemberResponse
VpcClient. ModifyTemplateMember(ModifyTemplateMemberRequest req)
修改模板对象中的IP地址、协议端口、IP地址组、协议端口组。当前仅支持北京、泰国、北美地域请求。ModifyVpcAttributeResponse
VpcClient. ModifyVpcAttribute(ModifyVpcAttributeRequest req)
本接口(ModifyVpcAttribute)用于修改私有网络(VPC)的相关属性。ModifyVpcEndPointAttributeResponse
VpcClient. ModifyVpcEndPointAttribute(ModifyVpcEndPointAttributeRequest req)
本接口(ModifyVpcEndPointAttribute)用于修改终端节点属性。ModifyVpcEndPointServiceAttributeResponse
VpcClient. ModifyVpcEndPointServiceAttribute(ModifyVpcEndPointServiceAttributeRequest req)
本接口(ModifyVpcEndPointServiceAttribute)用于修改终端节点服务属性。ModifyVpcEndPointServiceWhiteListResponse
VpcClient. ModifyVpcEndPointServiceWhiteList(ModifyVpcEndPointServiceWhiteListRequest req)
本接口(ModifyVpcEndPointServiceWhiteList)用于修改终端节点服务白名单属性。ModifyVpcPeeringConnectionResponse
VpcClient. ModifyVpcPeeringConnection(ModifyVpcPeeringConnectionRequest req)
本接口(ModifyVpcPeeringConnection)用于修改私有网络对等连接属性。ModifyVpnConnectionAttributeResponse
VpcClient. ModifyVpnConnectionAttribute(ModifyVpnConnectionAttributeRequest req)
本接口(ModifyVpnConnectionAttribute)用于修改VPN通道。ModifyVpnGatewayAttributeResponse
VpcClient. ModifyVpnGatewayAttribute(ModifyVpnGatewayAttributeRequest req)
本接口(ModifyVpnGatewayAttribute)用于修改VPN网关属性。ModifyVpnGatewayCcnRoutesResponse
VpcClient. ModifyVpnGatewayCcnRoutes(ModifyVpnGatewayCcnRoutesRequest req)
本接口(ModifyVpnGatewayCcnRoutes)用于修改VPN网关云联网路由。ModifyVpnGatewayRoutesResponse
VpcClient. ModifyVpnGatewayRoutes(ModifyVpnGatewayRoutesRequest req)
本接口(ModifyVpnGatewayRoutes)用于修改VPN路由是否启用。NotifyRoutesResponse
VpcClient. NotifyRoutes(NotifyRoutesRequest req)
本接口(NotifyRoutes)用于路由表列表页操作增加“发布到云联网”,发布路由到云联网。RefreshDirectConnectGatewayRouteToNatGatewayResponse
VpcClient. RefreshDirectConnectGatewayRouteToNatGateway(RefreshDirectConnectGatewayRouteToNatGatewayRequest req)
刷新专线直连nat路由,更新nat到专线的路由表RejectAttachCcnInstancesResponse
VpcClient. RejectAttachCcnInstances(RejectAttachCcnInstancesRequest req)
本接口(RejectAttachCcnInstances)用于跨账号关联实例时,云联网所有者拒绝关联操作。RejectVpcPeeringConnectionResponse
VpcClient. RejectVpcPeeringConnection(RejectVpcPeeringConnectionRequest req)
本接口(RejectVpcPeeringConnection)用于驳回对等连接请求。ReleaseAddressesResponse
VpcClient. ReleaseAddresses(ReleaseAddressesRequest req)
本接口 (ReleaseAddresses) 用于释放一个或多个[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称 EIP)。 该操作不可逆,释放后 EIP 关联的 IP 地址将不再属于您的名下。 只有状态为 UNBIND 的 EIP 才能进行释放操作。ReleaseIp6AddressesBandwidthResponse
VpcClient. ReleaseIp6AddressesBandwidth(ReleaseIp6AddressesBandwidthRequest req)
该接口用于给弹性公网IPv6地址释放带宽。RemoveBandwidthPackageResourcesResponse
VpcClient. RemoveBandwidthPackageResources(RemoveBandwidthPackageResourcesRequest req)
接口用于删除带宽包资源,包括[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)和[负载均衡](https://cloud.tencent.com/document/product/214/517)等RemoveIp6RulesResponse
VpcClient. RemoveIp6Rules(RemoveIp6RulesRequest req)
1.RenewAddressesResponse
VpcClient. RenewAddresses(RenewAddressesRequest req)
该接口用于续费包月带宽计费模式的弹性公网IPRenewVpnGatewayResponse
VpcClient. RenewVpnGateway(RenewVpnGatewayRequest req)
本接口(RenewVpnGateway)用于预付费(包年包月)VPN网关续费。目前只支持IPSEC网关。ReplaceDirectConnectGatewayCcnRoutesResponse
VpcClient. ReplaceDirectConnectGatewayCcnRoutes(ReplaceDirectConnectGatewayCcnRoutesRequest req)
本接口(ReplaceDirectConnectGatewayCcnRoutes)根据路由ID(RouteId)修改指定的路由(Route),支持批量修改。ReplaceRoutesResponse
VpcClient. ReplaceRoutes(ReplaceRoutesRequest req)
本接口(ReplaceRoutes)根据路由策略ID(RouteId)修改指定的路由策略(Route),支持批量修改。ReplaceRouteTableAssociationResponse
VpcClient. ReplaceRouteTableAssociation(ReplaceRouteTableAssociationRequest req)
本接口(ReplaceRouteTableAssociation)用于修改子网(Subnet)关联的路由表(RouteTable)。 一个子网只能关联一个路由表。ReplaceSecurityGroupPoliciesResponse
VpcClient. ReplaceSecurityGroupPolicies(ReplaceSecurityGroupPoliciesRequest req)
本接口(ReplaceSecurityGroupPolicies)用于批量修改安全组规则(SecurityGroupPolicy)。 单个请求中只能替换单个方向的一条或多条规则, 必须要指定索引(PolicyIndex)。ReplaceSecurityGroupPolicyResponse
VpcClient. ReplaceSecurityGroupPolicy(ReplaceSecurityGroupPolicyRequest req)
本接口(ReplaceSecurityGroupPolicy)用于替换单条安全组规则(SecurityGroupPolicy)。 单个请求中只能替换单个方向的一条规则, 必须要指定索引(PolicyIndex)。ResetAttachCcnInstancesResponse
VpcClient. ResetAttachCcnInstances(ResetAttachCcnInstancesRequest req)
本接口(ResetAttachCcnInstances)用于跨账号关联实例申请过期时,重新申请关联操作。ResetNatGatewayConnectionResponse
VpcClient. ResetNatGatewayConnection(ResetNatGatewayConnectionRequest req)
本接口(ResetNatGatewayConnection)用来NAT网关并发连接上限。ResetRoutesResponse
VpcClient. ResetRoutes(ResetRoutesRequest req)
本接口(ResetRoutes)用于对某个路由表名称和所有路由策略(Route)进行重新设置。
注意: 调用本接口是先删除当前路由表中所有路由策略, 再保存新提交的路由策略内容, 会引起网络中断。ResetVpnConnectionResponse
VpcClient. ResetVpnConnection(ResetVpnConnectionRequest req)
本接口(ResetVpnConnection)用于重置VPN通道。ResetVpnGatewayInternetMaxBandwidthResponse
VpcClient. ResetVpnGatewayInternetMaxBandwidth(ResetVpnGatewayInternetMaxBandwidthRequest req)
本接口(ResetVpnGatewayInternetMaxBandwidth)用于调整VPN网关带宽上限。VPN网关带宽目前仅支持部分带宽范围内升降配,如【5,100】Mbps和【200,1000】Mbps,在各自带宽范围内可提升配额,跨范围提升配额和降配暂不支持,如果是包年包月VPN网关需要在有效期内。ResumeSnapshotInstanceResponse
VpcClient. ResumeSnapshotInstance(ResumeSnapshotInstanceRequest req)
本接口(ResumeSnapshotInstance)用于根据备份内容恢复安全组策略。ReturnNormalAddressesResponse
VpcClient. ReturnNormalAddresses(ReturnNormalAddressesRequest req)
本接口(ReturnNormalAddresses)用于解绑并释放普通公网IP。 为完善公网IP的访问管理功能,此接口于2022年12月15日升级优化鉴权功能,升级后子用户调用此接口需向主账号申请CAM策略授权,否则可能调用失败。您可以提前为子账号配置操作授权,详情见[授权指南](https://cloud.tencent.com/document/product/598/34545)。SetCcnRegionBandwidthLimitsResponse
VpcClient. SetCcnRegionBandwidthLimits(SetCcnRegionBandwidthLimitsRequest req)
本接口(SetCcnRegionBandwidthLimits)用于设置云联网(CCN)各地域出带宽上限,或者地域间带宽上限。SetVpnGatewaysRenewFlagResponse
VpcClient. SetVpnGatewaysRenewFlag(SetVpnGatewaysRenewFlagRequest req)
本接口(SetVpnGatewaysRenewFlag)用于设置VPNGW续费标记。TransformAddressResponse
VpcClient. TransformAddress(TransformAddressRequest req)
本接口 (TransformAddress) 用于将实例的普通公网 IP 转换为[弹性公网IP](https://cloud.tencent.com/document/product/213/1941)(简称 EIP)。 平台对用户每地域每日解绑 EIP 重新分配普通公网 IP 次数有所限制(可参见 [EIP 产品简介](/document/product/213/1941))。上述配额可通过 [DescribeAddressQuota](https://cloud.tencent.com/document/api/213/1378) 接口获取。UnassignIpv6AddressesResponse
VpcClient. UnassignIpv6Addresses(UnassignIpv6AddressesRequest req)
本接口(UnassignIpv6Addresses)用于释放弹性网卡`IPv6`地址。
本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。UnassignIpv6CidrBlockResponse
VpcClient. UnassignIpv6CidrBlock(UnassignIpv6CidrBlockRequest req)
本接口(UnassignIpv6CidrBlock)用于释放IPv6网段。
网段如果还有IP占用且未回收,则网段无法释放。UnassignIpv6SubnetCidrBlockResponse
VpcClient. UnassignIpv6SubnetCidrBlock(UnassignIpv6SubnetCidrBlockRequest req)
本接口(UnassignIpv6SubnetCidrBlock)用于释放IPv6子网段。
子网段如果还有IP占用且未回收,则子网段无法释放。UnassignPrivateIpAddressesResponse
VpcClient. UnassignPrivateIpAddresses(UnassignPrivateIpAddressesRequest req)
本接口(UnassignPrivateIpAddresses)用于弹性网卡退还内网 IP。 退还弹性网卡上的辅助内网IP,接口自动解关联弹性公网 IP。不能退还弹性网卡的主内网IP。 本接口是异步完成,如需查询异步任务执行结果,请使用本接口返回的`RequestId`轮询`DescribeVpcTaskResult`接口。UnlockCcnBandwidthsResponse
VpcClient. UnlockCcnBandwidths(UnlockCcnBandwidthsRequest req)
本接口(UnlockCcnBandwidths)用户解锁云联网限速实例。 该接口一般用来封禁地域间限速的云联网实例下的限速实例, 目前联通内部运营系统通过云API调用, 如果是出口限速, 一般使用更粗的云联网实例粒度封禁(SecurityUnlockCcns)。 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统。UnlockCcnsResponse
VpcClient. UnlockCcns(UnlockCcnsRequest req)
本接口(UnlockCcns)用于解锁云联网实例 该接口一般用来解封禁出口限速的云联网实例, 目前联通内部运营系统通过云API调用, 因为出口限速无法按地域间解封禁, 只能按更粗的云联网实例粒度解封禁, 如果是地域间限速, 一般可以通过更细的限速实例粒度解封禁(UnlockCcnBandwidths) 如有需要, 可以封禁任意限速实例, 可接入到内部运营系统WithdrawNotifyRoutesResponse
VpcClient. WithdrawNotifyRoutes(WithdrawNotifyRoutesRequest req)
本接口(WithdrawNotifyRoutes)用于撤销已发布到云联网的路由。路由表列表页操作增加“从云联网撤销”。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.vrs.v20200824
Methods in com.tencentcloudapi.vrs.v20200824 that throw TencentCloudSDKException Modifier and Type Method Description CancelVRSTaskResponse
VrsClient. CancelVRSTask(CancelVRSTaskRequest req)
声音复刻取消任务接口CreateVRSTaskResponse
VrsClient. CreateVRSTask(CreateVRSTaskRequest req)
本接口服务对提交音频进行声音复刻任务创建接口,异步返回复刻结果。 • 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8" • 签名方法参考 公共参数 中签名方法v3。DescribeVRSTaskStatusResponse
VrsClient. DescribeVRSTaskStatus(DescribeVRSTaskStatusRequest req)
在调用声音复刻创建任务请求接口后,有回调和轮询两种方式获取识别结果。 • 当采用回调方式时,识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL,具体请参见 声音复刻结果回调 。 • 当采用轮询方式时,需要主动提交任务ID来轮询识别结果,共有任务成功、等待、执行中和失败四种结果,具体信息请参见下文说明。 • 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8" • 签名方法参考 公共参数 中签名方法v3。DetectEnvAndSoundQualityResponse
VrsClient. DetectEnvAndSoundQuality(DetectEnvAndSoundQualityRequest req)
本接口用于检测音频的环境和音频质量。 • 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8" • 签名方法参考 公共参数 中签名方法v3。DownloadVRSModelResponse
VrsClient. DownloadVRSModel(DownloadVRSModelRequest req)
下载声音复刻离线模型GetTrainingTextResponse
VrsClient. GetTrainingText(GetTrainingTextRequest req)
本接口用于获取声音复刻训练文本信息。 请求方法为 HTTP POST , Content-Type为"application/json; charset=utf-8" • 签名方法参考 公共参数 中签名方法v3。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.waf.v20180125
-
Uses of TencentCloudSDKException in com.tencentcloudapi.wav.v20210129
-
Uses of TencentCloudSDKException in com.tencentcloudapi.wedata.v20210820
-
Uses of TencentCloudSDKException in com.tencentcloudapi.weilingwith.v20230427
Methods in com.tencentcloudapi.weilingwith.v20230427 that throw TencentCloudSDKException Modifier and Type Method Description DescribeApplicationListResponse
WeilingwithClient. DescribeApplicationList(DescribeApplicationListRequest req)
查询指定空间关联的应用列表DescribeEdgeApplicationTokenResponse
WeilingwithClient. DescribeEdgeApplicationToken(DescribeEdgeApplicationTokenRequest req)
查询边缘应用凭证DescribeInterfaceListResponse
WeilingwithClient. DescribeInterfaceList(DescribeInterfaceListRequest req)
查询接口列表DescribeWorkspaceListResponse
WeilingwithClient. DescribeWorkspaceList(DescribeWorkspaceListRequest req)
获取租户下的空间列表DescribeWorkspaceUserListResponse
WeilingwithClient. DescribeWorkspaceUserList(DescribeWorkspaceUserListRequest req)
查询项目空间人员列表 -
Uses of TencentCloudSDKException in com.tencentcloudapi.wss.v20180426
Methods in com.tencentcloudapi.wss.v20180426 that throw TencentCloudSDKException Modifier and Type Method Description DeleteCertResponse
WssClient. DeleteCert(DeleteCertRequest req)
本接口(DeleteCert)用于删除证书。DescribeCertListResponse
WssClient. DescribeCertList(DescribeCertListRequest req)
本接口(DescribeCertList)用于获取证书列表。UploadCertResponse
WssClient. UploadCert(UploadCertRequest req)
本接口(UploadCert)用于上传证书。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.yinsuda.v20220527
-
Uses of TencentCloudSDKException in com.tencentcloudapi.youmall.v20180228
-
Uses of TencentCloudSDKException in com.tencentcloudapi.yunjing.v20180228
-
Uses of TencentCloudSDKException in com.tencentcloudapi.yunsou.v20180504
Methods in com.tencentcloudapi.yunsou.v20180504 that throw TencentCloudSDKException Modifier and Type Method Description DataManipulationResponse
YunsouClient. DataManipulation(DataManipulationRequest req)
上传云搜数据的API接口DataSearchResponse
YunsouClient. DataSearch(DataSearchRequest req)
用于检索云搜中的数据 -
Uses of TencentCloudSDKException in com.tencentcloudapi.yunsou.v20191115
Methods in com.tencentcloudapi.yunsou.v20191115 that throw TencentCloudSDKException Modifier and Type Method Description DataManipulationResponse
YunsouClient. DataManipulation(DataManipulationRequest req)
上传云搜数据的API接口。DataSearchResponse
YunsouClient. DataSearch(DataSearchRequest req)
用于检索云搜中的数据。 -
Uses of TencentCloudSDKException in com.tencentcloudapi.zj.v20190121
-