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

接口功能介绍 应用组删除 接口约束 无 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 无

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

接口功能介绍 调用此接口可批量删除多个创建告警规则。 接口约束 告警规则存在。 URI POST /v4/monitor/deletealarmrules 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID alarmRuleIDList Array of String 是 ["f79fe6a8284f5cd89031812b06821b9c","eec4a76a35ba57b891c6c4fd923351d6"] 告警规则ID列表 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Array of String 删除成功的告警规则id列表 ["f79fe6a8284f5cd89031812b06821b9c","eec4a76a35ba57b891c6c4fd923351d6"] failed Array of String 删除失败的告警规则id列表 ["f79fe6a8284f5cd89031812b06821b9c","eec4a76a35ba57b891c6c4fd923351d6"]

接口功能介绍 调用此接口可修改告警联系组。 接口约束 告警联系人组存在，告警联系人组名称不可重复，可包含字母、中文、数字，230个字符。 URI POST /v4/monitor/updatecontactgroup 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 contactGroupID String 是 fe7f0cdc469255168d3ab06355482090 组ID name String 否 moCEN 告警联系组新名称 desc String 否 test 告警联系组新描述 contactIDList Array of String 否 ["a6fb570f22995bde989cdf0819c687d0"] 告警联系人ID列表 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID bbfb781d22995bde989cdf0819c687d0

接口功能介绍 调用此接口可创建告警联系组。 接口约束 告警联系人组名称不可重复，可包含字母、中文、数字，230个字符。 URI POST /v4/monitor/createcontactgroup 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 name String 是 moCEN 告警联系人组名称 desc String 否 test 组描述 contactIDList Array of String 否 ["a6fb570f22995bde989cdf0819c687d0"] 告警联系人ID列表 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID bbfb781d22995bde989cdf0819c687d0 请求示例 POST /v4/monitor/createcontactgroup 请求体body json { "name": "hEtmm", "contactIDList": ["6412da6e787051c0ac93b8e5635be437"] }

接口功能介绍 调用此接口可批量移出资源分组中的资源。 接口约束 资源分组已存在。 URI POST /v4/monitor/deleteresourcegroupbatch 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID resGroupID String 是 95f7f0cbb5d7547e86673fceeab177d5 资源分组ID IDList Array of String 是 ["d48daba2f4775503993a39780e6e0a07"] 资源ID列表 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 success Boolean 是否成功 true 请求示例 POST /v4/monitor/deleteresourcegroupbatch 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "resGroupID": "5ce993cb71c65ef0a386879b6f183979", "IDList": ["d48daba2f4775503993a39780e6e0a07"] ] }

外部告警 外部告警：刷新告警联系人组token 接口功能介绍 调用此接口可刷新告警联系人组token。 接口约束 无。 URI GET /v4/monitor/refreshtoken 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 contactGroupID 是 String 告警联系人组ID cf21ea17e31d5f47bf106c489a86f67d 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 token String token 1411668ec8c13f57472576d5d1603226 请求示例 请求url /v4/monitor/refreshtoken?contactGroupIDcf21ea17e31d5f47bf106c489a86f67d 请求头header 无 请求体body 无

资源分组 资源分组：删除 接口功能介绍 调用此接口可删除指定资源分组。 接口约束 参见请求参数说明。 URI POST /v4.1/monitor/deleteresourcegroups 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 81f7728662dd11ec810800155d307d5b resGroupIDList 是 Array of Strings 资源分组ID列表 ['95f7f0cbb5d7547e86673fceeab177d5'] 响应参数 参数 参数类型 说明 示例 下级对象 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

接口功能介绍 更新Ukey证书状态 接口约束 无 URI POST /v1/manageCertificate/updateCertificateStatusForUk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 474e569e8814474a948bdbcf6d853eff status 是 String 证书状态 ACTIVE 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 枚举参数 参数名 status 枚举值 类型 说明 ACTIVE String 启用 INACTIVE String 禁用 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "certificateId": "8c6cbfc113be4817b106e324189d088d", "status": "INACTIVE" } 响应示例 plaintext { "statusCode": 200, "message": "uk证书状态更新成功", "returnObj": { } } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 密钥加密接口 接口约束 请保证账户余额大于0 URI POST /v1/keyCompute/encrypt 路径参数 无 Query参数 无 请求参数 请求头header参数 请参见请求消息头 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff plaintext 是 String 待加密数据，且必须经过Base64编码后上传 U0dWc2JHOGdkMjl5MWVhOQ 响应参数 参数 参数类型 说明 示例 下级对象 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 ciphertextBlob String 加密结果，且经过Base64加密 DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjKy5nl

工作负载中lable 的key operator: In values: test 工作负载中对应lable 的value 工作负载创建完成后设置 步骤 1 登录CCE控制台，在左侧导航栏中选择“工作负载 > 无状态负载 Deployment”或“工作负载 > 有状态负载 StatefulSet”。 步骤 2 单击工作负载名称进入详情页，单击“调度策略 > 简易调度策略 > 添加亲和对象”。 步骤 3 对象类型选择“工作负载”，勾选希望部署到相同节点上的工作负载，设置完成后当前工作负载会和已勾选的工作负载部署在相同节点上。 说明： 该方法可新增、编辑和删除调度策略。

响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码，取值范围： 200：成功 400：参数缺失或错误 401：用户验证错误 404：操作目标不可用 500：系统内部错误 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 导出数据密钥成功 data Object 接口返回结果 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 exportedDataKey String 导出的数据密钥密文 AK0Fq+zuxUitFTmOpyJkJb8VsjR7t8RLFGMSLxsiuK6s6/8dyQmlI5lxCxBFDfu RT9bpLqLAlKNm7DM+NzYNNwshq1GsX7+ujaTfHIt5a4QOW5mLdnPEpdp bUfOHzXlV3pvToDC24wPJjw7KcIQMqchfOzuixXWtreEVf8LK4J1hMiVp1Vui DO2HR1dUjk+RZVsQKlZy0xf55qN4uffknp1c7bwv5Fd1mPIVzBjvjdz9h+8gT G2VVygN1uHo0tCCljQRKFGLo67y/E8Dn8qyWANWKhPl0dkjNrOtRvwm1kN K7cunPIECkpYm1lHnBPO3QPkzIC7t5dQJzu3T0iMAAg cmkUuid String 密钥唯一标识id 474e569e8814474a948bdbcf6d853eff keyVersionId String 密钥版本id f2ffbff9940a41a4ba9afe1fd8f22792

本节主要介绍如何将数据从AWS S3迁移到OOS中。 应用场景 将数据从AWS S3的Bucket迁移到OOS的Bucket。 注意 在线迁移会占用源地址和目的地址的网络资源。若您的业务比较重要，建议您对迁移任务设置限速（设置system.conf中的maxThroughput），或在空闲时间启动迁移任务。 从AWS S3迁移到OOS的文件（Object），仅迁移当前可读取到的文件，不支持按object version Id 迁移。 前提条件 Windows7 及以上版本或 Linux CentOS 7.x 及以上版本。 Java 1.8 及以上版本。 迁移工具所在的服务器可以访问AWS S3资源池和OOS资源池。 具体操作 确定目标Bucket 在OOS中创建目标Bucket，具体操作请参见创建存储桶（Bucket）或PUT Bucket，用于存放迁移的数据。也可以使用已存在的Bucket。 下载安装迁移工具 1. 下载数据迁移工具。 2. 解压缩安装包 对于Windows客户端，直接解压缩迁移工具zip 包即可。 对于Linux客户端，执行 unzip 解压缩安装包。 迁移工具解压后的目录结果如下： CTYUNOOSImportversionid config log4j2.xml migrate.conf system.conf lib import.sh import.bat 修改配置文件 更新迁移任务配置文件migrate.conf，配置源和目的资源池信息、迁移配置项。您可根据需要配置system.conf和 log4j2.xml文件，具体参数介绍参见常用工具OOS数据迁移工具迁移步骤。其中： srcType需填写为：S3，代表AmazonS3。 srcEndpoint为s3.amazonaws.com。 S3的region可在S3控制台存储桶列表中查看源Bucket所在的区域。 S3 AccessKey和SecretKey需要至少拥有源Bucket的读权限，OOS的AccessKeyID和SecretAccessKey需要至少拥有目的Bucket的写权限。 migrate.conf配置示例如下： { "srcType":"S3", 从S3迁移文件 "srcEndpoint":"s3.amazonaws.com", S3的Endpoint "srcAccessKey":"your s3 accessKey", S3的AccessKey "srcSecretKey":"your s3 secretKey", S3的SecretKey "srcBucket":"s3bucket", S3的bucket "srcRegionName":"useast1",S3的region，请根据实际填写 "srcPrefix":"logs/", S3上要迁移文件的前缀，请根据实际填写 "srcMarker":"", 从第一个文件开始迁移 "srcStopObject":"", S3上要迁移的截止文件 "destEndpoint":"ooscn.ctyunapi.cn", OOS的Endpoint "destAccessKey":"AccessKeyID", OOS的AccessKeyID "destSecretKey":"SecretAccessKey", OOS的SecretAccessKey "destBucket":"BucketName", OOS的Bucket名称 "isSkipExistFile":false 是否跳过目标资源池中已有的文件 }

接口功能介绍 查询ukey证书详情 接口约束 无 URI POST /v1/manageCertificate/describeCertificateForUk 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 certificateId 是 String 证书id 9612627252624b61bf5cd66ca3c7a0b3 响应参数 参数 参数类型 说明 示例 下级对象 code String 状态码 取值范围：200 成功 200 msg String 提示信息 Success returnObj Object 返回数据结构体 result errorCode String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 表 result 参数 参数类型 说明 示例 下级对象 certificateId String 证书id 474e569e8814474a948bdbcf6d853eff exportablePrivateKey String 私钥是否可以导出 1 certificateName String 证书名称 cert1 createdAt String 创建时间 20240807 15:08:13 issuer String 证书的签发者信息 CNtestCA,OUkms,Oaliyun,CCN keySpec String 证书密钥类型 RSA2048 notAfter String 证书有效期的截止时间 20250807 15:34:53 notBefore String 证书有效期的开始时间 20240807 15:34:53 serial String 证书序列号 12345 signatureAlgorithm String 证书签名算法 SHA256withRSA status Integer 证书状态 2 subject String 证书拥有者主体 CNuserName,OUaliyun,Oaliyun,CCN subjectAlternativeNames Array of Strings 证书主体别名 ["test1.example.com","test2.example.com"] subjectKeyIdentifier String 主体公钥识别符 ab cd ef gh subjectPublicKey String 证书公钥 BEGIN PUBLIC KEY END PUBLIC KEY useId String 创建者 1 keyUsage String 密钥用途 crlDistributionPoint String crl分发点 isValidityCheck String 是否开启有效性验证 0未开启 1开启

告警联系人/组 告警联系人组：查看详情 接口功能介绍 调用此接口可查询告警联系人组的配置详情。 接口约束 无。 URI GET /v4/monitor/describecontactgroup 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 contactGroupID 是 String 告警联系人组ID a6fb570f22995bde989cdf0819c687d0 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 contactGroupID String 告警联系人组ID cf21ea17e31d5f47bf106c489a86f67d name String 组名 group3 desc String 组备注 test contactList Array of Objects 告警联系人列表 contact updateTime Integer 最近更新时间, 时间戳，精确到毫秒 1667459789000 createTime Integer 创建时间，时间戳，精确到毫秒 1667459789000 表 contact 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0 name String 用户名 gxlupdate phone String 手机号 18919128910 email String 邮箱 864307365@qq.com phoneActivation Integer 本参数表示手机号码是否激活。取值范围：1：已激活。0：未激活。根据以上范围取值。 0 emailActivation Integer 本参数表示邮箱是否激活。取值范围：1：已激活。0：未激活。根据以上范围取值。 0