接口功能介绍 修改标签接口 接口约束 无 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 POST /v3/dlq/resend 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 200000002368 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID groupId 是 String 订阅组名称 msgId 是 String 消息ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 接口系统层面状态码。成功：800，失败：900 message String 描述状态 returnObj Object 返回对象。此参数所包含的参数请见“响应示例'里面的注释 error String 错误码，只有非成功才有这个字段，方便快速定位问题 201 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "prodInstId":"mqtest", "groupId": "T1", "msgId": "xxx" } 响应示例 响应成功示例 { "returnObj":{ }, "message":"success", "statusCode":800 } 响应失败示例 { "returnObj": {}, "message": "...", "error":"201", "statusCode": "900" }

接口功能介绍 获取监控/告警服务的服务与维度的对应关系。 接口约束 无。 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

接口功能介绍 清空指定监控面板的所有监控视图（不可回退，请谨慎操作）。 一个监控面板包含若干个监控视图。 接口约束 regionID（资源池）、templateID（监控面板）存在。 URI POST /v4/monitor/clearmonitorview 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID templateID String 是 466d5eb4484311eda9b7005056897257 监控面板ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 clearCount Integer 成功清除的监控视图个数 2 请求示例 POST /v4/monitor/clearmonitorview 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "templateID": "466d5eb4484311eda9b7005056897257" }

接口功能介绍 查询指定地域内的可用区信息 接口约束 无 URI GET /eci/api/v1/region 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 地域Id bb9fdb42056f11eda1610242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 请求成功(200)或失败(非200) 200 error String 错误码，三段式 ECI.Openapi.StatusReasonInternalError message String 错误信息描述 Internal error occurred returnObj Object 返回信息 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 region Object 地域Id region 表 region 参数 参数类型 说明 示例 下级对象 regionId String 地域Id {} zones Array of Strings 可用区信息 枚举参数 无 请求示例 请求url GET 请求头header {"regionId": "bb9fdb42056f11eda1610242ac110002"} 请求体body 无 响应示例 { "statusCode": 200, "returnObj": { "region": { "regionId": "b342b77ef26b11ecb0ac0242ac110002", "zones": [ "cnxinan11A", "cnxinan12A", "cnxinan13A" ] } } }

接口功能介绍 计算hmacSm3 接口约束 请保证账户余额大于0 URI POST /v1/get/hmaccompute 路径参数 无 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参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥id 3896591785c441a993b247f81634bea7 input 是 String 待处理数据 aa 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码 取值范围：200 成功 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 HMAC结果 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 hmacoutput String sm3hmac结果 DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjKy5nl requestId String 请求id a857cc58ab6f40acb9e7fa1781209a76

接口功能介绍 查设备连接信息 接口约束 无 URI GET /v3/api/connectionInfo 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID clientId 是 String 设备ID 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 800成功 其他失败 message String 描述状态 returnObj Object 返回数据 returnObj error String 错误码 表 returnObj 参数 参数类型 说明 示例 下级对象 clientid String 设备ID keepalive Integer 心跳时间 mqueuelen Integer 队列消息长度 maxinflight Integer 暂无描述 createdat String 创建时间 connectedat String 连接时间 sendmsg Integer 发送消息数量 mqueuedropped Integer 队列丢弃消息数量 recvmsg Integer 接收消息数量 ipaddress String ip port Integer 端口 username String 用户名 cleanstart Boolean 持久化会话

接口功能介绍 调用此接口可批量删除告警模板。 接口约束 告警模板ID列表不能为空。 URI POST /v4/monitor/deletealarmtemplates 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 templateIDList Array of String 是 ["312b56b43e4311ed8ef2005056898fe0","318cc4a83e4311ed8ef2005056898fe0"] 告警模板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/deletealarmtemplates 请求体body json { "templateIDList":[ "315c7f8c3e4311ed8ef2005056898fe0", "318cc4a83e4311ed8ef2005056898fe0" ] }

接口功能介绍 资源绑定标签接口 接口约束 无 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

接口功能介绍 计算删除密钥 接口约束 请保证账户余额大于0 URI POST /v1/cmkManage/scheduleKeyDeletion 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff pendingWindowInDays 是 String 计划删除时间，在此时间之后密钥将被删除 7 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 计划删除密钥设置成功 returnObj Object 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id a33dc451c0a046f5b2751d8378c1c833 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "cmkUuid": "27e658cf3b904987adfdfe8700ee4f59", "pendingWindowInDays": 7 }

接口功能介绍 计算删除密钥 接口约束 请保证账户余额大于0 URI POST /v1/cmkManage/scheduleKeyDeletion 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 主密钥加密的数据密钥密文 474e569e8814474a948bdbcf6d853eff pendingWindowInDays 是 String 计划删除时间，在此时间之后密钥将被删除 7 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 计划删除密钥设置成功 returnObj Object 接口返回结果 null returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 requestId String 请求id a33dc451c0a046f5b2751d8378c1c833 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body { "cmkUuid": "27e658cf3b904987adfdfe8700ee4f59", "pendingWindowInDays": 7 }

接口功能介绍 资源解绑标签接口 接口约束 无 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

SSL VPN客户端断开连接。 接口功能介绍 SSL客户端断开连接 接口约束 支持集群模式资源池。 URI POST /v4/vpn/sslclient/disconnect 路径参数 无 Query参数 无 请求参数 请求header参数 无 请求body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID b342b77ef26b11ecb0ac0242ac110002 sslClientID 是 String SSL客户端ID 35d5fa99c0404bb0806a8be317cc4d89 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 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" }

接口功能介绍 配置Topic的读写模式 接口约束 无 URI POST /v3/topic/update 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池编码 100054c0416811e9a6690242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 prodInstId 是 String 实例ID topic 是 String 主题名称 perm 是 Integer 设置该Topic的读写模式。取值说明如下：6：同时支持读写;4：禁写; 2：禁读 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 接口系统层面状态码。成功：800，失败：900 800 message String 描述状态 returnObj Object 返回对象。此参数所包含的参数请见“响应示例'里面的注释 error String 错误码，只有非成功才有这个字段，方便快速定位问题 201 枚举参数 无 请求示例 请求url 请求头header 无 请求体body { "perm": 4, "topic": "topicTest", "prodInstId": "d7ed2dbad63843f4bcb3b9dc0955a617" }

接口功能介绍 调用此接口可删除告警模板。 接口约束 告警模板ID不能为空，且应为已创建的模板的ID。 URI POST /v4/monitor/deletealarmtemplate 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 templateID String 是 312b56b43e4311ed8ef2005056898fe0 告警模板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/deletealramtemplate 请求体body json { "templateID":"312b56b43e4311ed8ef2005056898fe0" } 响应示例 json { "statusCode":800, "returnObj":{ "success":true }, "errorCode":"", "message":"Success", "msgDesc":"成功" }

接口功能介绍 调用此接口可查询指定资源池下所有资源总数量。 接口约束 regionID（资源池）存在。 URI GET /v4/monitor/queryitemtotal 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 ecs Integer 云主机资源数量 33 evs Integer 云硬盘资源数量 37 scaling Integer 弹性伸缩资源数量 0 pms Integer 物理机资源数量 1 ippool Integer 弹性ip和共享带宽的资源数量 16 elb Integer 负载均衡资源数量 7 totalCount Integer 所有资源的总数量 94

接口功能介绍 通过给定资源池 ID 和面板名称，创建一个空的监控面板。 接口约束 regionID（资源池）存在。 URI POST /v4/monitor/createmonitor 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池 ID name String 是 newtemplate 监控面板名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 templateID String 面板ID 1378f646505711ed8fb7005056897257 请求示例 POST /v4/monitor/createmonitor 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "name": "newtemplate" } 响应示例 json { "statusCode": 800, "returnObj": { "templateID": "1378f646505711ed8fb7005056897257" }, "errorCode": "", "message": "Success", "msgDesc": "成功" }

接口功能介绍 调用此接口可查询指定资源池告警资源的总数。 接口约束 regionID（资源池）存在。 URI GET /v4/monitor/queryalarmtotal 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 ecs Integer 云主机告警数量 0 evs Integer 云硬盘告警数量 0 scaling Integer 弹性伸缩告警数量 0 pms Integer 物理机告警数量 0 ippool Integer 弹性ip和共享带宽的告警数量 0 elb Integer 负载均衡告警数量 0 totalCount Integer 总告警数量 0

接口功能介绍 创建证书。 接口约束 无 URI POST /v3/api/ssl/cert/create 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 实例的资源池ID。 bb9fdb42056f11eda1610242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certName 是 String 证书名称 myCert type 是 String 证书类型 CLIENTCA certFile 是 String 证书内容 123 certKey 否 String 证书配套私钥（仅服务端证书需要） 123 remark 否 String 证书备注 testcert encryptor 是 String 私钥加密方式 RSA 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 调用结果状态 error String 错误码 message String 结果描述 returnObj Object 返回数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certId String 新创建证书id 123 枚举参数 参数名 type 枚举值 类型 说明 CLIENTCA String 客户端CA证书 SERVER String 服务端证书 参数名 encryptor 枚举值 类型 说明 RSA String RSA

参数 参数说明 取值样例 名称 系统会随机产生一个名称，用户也可以进行修改。 alarmb6al 描述 告警规则描述（此参数非必填项）。 资源类型 配置告警规则监控的服务名称。 Elastic Cloud Server 维度 用于指定告警规则对应指标的维度名称。 ECSs 监控对象 用来配置该告警规则针对的具体资源，可以是一个或多个。 监控对象ID 资源ID。 监控指标 例如： CPU使用率 该指标用于统计测量对象的CPU使用率，以百分比为单位。 内存使用率 该指标用于统计测量对象的内存使用率，以百分比为单位。 CPU使用率 告警策略 触发告警的告警策略。 例如：监控周期为5分钟，连续三个周期平均值≥80% 告警级别 根据告警的严重程度不同等级，可选择紧急、重要、次要、提示。 重要 发送通知 配置是否发送邮件、短信通知用户。 触发条件 可以选择“出现告警”、“恢复正常”两种状态，作为触发告警通知的条件。

接口功能介绍 查询租户购买的eip列表信息。 接口约束 天翼云用户。 URI POST /osm/v2/console/listEip 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNumber 是 Integer 当前分页 1 pageSize 是 Integer 分页显示的数据条数 10 regionID 否 String 资源池id rs848834 azName 否 String 可用区名称 az834834 vpcID 否 String vpc id vpcuijdsj3443 eipId 否 String eip id 700c065cbbd35b8aa07d551dba4a5141 响应参数 参数 参数类型 说明 示例 下级对象 error String 接口错误详情 statusCode String 接口请求状态码 00000表示成功，其他为失败 message String 请口操作结果说明 操作成功或失败说明 page Object 返回数据对像 page returnObj Array of Objects 返回数据对像数组 returnObj 表 page 参数 参数类型 说明 示例 下级对象 current Integer 当前分页 3 size Integer 分页数据记录数 10 total Integer 总数据量 54 表 returnObj 参数 参数类型 说明 示例 下级对象 id String eip id 7uyewjjw977343 name String eip名称 eiposm eipAddress String eip地址 20.138.38.20 status String 状态 ACTIVE: 激活,已绑定 DOWN: 未使用 bandwidth String 带宽 100Mbps createdAt String 创建时间 2024/10/10 10:10 expireDate String 到期时间 2024/10/10 10:10

您可以为已绑定标签的资源解绑标签,本文帮助您了解解绑标签的流程。 前提条件 实例资源已绑定标签。 操作步骤 解绑单个实例的标签 1. 登录“控制中心”，管理控制台顶部菜单左侧 ，选择地域。 2. 选择 “存储>弹性文件服务SFS Turbo”，进入SFS Turbo文件系统列表页面。 3. 在文件系统列表中，点击待添加标签的文件系统所在行的“操作>更多>编辑标签”。 4. 弹出“编辑标签”窗口，点击标签键值后面的“删除”，可同时删除多个标签。 5. 单击弹窗下方“确定”，完成标签的解绑操作。 批量解绑多个实例的标签 1. 登录“控制中心”，管理控制台顶部菜单左侧 ，选择地域。 2. 选择 “存储>弹性文件服务SFS Turbo”，进入SFS Turbo文件系统列表页面。 3. 在文件系统列表中，勾选需要批量绑定标签的文件系统实例，点击列表上方按钮“批量解绑标签”。 4. 在“批量绑定标签”弹窗中，找到想要为已选资源解绑的标签项，勾选左侧复选框。 5. 点击弹窗下方“确定”按钮，完成批量解绑操作。

指标ID 指标名称 含义 取值范围 测量对象&维度 监控周期（原始指标） bandwidthusage 带宽使用率 当前流量带宽与最大带宽限制的百分比 0200% 测量对象：Redis 4.0/5.0主备实例数据节点Redis 4.0/5.0 Cluster集群实例数据节点测量维度：dcsclusternode 1分钟

本页介绍天翼云TeleDB数据库元数据pgauditstmtconf的内容。 存储语句级别的审计策略的管理和配置。 名称 类型 定义 auditorid Oid 编写配置用户id actionid int32 需要审计的行为ID actionmode char 何时进行审计：成功时、失败时或全部 actionison bool 开启或关闭此审计配置

接口功能介绍 修改安全组v3 接口约束 无 URI POST /v3/securityGroup/update 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池ID。 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 securityGroupOid 是 String 安全组ID securityGroupName 是 String 安全组名称 remark 否 String 安全组备注 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码。可能值： 800：请求成功。 900：请求失败。 800 error String 错误码。 ECPC1000 message String 提示信息。 OK. returnObj String 返回数据结构体。安全组id。 sg41f5rni5zu4oufa85xwob 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "securityGroupOid":"sg41f5rni5zu4oufa85xwob", "securityGroupName":"securityapitest", "remark":"qqq" } 响应示例 { "statusCode":800, "message":"OK.", "returnObj":"sg41f5rni5zu4oufa85xwob" }