接口功能介绍 密钥版本详情查询 接口约束 请保证账户余额大于0 URI POST /v1/versionControl/describeKeyVersion 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 获取密钥版本成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 creationDate String 版本创建时间 Tue Oct 25 15:06:52 CST 2022 requestId String 请求id 87d821f6679544eda3553b6e9dbc2e4c

接口功能介绍 本接口用于修改单个目录信息。 接口约束 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/dirs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DirId 是 String 目录ID。 897098424844288 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 DirName 是 String 目录名称，长度不超过64个字符。 openapidir Description 否 String 目录描述，长度不超过255个字符。 description 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 DirId String 目录ID。 693323900457467904 RequestId String 请求ID。 432a3ea5157740d296194ebf188f9403

VPN用户服务删除。 接口功能介绍 vpn用户服务删除 接口约束 支持集群模式资源池。 URI POST /v4/vpn/ipsecuserservice/delete 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 ipsecServiceID 是 String vpn用户服务ID 35d5fa99c0404bb0806a8be317cc4d89 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 74cb2e661f9545daaac5ee013470fd96 请求示例 请求url 无 请求头header 无 请求体body json { "regionID":"b342b77ef26b11ecb0ac0242ac110002", "ipsecServiceID":"cbf6e5e281784861b133b66d0ba336cd" }

接口功能介绍 调用此接口可获取下载链接地址。 接口约束 参见请求参数说明。 URI POST /v4/monitor/taskcenter/download 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b taskID 是 String 任务ID TASKtacd8b6b4610b97d202306301808 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 downloadUrl String 下载链接地址 枚举参数 无 请求示例 请求url /v4/monitor/taskcenter/download 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "taskID": "TASKtacd8b6b4610b97d202306301808" }

接口功能介绍 查询VIP详情v3 接口约束 无 URI GET /v3/vip/detail 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx vipOid 是 String vip id 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 vipOid String vip id vipIpAddress String vip地址 networkId String vpc的uuid subnetOid String 子网id subnetId String 子网uuid vipPortId String vip的uuid 枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "vipOid":"vipxxyrk3utggvmmyeiunfic", "vipIpAddress":"192.168.1.82", "networkId":"86bf2cd69e00446883a004327b716a07", "subnetOid":"snxxbfzimdno1l00k9a5yk4", "subnetId":"b6deaadd0b334422aef00dceba639541", "vipPortId":"70744a96d32041008c789fd1ae1c1539" } }

接口功能介绍 获取VPC下能创建子网的个数v3 接口约束 无 URI GET /v3/vpc/subnet/vpcSubnetNum 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 vpcOid 是 String VPC ID xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj Object 返回数据对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 maximum Integer 最大可创建数量 available Integer 剩余可创建数量 枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无 响应示例 { "statusCode":800, "message":"OK.", "returnObj":{ "maximum":5, "available":3 } } 状态码 请参考 状态码 错误码 请参考 错误码

接口描述 查询子网列表 接口约束 无 URI GET /v1/eop/subnets 请求参数 请求体Query参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcId 否 String 真实vpcId c455ffa4ace64f5fbc184587b5a10650 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS returnObj Array 返回对象 SubnetVO SubnetVO 参数 参数类型 说明 示例 下级对象 resVlanId String 子网id c455ffa4ace64f5fbc184587b5a10650 name String 子网名称 subnetcc1d regionId String 资源池id 100054c0416811e9a6690242ac110002 vpcId String vpc id 840a039a79264f96b6f92d79dcfaaaac zoneId String 资源池id 100054c0416811e9a6690242ac110002 zoneName String 资源池名称 保定os cidr String 子网网段 192.168.0.0/24 cidrv6 String v6子网网段 description String 描述 gateway Integer 网关ip 192.168.0.1 gatewayipv6 Integer IPV6网关ip v4id String v4 id a6045aec3dfc42aebe789dde0fe1335c v6id String v6 id vlanStatus String vlan状态 ACTIVE fisrtDcn String 主dns地址 secondDcn String 备dns地址

特性 说明 检测位置 检测Web网站和新媒体平台发布的内容。 检测范围 内容的合法合规性、准确性。 检测技术 机器检测：基于丰富的违规样例库进行机器初审核。 检测技术 人工审核：内容审核专家基于多年经验对机器检测结果进行再审核。 交付形式 Word形式的检测报告。 “检测类型”选择“内容安全单次检测（按需）”时，下单后的7个工作日内出报告。 “检测类型”选择“文本安全监测（按月/按年）”时，下单后的检测周期（1个月）后的7个工作日内出报告。 计费模式 包年/包月（预付费）和按需计费（后付费）两种计费方式。 文本安全监测（按年） 文本安全监测（按月） 内容安全单次检测（按需） 按“检测对象”的总个数进行收费。同一个对象再次进行扫描时，需要重新收费。例如：单次配置了10个检测对象（新媒体账号或网站网址），每个检测对象检测一次，则需要进行10次收费。

接口功能介绍 调用此接口可查询探测节点列表。 接口约束 资源池ID不能为空。 URI GET /v4/monitor/queryprobepoint 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 pointList Array of Objects 探测节点列表 point totalCount Integer 总记录数 1 表point 参数 参数类型 说明 示例 下级对象 mongoID String 数据库ID 635a4a3869bdc841ab0495dd ID String 探测节点唯一ID 1 name String 探测节点名称 NeiMeng hermesRegion String region名称 neimengaz03 position String 探测节点区域 内蒙 status Boolean 探测节点是否可用 true

接口功能介绍 检查接入点是否开启权限策略 接口约束 无 URI POST /v1/applicationAccessPointManage/policyCheckIsOpen 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 isOpen Boolean 是否开启 true 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" } 响应示例 plaintext { "statusCode": 200, "message": "判断接入点权限开启状态成功", "returnObj": { "isOpen": true } } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 判断用户是否开通 接口约束 请保证账户余额大于0 URI POST /userControl/isActivated 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 hmac 是 String kms鉴权值 B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw requestDate 是 String 时间戳 Wed, 29 Aug 2023 17:05:01 CST accessKey 是 String ctapi鉴权ak ae2cc5cc5e8211ea978a186590d96509 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 regionId 是 Integer 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 userId 是 String 账号id，对应IT的accountId 562b89493b1a40e1b97ea05e50dd8170 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 code 是 String 返回码 取值范围：200 成功 200 errorCode 是 String 错误码 KMS.0514 msg 是 String 调用结果信息 用户开通状态判断完成 data 是 Object 接口返回结果 returnObj 表 returnObj 参数 是否必填 参数类型 说明 示例 下级对象 activated 是 String 开通状态 true：开通 false：未开通 true requestId 是 String 请求id a857cc58ab6f40acb9e7fa1781209a76

天翼云API网关用户指南.pdf

该模块旨在让管理员能够轻松查看并设置本租户下所有用户对资源使用的限额。 进入设置模块，可设置单用户最大同时使用的GPU/CPU数量以及并行文件存储初始分配额度。

本页为您介绍如何开通数据库专家服务。 操作步骤 第一步，打开天翼云官网 第二步，未实名认证的用户需按提示完成实名认证才能开通数据库专家服务。 第三步，实名认证后进入数据库专家服务产品详情页快速了解产品，如需订购数据库增值服务包的，务必请先咨询客服确认天翼云能否按您的需要提供相应的服务内容，确认后单击【立即开通】。 第四步，在购买页面选择适合的计费方式，确认订单，点击【立即开通】。 第五步，服务开通后，待数据库专家服务团队进行技术评估，评估通过后，便可进入施工环节享受专家团队的服务。

接口功能介绍 节点停止 接口约束 无 URI GET /PG/v1/node/stop 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例id 567078229420302954 nodeId 是 Long 节点id 25 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id，比如实例在资源池A，则需要填写A资源池的id 81f7728662dd11ec810800155d307d5b 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 返回结果 NodeStopVO 表 NodeStopVO 参数 参数类型 说明 示例 下级对象 pgEventId Long 任务Id 1 枚举参数 无 请求示例 请求url 请求头header { "ProjectId":"0", "regionId":"81f7728662dd11ec810800155d307d5b" } 请求体body 无

接口功能介绍 节点启动 接口约束 无 URI GET /PG/v1/node/start 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例id 567078229420302954 nodeId 是 Long 节点id 25 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id，比如实例在资源池A，则需要填写A资源池的id 81f7728662dd11ec810800155d307d5b 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 返回结果 NodeStartVO 表 NodeStartVO 参数 参数类型 说明 示例 下级对象 pgEventId Long 任务Id 1 枚举参数 无 请求示例 请求url 请求头header { "ProjectId":"0", "regionId":"81f7728662dd11ec810800155d307d5b" } 请求体body 无

接口功能介绍 节点启动 接口约束 无 URI GET /PG/v1/node/start 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例id 567078229420302954 nodeId 是 Long 节点id 25 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id，比如实例在资源池A，则需要填写A资源池的id 81f7728662dd11ec810800155d307d5b 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 返回结果 NodeStartVO 表 NodeStartVO 参数 参数类型 说明 示例 下级对象 pgEventId Long 任务Id 1 枚举参数 无 请求示例 请求url 请求头header { "ProjectId":"0", "regionId":"81f7728662dd11ec810800155d307d5b" } 请求体body 无

接口功能介绍 创建数据库参数模板 接口约束 无 URI POST /PG/v1/template/create 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id，比如实例在资源池A，则需要填写A资源池的id。 81f7728662dd11ec810800155d307d5b 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 sourceTemplateId 是 Long 参考的参数模板ID 12 name 是 String 参数模板名字，长度限制：1128 11 description 否 String 参数模板的描述，若不为空，则长度限制：11024 My Template 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 返回结果 TemplateCreateVO 表 TemplateCreateVO 参数 参数类型 说明 示例 下级对象 templateId Long 模板Id 1 枚举参数 无

接口功能介绍 密钥加密接口 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/encrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff plaintext 是 String 待加密的base64之后的明文数据 U0dWc2JHOGdkMjl5MWVhOQ 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 加密数据成功 returnObj Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 ciphertextBlob String 加密结果 DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjKy5nl requestId String 请求id f0c64b33d4664fd1b0bdac09471e73d8

接口功能介绍 根据id删除基线策略 接口约束 此功能为收费功能。确认已经购买系统配额，并且开启基线扫描配置。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护 URI GET /v1/sca/rule/delete/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 scaRuleId 是 Integer 策略数据id Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj Object 返回对象 traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200

接口功能介绍 根据id删除告警数据 接口约束 此功能为收费功能。确认已经购买网页防篡改配额，并且开启防篡改扫描配置。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护 URI GET /v1/tamperProof/alarmLog/deleteById/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 id 是 String Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String ContentType application/json 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 error String 返回码 CTCSSCN000000：成功 CTCSSCN000001：失败 CTCSSCN000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN000004：鉴权错误 CTCSSCN000005：用户没有付费版配额，功能不可用 CTCSSCN000000 message String 返回信息 success returnObj String 返回对象 traceId String traceId asaadasd11111 statusCode String 状态码 200成功 200

接口功能介绍 资源绑定标签接口 接口约束 无 URI POST /v1/lebalControl/bindResource 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 resourceId 是 String 资源id 9612627252624b61bf5cd66ca3c7a0b3 labelId 是 String 标签标识 3726fb6c48sdq123b7ae7aa2650eeec4 baseResourceId 是 String 资源标识 9612627252624b61bf5cd66ca3c7a0b3 key 是 String key值 123 value 是 String value值 123 prodSpecInstId 否 String 产品规格实例id 53e50630604f42eba9d4fd9e0d8458bf operateType 否 String BIND 操作类型(绑定BIND) 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 资源绑定标签成功 returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d

接口功能介绍 证书私钥签名 接口约束 用户已开通 URI POST /v1/certificateCompute/certificatePrivateKeySign 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff algorithm 是 String 解密算法，取值范围为RSAPSSSHA256、SM2 RSAPSSSHA256 message 是 String 待签名数据 abcd messageType 是 String 数据类型 RAW 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 签名成功 returnObj String 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 2a56124813ed4ef7a359e818dce118d8 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff signatureValue String 签名值 ZOyIygCyaOW6GjMlNKiuyjfzw

接口功能介绍 导入证书 接口约束 无 URI POST /v1/manageCertificate/importCertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff certificate 是 String 证书 BEGIN CERTIFICATE (X.509 Certificate PEM Content) END CERTIFICATE certificateChain 是 String 证书链 BEGIN CERTIFICATE (Sub CA Certificate PEM Content) END CERTIFICATE BEGIN CERTIFICATE (Sub CA Certificate PEM Content) END CERTIFICATE BEGIN CERTIFICATE (Root CA Certificate PEM Content) END CERTIFICATE 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 导入证书成功 returnObj String 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff requestId String 请求id 2a56124813ed4ef7a359e818dce118d8

接口功能介绍 资源解绑标签接口 接口约束 无 URI POST /v1/lebalControl/unbindResource 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 resourceId 是 String 资源id 9612627252624b61bf5cd66ca3c7a0b3 prodSpecInstId 否 String 产品规格实例id 53e50630604f42eba9d4fd9e0d8458bf labelId 是 String 标签标识 9612627252624b61bf5cd66ca3c7a0b3 baseResourceId 是 String 资源标识 9612627252624b61bf5cd66ca3c7a0b3 key 是 String key值 123 value 是 String value值 123 operateType 否 String 操作类型(解绑UNBIND) UNBIND 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 1d6d65ac761d4276ad0f1b94ef2ea29d

接口功能介绍 修改标签接口 接口约束 无 URI POST /v1/lebalControl/updateLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 operateType 否 String 操作类型（新增ADD，修改UPDATE，删除DELETE） UPDATE 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 56495f1608e845a7871844941bcc8350 枚举参数 无 请求示例 请求url 请求头header { "regionId": "200000001852" } 请求体body { "key": "xyz", "value": "777" }

接口功能介绍 修改标签接口 接口约束 无 URI POST /v1/lebalControl/updateLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 operateType 否 String 操作类型（新增ADD，修改UPDATE，删除DELETE） UPDATE 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 returnObj error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id 56495f1608e845a7871844941bcc8350 枚举参数 无 请求示例 请求url 请求头header { "regionId": "200000001852" } 请求体body { "key": "xyz", "value": "777" }

SSL VPN客户端密码重置。 接口功能介绍 SSL VPN客户端密码重置 接口约束 无 URI POST /v4/vpn/sslclient/resetkeyword 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 sslClientID 是 String SSL客户端ID c81b17f32073409295e3cfd78bf49444 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 statusCode 否 Integer 返回状态码 取值范围: 800：成功 900：失败 800 errorCode 否 String 业务细分码，为product.module.code三段式码 message 否 String 失败时的错误描述，一般为英文描述 description 否 String 失败时的错误描述，一般为中文描述 returnObj 否 Object 返回对象 returnObj 表returnObj 参数 是否必填 参数类型 说明 示例 下级对象 logMark 否 String 链路追踪ID 616797965481 请求示例 请求url 无 请求头header 无 请求体body json { "sslClientID":"c81b17f32073409295e3cfd78bf49444", "regionID":"b342b77ef26b11ecb0ac0242ac110002" }

接口功能介绍 获取监控/告警服务的服务与维度的对应关系。 接口约束 无。 URI GET /v4/monitor/queryalarmserdimrelations 请求参数 Query参数 无。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 relations Array of Objects 关系列表 relation 表relation 参数 参数类型 说明 示例 下级对象 service String 服务 ecs dimension Array of String 服务列表 ["ecs"] 请求示例 GET /v4/monitor/queryalarmserdimrelations 响应示例 json { "statusCode": 800, "returnObj": { "relations": [ {"service": "ecs", "dimension": ["ecs"]}, {"service": "evs", "dimension": ["evs"]}, {"service": "cdci", "dimension": ["netbag"]}, {"service": "ippool", "dimension": ["trafficp", "fip", "fipv6"]}] }, "errorCode": "", "message": "Success", "msgDesc":"成功" }

接口功能介绍 获取监控/告警服务的维度与设备类型的对应关系。 接口约束 无。 URI GET /v4/monitor/querydimdevrelations 请求参数 Query参数 无。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 relations Array of Objects 关系列表 relation 表relation 参数 参数类型 说明 示例 下级对象 dimension String 维度 ecs device String 设备类型 vm 请求示例 GET /v4/monitor/querydimdevrelations 响应示例 json { "statusCode": 800, "returnObj": { "relations": [ {"dimension": "ecs", "device": "vm"}, {"dimension": "disk", "device": "disk"}, {"dimension": "pms", "device": "metal"} ] }, "errorCode": "", "message": "Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功

接口功能介绍 调用此接口可删除站点监控任务。 接口约束 资源池ID，站点监控任务ID列表不能为空。 URI POST /v4/monitor/deletesitemonitor 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regonID String 是 81f7728662dd11ec810800155d307d5b 资源池ID siteIDList Array of String 是 ["64ea16644347558e9bc6651341c2fa15"] 站点监控任务ID列表 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数，参考returnObj对象结构 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 删除成功标识 true 请求示例 POST /v4/monitor/deletesitemonitor 请求体body json { "regionID":"81f7728662dd11ec810800155d307d5b", "siteID":["64ea16644347558e9bc6651341c2fa15"] }

接口功能介绍 校验监控视图的名称是否存在（重复）。 一个监控面板（template），包含多个监控视图（views），监控视图包含多个监控项（items）内容。 此处检验的名称，指的是监控视图（views）的名称。 接口约束 regionID（资源池）和templateID（监控面板）存在。 URI GET /v4/monitor/checkmonitor 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 f2efc544504711ed8fb7005056897257 监控模板ID title String 是 view1 监控视图名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 exist Boolean 是否重复命名 true