接口功能介绍 调用此接口可查询指定套餐包使用数量。 接口约束 参见请求参数说明。 URI GET /v4/monitor/order/noticepackused 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 method 是 String 本参数表示通知套餐包类型。取值范围： sms：短信通知套餐包。 voice：语音通知套餐包。 根据以上范围取值。 voice 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，适配中英文 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Array of Objects 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 packIsAvailable Boolean 是否有可用收费套餐包 true monthPackCost Integer 本月收费套餐包使用量，前提条件需有可用的收费套餐包。 500 monthFreeCost Integer 本月免费套餐包使用量 100 monthFreeQuota Integer 本月免费套餐包额度 500 yearCost Integer 本年使用总量 10000

删除一个弹性伸缩配置 接口功能介绍 删除一个弹性伸缩配置 接口约束 无 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/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/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 }

停用伸缩组中的指定策略 接口功能介绍 停用伸缩组中的指定策略。 接口约束 无 URI POST /v4/scaling/rule/stop 路径参数 无 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/check 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 443 响应参数 参数 参数类型 说明 示例 下级对象 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 参数 参数类型 说明 示例 下级对象 result Integer 伸缩组是否可以修改取值范围：1：可以修改2：不可以修改 1 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "groupID": 405 }

删除一个告警策略 接口功能介绍 删除一个告警策略 接口约束 无 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 }

接口功能介绍 更新target 接口约束 无 URI POST /v4/gwlb/updatetarget 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池 ID bb9fdb42056f11eda1610242ac110002 targetID 是 String 后端服务 ID tgxxx description 否 String 支持拉丁字母、中文、数字, 特殊字符：~!@ $%^&()+ <>?:"{},./;'[]·！@ ￥%……&（） —— +{}《》？：“”【】、；‘'，。、，不能以 http: / https: 开头，长度 0 128 desc weight 否 Integer 权重，仅支持填 100 1 响应参数 参数 参数类型 说明 示例 下级对象 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 参数 参数类型 说明 示例 下级对象 targetID String 后端服务ID targetxxxx

接口功能介绍 更新多证书 接口约束 无 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

响应参数 参数 参数类型 说明 示例 下级对象 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" ] }

接口功能介绍 本接口用于删除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用户端，为六个应用系统，属于大型系统。

参数 是否必填 参数类型 说明 示例 下级对象 statusCode 是 String 接口状态码，返回状态，返回 0 表示成功，返回错误代码参考下面的错误代码列表 0 message 是 String 如果statusCode 为 0，返回 success；如果statusCode 非 0，返回 error success returnObj 是 Object 返回的人脸检测结果对象 returnObj

本章节介绍Eureka引擎告警管理功能 概述 通过实例的告警管理能力，您可以对实例状态进行实时监控，并在特定指标异常时，将消息以不同形式（短信、邮件、翼连）推送到相关负责人，以便及时感知问题、处理线上故障。 管理通知对象 在配置告警规则之前，您需要先添加通知对象。通知对象包括联系人、联系人组、翼连、WebHook集成四种形式。 联系人：一个告警规则所通知的“个人”，通知渠道包括该“个人”的手机短信和个人邮箱。 联系人组：多个联系人组成的逻辑团体。若告警通知到联系人组，将会通知联系人组下的每个联系人。 翼连：通知到翼连群。 WebHook集成：通过调用预先指定的地址进行告警通知。 下面以最简单的联系人为例，演示如何添加通知对象。 1.进入实例引擎控制台>告警管理>通知组页签，点击“新建联系人”按钮。 2.在弹出的窗口中，填写联系人的对应信息，即可完成创建。 管理告警规则 告警规则决定了一次告警发生的阈值、通知的对象和渠道，以及通知的内容。完成联系人创建后，进入实例引擎控制台>告警管理>告警规则页签，可以管理您的告警规则。 下面将演示如何创建一个“Eureka引擎注册服务健康实例数量占比过少”多告警并使其生效，触发告警。 1. 创建通知策略。进入实例引擎控制台>告警管理>通知策略页签，点击“创建通知策略”按钮，填写相关信息，并指定通知对象为上一步骤中创建的联系人，完成通知策略创建； 2. 点击“创建告警规则”按钮，在弹出的窗口中填写告警相关信息。其中，通知策略指定为步骤1中创建的通知策略，告警分组选择“Eureka引擎”，告警指标选择“健康实例数量占比”，根据您的需求选择合适的判断条件，告警等级。 3. 完成告警规则创建后，可在告警规则列表中查询到该条目。告警规则创建完毕后默认启用，可通过右侧“操作”中的“停止”来使该规则失效。 4. 告警规则生效后，可在实例引擎控制台>告警管理>告警事件历史页签中，对告警事件的当前状态进行追踪。

接口功能介绍 开启防护的自动检查结果 接口约束 传参规范 URI GET /vfw/v2assertprotectcheck 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 vpcId 是 String natId scenarioType 是 String 场景类型nat;vpcPeer对等连接;cda云专线;ec云间高速 scenarioId 是 String 场景id 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 urlType 是 String 请求地址类型 CTAPI regionId 是 String 资源池id 100054c0416811e9a6690242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 subnetCheck String VPC子网配额检查 normal正常warn告警 error错误 routeQuotaCheck String 路由表配额配额检查 同上 routeRuleQuotaCheck String 默认路由表检查 同上 subnetRouteCheck String 子网路由表检查 同上 subnetCheckResult Array of Strings VPC子网配额检查详情 VPC下子网数已超过5个(请提工单提升子网配额，已提升请忽略) routeQuotaCheckResult Array of Strings 路由表配额配额检查详情 路由表超过100个(请提工单提升路由表配额，已提升请忽略) routeRuleQuotaCheckResult Array of Strings 默认路由表检查详情 默认路由表规则超过100条，请处理 subnetRouteCheckResult Array of Strings 子网路由表检查详情 xxx没有自定义路由表；xxx路由表规则大于100

告警规则 告警规则：查看详情 接口功能介绍 查看告警规则的详情信息。 接口约束 regionID（资源池）和alarmRuleID（告警规则）存在。 URI GET /v4.1/monitor/describealarmrule 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleID 是 String 告警规则ID 3dbd23b274e253f8869c6fe6b07b9dba 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 alarmRule Object 告警规则 alarmRule 表 alarmRule 参数 参数类型 说明 示例 下级对象 regionID String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleID String 告警规则ID 3dbd23b274e253f8869c6fe6b07b9dba name String 规则名 告警规则名称 desc String 描述 描述 repeatTimes Integer 重复告警通知次数 1 service String 服务 ecs dimension String 维度 ecs silenceTime Integer 静默时间，单位：秒 300 recoverNotify Integer 本参数表示恢复是否通知。取值范围：0：否。1：是。根据以上范围取值。 0 notifyType Array of Strings 本参数表示告警接收策略。取值范围：email：邮件告警。sms：短信告警。根据以上范围取值。 ['email', 'sms'] contactGroupList Array of Objects 告警联系组 contactGroup notifyWeekdays Array of Integers 本参数表示通知周期。取值范围：0：周日。1：周一。2：周二。3：周三。4：周四。5：周五。6：周六。根据以上范围取值。 [0,1,2,3] notifyStart String 通知起始时段 00:00:00 notifyEnd String 通知结束时段 23:59:59 status Integer 本参数表示告警规则启用状态。取值范围：0：启用。1：停用。根据以上范围取值。 0 webhookUrl Array of Strings webhook消息推送url ['www.ctyun.cn'] resGroupID String 资源分组ID eec4a76a35ba57b891c6c4fd923351d6 createTime Integer 创建时间 1666855494 updateTime Integer 更新时间 1666856960 projectID String 项目ID resources Array of Objects 具体匹配资源 resources condition Array of Objects 触发规则的条件 condition dimensions Array of Objects 自定义监控信息，仅支持部分资源池 dimensions conditionType Integer 本参数表示告警策略触发类型。取值范围：0：或，任一条件触发。1：全部条件满足触发。根据以上范围取值。 0 alarmStatus Integer 本参数表示告警规则是否告警。取值范围：0：未触发告警。1：触发告警。2：无数据（仅部分资源池支持）。根据以上范围取值。 1 alarmType String 告警规则类型。取值范围：series：时序类监控。event：事件类。根据以上范围取值。 1 project String 告警规则来源 console 表 contactGroup 参数 参数类型 说明 示例 下级对象 groupID String 联系组ID 392c2sfcb05d5f5cae1c80c24c282090 name String 联系组名称 告警联系组 表 condition 参数 参数类型 说明 示例 下级对象 evaluationCount Integer 持续次数，当规则执行结果持续多久符合条件时报警（防抖），默认2次 2 metric String 监控指标 cpuutil metricCnName String 监控指标中文名 cpu使用率 fun String 本参数表示告警采用算法。取值范围：last：原始值算法。avg：平均值算法。max：最大值算法。min：最小值算法。根据以上范围取值。 avg operator String 本参数表示比较符。取值范围：eq：等于。gt：大于。ge：大于等于。lt：小于。le：小于等于。rg：环比上升。cf：环比下降。rc：环比变化。根据以上范围取值。 eq value String 告警阈值，可以是整数、小数或百分数格式字符串 0 period String 本参数表示算法统计周期。默认值5m。参数fun为last时不可传。参数fun为avg、max、min均需填此参数。本参数格式为“数字+单位”。单位取值范围：m：分钟。h：小时。d：天。根据以上范围取值。 5m unit String 监控指标单位 bit 表 resources 参数 参数类型 说明 示例 下级对象 resource Array of Objects 资源信息 resource 表 resource 参数 参数类型 说明 示例 下级对象 name String 资源实例标签键 uuid value String 资源实例标签值 000f03221f4d8cc8bb2e1c30fb751aa5 表 dimensions 参数 参数类型 说明 示例 下级对象 name String 自定义监控资源实例标签键 uuid value Array of Strings 自定义监控资源实例标签值 ['1c30fb751aa5']

接口功能介绍 查看事件告警规则的详情信息。 接口约束 regionID（资源池）和alarmRuleID（告警规则）存在。 URI GET /v4/monitor/describeeventalarmrule 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleID 是 String 告警规则ID 3dbd23b274e253f8869c6fe6b07b9dba 请求参数 请求头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 参数 参数类型 说明 示例 下级对象 alarmRuleID String 告警规则ID 2c2472dff6335b4bbe459609fc9f8154 regionID String ctyun资源池ID 81f7728662dd11ec810800155d307d5b name String 规则名 ctyunrule desc String 描述 demo service String 本参数表示服务。取值范围： ecs：云主机。 evs：云硬盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs dimension String 本参数表示告警维度。取值范围： ecs：云主机。 disk：磁盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs repeatTimes Integer 重复告警通知次数 0 silenceTime Integer 告警接收策略静默时间，多久重复通知一次，单位为秒 300 recoverNotify Integer 本参数表示恢复是否通知。取值范围： 0：否。 1：是。 根据以上范围取值。 0 notifyType Array of Strings 本参数表示告警接收策略。取值范围： email：邮件告警。 sms：短信告警。 根据以上范围取值。 ['email','sms'] contactGroupList Array of Objects 告警联系人组 contactGroup notifyWeekdays Array of Integers 本参数表示通知周期。取值范围： 0：周日。 1：周一。 2：周二。 3：周三。 4：周四。 5：周五。 6：周六。 根据以上范围取值。 [0,1,2,3,4,5,6] notifyStart String 通知起始时段，默认为00:00:00 00:00:00 notifyEnd String 通知结束时段，默认为23:59:59 23:59:59 webhookUrl Array of Strings webhook消息推送url地址 [' status Integer 本参数表示告警规则启用状态。取值范围： 0：启用。 1：停用。 根据以上范围取值。 0 alarmStatus Integer 本参数表示告警规则告警状态。取值范围： 0：正常。 1：正在告警。 根据以上范围取值。 0 createTime Integer 创建时间，毫秒级时间戳。 1689580180000 updateTime Integer 更新时间，毫秒级时间戳。 1689580180000 projectID String 项目ID 0 conditions Array of Objects 具体匹配策略 condition resources Array of Objects 资源信息列表 resources resourceScope Integer 规则的资源范围，取值范围： 0：实例资源类型。 1：资源分组类型。 2：全部资源类型 。 根据以上范围取值。 0 defaultContact Integer 是否使用天翼云默认联系人接收通知，取值范围： 0：否。 1：是。 根据以上范围取值。 0 表 contactGroup 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID 000f03221f4d8cc8bb2e1c30fb751ccc name String 告警联系人组名称 告警组aaa 表 condition 参数 参数类型 说明 示例 下级对象 eventName String 事件指标 migrationeventstart description String 事件中文描述 云主机迁移发生 value String 出现次数，告警阈值，整数格式字符串 1 period String 本参数表示算法统计周期。 5m level Integer 告警等级。取值范围： 1：紧急。 2：警示。 3：普通。 根据以上范围取值。 3 表 resources 参数 参数类型 说明 示例 下级对象 resource Array of Objects 资源信息 resourceObj 表 resourceObj 参数 参数类型 说明 示例 下级对象 name String 资源实例标签键 uuid value String 资源实例标签值 17d7e40a1f4ebca6fdb437dbb43237ee

接口功能介绍 查看事件告警规则的详情信息。 接口约束 regionID（资源池）和alarmRuleID（告警规则）存在。 URI GET /v4/monitor/describeeventalarmrule 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b alarmRuleID 是 String 告警规则ID 3dbd23b274e253f8869c6fe6b07b9dba 请求参数 请求头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 参数 参数类型 说明 示例 下级对象 alarmRuleID String 告警规则ID 2c2472dff6335b4bbe459609fc9f8154 regionID String ctyun资源池ID 81f7728662dd11ec810800155d307d5b name String 规则名 ctyunrule desc String 描述 demo service String 本参数表示服务。取值范围： ecs：云主机。 evs：云硬盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs dimension String 本参数表示告警维度。取值范围： ecs：云主机。 disk：磁盘。 pms：物理机。 ... 云监控服务，具体服务参见云监控：查询服务维度及监控项 ecs repeatTimes Integer 重复告警通知次数 0 silenceTime Integer 告警接收策略静默时间，多久重复通知一次，单位为秒 300 recoverNotify Integer 本参数表示恢复是否通知。取值范围： 0：否。 1：是。 根据以上范围取值。 0 notifyType Array of Strings 本参数表示告警接收策略。取值范围： email：邮件告警。 sms：短信告警。 根据以上范围取值。 ['email','sms'] contactGroupList Array of Objects 告警联系人组 contactGroup notifyWeekdays Array of Integers 本参数表示通知周期。取值范围： 0：周日。 1：周一。 2：周二。 3：周三。 4：周四。 5：周五。 6：周六。 根据以上范围取值。 [0,1,2,3,4,5,6] notifyStart String 通知起始时段，默认为00:00:00 00:00:00 notifyEnd String 通知结束时段，默认为23:59:59 23:59:59 webhookUrl Array of Strings webhook消息推送url地址 [' status Integer 本参数表示告警规则启用状态。取值范围： 0：启用。 1：停用。 根据以上范围取值。 0 alarmStatus Integer 本参数表示告警规则告警状态。取值范围： 0：正常。 1：正在告警。 根据以上范围取值。 0 createTime Integer 创建时间，毫秒级时间戳。 1689580180000 updateTime Integer 更新时间，毫秒级时间戳。 1689580180000 projectID String 项目ID 0 conditions Array of Objects 具体匹配策略 condition resources Array of Objects 资源信息列表 resources resourceScope Integer 规则的资源范围，取值范围： 0：实例资源类型。 1：资源分组类型。 2：全部资源类型 。 根据以上范围取值。 0 defaultContact Integer 是否使用天翼云默认联系人接收通知，取值范围： 0：否。 1：是。 根据以上范围取值。 0 表 contactGroup 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID 000f03221f4d8cc8bb2e1c30fb751ccc name String 告警联系人组名称 告警组aaa 表 condition 参数 参数类型 说明 示例 下级对象 eventName String 事件指标 migrationeventstart description String 事件中文描述 云主机迁移发生 value String 出现次数，告警阈值，整数格式字符串 1 period String 本参数表示算法统计周期。 5m level Integer 告警等级。取值范围： 1：紧急。 2：警示。 3：普通。 根据以上范围取值。 3 表 resources 参数 参数类型 说明 示例 下级对象 resource Array of Objects 资源信息 resourceObj 表 resourceObj 参数 参数类型 说明 示例 下级对象 name String 资源实例标签键 uuid value String 资源实例标签值 17d7e40a1f4ebca6fdb437dbb43237ee

组件名称 组件介绍 适用场景 使用限制 HPA Kubernetes内置组件，主要面向在线业务。 在线业务 适用于Deployment、StatefulSet等实现scale接口的对象。 VPA（alpha） 开源社区组件，主要面向大型单体应用。 大型单体应用 适用于无法水平扩展的应用，通常是在Pod出现异常恢复时生效。 Cubescaler CCSE自研插件，主要面向应用资源使用率存在周期性变化的场景。 周期性负载业务 适用于Deployment、StatefulSet等，实现了scale接口的对象。

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj

参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj

身份凭证 身份凭证是识别用户身份的依据，您通过控制台或者API访问云服务时，需要使用身份凭证来进行系统的认证鉴权。身份凭证包括密码和访问密钥，您可以在IAM中管理自己以及帐号中IAM用户的身份凭证。 密码：常见的身份凭证，密码可以用来登录控制台。 访问秘钥：即AK/SK（Access Key ID/Secret Access Key），调用云服务API接口的身份凭证，不能登录控制台。访问密钥中具有验证身份的签名，通过加密签名验证可以确保机密性、完整性和请求双方身份的正确性。 项目 每个资源池默认对应一个项目，目前这个项目由系统预置，用来隔离各资源池的资源（计算资源、存储资源和网络资源等），以该默认项目为范围进行授权，用户可以访问您帐号中该资源节点（即该默认项目）的所有资源。 委托 委托根据委托对象的不同，分为委托其他帐号和委托其他云服务。 委托其他天翼云帐号：通过委托信任功能，您可以将自己帐号中的资源操作权限委托给其他帐号，被委托的帐号可以根据权限代替您进行资源运维工作。 委托其他云服务：由于云服务之间存在业务交互关系，一些云服务需要与其他云服务协同工作，需要您创建云服务委托，将操作权限委托给该服务，让该服务以您的身份使用其他云服务，代替您进行一些资源运维自动化工作。