华为云用户手册

响应参数 状态码：200 表1 响应Body参数 参数 参数类型 描述 region_id String 参数解释： 区域ID。 取值范围： 不涉及。 available_zones Array of available_zones objects 参数解释： 可用区数组。 表2 available_zones 参数 参数类型 描述 soldOut Boolean 参数解释： 是否售罄。 取值范围： true：售罄。 false：未售罄。 id String 参数解释： 可用区ID。 取值范围： 不涉及。 code String 参数解释： 可用区编码。 取值范围： 不涉及。 name String 参数解释： 可用区名称。 取值范围： 不涉及。 port String 参数解释： 可用区端口号。 取值范围： 不涉及。 resource_availability String 参数解释： 分区上是否还有可用资源。 取值范围： 不涉及。 default_az Boolean 参数解释： 是否为默认可用区。 取值范围： true：默认可用区 false：不是默认可用区 remain_time Long 参数解释： 剩余时间。 取值范围： 不涉及。 ipv6_enable Boolean 参数解释： 是否支持IPv6。 取值范围： true：支持 false：不支持

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of Message objects 消息。 表4 Message 参数 参数类型 描述 msg_id String 消息ID。 instance_id String 实例ID。 topic String 主题名称。 store_timestamp Number 存储消息的时间。 born_timestamp Number 产生消息的时间。 reconsume_times Integer 重试次数。 body String 消息体。 body_crc Number 消息体校验和。 store_size Number 存储大小。 property_list Array of property_list objects 消息属性列表。 born_host String 产生消息的主机IP。 store_host String 存储消息的主机IP。 queue_id Integer 队列ID。 queue_offset Integer 在队列中的偏移量。 表5 property_list 参数 参数类型 描述 name String 属性名称。 value String 属性值。

请求示例 导出主题中指定消息ID和Key的死信消息。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/messages/export { "topic" : "%DLQ%group1", "msg_id_list" : [ "C0A8011700002774000000000013B19D", "C0A8011700002774000000000013B30F" ], "uniq_key_list" : [ "7F000001001C18B4AAC26B8AED170010", "7F000001001C18B4AAC26B8AEE030015" ] }

响应示例 状态码：200 导出死信消息成功。 { "topic" : "topic_01", "body" : "Hello world", "property_list" : { "name" : "ORIGIN_MESSAGE_ID", "value" : "C0A8005B00002775000000000000EBAE" }, "msg_id" : "C0A8005B0000277500000000000133A2", "instance_id" : "56055acb-3c3b-4481-aeab-10464086c2b4", "store_timestamp" : 1662690563020, "born_timestamp" : 1662690324415, "reconsume_times" : 5, "body_crc" : 198614610, "store_size" : 317, "born_host" : "10.58.233.224:63529", "store_host" : "192.168.0.91:10101", "queue_id" : 0, "queue_offset" : 0 }

URI DELETE /v2/{engine}/{project_id}/instances/{instance_id}/groups/{group} 表1 路径参数 参数 是否必选 参数类型 描述 engine 是 String 引擎。 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 group 是 String 消费组ID。

请求示例 创建一个非管理员的用户，授予发布、订阅topic1和group1的权限。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/users { "access_key" : "user_name", "secret_key" : "**************", "white_remote_address" : "", "admin" : false, "default_topic_perm" : "DENY", "default_group_perm" : "DENY", "topic_perms" : [ { "name" : "topic1", "perm" : "PUB|SUB" } ], "group_perms" : [ { "name" : "group1", "perm" : "PUB|SUB" } ] }

响应示例 状态码：200 创建成功。 { "access_key" : "test_01", "admin" : false, "default_group_perm" : "DENY", "default_topic_perm" : "SUB", "group_perms" : [ ], "secret_key" : "**************", "topic_perms" : [ ], "white_remote_address" : "" }

URI POST /v2/{project_id}/instances/{instance_id}/users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 项目ID，获取方式请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。获取方法如下：登录RocketMQ控制台，在RocketMQ实例详情页面查找实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求参数 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否 String 主题名称，只能由英文字母、数字、百分号、竖线、中划线、下划线组成，长度3~64个字符。 brokers 否 Array of strings 关联的代理（仅RocketMQ实例4.8.0版本需要填写此参数）。 queue_num 否 Number 队列数，范围1~50。 queues 否 Array of queues objects 队列（仅RocketMQ实例4.8.0版本需要填写此参数）。 permission 否 String 权限（仅RocketMQ实例4.8.0版本需要填写此参数）。 取值范围： pub（发布） sub（订阅） all（发布+订阅） message_type 否 String 消息类型（仅RocketMQ实例5.x版本需要填写此参数）。 取值范围： NORMAL（普通消息） FIFO（顺序消息） DELAY（定时消息） TRANSACTION（事务消息） topics 否 Array of strings 主题列表，当批量删除主题时使用。 表4 queues 参数 是否必选 参数类型 描述 broker 否 String 关联的代理。 queue_num 否 Number 队列数，范围1~50。

请求示例 4.8.0版本RocketMQ实例创建一个主题，关联的代理为broker-0，队列数为3。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics { "name" : "topic-test", "brokers" : [ "broker-0" ], "permission" : "all", "queues" : [ { "broker" : "broker-0", "queue_num" : 3 } ] } 5.x版本RocketMQ实例创建一个主题，消息类型为普通。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/topics { "name" : "topic-test", "message_type" : "NORMAL" }

URI POST /v2/{project_id}/instances/{instance_id}/topics 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 action 否 String 批量删除Topic时使用，不配置则为创建接口。删除操作：delete。

URI POST /v2/{project_id}/instances/{instance_id}/metadata 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 overwrite 是 String true开启同名覆盖，会对已有的同名元数据的配置进行修改，false时当Topic或group已存在则会报错。 name 是 String 迁移任务名称，名称规则参考创建实例。 type 是 String 迁移任务类型，分为自建RocketMQ上云(rocketmq)、自建RabbitMQ上云(rabbitToRocket)

请求示例 创建元数据迁移任务，迁移其他厂商或自建RocketMQ实例的元数据到云上RocketMQ实例。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/metadata?overwrite=true&name=task-123&type=rocketmq { "topicConfigTable" : { "topic-test1" : { "order" : false, "perm" : 6, "readQueueNums" : 3, "topicFilterType" : "SINGLE_TAG", "topicName" : "topic-test1", "topicSysFlag" : 0, "writeQueueNums" : 3 } }, "subscriptionGroupTable" : { "group-test1" : { "consumeBroadcastEnable" : true, "consumeEnable" : true, "consumeFromMinEnable" : true, "groupName" : "group-test1", "notifyConsumerIdsChangedEnable" : true, "retryMaxTimes" : 2, "retryQueueNums" : 1, "whichBrokerWhenConsumeSlow" : 1 } } } 创建元数据迁移任务，迁移RabbitMQ的元数据到云上RocketMQ实例。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/metadata?overwrite=true&name=task-123&type=rabbitToRocket { "vhosts" : [ { "name" : "DeleteVhost123" } ], "queues" : [ { "name" : "test-001", "vhost" : "/", "durable" : false } ], "exchanges" : [ { "name" : "direct", "vhost" : "/", "type" : "topic", "durable" : false } ], "bindings" : [ { "source" : "direct", "vhost" : "/", "destination" : "test-001", "destination_type" : "queue", "routing_key" : "test-001" } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 name String 实例名称。 由英文字符开头，只能由英文字母、数字、中划线、下划线组成，长度为4~64的字符。 description String 实例的描述信息。 长度不超过1024的字符串。 说明： \与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\或者"。 engine String 消息引擎。取值填写为：reliability。 engine_version String 消息引擎的版本。取值填写为：4.8.0。 storage_space Integer 存储空间。 vpc_id String 虚拟私有云ID。 获取方法如下：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 subnet_id String 子网信息。 获取方法如下：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 security_group_id String 指定实例所属的安全组。 获取方法如下：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 available_zones Array of strings 创建节点到指定且有资源的可用区ID。请参考查询可用区信息获取可用区ID。 该参数不能为空数组或者数组的值为空， 请注意查看该可用区是否有资源。 创建RocketMQ实例，支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时，用逗号分隔开。 product_id String RocketMQ实例规格。 c6.4u8g.cluster.small：单个代理最大Topic数2000，单个代理最大消费组数2000 c6.4u8g.cluster：单个代理最大Topic数4000，单个代理最大消费组数4000 c6.8u16g.cluster：单个代理最大Topic数8000，单个代理最大消费组数8000 c6.12u24g.cluster：单个代理最大Topic数12000，单个代理最大消费组数12000 c6.16u32g.cluster：单个代理最大Topic数16000，单个代理最大消费组数16000 ssl_enable Boolean 是否打开SSL加密访问。 true：打开SSL加密访问。 false：不打开SSL加密访问。 storage_spec_code String 存储IO规格。 dms.physical.storage.high.v2: 高IO类型磁盘 dms.physical.storage.ultra.v2: 超高IO类型磁盘 enterprise_project_id String 企业项目ID。若为企业项目账号，该参数必填。 enable_acl Boolean 是否开启访问控制列表。 ipv6_enable Boolean 是否支持IPv6。 true：支持 false：不支持 enable_publicip Boolean 是否开启公网访问功能。默认不开启公网。 true：开启 false：不开启 publicip_id String 实例绑定的弹性IP地址的ID。 以英文逗号隔开多个弹性IP地址的ID。 如果开启了公网访问功能（即enable_publicip为true），该字段为必选。 broker_num Integer 代理个数。 bss_param BssParam object 表示包周期计费模式的相关参数。 如果为空，则默认计费模式为按需计费；否则是包周期方式。 表3 BssParam 参数 参数类型 描述 is_auto_renew Boolean 是否自动续订。 取值范围： true: 自动续订。 false: 不自动续订。 默认不自动续订。 charging_mode String 计费模式。 功能说明：付费方式。 取值范围： prePaid：预付费，即包年包月； postPaid：后付费，即按需付费； 默认为postPaid。 is_auto_pay Boolean 下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。 取值范围： true：是（自动支付） false：否（需要客户手动支付） 默认为手动支付。 period_type String 订购周期类型。 取值范围： month：月 year：年 chargingMode为prePaid时生效且为必选值。 period_num Integer 订购周期数。 取值范围： periodType=month（周期类型为月）时，取值为[1，9]； periodType=year（周期类型为年）时，取值为[1，3]； chargingMode为prePaid时生效且为必选值。

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称。 由英文字符开头，只能由英文字母、数字、中划线、下划线组成，长度为4~64的字符。 description 否 String 实例的描述信息。 长度不超过1024的字符串。 说明： \与"在json报文中属于特殊字符，如果参数值中需要显示\或者"字符，请在字符前增加转义字符\，比如\或者"。 engine 是 String 消息引擎。取值填写为：reliability。 engine_version 是 String 消息引擎的版本。取值填写为：4.8.0。 storage_space 是 Integer 存储空间。 vpc_id 是 String 虚拟私有云ID。 获取方法如下：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 subnet_id 是 String 子网信息。 获取方法如下：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 security_group_id 是 String 指定实例所属的安全组。 获取方法如下：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 available_zones 是 Array of strings 创建节点到指定且有资源的可用区ID。请参考查询可用区信息获取可用区ID。 该参数不能为空数组或者数组的值为空， 请注意查看该可用区是否有资源。 创建RocketMQ实例，支持节点部署在1个或3个及3个以上的可用区。在为节点指定可用区时，用逗号分隔开。 product_id 是 String RocketMQ实例规格。 c6.4u8g.cluster.small：单个代理最大Topic数2000，单个代理最大消费组数2000 c6.4u8g.cluster：单个代理最大Topic数4000，单个代理最大消费组数4000 c6.8u16g.cluster：单个代理最大Topic数8000，单个代理最大消费组数8000 c6.12u24g.cluster：单个代理最大Topic数12000，单个代理最大消费组数12000 c6.16u32g.cluster：单个代理最大Topic数16000，单个代理最大消费组数16000 ssl_enable 否 Boolean 是否打开SSL加密访问。 true：打开SSL加密访问。 false：不打开SSL加密访问。 storage_spec_code 是 String 存储IO规格。 dms.physical.storage.high.v2: 高IO类型磁盘 dms.physical.storage.ultra.v2: 超高IO类型磁盘 enterprise_project_id 否 String 企业项目ID。若为企业项目账号，该参数必填。 enable_acl 否 Boolean 是否开启访问控制列表。 ipv6_enable 否 Boolean 是否支持IPv6。 true：支持 false：不支持 enable_publicip 否 Boolean 是否开启公网访问功能。默认不开启公网。 true：开启 false：不开启 publicip_id 否 String 实例绑定的弹性IP地址的ID。 以英文逗号隔开多个弹性IP地址的ID。 如果开启了公网访问功能（即enable_publicip为true），该字段为必选。 broker_num 是 Integer 代理个数。 bss_param 否 BssParam object 表示包周期计费模式的相关参数。 如果为空，则默认计费模式为按需计费；否则是包周期方式。 表3 BssParam 参数 是否必选 参数类型 描述 is_auto_renew 否 Boolean 是否自动续订。 取值范围： true: 自动续订。 false: 不自动续订。 默认不自动续订。 charging_mode 否 String 计费模式。 功能说明：付费方式。 取值范围： prePaid：预付费，即包年包月； postPaid：后付费，即按需付费； 默认为postPaid。 is_auto_pay 否 Boolean 下单订购后，是否自动从客户的账户中支付，而不需要客户手动去进行支付。 取值范围： true：是（自动支付） false：否（需要客户手动支付） 默认为手动支付。 period_type 否 String 订购周期类型。 取值范围： month：月 year：年 chargingMode为prePaid时生效且为必选值。 period_num 否 Integer 订购周期数。 取值范围： periodType=month（周期类型为月）时，取值为[1，9]； periodType=year（周期类型为年）时，取值为[1，3]； chargingMode为prePaid时生效且为必选值。

请求示例 创建一个RocketMQ实例，规格为4U8G*1，600GB的存储空间，按需付费。 POST https://{endpoint}/v2/reliability/{project_id}/instances { "name" : "reliability-1751840557", "description" : "", "engine" : "reliability", "engine_version" : "4.8.0", "storage_space" : 600, "vpc_id" : "3db8490c-4d6d-4d8f-8d3f-047b0de4c5cf", "subnet_id" : "0a0f1fcb-f019-458d-b9e5-301867394d50", "security_group_id" : "23c5977f-ff33-4b95-a73e-08d8a0bc4e6c", "available_zones" : [ "9f1c5806706d4c1fb0eb72f0a9b18c77" ], "product_id" : "c6.4u8g.cluster", "enterprise_project_id" : "0", "ssl_enable" : false, "storage_spec_code" : "dms.physical.storage.ultra.v2", "ipv6_enable" : false, "enable_publicip" : false, "publicip_id" : "", "broker_num" : 1 }

请求参数 表3 请求Body参数 参数 是否必选 参数类型 描述 groups 否 Array of strings 待删除的消费组列表。 name 否 String 消费组名称，只能由英文字母、数字、百分号、竖线、中划线、下划线组成，长度3~64个字符。 brokers 否 Array of strings 关联的代理列表（仅RocketMQ实例4.8.0版本需要填写此参数）。 broadcast 否 Boolean 是否广播。 retry_max_time 否 Integer 最大重试次数，取值范围为1~16。 enabled 否 Boolean 是否可以消费。 consume_orderly 否 Boolean 是否按顺序消费（仅RocketMQ实例5.x版本需要填写此参数）。 group_desc 否 String 消费组描述，长度0~200个字符。

请求示例 4.8.0版本RocketMQ实例创建一个消费组，不允许以广播模式消费，关联代理为broker-0，最大重试次数为16。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups { "name" : "consumer-group-test", "group_desc" : "group_description", "brokers" : [ "broker-0" ], "broadcast" : false, "retry_max_time" : 16 } 5.x版本RocketMQ实例创建一个消费组，不允许以广播模式消费，不按顺序消费，最大重试次数为16。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups { "name" : "consumer-group-test", "group_desc" : "group_description", "consume_orderly" : false, "broadcast" : false, "retry_max_time" : 16 } 删除消费组consumer-group-test。 POST https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups?action=delete { "groups" : [ "consumer-group-test" ] }

URI POST /v2/{project_id}/instances/{instance_id}/groups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 action 否 String 批量删除消费组时使用，不配置则为创建接口。删除操作：delete。

请求示例 批量修改消费组的参数，将consumer-group-test消费组的最大重试次数修改为16。 PUT https://{endpoint}/v2/{project_id}/instances/{instance_id}/groups { "groups" : [ { "name" : "consumer-group-test", "enabled" : true, "broadcast" : false, "consume_orderly" : false, "retry_max_time" : 16 } ] }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 groups 否 Array of BatchUpdateConsumerGroup objects 消费组列表。 表3 BatchUpdateConsumerGroup 参数 是否必选 参数类型 描述 name 否 String 消费组名称，只能由英文字母、数字、百分号、竖线、中划线、下划线组成，长度3~64个字符。 broadcast 否 Boolean 是否广播。 retry_max_time 否 Integer 最大重试次数，取值范围为1~16。 enabled 否 Boolean 是否可以消费。 consume_orderly 否 Boolean 是否按顺序消费（仅RocketMQ实例5.x版本需要填写此参数）。 group_desc 否 String 消费组描述，长度0~200个字符。

请求示例 批量删除RocketMQ实例。 POST https://{endpoint}/v2/{project_id}/instances/action { "action" : "delete", "instances" : [ "54602a9d-5e22-4239-9123-77e350df4a34", "7166cdea-dbad-4d79-9610-7163e6f8b640" ] } 删除所有创建失败的RocketMQ实例。 POST https://{endpoint}/v2/{project_id}/instances/action { "action" : "delete", "all_failure" : "reliability" }

请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 action 否 String 操作标识（仅支持小写）： create（创建） delete（删除） tags 否 Array of TagEntity objects 标签列表。 表3 TagEntity 参数 是否必选 参数类型 描述 key 否 String 标签键。 不能为空。 对于同一个实例，Key值唯一。 长度为1~128个字符（中文也可以输入128个字符）。 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @ 首尾字符不能为空格。 value 否 String 标签值。 长度为0~255个字符（中文也可以输入255个字符）。 由任意语种字母、数字、空格和字符组成，字符仅支持_ . : = + - @ 首尾字符不能为空格。

请求示例 创建两个实例标签，标签名为key1、key2，值为value1、value2。 POST https://{endpoint}/v2/{project_id}/rocketmq/{instance_id}/tags/action { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }

请求示例 { "relation_type" : "DEFAULT", "relation_ids" : [ "al123232232341232132" ], "mask_id" : "nm1689737291469aj38xNVLK", "mask_name" : "mn_test", "mask_status" : "MASK_EFFECTIVE", "resource_id" : "dse23xw43", "namespace" : "SYS.E CS ", "dimensions" : [ { "name" : "instance_id", "value" : "4270ff17-aba3-4138-89fa-820594c39755" } ] }

URI POST /v2/{project_id}/notification-masks/batch-query 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页偏移量 最小值：0 最大值：10000 缺省值：0 正则匹配：^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$ limit 否 Integer 分页大小 最小值：1 最大值：100 缺省值：100 正则匹配：^([1-9]|[1-9][0-9]|100)$ sort_key 否 String 排序关键字，与sort_dir同时使用。 目前只支持create_time与update_time create_time表示按创建时间排序，update_time表示按修改时间排序 枚举值： create_time update_time sort_dir 否 String 排序顺序，与sort_key同时使用。DESC表示降序排序；ASC表示升序排序； 枚举值： ASC DESC

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384 表4 请求Body参数 参数 是否必选 参数类型 描述 relation_type 是 String 关联类型。ALARM_RULE：关联告警规则，RESOURCE：关联资源，RESOURCE_POLICY_NOTIFICATION：关联资源策略屏蔽告警通知，RESOURCE_POLICY_ALARM：关联资源策略不计算告警，DEFAULT：默认包含RESOURCE、RESOURCE_POLICY_NOTIFICATION（查询告警屏蔽列表时使用）。 枚举值： ALARM_RULE RESOURCE RESOURCE_POLICY_NOTIFICATION RESOURCE_POLICY_ALARM DEFAULT relation_ids 是 Array of strings 关联编号（目前是告警规则ID） 数组长度：1 - 100 metric_name 否 String 资源的监控指标名称，必须以字母开头，只能包含0-9/a-z/A-Z/_，字符长度最短为1，最大为64；如：弹性云服务器中的监控指标cpu_util，表示弹性服务器的CPU使用率；文档数据库中的指标mongo001_command_ps，表示command执行频率；各服务的指标名称可查看：“服务指标名称”。 resource_level 否 String dimension: 子维度,product: 云产品 枚举值： dimension product mask_id 否 String 屏蔽规则ID,可选 最小长度：1 最大长度：64 正则匹配：^nm([0-9A-Za-z]){0,62}$ mask_name 否 String 屏蔽规则名称,可选，只能为字母、数字、汉字、-、_，最大长度为64 最小长度：1 最大长度：64 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ mask_status 否 String 屏蔽状态,可选。MASK_EFFECTIVE：已生效，MASK_INEFFECTIVE：未生效。 最小长度：1 最大长度：32 枚举值： MASK_EFFECTIVE MASK_INEFFECTIVE resource_id 否 String 资源维度值,提供一个维度的资源ID即可,可选 最小长度：1 最大长度：700 namespace 否 String 查询服务的命名空间，各服务命名空间请参考“服务命名空间” dimensions 否 Array of ResourceDimension objects 资源的维度信息 数组长度：1 - 4 表5 ResourceDimension 参数 是否必选 参数类型 描述 name 是 String 资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务指标维度”。 正则匹配：^([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_|-){1,32}$ value 是 String 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。 正则匹配：^((([a-z]|[A-Z]|[0-9]){1}([a-z]|[A-Z]|[0-9]|_|-|\.)*)|\*){1,256}$

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384

URI GET /v2/{project_id}/alarms/{alarm_id}/policies 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户ID 最小长度：1 最大长度：64 正则匹配：^[a-zA-Z0-9-]{1,64}$ alarm_id 是 String 告警规则ID 正则匹配：^al([0-9A-Za-z]){22}$ 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页偏移量 最小值：0 最大值：10000 缺省值：0 正则匹配：^([0]|[1-9]|[1-9][0-9]|[1-9][0-9][0-9]|[1-9][0-9][0-9][0-9]|10000)$ limit 否 Integer 分页大小 最小值：1 最大值：100 缺省值：10 正则匹配：^([1-9]|[1-9][0-9]|100)$

响应参数 状态码：400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：404 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码：500 表10 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256