接口功能介绍 本接口用于查询指定设备的服务配置列表，包含视频、视图和AI配置等。 接口约束 需要确认存在该设备。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI GET /v2/device//resource/list 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 32388487739092996 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 DeviceType 是 String 设备类型，需与查询的DeviceId真实设备类型一致。取值：ipc，nvr。 ipc 请求参数 请求头header参数 无 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 Resource Object 资源信息。 Resource RequestId String 请求ID。 362d4e78556b47129182d0881fade86b 表 Resource 参数 参数类型 说明 示例 下级对象 Video Array of Objects 视频资源。 Video Viid Array of Objects 视图资源。 Viid AI Array of Objects AI资源。 AI 表 Video 参数 参数类型 说明 示例 下级对象 ChannelNum String 通道号。 1 ChannelName String 通道名称。 通道1 WorkOrderNo String 订单号。 202211031607018234 WorkOrderId String 订单ID。 workorder20723343 BillingMode String 计费模式。取值：packages(资源包)，onDemand(按需计费)，unBinding(停用)。 packages ResourceId String 资源ID。 resource20723343 RecordNum String 录制配置，取值：0：无录制；1：录制。 1 TemplateId String 录制模板ID。 717074786139029504 TotalDeviceCount String 设备总路数。 100 RemainDeviceCount String 设备剩余路数。 100 CodeRate String 码率。 8 StorageTime String ST天数 。 ST3 BandWidth String 总带宽。 100 IsTrialOrder String 是否试用。取值：0(代表商用)，1(代表试用)。 0 CreateTime String 创建时间。 20221125 16:03:04 ExpireTime String 失效时间。 20241201 10:55:04 表 Viid 参数 参数类型 说明 示例 下级对象 ChannelNum String 通道号。 1 ChannelName String 通道名称。 通道1 WorkOrderNo String 订单号。 202211031607018234 WorkOrderId String 订单ID。 workorder20723343 BillingMode String 计费模式。取值：onDemand(按需计费)，unBinding(停用)。 onDemand ResourceId String 资源ID。 resource20723343 RecordNum String 录制配置，取值：0：无录制；1：录制。 1 TemplateId String 录制模板ID。 717074786139029504 IsTrialOrder String 是否试用。取值：0(代表商用)，1(代表试用)。 0 CreateTime String 创建时间。 20221125 16:03:04 ExpireTime String 失效时间。 20241201 10:55:04 表 AI 参数 参数类型 说明 示例 下级对象 WorkOrderNo String 订单号。 202211031607018234 WorkOrderId String 订单ID。 workorder20723343 BillingMode String 计费模式。取值：packages(资源包)，onDemand(按需计费)，unBinding(停用)。 packages ResourceId String 资源ID。 resource20723343 AppId String AI应用id。 1 AppName String 应用名。 人脸识别 AlgorithmType String 算法类型。 吸烟检测 AnalysisType String 分析类型。 AI100 ConfigCheckArea String 配置检查区域。 false TotalDeviceCount String 设备总路数。 100 RemainDeviceCount String 设备剩余路数。 100 Status String 是否启动算法。 1 CreateTime String 创建时间。 20221125 16:03:04 ExpireTime String 失效时间。 20241201 10:55:04

接口功能介绍 查询RDS实例列表 接口约束 无 URI GET /PG/v1/product/pagepaasproduct 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 pageNum 是 Integer 当前页 1 pageSize 是 Integer 页大小，范围11000 10 prodInstName 否 String 实例名称，支持模糊匹配 pgtests3 labelName 否 String 标签名称（一级标签） test labelValue 否 String 标签值（二级标签） test prodInstId 否 String 实例id 169528973574900007 instanceType 否 String 实例类型，primary:主实例，readonly:只读实例，不传则查询全部实例 primary obtainStatus 否 Boolean 是否实时获取实例状态，true：实例状态，false：非实时获取 false 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ProjectId 否 String 企业项目id，若不传入则查询默认的企业项目，默认的企业项目id为0 0 regionId 是 String 资源池id bb9fdb42056f11eda1610242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 状态码 800 message String 消息提示 SUCCESS error String 错误码 returnObj Object 实例节点规格信息列表 PageInfo 表 PageInfo 参数 参数类型 说明 示例 下级对象 pageNum Integer 当前页 1 pageSize Integer 页大小 10 total Integer 总记录数 1 pageTotal Integer 总页数 1 list Array of Objects 实例列表 PagePaasProductVO 表 PagePaasProductVO 参数 参数类型 说明 示例 下级对象 createTime String 创建时间 20230921 17:49:52 prodDbEngine String 数据库实例引擎 prodInstId String 实例id 169528973574900007 prodInstName String 实例名称 testpg1 prodRunningStatus Integer 实例当前的运行状态 0:运行中 1:重启中 2:备份中 3:恢复中 1001:已停止 1006:恢复失败 1007:VIP不可用 1008:GATEWAY不可用 1009:主库不可用 1010:备库不可用 1021:实例维护中 2000:开通中 2002:已退订 2005:扩容中 2011:冻结 0 alive Integer 实例是否存活,0:存活，1：异常 0 prodOrderStatus Integer 订单状态，0：正常，1：冻结，2：删除，3：操作中，4：失败,2005:扩容中 0 prodType Integer 实例部署方式 0：单机部署,1：主备部署 1 readPort Integer 读端口 9304 vip String 虚拟ip地址 writePort String 写端口 9304 readonlyInstnaceIds Array of Strings 只读实例id列表 [] instanceType String 实例类型，primary:主实例，readonly:只读实例 primary toolType Integer 备份工具类型，1：pgbaseback，2：pgbackrest，3：s3 1

快速交付 提供软硬一体化交付方案，预置大模型、混合云管平台及高性能基础设施，支持全流程自动化部署，最快仅需2天即可完成环境搭建。 全栈管理 打造全栈式管理平台，涵盖计算、存储、网络及大模型资源的一站式管理功能，支持大模型的纳管调用，助力用户快速构建专属问答助手。 安全可控 确保本地化部署，满足政务、医疗等行业"数据不出机房"的安全要求，同时通过严格的权限隔离机制，全面保障信息安全。 极简运维 多维度监控、告警数据，帮助用户提前发现业务运行隐患；属地化运维和724小时在线服务，全方位解决客户后顾之忧。

本章节主要介绍如何创建自定义拓扑集群。 MRS当前提供的“分析集群”、“流式集群”和“混合集群”采用固定模板进行部署集群的进程，无法满足用户自定义部署管理角色和控制角色在集群节点中的需求。如需自定义集群部署方式，可在创建集群时的“集群类型”选择“自定义”，实现用户自主定义集群的进程实例在集群节点中的部署方式。仅MRS 3.x及之后版本支持创建自定义拓扑集群。 自定义集群可实现以下功能： 管控分离部署，管理角色和控制角色分别部署在不同的Master节点中。 管控合设部署，管理角色和控制角色共同部署在Master节点中。 ZooKeeper单独节点部署，增加可靠性。 组件分开部署，避免资源争抢。 MRS集群中角色类型： 管理角色：Management Node(MN)，安装Manager，即MRS集群的管理系统，提供统一的访问入口。Manager对部署在集群中的节点及服务进行集中管理。 控制角色：Control Node(CN)，控制监控数据角色执行存储数据、接收数据、发送进程状态及完成控制节点的公共功能。 MRS的控制节点包括HMaster、HiveServer、ResourceManager、NameNode、JournalNode、SlapdServer等。 数据角色：Data Node(DN)，执行管理角色发出的指示，上报任务状态、存储数据，以及执行数据节点的公共功能。MRS的数据节点包括DataNode、RegionServer、NodeManager等。 创建自定义集群 1.登录MRS管理控制台。 2.单击“创建集群”，进入“创建集群”页面。 3.在创建集群页面，选择“自定义创建”页签。 4.参考下列参数说明配置集群软件信息，参数详细信息请参考创建自定义集群章节中的MRS集群软件配置表。 区域：默认即可。 集群名称：可以设置为系统默认名称，但为了区分和记忆，建议带上项目拼音缩写或者日期等。例如：“mrs20180321”。 集群版本：目前仅MRS 3.x版本支持。 集群类型：选择“自定义”并根据需要勾选对应组件。 5.单击“下一步”，并配置硬件信息。 可用区：默认即可。 虚拟私有云：默认即可。如果没有虚拟私有云，请单击“查看虚拟私有云”进入虚拟私有云，创建一个新的虚拟私有云。 子网：默认即可。 安全组：选择“自动创建”。 弹性公网IP：选择“暂不绑定”。 CPU架构：默认即可。MRS 3.x版本无该参数。 常用模板：具体说明请参见下方“自定义集群模板说明”。 实例规格：单击配置实例规格、系统盘和数据盘存储类型和存储空间。 实例数量：请根据业务量调整集群实例数量。具体可参考下方“MRS自定义集群节点部署方案”。 拓扑调整：若常用模板中的部署方式不满足需求或者需要手动安装部分默认安装不部署的实例或者需要手动安装部分实例时，请设置“拓扑调整”为“开启”，然后根据业务需要调整实例部署方式，具体说明请参见下方“自定义集群拓扑调整说明”。 6.单击“下一步”进入高级配置页签。 参数说明请参见创建自定义集群章节中的“高级配置（可选）”。 7.单击“立即创建”。 当集群开启Kerberos认证时，需要确认是否需要开启Kerberos认证，若确认开启请单击“继续”，若无需开启Kerberos认证请单击“返回”关闭Kerberos认证后再创建集群。 8.单击“返回集群列表”，可以查看到集群创建的状态。 集群创建需要时间，所创集群的初始状态为“启动中”，创建成功后状态更新为“运行中”，请您耐心等待。

本文介绍存储资源盘活系统的软件许可证订购操作。 软件许可证订购途径 1. 天翼云官网：在存储资源盘活系统产品详情页点击“订购软件”，进入订购存储资源盘活系统页面，进行订购。本节仅介绍此种订购方式。 2. 中国电信数字化原子能力平台：请在平台帮助指引下进行操作。 前提条件 您已经成功安装存储资源盘活系统，执行命令./stor info，获取HBlock序列号，用于进行软件许可证的申请。 注意 生成的软件许可证仅能用于该序列号对应的HBlock系统，不能在其他环境中使用。 操作步骤 1. 在存储资源盘活系统产品详情页点击“订购软件”，进入订购存储资源盘活系统页面，进行订购。 2. 在“订购存储资源盘活系统”页面中，选择许可证类型，输入序列号，设置容量和订购时长等信息。 订购参数 描述 许可证类型 许可证类型： 订阅模式：控制产品提供的本地卷的存储容量以及有效时长，按照容量和时长收费，到期后管理功能不可用，即无法再使用命令行、API或者Web页面执行HBlock的管理操作。 永久模式：控制产品提供的本地卷的存储容量以及维保时间，按照容量和维保收费，到期后软件可以正常使用，但是不再提供售后支持。 具体详见计费模式。 HBlock序列号 用于生成软件许可证的HBlock环境信息。 说明 请确保已完成HBlock安装，执行./stor info命令可查询HBlock序列号。生成的软件许可证仅能用于该序列号对应的HBlock系统，不能在其他环境中使用。 HBlock名称 HBlock环境的描述信息。 容量设置 控制软件许可证可以支持的所有本地卷的总的存储容量。 说明 支持通过“自定义容量”和“容量包”叠加的方式进行设置。最后按照“总容量”进行软件许可证的生成。 有效时长 仅针对订阅模式。到期后管理功能不可用，即无法再使用命令行、API或者Web页面执行HBlock的管理操作。 维保时长 仅针对永久模式。到期后软件可以正常使用，但是不再提供售后支持。 3. 确认无误后勾选“我已阅读，理解并同意《天翼云存储资源盘活系统服务协议》”，再单击“立即购买”，完成支付，等待天翼云工作人员和您联系，确认许可证的信息，并进行许可证的交付。

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 description String 失败时的错误描述，适配中英文 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 alarmRuleIDList Array of Strings 告警规则ID ['83bd75379e065a45a3b5f4b13a7e81ea'] 枚举参数 无 请求示例 请求url /v4/monitor/createeventalarmrule 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "name": "ctyunrule", "desc": "描述", "resources": [ { "resource": [ { "name": "uuid", "value": "7dd744ea5a0261d3e62738f82f5fd3e1" }, { "name": "instancename", "value": "ecmaf97" } ] } ], "conditions": [ { "eventName": "migrationeventstart", "value": "15", "period": "1h" } ] }

接口功能介绍 查询用户实例个数 接口约束 无 URI GET /v1/getInstanceCount 路径参数 无 Query参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 否 String 资源池编码 d8bbd132b53a11e9b0e40242ac110002 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 ContentType 是 String 类型 application/json regionId 是 String 资源池编码 bb9fdb42056f11eda1610242ac110002 请求体body参数 无 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应码 0 message String 返回信息 returnObj Integer 实例个数 4 error String 错误信息 枚举参数 无 请求示例 请求url GET 请求头header json { "ContentType":"application/json" } 请求体body json 无 响应示例 json { "statusCode":0, "message":"", "returnObj":4 } 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 删除密钥别名 接口约束 请保证账户余额大于0 URI POST /v1/keyName/deleteAlias 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 aliasName 是 String 密钥别名 ECS 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 返回码 取值范围：200 成功 200 error String 错误码 KMS0514 message String 调用结果信息 用戶删除别名成功 returnObj Object 接口返回结果 null 枚举参数 无 请求示例 请求url 无 请求头header { "regionId": "200000001852" } 请求体body { "aliasName": "tdesdtali1adddddadcccdsasdas" } 响应示例 { "statusCode": "200", "message": "刪除别名成功" } 状态码 请参考 状态码 错误码 请参考 错误码

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 taskID String 数据导出任务ID TASKtacd8b6b4610b97d202306301808 枚举参数 无 请求示例 请求url /v4/monitor/taskcenter/createtask 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "task": { "name": "数据导出任务A", "description": "用于导出云主机7月份历史数据", "service": "ecs", "dimension": "ecs", "dimensions":[ { "name":"uuid", "value":[ "000f03221f4d8cc8bb2e1c30fb751aa5" ] } ], "itemNameList": ["cpuutil","memutil"], "aggregateType": ["avg"], "startTime": 1692812541, "endTime": 1692842541, "period": 3600, "reportTemplate": 0 } }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回参数，参考returnObj对象结构 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 taskID String 数据导出任务ID TASKtacd8b6b4610b97d202306301808 枚举参数 无 请求示例 请求url /v4/monitor/taskcenter/createtask 请求头header 无 请求体body { "regionID": "81f7728662dd11ec810800155d307d5b", "task": { "name": "数据导出任务A", "description": "用于导出云主机7月份历史数据", "service": "ecs", "dimension": "ecs", "dimensions":[ { "name":"uuid", "value":[ "000f03221f4d8cc8bb2e1c30fb751aa5" ] } ], "itemNameList": ["cpuutil","memutil"], "aggregateType": ["avg"], "startTime": 1692812541, "endTime": 1692842541, "period": 3600, "reportTemplate": 0 } }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数，参考returnObj对象结构 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 templateID String 告警模板ID 312b56b43e4311ed8ef2005056898fe0 请求示例 POST /v4/monitor/createalramtemplate 请求体body json { "content":{ "name":"xsZSu", "ser":"ecs", "dim":"ecs", "desc":"test", "rules":[ { "metric":"cpuutil", "fun":"avg", "value":"100", "operator":"eq", "for":120, "period":"5m", "level":3 }, { "metric":"cpuutil", "fun":"avg", "value":"70", "operator":"eq", "for":120, "period":"5m", "level":2 } ] } } 响应示例 json { "statusCode":800, "returnObj":{ "templateID":"312b56b43e4311ed8ef2005056898fe0" }, "errorCode":"", "message":"Success", "msgDesc":"成功" } 状态码 状态码 描述 200 请求成功

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数，参考returnObj对象结构 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 templateID String 告警模板ID 312b56b43e4311ed8ef2005056898fe0 请求示例 POST /v4/monitor/updatealramtemplate 请求体body json { "templateID":"312b56b43e4311ed8ef2005056898fe0", "content":{ "name":"xsZSu", "ser":"ecs", "dim":"ecs", "desc":"test", "rules":[ { "metric":"cpuutil", "fun":"avg", "value":"100", "operator":"eq", "for":120, "period":"5m", "level":3 }, { "metric":"cpuutil", "fun":"avg", "value":"60", "operator":"eq", "for":120, "period":"5m", "level":1 } ] } } 响应示例 json { "statusCode":800, "returnObj":{ "templateID":"312b56b43e4311ed8ef2005056898fe0" }, "errorCode":"", "message":"Success", "msgDesc":"成功" }

接口功能介绍 调用此接口可查看探测节点的配置详情。 接口约束 资源池ID，探测节点名称不能为空。 URI GET /v4/monitor/describeprobepoint 请求参数 Query参数 参数 参数类型 是否必填 示例 说明 下级对象 regionID String 是 81f7728662dd11ec810800155d307d5b 资源池ID name String 是 NeiMeng 探测节点名称 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 mongoID String 数据库ID 635a4a3869bdc841ab0495dd ID String 探测节点唯一ID 1 name String 探测节点名称 NeiMeng hermesRegion String region名称 neimengaz03 position String 探测节点区域 内蒙 status Boolean 探测节点是否可用 true

接口功能介绍 调用此接口可修改告警联系人配置。 接口约束 告警联系人ID存在，告警联系人名称不可重复，可包含字母、中文、数字，230个字符。 URI POST /v4/monitor/updatecontacts 请求参数 请求体body参数 参数 参数类型 是否必填 示例 说明 下级对象 contactID String 是 a6fb570f22995bde989cdf0819c687d0 告警联系人ID name String 是 moCEN 用户名 phone String 否 13309310049 手机号 email String 否 123323@qq.com 邮箱 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 returnObj Object 返回参数 returnObj 表returnObj 参数 参数类型 说明 示例 下级对象 contactID String 告警联系人ID a6fb570f22995bde989cdf0819c687d0

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 alarmBlacklistID String 告警黑名单ID "46d7bc837ac45238a9342076d0b9f9f0" 请求示例 请求url /v4/monitor/createalarmblacklist 请求头header 无 请求体body json { "name": "测试黑名单725", "desc": "testdesc", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "devices": ["xxxaadasd", "asdasdasgfasd"], "metrics": ["cpuutil", "memutil"], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": ["234bee0616f65b0aadb8c0903d480a58"] } 响应示例 json { "statusCode": 800, "returnObj": { "alarmBlacklistID": "5a592d2f48695667a088b9d54336c166" }, "errorCode": "", "message": "Success", "msgDesc":"成功" }

响应参数 参数 参数类型 说明 示例 下级对象 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 请求示例 请求url /v4/monitor/updatealarmblacklist 请求头header 无 请求体body json { "blacklistID": "46d7bc837ac45238a9342076d0b9f9f0", "name": "测试黑名单725", "desc": "testdesc", "regionID": "81f7728662dd11ec810800155d307d5b", "service": "ecs", "dimension": "ecs", "devices": ["xxxaadasd", "asdasdasgfasd"], "metrics": ["cpuutil", "memutil"], "startTime": 1687337384, "endTime": 1687338884, "contactGroupList": ["234bee0616f65b0aadb8c0903d480a58"] } 响应示例 json { "statusCode": 800, "returnObj": { "success":true }, "errorCode": "", "message": "Success", "msgDesc":"成功" }

响应参数 参数 参数类型 说明 示例 下级对象 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/monitorboard/updateview 请求头header 无 请求体body json { "regionID": "1234567890", "viewID": "58631437d4897105d9ac9bc044d7b6ab", "view": { "name": "视图1", "service": "ecs", "dimension": "ecs", "viewType": "timeSeries", "itemNameList": [ "cpuutil" ], "compares": [ ], "resources": [ { "resource": [ { "key": "uuid", "value": "3280eb61b0c434135bb2a2b0d79a6870" } ] } ] } } 响应示例 json { "statusCode": 800, "returnObj": { "success": true }, "errorCode": "", "message": "Success", "msgDesc": "成功", "description": "成功" }

响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 返回状态码（800为成功，900为失败），默认值：800 800 errorCode String 失败时的错误代码，参见公共错误码说明 message String 失败时的错误描述，一般为英文描述 Success msgDesc String 失败时的错误描述，一般为中文描述 成功 error String 错误码，请求成功时，不返回该字段 Openapi.Parameter.Error returnObj Object 返回对象 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 alarmRuleID String 告警规则ID '83bd75379e065a45a3b5f4b13a7e81ea' 请求示例 请求url /v4/monitor/createcustomeventalarmrule 请求头header 无 请求体body json { "regionID": "81f7728662dd11ec810800155d307d5b", "name": "自定义告警规则测试", "desc": "test", "repeatTimes": 0, "silenceTime": 300, "recoverNotify": 0, "notifyType": ["email"], "contactGroupList": ["000f03221f4d8cc8bb2e1c30fb751ccc"], "notifyWeekdays": [0, 1, 2, 3, 4, 5, 6], "notifyStart": "00:00:00", "notifyEnd": "23:59:59", "webhookUrl": [" "customEventID": "Event63cb8954325480a320230707180", "value": "3", "period": "5m" }

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

接口功能介绍 删除标签接口 接口约束 无 URI POST /v1/lebalControl/deleteLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "labelId" : "123123", "key": "123", "value":"123" } 响应示例 plaintext { "statusCode": 200, "message": "删除标签成功", "returnObj": null } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 修改标签接口 接口约束 无 URI POST /v1/lebalControl/updateLebal 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 labelId 是 String 标签标识 123123 key 是 String key值 123 value 是 String value值 123 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "labelId": "123123", "key": "123", "value":"123" } 响应示例 plaintext { "statusCode": 200, "message": "标签修改成功", "returnObj": null } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 删除一个应用接入点 接口约束 无 URI POST /v1/applicationAccessPointManage/deleteApplicationAccessPoint 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 应用接入点id 8c9107b652304f3384338a4c2a568454 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "applicationId": "8c9107b652304f3384338a4c2a568454" } 响应示例 plaintext { "statusCode": 200, "message": "删除vpce成功" } 状态码 请参考状态码章节 错误码 请参考错误码章节

接口功能介绍 关闭接入点的权限控制 接口约束 无 URI POST /v1/applicationAccessPointManage/closePolicyCheck 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 regionId 是 String 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 applicationId 是 String 接入点id b2160c2c9c704ca9b8080d186c97280d 响应参数 参数 参数类型 说明 示例 下级对象 statusCode String 状态码 取值范围：200 成功 200 message String 提示信息 Success returnObj Object 返回数据结构体 {} result error String 错误码 仅错误时返回 格式为{服务编码}.{错误编号} KMS.0269 请求示例 请求url plaintext 请求头header plaintext { "regionid": "fecnjniakfkn2314ndekqldedcsadfg" } 请求体body plaintext { "applicationId": "b2160c2c9c704ca9b8080d186c97280d" } 响应示例 plaintext { "statusCode": 200, "message": "关闭接入点权限控制成功", } 状态码 请参考状态码章节 错误码 请参考错误码章节

当函数计算运行您的函数时，会将上下文对象传递到执行方法中。该对象包含有关调用、服务、函数和执行环境等信息。 上下文对象context主要包括如下字段： 字段 类型 说明 requestid String 函数请求ID。 credentials Credentials结构，包含以下字段： accesskeyid accesskeysecret securitytoken 临时密钥信息。 function FunctionMeta结构，包含以下字段： name handler memory timeout 当前函数的基本信息。 service ServiceMeta结构，包含以下字段： logproject logstore qualifier versionid 当前函数的服务信息。 region String 当前函数的所在地域ID。 accountid String 日志对象。 事件请求函数上下文 当函数计算运行您的函数时，会将上下文相关信息传递到执行方法中的第二个参数context中，通过如下示例查看上下文相关信息： coding: utf8 import logging def handler(event, context): logger logging.getLogger() logger.info(f"Request id: {context.requestid}") return context.headersMap HTTP请求函数上下文 当函数计算运行您的函数时，会将上下文相关信息传递到执行方法中的第一个参数environ中，通过如下示例查看上下文相关信息： coding: utf8 def handler(environ, startresponse): ret "" for key, value in environ.items(): ret ret + f"key: {key}, value:{value} n" status '200 OK' responseheaders [('Contenttype', 'text/plain')] startresponse(status, responseheaders) return [ret]

通过本接口向云点播查询转码任务进行状态。 接口功能介绍 用户可在点播模式下通过本接口向云点播查询转码任务。 接口约束 本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。 URI POST /task/search 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 status 否 String 任务状态，分别为 WORKING（工作中）、DONE（完成）、WARNING（执行结束）、FAIL（失败）。 DONE createTime 否 Object 用户的创建时间。 createTime pageSize 是 Integer 必填参数，每页的数量，由于任务数量多，请必须传入该参数，该参数最大数值为1000。 pageIndex 是 Integer 必填参数，页码，由0开始。 表 createTime 参数 是否必填 参数类型 说明 示例 下级对象 from 否 String 用户的创建时间，格式为 yyyyMMdd HH:mm:ss。 20190515 03:15:30 to 否 String 用户的创建时间，格式为 yyyyMMdd HH:mm:ss。 20190515 03:15:31 响应参数 返回值为一个 JsonArray，即使结果仅有一条也一样。 参数 是否必填 参数类型 说明 示例 下级对象 code 是 Integer 本次请求的结果码 0 message 是 String 错误文本信息，创建成功时，为空字符串。 "" data 是 Array of Objects 返回数据 data 表 data 参数 是否必填 参数类型 说明 示例 下级对象 taskId 是 String 任务id 0001

接口介绍 通过接口故障切换完，检查后发现当前时间点应用运行正常，根据用户输入的保护组ID，云主机ID，进行确认故障切换 接口约束 1、云主机存在保护组中 2、云容灾保护组存在 URI POST /v4/disaster/confirmfailoverdisaster 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 regionID 是 String 资源池ID 参考请求示例 pairID 是 String 保护组ID 参考请求示例 ecsID 是 String 云主机ID 参考请求示例 响应参数 参数 是否必填 参数类型 说明 示例 下级对象 :: statusCode 是 Integer 返回状态码(800为成功，900为失败) 参考响应示例 message 是 String 成功或失败时的描述，一般为英文描述 参考响应示例 description 是 String 成功或失败时的描述，一般为中文描述 参考响应示例 returnObj 否 Object 成功时返回对象 returnObj 表 errorCode 否 String 业务细分码，为product.module.code三段式码 参考状态码 error 否 String 业务细分码，为product.module.code三段式大驼峰码 参考状态码 表 returnObj 参数 是否必填 参数类型 说明 示例 下级对象 status 是 String 确认故障切换成功 参考响应示例 msg 是 String 确认故障切换成功描述 参考响应示例

接口功能介绍 取消密钥删除保护 接口约束 请保证账户余额大于0 URI POST /cmkManage/cancelDeleteProtect 路径参数 无 Query参数 无 请求参数 请求头header参数 参数 是否必填 参数类型 说明 示例 下级对象 hmac 是 String kms鉴权值 B1uAGreROOnfuQkNp9I5bE4aXsGwBcL5daW3W0nL0Mw requestDate 是 String 时间戳 Wed, 29 Aug 2023 17:05:01 CST accessKey 是 String ctapi鉴权ak ae2cc5cc5e8211ea978a186590d96509 userId 是 String 用户id 562b89493b1a40e1b97ea05e50dd8170 regionId 是 Integer 资源池id fecnjniakfkn2314ndekqldedcsadfg 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 cmkUuid 是 String 密钥id 474e569e8814474a948bdbcf6d853eff 响应参数 参数 参数类型 说明 示例 下级对象 code String 返回码 取值范围：200 成功 200 errorCode String 错误码 KMS.0514 msg String 调用结果信息 取消密钥删除保护成功 data Object 接口返回结果 null

您可通过配置通知策略，自定义告警事件的匹配条件。当触发相应匹配条件时，系统将按照预设的通知方式向指定对象推送告警信息，提醒其及时开展问题排查与处理工作。 前提条件 已创建通知对象，具体操作，请参见【告警通知对象】。 新建通知策略 1. 登录【应用性能监控控制台】，在左侧导航栏选择告警管理 > 通知策略。 2. 在通知策略 页面左上角单击创建通知策略。 3. 点击“高级设置”（如只需要设置通知对象与通知时段，可无需点击高级设置）。 4. 在新建通知策略页面顶部设置通知策略名称。 5. 在匹配规则区域设置告警事件的匹配规则，点击添加规则，然后进行以下设置： 注意 静默策略优先于通知策略，即已被静默策略匹配到的告警事件将会被静默，无法再进行通知策略的事件匹配。创建静默策略的操作，请参见【静默策略】。 1. 选择数据来源。 指定来源：通知策略会针对指定来源（集成）的告警事件进行匹配规则过滤并发送通知。 无预设来源：通知策略会针对所有告警事件进行匹配规则过滤并发送通知。 2. 设置匹配规则表达式，您可以自定义标签或选择已有的标签。 已有的标签包括： 告警规则表达式指标中携带的标签。 系统自带的默认标签，默认标签说明如下。 分类 标签 说明 常用字段 alertname 告警规则名称 常用字段 carmsobjid 告警对象ID 常用字段 carmsobjtype 告警对象类型 常用字段 carmsobjname 告警对象名称 常用字段 alertGroup 告警规则的group属性 系统预置字段 ctyunarmsregioncode 资源池编码 系统预置字段 ctyunarmsregionname 资源池名称 系统预置字段 ctyunarmstenantcode 租户编码 系统预置字段 ctyunarmstenantname 租户名称 系统预置字段 ctyunarmsalertlevel 告警等级： 1一般 2次要 3重要 4紧急 系统预置字段 ctyunarmsalertruleid 告警规则ID，在告警规则页面选择通知策略后，在对应通知策略中会新增一条匹配规则ctyunarmsalertruleid告警规则ID 系统预置字段 ctyunarmsnotifystrategyid 告警通知策略ID 系统预置字段 ctyunarmsintegrationname 集成名称，ARMS默认上报的告警集成名称为ARMSDEFAULT。 系统预置字段 ctyunarmsalertrulefrequency 告警通知频率 说明 如果需同时满足多个匹配规则才告警，则单击添加条件 编辑第二条匹配规则条件。 如果需满足任意一个匹配告警事件规则就告警，则单击添加规则 编辑第二条匹配规则。 在配置通知策略并设置匹配规则时，需注意所有关联规则的描述内容总和不可超过 64KB，大约100条匹配规则（具体数量与实际规则的复杂度相关），如超过限制则会配置失败，此时为确保配置顺利完成，请重新创建一条通知策略关联更多的匹配规则。 若将通知策略中的匹配规则删除（ctyunarmsalertruleid告警规则ID），告警规则详情中关联的通知策略虽仍可看到，但无法发出通知。 3. 单击下一步。 6. 在事件分组 区域，设置告警事件是否需要分组，然后单击下一步。 不需要分组：所有告警事件会以一条告警信息发送给处理人。 设置分组字段：选择指定字段，该字段内容相同的告警事件会汇总到同一告警发送通知，减少联系人需要处理的告警。 7. 在通知对象区域，设置以下参数。 1. 单击+添加通知对象 选择通知对象。 通知对象类型如下： 联系人：选择具体联系人后还需选择使用电话、短信或邮件的通知方式。 联系人组：选择具体联系人组后还需选择使用电话、短信或邮件的通知方式。 排班：选择具体排班后还需选择使用电话、短信或邮件的通知方式。 钉钉/飞书/企微：通过钉钉、飞书或企业微信发送告警通知。 通用Webhook：通过Webhook发送告警通知。 2. 选择告警恢复后是否发送恢复通知。 发送恢复通知：当告警下面全部事件都恢复时，告警状态是否自动恢复为已解决。当告警恢复时，系统将会发送通知给告警处理人。 3. 如选择邮件或短信方式，可设置邮件与短信通知模板。 4. 设置通知时段，告警会在设置的通知时段内发送告警通知。 5. 单击下一步。 8. 在重复/升级/恢复策略 区域设置告警是否需要重复通知或使用升级策略，然后单击下一步。 告警是否需要重复通知： 如果选择不需要重复通知，告警未恢复状态下只发送一次。 如果需要重复通知，设置重复频率。当告警未恢复或未认领时，告警会以设置的重复频率循环发送告警信息直至告警恢复。 告警是否配置升级策略：选择升级策略后，告警未恢复状态下，告警通知将会根据升级策略发送通知给其他通知对象。 9. 在行动集成 区域可以设置告警触发或恢复后自动执行的行动。具体可参考【行动集成】。 10. 设置完成后，单击提交。

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

本节主要介绍DN管理概述 DN管理提供数据节点管理服务，管理DRDS实例关联的RDS for MySQL实例或者GaussDB(for MySQL)实例，展现实例的状态、存储、规格、读权重等信息，提供设置读权重、增加只读实例的快捷操作。 “设置读权重”主要用于批量设置读权重，可同时设置列表中多个数据节点的权重，注意如果数据节点未挂载只读实例，该主实例无法设置权重。 “同步DN信息”用于数据节点数量比较多的场景下，可以先设置第一个数据节点的读权重，点击“同步DN信息”后，会把第一个数据节点的设置同步到其他只读实例数量相同的数据节点上，如果只读实例数量不同，请手动设置。

STS即Secure Token Service 是一种安全凭证服务，可以使用STS来完成对于临时用户的访问授权。对于跨用户短期访问对象存储资源时，可以使用STS服务。这样就不需要透露主账号AK/SK，只需要生成一个短期访问凭证给需要的用户使用即可，避免主账号AK/SK泄露带来的安全风险。 初始化STS服务 cpp Aws::String ak " "; Aws::String sk " "; Aws::String endPoint " "; ​ Aws::Auth::AWSCredentials cred(ak, sk); Aws::Client::ClientConfiguration cfg; cfg.endpointOverride endPoint; cfg.scheme Aws::Http::Scheme::HTTP; cfg.verifySSL false; stsclient new Aws::STS::STSClient(cred, cfg); 获取临时token cpp const Aws::String roleArn "arn:aws:iam:::role/xxxxxx"; const Aws::String roleSessionName " "; const Aws::String bucketname " "; const Aws::String policy "{"Version":"20121017"," ""Statement":" "{"Effect":"Allow"," ""Action":["s3:"]," // 允许进行 S3 的所有操作。如果仅需要上传，这里可以设置为 PutObject ""Resource":["arn:aws:s3:::" + bucketname + "","arn:aws:s3:::" + bucketname + "/"]"// 允许操作默认桶中的所有文件，可以修改此处来保证操作的文件 "}}"; Aws::STS::Model::AssumeRoleRequest request; request.SetPolicy(policy); request.SetRoleArn(roleArn); request.SetRoleSessionName(roleSessionName); std::cout AssumeRole(request); if (outcome.IsSuccess()) { auto& cred outcome.GetResult().GetCredentials(); std::cout << "ak:" << cred.GetAccessKeyId() << std::endl; std::cout << "sk:" << cred.GetSecretAccessKey() << std::endl; std::cout << "token:" << cred.GetSessionToken() << std::endl; return true; } else { auto err outcome.GetError(); std::cout << "Error: AssumeRole: " << err.GetExceptionName() << ", " << err.GetMessage() << std::endl; return false; }

STS即Secure Token Service 是一种安全凭证服务，可以使用STS来完成对于临时用户的访问授权。对于跨用户短期访问对象存储资源时，可以使用STS服务。这样就不需要透露主账号AK/SK，只需要生成一个短期访问凭证给需要的用户使用即可，避免主账号AK/SK泄露带来的安全风险。 初始化STS服务 php require '/path/to/autoload.php'; use AwsStsStsClient; use AwsExceptionAwsException; use AwsCredentialsCredentials; ​ const endpoint ' '; // e.g. or const accesskey ' '; const secretkey ' '; ​ $credentials new Credentials(accesskey, secretkey); ​ $this>stsClient new StsClient([ 'region' > 'ctyun', // region固定填ctyun 'version' > '20110615', // sts接口版本号，固定填20110615 'credentials' > $credentials, 'endpoint' > endpoint, ]); 获取临时token php public function AssumeRole() { $bucket ' '; $arn ' '; ​ $roleSessionName ' '; $roleArn "arn:aws:iam:::role/$arn"; $policy "{"Version":"20121017","Statement":{"Effect":"Allow","Action":["s3:"],"Resource":["arn:aws:s3:::$bucket","arn:aws:s3:::$bucket/"]}}"; ​ try { $res $this>stsClient>assumeRole([ 'Policy' > $policy, 'RoleArn' > $roleArn, 'RoleSessionName' > $roleSessionName, ]); vardump($res>get('Credentials')); } catch (AwsStsExceptionStsException $e) { echo "Exception: $e"; } } 参数说明： 参数 类型 描述 是否必要 RoleArn String 角色的ARN，在控制台创建角色后可以查看 是 Policy String 角色的policy，需要是json格式，限制长度1~2048 是 RoleSessionName String 角色会话名称，此字段为用户自定义，限制长度2~64 是 DurationSeconds Integer 会话有效期时间，默认为3600s 否