响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 noticeTemplateID String 通知模板ID 312b56b43e4311ed8ef2005056898fe0 枚举参数 无 请求示例 请求url /v4/monitor/createnoticetemplate 请求头header 无 请求体body { "name": "ctyunnoticetemplate", "service": "ecs", "dimension": "ecs", "contents": [ { "notifyType": "email", "content": "this is a demo" } ] } 响应示例 { "statusCode": 800, "returnObj": { "noticeTemplateID": "c76ee847fe895ab591bc0407f01a3e6f" }, "errorCode": "", "message": "Success", "msgDesc": "成功", "description": "成功" } 状态码 请参考 状态码

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 枚举参数 无 请求示例 请求url /v4/monitor/updatealarmblacklist 请求头header 无 请求体body { "blacklistID": "46d7bc837ac45238a9342076d0b9f9f0", "name": "ctyunalarmblacklist", "desc": "demo", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "resources": [ { "resource": [ { "name": "uuid", "value": "7dd744ea5a0261d3e62738f82f5fd3e1" }, { "name": "instancename", "value": "ecmaf97" } ] } ], "metrics": [ "cpuutil", "memutil" ], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": [ "234bee0616f65b0aadb8c0903d480a58" ] }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 枚举参数 无 请求示例 请求url /v4/monitor/updatealarmblacklist 请求头header 无 请求体body { "blacklistID": "46d7bc837ac45238a9342076d0b9f9f0", "name": "ctyunalarmblacklist", "desc": "demo", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "resources": [ { "resource": [ { "name": "uuid", "value": "7dd744ea5a0261d3e62738f82f5fd3e1" }, { "name": "instancename", "value": "ecmaf97" } ] } ], "metrics": [ "cpuutil", "memutil" ], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": [ "234bee0616f65b0aadb8c0903d480a58" ] }

删除一个告警策略 接口功能介绍 删除一个告警策略 接口约束 无 URI POST /v4/scaling/rule/deletealarm 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 511 ruleID 是 Integer 伸缩策略ID 72 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found instance description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 72 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "ruleID": 72, "groupID": 499 }

删除一个周期策略 接口功能介绍 删除一个周期策略 接口约束 无 URI POST /v4/scaling/rule/deletecycle 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

启用一个告警策略 接口功能介绍 启用一个告警策略 接口约束 无 URI POST /v4/scaling/rule/startalarm 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

修改弹性伸缩组的健康检查方式 接口功能介绍 修改弹性伸缩组的健康检查方式 接口约束 无 URI POST /v4/scaling/group/updatehealthmode 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 443 healthMode 是 Integer 健康检查方式。取值范围：1：云主机健康检查。2：弹性负载均衡健康检查。 1 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 groupID Integer 伸缩组ID 443

启用伸缩组中的指定策略 接口功能介绍 启用伸缩组中的指定策略。 接口约束 无 URI POST /v4/scaling/rule/start 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

修改弹性伸缩组的伸缩配置 接口功能介绍 修改弹性伸缩组的伸缩配置 接口约束 无 URI POST /v4/scaling/group/updateconfigid 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 88f8888888dd88ec888888888d888d8b groupID 是 Integer 伸缩组ID 489 configID 是 Integer 伸缩配置ID 375 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 groupID Integer 伸缩组ID 489 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 509, "configID": 375 }

停用一个周期策略 接口功能介绍 停用一个周期策略 接口约束 无 URI POST /v4/scaling/rule/stopcycle 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

查询伸缩活动ID 接口功能介绍 查询伸缩活动ID列表 接口约束 无 URI POST /v4/scaling/group/queryactivities 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 472 pageNo 否 Integer 页码 5 pageSize 否 Integer 分页查询时设置的每页行数，取值范围:[1~100]，默认值为10 10 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Group.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling group info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩组信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 activeIDList Array of Integers 伸缩活动ID列表 [938]

删除一个弹性伸缩配置 接口功能介绍 删除一个弹性伸缩配置 接口约束 无 URI POST /v4/scaling/configdelete 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b configID 是 Integer 伸缩配置ID 410 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Config.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling config info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩配置信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 configID Integer 伸缩配置ID 410 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "configID": 410 } 响应示例 json { "returnObj": { "configID": 410 }, "errorCode": "", "message": "SUCCESS", "description": "成功", "statusCode": 800 }

执行一条伸缩策略 接口功能介绍 执行一条伸缩策略 接口约束 无 URI POST /v4/scaling/rule/execute 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b ruleID 是 Integer 伸缩策略ID 78 groupID 是 Integer 伸缩组ID 483 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 78 请求示例 请求头header 无 请求体body json { "ruleID": 78, "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 483 }

停用一个告警策略 接口功能介绍 停用一个告警策略 接口约束 无 URI POST /v4/scaling/rule/stopalarm 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

启用一个周期策略 接口功能介绍 启用一个周期策略 接口约束 无 URI POST /v4/scaling/rule/startcycle 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5 groupID 是 Integer 伸缩组ID 471 ruleID 是 Integer 伸缩策略ID 149 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 Scaling.Rule.NotFound 错误码 message String 失败时的错误描述，一般为英文描述 scaling rule info not found description String 失败时的错误描述，一般为中文描述 未找到弹性伸缩策略信息 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 149 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 471, "ruleID": 149 }

查询用户弹性伸缩资源配额 接口功能介绍 查询用户的弹性伸缩组、伸缩配置、伸缩策略配额。 接口约束 无 URI POST /v4/scaling/quota 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回码：800表示成功，900表示失败 800 errorCode String 业务细分码，为product.module.code三段式码 错误码 message String 失败时的错误描述，一般为英文描述 description String 失败时的错误描述，一般为中文描述 returnObj Object 成功时返回的数据，参见表returnObj returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 scalingGroupLimit Integer 伸缩组配额 50 scalingRuleLimit Integer 伸缩策略配额 10 scalingConfigLimit Integer 伸缩配置配额 100 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b" } 响应示例 json { "returnObj": { "scalingGroupLimit": 50, "scalingRuleLimit": 10, "scalingConfigLimit": 100 }, "errorCode": "", "message": "SUCCESS", "description": "成功", "statusCode": 800 }

接口功能介绍 网关负载均衡开启删除保护 接口约束 无 URI POST /v4/gwlb/enabledeleteprotection 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 gwLbID 是 String 网关负载均衡ID gwlbxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 接口业务数据 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 gwElbID String 网关负载均衡 ID gwlbxxx 枚举参数 无 请求示例 请求url POST /openapi/v4/gwlb/enabledeleteprotection 请求头header 无 请求体body { "regionID": "xxxx", "gwLbID": "xxxx" }

接口功能介绍 更新多证书 接口约束 无 URI POST /v4/elb/updatedomaincertlinks 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b domainCertID 是 String 多证书 ID dclxxxx description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:{},./;'[]·！@ ￥%……&（） —— +{} 《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 decs certificateID 否 String 证书 ID certxxxxx 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败） 800 message String statusCode为900时的错误信息; statusCode为800时为success, 英文 success description String statusCode为900时的错误信息; statusCode为800时为成功, 中文 成功 errorCode String statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS SUCCESS returnObj Object 检查结果 见下表 表 returnObj 参数 参数类型 说明 示例 下级对象 domainCertID String 多证书 id dclxxxx

接口功能介绍 重置密码 接口约束 无 URI POST /v1/resetPassword 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String 类型 application/json regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 instanceId 是 Long 实例ID 166902317915212318 password 是 String 密码。长度在850个字符，且需包含至少一个大写字母、一个小写字母、一个数字和一个特殊字符。 Aa1!1234 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应码 0 message String 返回信息 returnObj Boolean 重置是否成功 true error String 错误信息 枚举参数 无 请求示例 请求url POST 请求头header json { "ContentType":"application/json" } 请求体body json { "instanceId":166902317915212320, "password":"Aa1!1234" } 响应示例 json { "statusCode":0, "message":"", "returnObj":true } 状态码 请参考 状态码

接口功能介绍 本接口用于删除GB28181凭证。 接口约束 删除凭证前请确保存在该凭证。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI DELETE /v2/gb28181Certs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名。 cert Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 1942b6dc15704a93950d90d3101d3ebb 枚举参数 无 请求示例 请求url DELETE '/v2/gb28181Certs/openapi01' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "1942b6dc15704a93950d90d3101d3ebb","returnObj": {"RequestId": "1942b6dc15704a93950d90d3101d3ebb"}}

接口功能介绍 本接口用于修改设备的目录。 接口约束 修改设备目录前确保存在该目录以及设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/dirs//devices/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DirId 是 String 目录ID。 1548576244711424 DeviceId 是 String 设备ID。 29942028422873997 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 68561b784a2944a7a713186f5cb20d34 枚举参数 无 请求示例 请求url PUT '/v2/dirs/1548576244711424/devices/29942028422873997' 请求头header 无 请求体body {"InProtocol":"gb28181"}

接口功能介绍 虚机删除 接口约束 注意边缘池id与虚机id需正确。 URI POST /v3/evm/deleteInstance 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 nodeCode 是 String 边缘池id，可通过查看区域集群编码列表接口获取。 ynlincang1 id 是 String 虚拟机id。 evmxxxxxx refundOrderType 否 Integer 选择退订方式，0退订正常状态资源，退订后冻结；1强制删除冻结状态资源；2退订并销毁正常状态资源，默认值是0。 0 reservedIP 否 Boolean 退订后是否保留IP，false不保留，true暂时保留，过期后仍会释放，默认false。 false 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 200 message String 状态描述 Success returnObj Object 返回数据 returnObj error String 错误码，执行成功时，不返回该字段 ECX0001 表 returnObj 参数 参数类型 说明 示例 下级对象 id String 虚拟机id evmxxxxx 枚举参数 无

接口功能介绍 调用此接口可设置指定告警规则的告警联系人及通知方式。 接口约束 告警规则存在。 URI POST /v4/monitor/setalarmrulecontact 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID alarmRuleID String 是 2c2472dff6335b4bbe459609fc9f8154 告警规则ID contactGroupList Array of String 是 ["7e6b4ac7cf07561db381fea74c401f50"] 告警接收策略通知人ID列表 notifyType Array of String 是 ["sms"] 告警接受策略通知方式。取值范围：sms：短信通知。email：邮件通知。根据以上范围取值。 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

接口功能介绍 调用此接口可变更告警联系人所属的告警联系人组列表。 接口约束 告警联系人及告警联系人组存在。 URI POST /v4/monitor/updatecontactgroups 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 contactID String 是 a6fb570f22995bde989cdf0819c687d0 告警联系人ID actionType String 是 add 本参数表示变更类型。取值范围：add：新增。del：删除。根据以上范围取值。 contactGroupIDList Array of String 否 ["fe7f0cdc469255168d3ab06355482090"] 告警联系人组ID列表 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0

告警规则 告警规则：启用/禁用 接口功能介绍 批量更新告警规则状态为禁用或启用。 接口约束 告警规则存在。 URI POST /v4.1/monitor/changealarmrulesstatus 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b status 是 Integer 本参数表示告警黑名单状态。取值范围：0：启用。1：停用。根据以上范围取值。 1 alarmRuleIDList 是 Array of Strings 告警规则ID列表 ['f79fe6a8284f5cd89031812b06821b9c','eec4a76a35ba57b891c6c4fd923351d6'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

告警规则 自定义告警规则：批量删除 接口功能介绍 调用此接口可批量删除多个自定义监控/事件告警规则。 接口约束 告警规则存在。 URI POST /v4/monitor/deletecustomalarmrules 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleIDList 是 Array of Strings 告警规则ID列表 ['f79fe6a8284f5cd89031812b06821b9c','eec4a76a35ba57b891c6c4fd923351d6'] 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true

接口功能介绍 创建证书csr接口 接口约束 请保证账户余额大于0 URI POST /v1/manageCertificate/createCertificate 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 keySpec 是 String 证书算法 RSA2048 subject 是 String 证书主体（拥有者） CNuserName,OUkms,Otele,CCN subjectAlternativeNames 是 List 证书主体别名 ["test1.example.com","test2.example.com"] exportablePrivateKey 是 int 证书私钥是否需要导出使用 1 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 用户创建证书成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff csr String 生成的证书csr BEGIN CERTIFICATE REQUESTnMIIDADCCAegCAQAwgboxCzAJBgNVBAYTAkNOMREwDwYDVQQIEwhaaGVqaWFuZzERnnmkj4rgnEND CERTIFICATE REQUESTn

本小节介绍购买渗透测试服务的操作步骤。 操作步骤 1. 在天翼云官网注册账户后，进入天翼云官网首页，在产品按钮中选择“安全及管理> 安全服务 > 渗透测试”，进入渗透测试页面。 2. 点击渗透测试服务的立即订购，按需求填写购买即可。 3. 您可以选择小型、中型、大型三种规格。 规格选择 描述 常见系统 小型渗透 测试对象为1个应用系统。 门户网站（仅包含信息展示页面）为一个应用系统，属于小型系统。 中型渗透 测试对象的复杂度相当于5个应用系统。 办公系统，包含邮箱系统、财务系统、工时系统，为三个应用系统，属于中型系统。 大型渗透 测试对象的复杂度相当于10个应用系统。 网银系统，包含门户网站、个人网银、企业网银、手机银行、微信银行、App用户端，为六个应用系统，属于大型系统。

通知模板 通知模板：查看详情 接口功能介绍 调用此接口可查看通知模板详情。 接口约束 通知模板存在。 URI GET /v4/monitor/describenoticetemplate 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 noticeTemplateID 是 String 通知模板ID 315c7f8c3e4311ed8ef2005056898fe0 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 noticeTemplateID String 通知模板ID 315c7f8c3e4311ed8ef2005056898fe0 name String 通知模板名称 bzmcV service String 服务 ecs dimension String 维度 ecs contents Array of Objects 通知模板 content isDefault Boolean 是否为自定义默认通知模板 false createTime Integer 创建时间，时间戳，精确到秒 1667459789 updateTime Integer 最近更新时间，时间戳，精确到秒 1667459789 表 content 参数 参数类型 说明 示例 下级对象 content String 通知模板内容 this is content notifyType String 本参数表示通知方式。取值范围：sms：短信。email：邮件。 根据以上范围取值。 sms

资源类型 配置项 配置明细 说明 RDS RDS实例名 rdstest 自定义，易理解可识别 RDS 数据库版本 MySQL 5.7 本示例中为单机。实际使用时，为提升业务可靠性，推荐选择主备RDS实例。 RDS 实例类型 单机 RDS 存储类型 SSD RDS 可用区 可用区1 本示例中为单机，实际业务场景推荐选择主备RDS实例，此时建议将两个实例创建在不同的可用区，提升业务可靠性。 RDS 规格 2 vCPUs 4 GB

本文介绍了查看快照使用容量的操作场景及操作步骤。 操作场景 天翼云云硬盘快照服务以云硬盘的快照使用总容量为粒度进行统计并计费。快照使用总容量为当前云硬盘中所有快照的数据块所占用的存储空间之和。您可实时查询云硬盘的快照使用容量。 操作步骤 1. 登录控制中心。 2. 单击控制中心左上角的，选择地域，此处我们选择华东1。 3. 单击“存储>云硬盘”，进入云硬盘主页面。 4. 单击待查看快照使用容量的云硬盘的“云硬盘名称”，进入“云硬盘详情”页面。 5. 在“云硬盘详情”页面可实时查看该云硬盘的快照个数以及快照使用容量。

本文将为您介绍什么是模板。 资源编排ROS 模板是用于创建、更新天翼云 资源编排ROS 资源栈的标准化配置脚本，作为资源部署的核心 “蓝图”，它采用 Terraform 的 HCL（HashiCorp Configuration Language）作为配置语法。 借助 HCL 的结构化语法特性，能够清晰定义资源栈所需的资源类型（如计算实例、存储服务、网络配置等）、具体参数（如实例规格、存储容量、网络地址等）及资源间依赖关系，确保资源部署逻辑具备可追溯性和可读性。 基于模板，用户无需手动逐一配置资源，可快速生成一致性的资源栈，同时支持后续对资源栈进行统一更新与管理，有效简化天翼云资源部署流程，提升操作效率与配置准确性，适配从简单到复杂场景的资源自动化管理需求。