# Alibaba Cloud ApsaraMQ for RocketMQ 5.0 API

> Alibaba Cloud ApsaraMQ for RocketMQ 5.0 API on Apizie: 94 endpoints (Adds a backup mapping task, Modifies the resource group of an instance, 创建 Agent 诊断会话, Creates a consumer group (ConsumerGroup) for ApsaraMQ for RocketMQ. A consumer group is a load balancing…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-rocketmq`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/rocketmq
- Page: https://zieapi.vercel.app/api/cloud/aliyun-rocketmq
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-rocketmq/openapi.json

Alibaba Cloud OpenAPI for ApsaraMQ for RocketMQ 5.0 (rocketmq, version 2022-08-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a backup mapping task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/add-disaster-recovery-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The ID of the backup plan |
| topics | array | no | The topics included in the backup mapping. Required |

### Modifies the resource group of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| resourceId | string | yes | The resource ID, which is the ID of the ApsaraMQ for RocketMQ instance. This parameter specifies the MSMQ queue instance whose resource… |
| regionId | string | yes | The region ID of the instance |
| resourceType | string | yes | The resource type. Set the value to instance, which indicates that the resource is an instance |
| resourceGroupId | string | yes | The ID of the resource group to which you want to transfer the specified instance. You can call the ListResourceGroups… |

### 创建 Agent 诊断会话
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-agent-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| clientToken | string | yes | 请求幂等令牌；24 小时内相同 token 和参数返回首次结果；同 token 不同参数返回冲突；重试复用，新操作换新 token |
| initialMessage | object | no | 可选首条消息；传入后创建会话并立即启动首轮诊断 |
| title | string | no | 会话标题 |

### Creates a consumer group (ConsumerGroup) for ApsaraMQ for RocketMQ. A consumer group is a load balancing…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID of the instance to which the consumer group to be created belongs |
| consumerGroupId | string | yes | The ID of the consumer group to be created. Used as the identity of the consumer group, which is globally unique. Valid values: Character… |
| consumeRetryPolicy | object | yes | The consumption retry policy of the consumer group to be created. For more information, see… |
| deliveryOrderType | string | yes | The delivery order type of the consumer group to be created. Valid parameter values: Concurrently: concurrent delivery Orderly: ordered… |
| exclusive | string | no | Specifies whether to enable exclusive subscription, which means a LiteTopic can only be subscribed to by one consumer. Set to true to… |
| maxReceiveTps | integer | no | The maximum TPS for consuming messages |
| messageModel | string | no | The subscribe pattern for consumers: CLUSTERING: clustering consumption pattern. All consumers in the ConsumerGroup share the same… |
| remark | string | no | The remarks for the consumer group to be created |
| topicName | string | no | The name of the lite-type topic to subscribe to when using the LITE_SELECTIVE consumption pattern |

### Creates a backup plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-disaster-recovery-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| autoSyncCheckpoint | string | no | Specifies whether to enable automatic consumer automatic synchronization. This parameter takes effect only when consumer automatic… |
| instances | array | no | The instances involved in the backup plan. This parameter is required |
| planDesc | string | no | The description of the plan |
| planName | string | no | The name of the plan. This parameter is required |
| planType | string | no | The type of the backup plan. This parameter is required. For more information, see https://help.aliyun.com/document_detail/2843187.html.… |
| syncCheckpointEnabled | string | no | Specifies whether to enable consumer offset synchronization |

### Creates an ApsaraMQ for RocketMQ 5.x series instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request. The client generates the value of this parameter, which must be… |
| aclInfo | object | no | The access control information |
| autoRenew | string | no | Specifies whether to enable auto-renewal. This parameter takes effect only when the billing method of the instance is set to Subscription |
| autoRenewPeriod | integer | no | The Unified Auto Renewal Cycle. This parameter takes effect only when auto-renewal is enabled. Unit: months. Valid values: Monthly… |
| commodityCode | string | no | The commodity code. - ons_rmqsub_public_cn: subscription instance. - ons_rmqpost_public_cn: pay-as-you-go instance. -… |
| instanceName | string | no | The name of the instance to be created. If you do not specify this parameter, the instance ID is used as the instance name |
| networkInfo | object | yes | The network configuration information |
| paymentType | string | yes | The billing method of the instance. ApsaraMQ for RocketMQ supports subscription and pay-as-you-go billing methods. For more information,… |
| period | integer | no | The subscription duration. This parameter takes effect only when the billing method of the instance is set to Subscription. Valid values:… |
| periodUnit | string | no | The minimum epoch unit of the subscription duration |
| productInfo | object | no | The instance specification information |
| remark | string | no | The remarks of the instance |
| resourceGroupId | string | no | The resource group ID |
| seriesCode | string | yes | The primary series encoding of the instance. For more information about the differences between primary series, see… |
| serviceCode | string | yes | The service encoding of the instance. The service encoding for MSMQ for RocketMQ is rmq |
| subSeriesCode | string | yes | The sub-series encoding of the instance. For more information about the differences between sub-series, see… |
| tags | array | no | The list of resource tags |

### Creates an access account for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-instance-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| password | string | yes | The account password |
| remark | string | no | The remark |
| username | string | yes | The account name |

### Creates access permissions for a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-instance-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| username | string | yes | The username |
| actions | array | yes | The type of the authorized operation. Valid operations vary by resource type: Topic: Pub, Sub, and Pub/Sub Consumer group: Sub |
| decision | string | yes | The authorization decision |
| ipWhitelists | array | no | The IP address whitelist |
| resourceName | string | yes | The name of the authorized resource |
| resourceType | string | yes | The type of the authorized resource |

### 创建实例巡检配置
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-instance-inspection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| instanceId | string | yes | 所属实例 ID；不允许通配符 |
| clientToken | string | yes | 幂等令牌；1～64 位字母、数字、短横线或下划线；重试必须内容一致 |
| items | array | yes | 逐项独立配置；1～20 项，templateCode 不重复，整数组替换 |
| resourceScope | object | yes | 实例内资源范围；All 或 Selected |
| schedule | object | yes | 统一定时配置 |

### Creates an IP address whitelist for access control
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-instance-ip-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| ipWhitelists | array | yes | The list of IP address whitelists |

### Creates a topic for ApsaraMQ for RocketMQ. A topic is the top-level container for message transmission and…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/create-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to which the topic to be created belongs |
| topicName | string | yes | The name of the topic to be created. The name is used to identify the topic and is globally unique. Naming conventions: Character limit:… |
| liteTopicExpiration | integer | no | The expiration time of the lite topic, in minutes. Valid values: 30 to 720. Default value: -1, which indicates the topic never expires |
| maxSendTps | integer | no | The maximum transactions per second (TPS) for sending messages |
| messageType | string | yes | The message type of the topic to be created. The type of the topic must be the same as the type of messages sent to the topic. For… |
| remark | string | no | The remarks of the topic to be created |

### 删除 Agent 诊断会话
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-agent-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |

### Deletes a specified consumer group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to which the consumer group to be deleted belongs |
| consumerGroupId | string | yes | The ID of the consumer group to be deleted |

### Deletes the subscription of a consumer group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-consumer-group-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| consumerGroupId | string | yes | The ID of the consumer group to be deleted |
| topicName | string | yes | The topic name |
| filterType | string | yes | The type of the filter expression. Valid values: SQL: SQL filtering TAG: tag filtering |
| filterExpression | string | yes | The filter expression |

### Deletes a backup mapping task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-disaster-recovery-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The ID of the backup plan |
| itemId | string | yes | The ID of the mapping task |

### Deletes a backup plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-disaster-recovery-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The ID of the backup plan |

### Releases an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the ApsaraMQ for RocketMQ instance that you want to delete |

### Deletes the access account information for a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-instance-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| username | string | yes | The username |

### Deletes the permissions of a specified account for a specified resource in a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-instance-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| username | string | yes | The username |
| resourceType | string | yes | The type of the authorized resource |
| resourceName | string | yes | The name of the authorized resource |

### 关闭实例巡检配置
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-instance-inspection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| instanceId | string | yes | 所属实例 ID；不允许通配符 |

### Deletes a specified global IP whitelist under a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-instance-ip-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| ipWhitelist | string | no | The IP whitelist |
| ipWhitelists | string | no | The list of IP whitelists (JSON-encoded) |

### Deletes a specified topic
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/delete-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to which the topic to be deleted belongs |
| topicName | string | yes | The name of the topic to be deleted |

### Performs a specified operation on a specified migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/execute-migration-operation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| migrationId | string | yes | The migration ID |
| instanceId | string | no | The instance ID |
| stageType | string | yes | The migration stage type |
| operationId | string | yes | The migration operation ID |
| operationParam | object | no | The operation parameter |

### Completes the current migration stage for a specified migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/finish-migration-stage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| migrationId | string | yes | The migration ID |
| instanceId | string | no | The instance ID |
| stageType | string | yes | The type of the migration stage. The value MIGRATE_MESSAGE indicates message migration |

### 查询 Agent 诊断会话详情
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-agent-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |

### 订阅 Agent 诊断会话事件
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-agent-conversation-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |
| after | integer | no | 仅返回该游标之后的事件 |

### 查询 Agent 诊断会话时间线
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-agent-conversation-timeline` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |
| after | integer | no | 仅返回该游标之后的时间线条目 |
| includeImageData | string | no | 是否返回图片 Base64，默认 false；仅在受控场景显式设为 true |

### Queries the time range in which a consumer offset can be reset for a topic
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-consume-timespan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| consumerGroupId | string | yes | The ID of the consumer group |
| topicName | string | yes | The name of the topic to which the consumer group subscribes |

### Retrieves the details of a specified consumer group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to which the consumer group to query belongs |
| consumerGroupId | string | yes | The ID of the consumer group to query |

### Queries the message accumulation of a consumer group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-consumer-group-lag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| consumerGroupId | string | yes | The consumer group ID |
| topicName | string | no | The name of the topic to which the consumer group subscribes |
| liteTopicName | string | no | The name of the lite topic |

### Queries the subscriptions of a consumer group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-consumer-group-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| consumerGroupId | string | yes | The ID of the consumer group whose subscriptions you want to query |
| topicName | string | yes | The name of the topic to which the consumer group subscribes |

### Queries the stack information about a consumer
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-consumer-stack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| consumerGroupId | string | yes | The consumer Group ID |
| clientId | string | yes | The client ID |

### Queries the details of a backup plan mapping
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-disaster-recovery-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The ID of the backup plan |
| itemId | string | yes | The ID of the mapping task |

### Queries the details of a backup plan
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-disaster-recovery-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The backup plan ID |

### Retrieves the details of a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to query |

### Retrieves the account details for a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-instance-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| username | string | no | The username. If you do not specify this parameter, the system returns details of the default account |

### Queries information about the access control list (ACL) of an instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-instance-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| username | string | yes | The username |
| resourceType | string | yes | The type of the resource on which you want to grant permissions. Valid values: Group Topic |
| resourceName | string | yes | The name of the resource on which you want to grant permissions |

### 查询实例巡检配置
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-instance-inspection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| instanceId | string | yes | 所属实例 ID；不允许通配符 |

### 查询实例风险诊断报告
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-instance-inspection-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| reportId | string | yes | 独立风险诊断报告 ID |

### 查询实例巡检结果
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-instance-inspection-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| instanceId | string | yes | 所属实例 ID；不允许通配符 |
| runId | string | yes | 实例巡检执行 ID |

### Queries the information about the IP address whitelist of an instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-instance-ip-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| ipWhitelists | string | no | The filter IP address whitelists (JSON-encoded) |

### Retrieves the details of a specified message
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-message-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| topicName | string | yes | The topic name |
| messageId | string | yes | The message ID |

### Retrieves the details of a specified topic
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to which the topic to query belongs |
| topicName | string | yes | The name of the topic to query |

### Retrieves the message trace for a specified message in a specified topic
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/get-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to query |
| topicName | string | yes | The name of the topic to query |
| messageId | string | yes | The message ID |
| startTime | string | no | The start time, in YYYY-MM-DD HH:mm:ss format |
| endTime | string | no | The end time, in YYYY-MM-DD HH:mm:ss format |

### 查询 Agent 诊断会话列表
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-agent-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| maxResults | integer | no | 单页数量，最大 100 |
| nextToken | string | no | 翻页游标 |
| q | string | no | 标题搜索关键字 |
| purpose | string | no | 会话用途，诊断对话使用 chat |

### Queries supported zones
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-available-zones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |

### Retrieves the connection information for clients in a specified consumer group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-consumer-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| consumerGroupId | string | yes | The consumer group ID |
| topicName | string | no | The name of the lite topic |
| liteTopicName | string | no | The name of the Lite MSMQ topic |

### Lists the subscription relationships for a consumer group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-consumer-group-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the ApsaraMQ for RocketMQ instance |
| consumerGroupId | string | yes | The ID of the consumer group whose subscription relationships you want to query |
| topicName | string | no | The name of the topic. If you do not specify this parameter, all subscription relationships are queried |

### Queries the list of consumer groups under a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-consumer-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance for which you want to query the consumer group list |
| filter | string | no | The filter condition for the query. If you do not specify this parameter, all consumer groups under the specified instance are queried |
| pageNumber | integer | no | The paging page number. Specifies which page of results to return |
| pageSize | integer | no | The paging size. The maximum number of results to return per page. Valid values: [10,100] |

### Queries the list of consumer offset synchronization checkpoints
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-disaster-recovery-checkpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The ID of the backup plan |
| itemId | string | yes | The ID of the backup mapping |
| instanceId | string | yes | The instance ID of the source instance |
| filter | string | no | The filter condition |
| pageNumber | integer | no | The current page number, starting from 1 |
| pageSize | integer | no | The page size. The maximum number of results to return per page |

### Queries the list of backup mapping tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-disaster-recovery-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The ID of the backup plan |
| topicName | string | no | The topic name |
| filter | string | no | The filter condition. Filters by topicName |
| pageNumber | integer | no | The page number of the results to return |
| pageSize | integer | no | The maximum number of results to return per page |

### Queries a list of backup plans
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-disaster-recovery-plans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | no | The instance ID |
| filter | string | no | The filter condition. Filters backup plans by backup name or backup description |
| pageNumber | integer | no | The page number of the page to return |
| pageSize | integer | no | The maximum number of entries to return on each page |

### 查询巡检模板列表
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-inspection-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| maxResults | integer | no | 单页数量，最大 100 |
| nextToken | string | no | 翻页游标 |

### Retrieves the access accounts for a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-instance-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the RocketMQ instance |
| pageNumber | integer | no | The page number. The first page is 1 |
| pageSize | integer | no | The number of entries to return on each page |
| username | string | no | The username of the account |
| accountType | string | no | The type of the account |
| accountStatus | string | no | The status of the account |

### Queries the access control lists (ACLs) of an instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-instance-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| pageNumber | integer | no | The page number. Pages start from page 1 |
| pageSize | integer | no | The number of entries per page |
| filter | string | no | The condition that you specify to filter the ACLs. If you do not specify this parameter, all ACLs are queried |

### 查询巡检项关联资源
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-instance-inspection-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| instanceId | string | yes | 所属实例 ID；不允许通配符 |
| templateCode | string | yes | 巡检项编码 |
| runId | string | no | 选填；指定后仅查询该次历史资源快照，快照未形成返回 409 |
| maxResults | integer | no | 单页数量；默认 20，范围 1～100 |
| nextToken | string | no | 上一页返回的游标；首次查询不传 |

### 查询实例巡检历史
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-instance-inspection-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| instanceId | string | yes | 所属实例 ID；不允许通配符 |
| templateCode | string | no | 巡检项编码 |
| startTime | string | no | 按执行请求时间筛选的起始时间，含边界；带时区 ISO 8601 |
| endTime | string | no | 按执行请求时间筛选的截止时间，含边界；须晚于 startTime；带时区 ISO 8601 |
| status | string | no | 实例任务执行状态筛选；Pending、Running、Succeeded、PartiallySucceeded、Failed |
| result | string | no | 巡检结论筛选；传 templateCode 时筛选该项结论，否则筛选实例报告结论 |
| reportStatus | string | no | 按实际报告生成状态筛选，先过滤再分页；NotRequired 无需生成，Pending 等待生成，Running 生成中，Succeeded 已生成，Failed 生成失败 |
| sortBy | string | no | 倒序排序字段；默认 requestedAt 按执行时间；reportFinishedAt 按报告完成时间且必须同时筛选 reportStatus=Succeeded；同时间按报告 ID 倒序 |
| maxResults | integer | no | 单页数量；默认 20，范围 1～100 |
| nextToken | string | no | 上一页返回的游标；首次查询不传；翻页须保持所有筛选条件一致 |

### 分页查询已配置的实例诊断；仅返回配置摘要
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-instance-inspections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| maxResults | integer | no | 单页数量；默认 20，范围 1～100 |
| nextToken | string | no | 上一页返回的游标；首次查询不传；翻页须保持所有筛选条件一致 |

### Queries the IP address whitelists of an instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-instance-ip-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| pageNumber | integer | no | The page number. Default value: 1 |
| pageSize | integer | no | The number of entries to return on each page |
| ipWhitelist | string | no | IP whitelist |

### Queries the list of all ApsaraMQ for RocketMQ instances in a specified region
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| filter | string | no | The filter condition for the query. If you do not specify this parameter, all instances are queried |
| pageNumber | integer | no | The paging number. Specifies the page of results to return. Valid values: 1 to 100000000. If you set this parameter to a value less than… |
| pageSize | integer | no | The paging size. The maximum number of results to return on each page. Valid values: 10 to 200. If you set this parameter to a value less… |
| resourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| tags | string | no | The list of resource labels that are used to filter instances |
| seriesCodes | string | no | The primary series encoding of the instance. Valid values: standard: Standard Edition. ultimate: Platinum Edition. professional:… |
| storageSecretKey | string | no | The storage encryption key |

### Queries a list of messages
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-messages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| topicName | string | yes | The topic name |
| messageId | string | no | The message ID |
| messageKey | string | no | The message key |
| startTime | string | no | The start time of the query time range. Format: YYYY-MM-DD HH:mm:ss |
| endTime | string | no | The end time of the query time range. Format: YYYY-MM-DD HH:mm:ss |
| pageNumber | integer | no | The current page number, starting from 1 |
| pageSize | integer | no | The page size. The maximum number of results to return per page |
| scrollId | string | no | The scroll ID for the request. You do not need to specify this parameter for the first page request. For subsequent page requests, specify… |
| liteTopicName | string | no | The lite topic name |

### Query Monitoring Items List
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-metric-meta` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| pageNumber | integer | yes | Page number, indicating which page of the results to return |
| pageSize | integer | yes | Page size, indicating the maximum number of results per page |

### Queries the list of migration operations
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-migration-operations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| migrationId | string | yes | The migration ID |
| stageType | string | yes | The migration stage type |
| operationType | string | yes | The operation type |
| filter | string | no | The filter condition for the query. Supports filtering by operationKey, which is the topic name |
| instanceId | string | no | The instance ID |
| operationStatus | string | no | The operation status (JSON-encoded) |
| businessStatus | string | no | The operation business status (JSON-encoded) |
| pageNumber | integer | yes | The page number of the results to return |
| pageSize | integer | yes | The page size, which specifies the maximum number of results to return per page |

### Queries the list of migration tasks
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-migrations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| filter | string | no | The filter conditions for the query |
| migrationType | string | yes | The migration type. Valid values: INSTANCE_MIGRATION: instance migration |
| pageNumber | integer | yes | The page number of the page to return |
| pageSize | integer | yes | The number of entries to return on each page |
| resourceGroupId | string | no | The resource group ID |

### Queries the list of regions
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |

### Queries the tags that are added to resources
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | Region ID |
| resourceType | string | yes | Resource type |
| resourceId | string | no | List of resource IDs, in JSON format |
| tag | string | no | List of tags, in JSON format |
| nextToken | string | no | The position from which the next query starts |
| resourceGroupId | string | no | Resource group ID |

### Queries the subscriptions of a specific topic
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-topic-subscriptions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the ApsaraMQ for RocketMQ instance |
| topicName | string | yes | The name of the topic on the ApsaraMQ for RocketMQ instance |

### Queries the list of topics in a specified instance
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-topics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance whose topic list you want to retrieve |
| filter | string | no | The filter condition for the query. If not specified, all topics in the instance are returned |
| pageNumber | integer | no | The page number of the results to return |
| pageSize | integer | no | The maximum number of results to display per page |
| messageTypes | string | no | The message type of the topic (JSON-encoded) |

### Queries the list of message traces under a specified topic
`GET https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/list-traces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| topicName | string | yes | The topic name |
| startTime | string | yes | The start time in YYYY-MM-DD HH:mm:ss format |
| endTime | string | yes | The end time in YYYY-MM-DD HH:mm:ss format |
| pageNumber | integer | yes | The page number of the returned results |
| pageSize | integer | yes | The number of results to display per page |
| queryType | string | yes | The query type |
| messageId | string | no | The message ID. Required if queryType is set to MESSAGE_ID |
| messageKey | string | no | The message key. Required if queryType is set to MESSAGE_KEY |
| liteTopicName | string | no | The lightweight topic name |

### Resets the consumer offset of a consumer group. If you reset a consumer offset, the offset from which a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/reset-consume-offset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| consumerGroupId | string | yes | The consumer group ID |
| topicName | string | yes | The topic name |
| resetTime | string | no | The time when the consumer offset is reset |
| resetType | string | no | The method that is used to reset the consumer offset. Valid values: LATEST_OFFSET and SPECIFIED_TIME |

### 响应 Agent 诊断交互
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/respond-agent-conversation-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |
| actionId | string | yes | 交互 Action ID |
| answers | object | no | Agent 追问答案，键为问题文本 |
| decision | string | no | 工具审批决定，可选 allow 或 deny |
| note | string | no | 审批备注 |

### 立即执行实例巡检
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/run-instance-inspection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| instanceId | string | yes | 所属实例 ID；不允许通配符 |
| clientToken | string | yes | 幂等令牌；1～64 位字母、数字、短横线或下划线；重试必须内容一致 |
| itemOverrides | array | no | 按巡检项覆盖本次参数；未指定项仍执行并使用保存配置，禁止重复或未知项 |

### 发送 Agent 诊断消息
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/send-agent-conversation-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |
| attachments | array | no | 当前会话已上传的客户端日志，最多 5 个；先调用 UploadAgentConversationLog，原样传入返回的名称、路径和大小 |
| clientContext | string | no | 调用方补充上下文 |
| images | array | no | 随消息发送的图片，最多 2 张；单张原图建议不超过 2 MiB |
| message | string | yes | 用户诊断问题；message、images 和 attachments 至少提供一项 |
| messageType | string | no | 特殊消息类型：ticket_request 请求 Agent 起草工单；普通问题及草稿订正省略，工单由前端审阅后提交 |
| ticketRequestId | string | no | 提单请求唯一标识，与 messageType 成对传入，1 至 64 个字母、数字、下划线或连字符 |

### Starts a topic mapping of a Global Replicator task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/start-disaster-recovery-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | Backup plan ID |
| itemId | string | yes | Mapping task ID |

### 引导 Agent 诊断会话执行
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/steer-agent-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |
| commandId | string | yes | 幂等命令 ID |
| message | string | yes | 追加给 Agent 的引导信息 |

### 停止 Agent 诊断会话执行
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/stop-agent-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |

### Stops a topic mapping of a Global Replicator task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/stop-disaster-recovery-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | Backup plan ID |
| itemId | string | yes | Mapping task ID |

### Synchronize Disaster Recovery Plan Consumption Progress
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/sync-disaster-recovery-checkpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | Backup Plan ID |
| itemId | string | yes | Mapping ID |
| checkpointId | string | yes | Consumption Progress ID |

### Creates resource tags
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | The region ID |
| resourceType | string | yes | The type of resource. Set this parameter to instance. The value of this parameter cannot be changed |
| resourceId | string | yes | The resource IDs, in the JSON format |
| tag | string | yes | tag, in JSON format |

### Removes tags from resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | The region ID |
| resourceType | string | yes | The type of resource. Set this parameter to instance. The value of this parameter cannot be changed |
| resourceId | string | yes | The resource IDs, in the JSON format |
| tagKey | string | no | The keys of tags |
| all | string | no | Whether to delete all tags |

### 重命名 Agent 诊断会话
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-agent-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |
| clientToken | string | yes | 请求幂等令牌；24 小时内相同 token 和参数返回首次结果；同 token 不同参数返回冲突；重试复用，新操作换新 token |
| title | string | yes | 新的会话标题 |

### 更新 Agent 诊断会话分享范围
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-agent-conversation-share-scope` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 会话 ID |
| shareScope | string | yes | 分享范围，可选 private、tenant_viewer 或 tenant_editor |

### Updates the basic information and consumption retry policy of a consumer group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to which the consumer group to be updated belongs |
| consumerGroupId | string | yes | The ID of the consumer group to be updated |
| consumeRetryPolicy | object | yes | The updated consumption retry policy of the consumer group. For more information, see https://help.aliyun.com/document_detail/440356.html |
| deliveryOrderType | string | no | Modification is not supported |
| maxReceiveTps | integer | no | The upper limit of TPS for consuming messages |
| remark | string | no | The updated remarks of the consumer group |

### Updates a topic mapping in a global message backup plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-disaster-recovery-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The ID of the global message backup plan |
| itemId | string | yes | The ID of the topic mapping |
| topics | array | no | The topics involved in the topic mapping |

### Modifies a global message backup plan
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-disaster-recovery-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| planId | string | yes | The ID of the global message backup plan |
| autoSyncCheckpoint | string | no | Specifies whether to enable automatic consumer progress synchronization. This parameter takes effect only when you set… |
| instances | array | no | The instances involved in the Global Replicator task. After you create a Global Replicator task, you cannot change the instances involved… |
| planDesc | string | no | The description of the Global Replicator task |
| planName | string | no | The name of the Global Replicator task |
| planType | string | no | The type of the Global Replicator task. After you create a Global Replicator task, you cannot change the type of the task. Valid values:… |
| syncCheckpointEnabled | string | no | Specifies whether to enable consumer progress synchronization. Valid values: true false |

### Updates the basic information and specification configurations of an ApsaraMQ for RocketMQ instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance to be updated |
| aclInfo | object | no | The access control information |
| instanceName | string | no | The updated instance name |
| networkInfo | object | no | The updated network information of the instance |
| productInfo | object | no | The extension configurations of the instance |
| remark | string | no | The updated remarks for the instance |

### Updates the information of a specified account under a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-instance-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| username | string | yes | The username |
| accountStatus | string | no | The account status |
| password | string | no | The account password |
| remark | string | no | The remark |

### Updates the permissions on the resources of a specific instance for a specific user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-instance-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| username | string | yes | The username |
| actions | array | no | The following types of operations are supported based on the resource type: Topic: Pub, Sub, and Pub/Sub Group: Sub Valid values: Sub:… |
| decision | string | no | The decision result of the authorization. Valid values: Deny Allow |
| ipWhitelists | array | no | The IP addresses in the whitelist |
| resourceName | string | yes | The name of the resource on which you want to grant permissions |
| resourceType | string | yes | The type of the resource on which you want to grant permissions. Valid values: Group Topic |

### 修改实例巡检配置
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-instance-inspection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| regionId | string | yes | 地域 ID |
| instanceId | string | yes | 所属实例 ID；不允许通配符 |
| clientToken | string | yes | 同一实例配置生命周期内有效 24 小时；同 token 同请求返回首次成功结果，不同请求返回冲突。新请求仍须携带当前 revision |
| items | array | no | 逐项独立配置；1～20 项，templateCode 不重复，整数组替换 |
| resourceScope | object | no | 实例内资源范围；All 或 Selected |
| revision | integer | yes | 最近查询的配置版本；其余字段整字段替换，至少修改一项 |
| schedule | object | no | 统一定时配置 |

### Updates the remarks for a topic
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/update-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance that contains the topic |
| topicName | string | yes | The name of the topic |
| liteTopicExpiration | integer | no | The expiration time of a lite topic, in minutes. Valid values: 15 to 720. The default value is -1, which indicates that the topic never… |
| maxSendTps | integer | no | The maximum number of transactions per second (TPS) for sending messages |
| remark | string | no | The updated remarks for the topic |

### 上传 Agent 会话客户端日志
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/upload-agent-conversation-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| conversationId | string | yes | 已有会话 ID；须拥有该会话写权限 |
| contentGzipB64 | string | yes | UTF-8 日志经 gzip 压缩后的 Base64；解压内容最多 200 MiB，Base64 最多 5 MiB 字符 |
| fileName | string | yes | 客户端日志文件名，仅支持 log、txt、out 和滚动日志；ZIP 须在客户端解包并裁剪 |
| timeRangeEnd | string | no | 日志裁剪结束时间，ISO 8601 带时区 |
| timeRangeStart | string | no | 日志裁剪开始时间，ISO 8601 带时区 |

### Verifies the consumption status of a message in a specific topic on a specific instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/verify-consume-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The instance ID |
| topicName | string | yes | The topic name |
| messageId | string | yes | The message ID |
| consumerGroupId | string | yes | The ID of the consumer group |
| clientId | string | yes | The client ID |

### Tests whether messages can be sent to a specified topic in an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/verify-send-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |
| instanceId | string | yes | The ID of the instance |
| topicName | string | yes | The name of the topic |
| deliveryTimeStamp | integer | no | The delivery time for a delayed message, specified as a UNIX timestamp in milliseconds |
| liteTopicName | string | no | The name of the Lite Message Queue topic |
| message | string | no | The message content |
| messageGroup | string | no | The ID of the message group. This parameter applies only to ordered messages. Messages with the same group ID are consumed in the order… |
| messageKey | string | no | The business key |
| messageTag | string | no | The message tag |
| userProperties | object | no | The user-defined properties of the message |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://rocketmq.ap-southeast-1.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/add-disaster-recovery-item" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraMQ for RocketMQ 5.0 API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-rocketmq/add-disaster-recovery-item with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ApsaraMQ for RocketMQ 5.0 API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud ApsaraMQ for RocketMQ 5.0 itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ApsaraMQ for RocketMQ 5.0 API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-rocketmq.

### What is the status of the Alibaba Cloud ApsaraMQ for RocketMQ 5.0 API?
Needs your own provider key (bring your own key)