接口功能介绍 密钥版本详情查询 接口约束 请保证账户余额大于0 URI POST /v1/versionControl/describeKeyVersion 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId 是 String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 获取密钥版本成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792 creationDate String 版本创建时间 Tue Oct 25 15:06:52 CST 2022

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

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

本节介绍kafka实例连接数限制 基准带宽为100MB/s时，Kafka客户端连接数在3000以内。 基准带宽为300MB/s时，Kafka客户端连接数在10000以内。 基准带宽为600MB/s时，Kafka客户端连接数在20000以内。 基准带宽为1200MB/s时，Kafka客户端连接数在20000以内。 实例规格为s7.xlarge.4（通用型4u16g）时，单个代理客户端总连接数上限为1000。 实例规格为s7.2xlarge.4 （通用型8u32g）时，单个代理客户端总连接数上限为2000。 实例规格为s7.4xlarge.4 （通用型16u64g）时，单个代理客户端总连接数上限为4500。 实例规格为c7.xlarge.2（计算增强型4u8g）时，单个代理客户端总连接数上限为4500。 实例规格为c7.2xlarge.2（计算增强型8u16g）时，单个代理客户端总连接数上限为6000。 实例规格为c7.4xlarge.2（计算增强型16u32g）时，单个代理客户端总连接数上限为10000。

请求参数 请求头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 参数 参数类型 说明 示例 下级对象 alarmRules Array of Objects 告警规则 alarmRule totalCount Integer 总记录数 20 currentCount Integer 当前页记录数 10 totalPage Integer 总页数 2 表 alarmRule 参数 参数类型 说明 示例 下级对象 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

欠费说明 欠费后天翼云数据库审计会自动停止，您所占用的存储空间资源仍会继续扣费，因此欠费余额会累计。如果您在15天内充值补足欠款，服务会自动启用。 当欠费超过15天，将视为您主动放弃该服务，您保存在天翼云数据库审计的全部数据将会被销毁，销毁后数据不可恢复。因此请您及时关注账户余额并及时续费以保证您的服务不受到影响。 若您确认不再使用天翼云数据库审计服务，请务必及时删除存储于数据库审计的数据。 续费说明 若是已购买资源包后欠费，请在15天内再次订购相应的资源包或保证帐号中的余额充足。 若是未购买资源包后欠费，请在15天内充值补足欠款并保证帐号中的余额充足。

终端安全EDR 终端检测和响应是一种主动式终端安全解决方案，通过记录终端与网络事件（例如用户，文件，进程，注册表，内存和网络事件），并将这些信息本地存储在终端或集中数据库，结合已知的攻击指示器（Indicators of Compromise，IOCs）、行为分析的数据库来连续搜索数据监测任何可能的安全威胁，并对这些安全威胁做出快速响应，还有助于快速调查攻击范围，并提供响应能力。对应等级保护安全计算环境技术要求。 云数据库审计 云数据库审计（简称DBAudit）能够实时记录网络上的数据库活动，对数据库操作进行细粒度审计的合规性管理，对数据库遭受到的风险行为进行告警。它通过对用户访问数据库行为的记录、分析和汇报，用来帮助用户事后生成合规报告、事故追根溯源，同时加强内外部数据库网络行为记录，提高资产安全。对应等级保护集中审计技术要求。 云日志审计 云日志审计全面收集安全设备、网络设备、数据库、服务器、应用系统、主机等设备所产生的日志（包括运行、告警、操作、消息、状态等）并进行存储、监控、审计、分析、报警和报告的系统。对应等级保护集中审计技术要求。 云堡垒机 云堡垒机为了保障网络和数据不受来自外部和内部用户的入侵和破坏，而运用各种技术手段监控和记录运维人员对网络内的服务器、网络设备、安全设备、数据库等设备的操作行为以便集中报警、及时处理及审计定责。对应等级保护集中审计技术要求。

本节介绍资源管理用于配置 AIuse 云电脑接入所需的凭证、云电脑关联关系和资源使用范围。 资源管理用于配置 AIuse 云电脑接入所需的凭证、云电脑关联关系和资源使用范围。通过资源管理，租户可以按项目、环境或任务批次划分 AccessKey，并将其绑定到指定云电脑。 资源对象 AIuse 云电脑当前主要涉及以下资源对象： 资源对象 说明 AccessKey 调用 SDK 或 MCP 时使用的身份凭证 云电脑 执行桌面任务的云端桌面资源 桌面编码 SDK 或 MCP 连接指定云电脑时使用的资源标识，对应 desktopCode 关联关系 AccessKey 与可操作云电脑之间的绑定关系 管理目标 资源管理主要用于解决以下问题： 谁可以调用 AIuse 云电脑能力。 某个 AccessKey 可以操作哪些云电脑。 不同项目、环境和任务批次如何隔离。 AccessKey 泄露或不再使用时如何快速禁用。 如何查看和维护 AccessKey 与云电脑的绑定关系。 推荐资源规划 建议按以下原则规划资源： 维度 建议 项目隔离 不同业务项目使用不同 AccessKey 环境隔离 开发、测试、生产环境使用不同 AccessKey 权限最小化 AccessKey 只关联必要的云电脑 生命周期管理 临时任务结束后及时禁用或删除 AccessKey 审计追踪 AccessKey 名称建议包含项目、环境和用途

接口功能介绍 获取CSR详情 接口约束 1.已有csr URI POST /v1/csr/detail 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 id 是 String CSR id aed5a52cf7a941af9aaad69410409f96 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 200 message String 提示信息 Success returnObj Object 返回数据结构体 CsrDetail error String 错误码,仅错误时返回 CCMS100000063 表 CsrDetail 参数 参数类型 说明 示例 下级对象 id String uuid 6ee1160088ef44ec80213d1a448b2d8e name String crs名称 csr6b9cea commonDomain String 通用域名 ctyun.cn otherDomainName String 其他域名 ctyun.cn generateMethod String CSR生产方式 MANUAL encryptionAlgorithm String 加密算法 SM2 csr String CSR privateKey String 私钥 country String 国家 CN province String 省 上海市 city String 市 上海市 keyLength Integer 密钥长度 2048 signHashType String 签名算法类型 SHA256 createTime String 创建时间 20240513T09:19:01Z email String 邮箱 123456@qq.com companyName String 公司名称 公司 department String 部门 部门 detailedAddress String 详细地址 上海市

启用伸缩组中的指定策略 接口功能介绍 启用伸缩组中的指定策略。 接口约束 无 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/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/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/isopen 路径参数 无 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 参数 参数类型 说明 示例 下级对象 isOpen Boolean 是否开通 true 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b" } 响应示例 json { "returnObj": { "isOpen": true }, "errorCode": "", "message": "SUCCESS", "description": "成功", "statusCode": 800 } 错误码 errorCode 描述 Openapi.Workorder.AccessFailed 获取伸缩组/伸缩配置失败

查询伸缩活动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/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/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/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/group/enable 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 489 响应参数 参数 参数类型 说明 示例 下级对象 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": 489 } 响应示例 json { "returnObj": { "groupID": 489 }, "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/group/instancemoveout 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必选 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 443 instanceIDList 是 Array of Strings 实例ID列表 [adc614e0e838d73f0618a6d51d09070a] 响应参数 参数 参数类型 说明 示例 下级对象 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 参数 参数类型 说明 示例 下级对象 instanceIDList Array of Strings 实例ID列表 [adc614e0e838d73f0618a6d51d09070a]

删除一个定时策略 接口功能介绍 删除一个定时策略 接口约束 无 URI POST /v4/scaling/rule/deletescheduled 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数名 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b ruleID 是 Integer 伸缩策略ID 87 groupID 是 Integer 伸缩组ID 489 响应参数 参数 参数类型 说明 示例 下级对象 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 参数 参数类型 说明 示例 下级对象 ruleID Integer 伸缩策略ID 87 请求示例 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "ruleID":141, "groupID":508 }

停用一个伸缩组 接口功能介绍 停用一个弹性伸缩组 接口约束 无 URI POST /v4/scaling/group/disable 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b groupID 是 Integer 伸缩组ID 489 响应参数 参数 参数类型 说明 示例 下级对象 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": 489 } 响应示例 json { "returnObj": { "groupID": 489 }, "errorCode": "", "message": "SUCCESS", "description": "成功", "statusCode": 800 }

响应参数 参数 参数类型 说明 示例 下级对象 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": "成功" } 状态码 请参考 状态码

接口功能介绍 应用组删除 接口约束 无 URI POST /v4/sdwan/appgroup/delete 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 groupIDList 是 Array of Strings 应用组id列表 ，值类型为string 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码('800为成功，900为失败) ，默认值:800 800 errorCode String 业务细分码，为product.module.code三段式码 message String 失败时的错误描述，一般为英文描述 description String 失败时的错误描述，一般为中文描述 returnObj Array of Objects 返回参数 returnObj error String 业务细分码，为product.module.code三段式码 表 returnObj 参数 参数类型 说明 示例 下级对象 operationID String 操作id 2667c06e4a0f11edb0e4005056898fe0 枚举参数 无 请求示例 请求url 无 请求头header 无 请求体body { "groupIDList": [ "58" ] } 响应示例 { "statusCode": 800, "returnObj": [ { "operationID": "2667c06e4a0f11edb0e4005056898fe0" } ], "errorCode": "", "error": "", "message": "", "description": "" }

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

接口功能介绍 本接口用于查询回调规则，即查询设备绑定的回调模板。 接口约束 查询模板前确保存在该设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/callbackRule/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996 Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 TemplateId String 模板ID。 739943519892963328 DeviceId String 设备ID。 700576974938832896 CreatedTime String 回调规则创建时间。 1691995152 UpdatedTime String 回调规则更新时间。 1691995152 RequestId String 请求ID。 362d4e78556b47129182d0881fade86b

接口功能介绍 本接口用于创建目录。 接口约束 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI POST /v2/dirs 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 ParentDirId 否 String 上级目录ID。 29941936081076293 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。 700835918517108736 CreatedTime String 目录创建时间。 1680516454250 UpdatedTime String 目录更新时间。 1680516454250 RequestId String 请求ID。 329a85603c8c416e8a96c7c5031056b2

接口功能介绍 本接口用于查询GB28181凭证信息。 接口约束 查询凭证前请确保存在该凭证。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/gb28181Certs/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名。 cert Query参数 无 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 UserName String 凭证用户名。 cert UserType String 凭证类型。 normal Description String 凭证描述。 描述 CreatedTime String 凭证创建时间。 1681370054426 UpdatedTime String 凭证更新时间。 1681370054426 RequestId String 请求ID。 b9d13f607bc14907815a8fd131ab0dbf

接口功能介绍 根据集群id退订集群。 接口约束 退订集群必须处于运行状态或异常终止状态。 URI GET /v2/emr/openapi/order/refund 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 clusterId 是 String 集群id 00c3a04292996955752f073c995a1cc6 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码，成功：200，失败：500 200 message String 用来简述当前接口调用状态以及必要提示信息 请求成功 error String 错误码，请求成功时，不返回该字段 EMR400000 returnObj Array of Objects 返回结果，退订成功时返回下单事件信息 表returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 errorMessage String 错误码 submitted Boolean 判断退订是否成功：为true表示成功；为false表示失败 newOrderId String 订单ID newOrderNo String 订单号 totalPrice Double 总价 枚举参数 无 请求示例 请求url 请求头header 无 请求体body 无