# Alibaba Cloud 金融分布式架构 SOFAStack API

> Alibaba Cloud 金融分布式架构 SOFAStack API on Apizie: 58 endpoints (Adds a property to a configuration item in a configuration file. You can push a property only after it is…, Adds resource metadata. A resource is similar to a file and can have multiple attributes, Creates a Group ID. The created Group ID is used to publish and subscribe to messages, Specifies the message type and topic name to create a topic, …) 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-sofa/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for 金融分布式架构 SOFAStack (sofa, version 2019-08-15). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a property to a configuration item in a configuration file. You can push a property only after it is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/add-ms-config-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AttributeName | string | yes | The property name |
| Desc | string | no | The property description |
| InstanceId | string | yes | The environment instance ID |
| ResourceId | integer | yes | The auto-increment ID of the resource to which the property belongs |

### Adds resource metadata. A resource is similar to a file and can have multiple attributes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/add-ms-config-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AppName | string | yes | The application name |
| Attributes | string | no | The attribute information of the resource, passed in as a JSON string |
| Desc | string | yes | The description of the resource |
| InstanceId | string | yes | The environment instance ID. This is a system field |
| Region | string | yes | The domain to which the resource type belongs |
| ResourceId | string | yes | The resource ID, similar to the file name of a configuration file |

### Creates a Group ID. The created Group ID is used to publish and subscribe to messages
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/create-mq-sofamq-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| GroupId | string | yes | The Group ID to create |
| GroupType | string | no | The group type |
| InstanceId | string | yes | The instance ID associated with the Group ID to create |
| Remark | string | no | The description of the Group ID |

### Specifies the message type and topic name to create a topic
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/create-mq-sofamq-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance to which the topic to be created belongs |
| MessageType | integer | yes | The message type. Valid values: 0: normal message. 1: partitionally ordered message. 2: globally ordered message. 4: transactional… |
| Remark | string | no | The description of the topic |
| Topic | string | yes | The name of the topic to be created |

### Creates an alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/create-rmsunified-alarm-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Name | string | yes | The name of the alert rule |
| Category | string | yes | The rule type |
| RuleConfig | string | yes | The rule configuration information |
| AlarmNodata | integer | yes | Specifies whether to trigger an alert when no data is found. Valid values: 1 (enabled) and 0 (disabled) |
| Level | integer | yes | The alert level. A value of 0 corresponds to P0, 1 corresponds to P1, and so on |
| Emergency | string | no | The emergency handler |
| EmergencyUrl | string | no | The emergency handling URL |
| PendingHit | integer | yes | The trigger period |
| RecoveredHit | integer | yes | The recovery period |
| Step | integer | yes | The detection frequency |
| SilenceTime | integer | yes | The notification mute period |
| NotifyFiring | integer | yes | Specifies whether to send notifications when an alert is triggered. Valid values: 1 (selected) and 0 (not selected) |
| NotifyRecovered | integer | yes | Specifies whether to send notifications when an alert is resolved. Valid values: 1 (selected) and 0 (not selected) |
| NotifyNodata | integer | yes | The total amount of subscription data to be deleted |
| NotifyTimeFilterJsonStr | string | no | The time range for querying alert rules |
| WorkspaceName | string | yes | The workspace name |
| ChannelsRepeatList | string | yes | The alert notification channels. Valid values: DD_WEBHOOK, SMS, PHONE, MAIL, and WEBHOOK (JSON-encoded) |
| NotifyTarget | string | no | The notification recipients for alerting. Valid values: accountContact (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| GroupId | string | yes | The group ID of the message consumption cluster to delete |
| InstanceId | string | yes | The instance ID corresponding to the group ID to delete |

### Deletes a specified topic. After the topic is deleted, all subscriptions under the topic are cleared
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/delete-mq-sofamq-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance to which the topic to be deleted belongs. This parameter is required for instances that have independent namespaces |
| Topic | string | yes | The name of the topic to delete |

### Deletes a specified message trace query task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/delete-mq-sofamq-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| QueryId | string | yes | The ID of the message trace query task to be deleted |

### Deletes a specified alert rule by alert rule ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/delete-mq-sofamq-warn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| WarnId | integer | yes | The ID of the alert rule to delete |

### Deletes the metadata of a property based on the property ID. Deleting the property metadata does not delete…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/delete-ms-config-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Id | integer | yes | The auto-increment ID of the property |
| InstanceId | string | yes | The ID of the environment instance. This is a system field |

### Delete the corresponding resource by resource ID. Deleting a resource will also delete all attribute…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/delete-ms-config-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Id | integer | yes | Auto-increment resource ID |
| InstanceId | string | yes | System field: environment instance ID |

### Deletes an alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/delete-rmsunified-alarm-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Id | integer | yes | The ID of the alert rule |
| WorkspaceName | string | yes | The workspace name |

### Queries the machine list by using paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/describe-cas-computers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| CurrentPage | integer | no | The page number |
| Name | string | no | The name |
| PageSize | integer | no | The number of items per page |
| Workspace | string | yes | The workspace |
| AppServiceIdsRepeatList | string | no | The list of application service IDs (JSON-encoded) |

### Disables a specified alert rule by alert rule ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/disable-mq-sofamq-warn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| WarnId | integer | yes | The ID of the alert rule to disable |

### Enables a specified alert rule by alert rule ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/enable-mq-sofamq-warn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| WarnId | integer | yes | The ID of the alert rule to enable |

### Locates issues
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/get-mq-sofamq-consumer-jstack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | yes | The unit to query |
| ClientId | string | yes | The client ID of the consumer to query |
| GroupId | string | yes | The group ID of the consumer to query |
| InstanceId | string | yes | The instance ID of the consumer to query |

### Queries the detailed status of consumers, including subscription relationship checks, consumption TPS…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/get-mq-sofamq-consumer-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The unit to query |
| Detail | string | no | Specifies whether to query detailed information. Valid values: true: Queries detailed information. false: Does not query detailed… |
| GroupId | string | yes | The ID of the consumer group to query |
| InstanceId | string | yes | The ID of the instance to which the group ID to query belongs. This parameter is required for instances that have independent namespaces |
| NeedJstack | string | no | Specifies whether to print Jstack information |

### Queries a dead-letter message by Message ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/get-mq-sofamq-dlqmessage-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell to query |
| GroupId | string | yes | The Group ID of the consumer to query |
| InstanceId | string | yes | The ID of the instance to which the message belongs. This parameter is required for instances that have independent namespaces |
| MsgId | string | yes | The ID of the message to query, which is the Message ID |

### Queries a message by exact match. The Message ID required for the query is obtained from the SendResult…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/get-mq-sofamq-message-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell where the message to query resides |
| InstanceId | string | yes | The instance ID associated with the message to query. This parameter is required for instances that have independent namespaces |
| MsgId | string | yes | The ID of the message to query, that is, the Message ID |
| Topic | string | yes | The topic of the message to query |

### Queries the delivery trace of a message by Message ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/get-mq-sofamq-trace-by-msg-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| BeginTime | integer | yes | The beginning of the time range to query. Unit: milliseconds |
| Cell | string | no | The cell to query |
| EndTime | integer | yes | The end of the time range to query. Unit: milliseconds |
| InstanceId | string | yes | The ID of the instance that corresponds to the topic of the message to query. This parameter is required for instances that have… |
| MsgId | string | yes | The ID of the message to query, that is, the Message ID |
| Topic | string | yes | The topic of the message to query |

### Retrieves the details of a message trace query result by specifying the query task ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/get-mq-sofamq-trace-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| QueryId | string | yes | The task ID of the message trace query |

### Get the corresponding attribute information by attribute ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/get-ms-config-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Id | integer | yes | Auto-increment ID of the attribute |
| InstanceId | string | yes | System field: environment instance ID |

### Retrieves the metadata of a resource by resource ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/get-ms-config-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Id | integer | yes | The auto-increment ID of the resource |
| InstanceId | string | yes | The system field: environment instance ID |

### Pushes a property value by IP-based canary release
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/gray-push-ms-config-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AttributeId | integer | yes | The auto-increment ID of the property. You can obtain the ID by calling the query property operation |
| Data | string | no | The property value to push |
| Hosts | string | yes | The list of machines for canary release push. Separate multiple IP addresses with commas (,) |
| InstanceId | string | yes | The environment instance ID. This is a system field |
| Operator | string | no | The operator |

### Queries the list of Group ID resources in a specified environment instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/list-mq-sofamq-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| GroupId | string | no | The Group ID to query. If this parameter is not specified, all Group IDs are queried |
| GroupType | string | no | The group type. Default value: tcp, which indicates that the Group ID is applicable only to message sending and receiving over the TCP… |
| InstanceId | string | yes | The instance ID that corresponds to the Group ID |
| PageNum | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |

### Queries the list of topics for a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/list-mq-sofamq-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance for which you want to query the topic list |
| PageNum | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |
| Topic | string | no | The name of the topic to query. If this parameter is not specified, all topics are queried |

### Queries the list of message trace query tasks under a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/list-mq-sofamq-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| PageNum | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |
| QueryItem | string | no | The fuzzy query item. Valid values: Topic, Message ID, and Message Key |

### Obtain the list of alarm rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/list-mq-sofamq-warn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| GroupId | string | no | Set when querying alarm rules for a specified group |
| InstanceId | string | yes | Instance ID |
| PageNum | integer | yes | Page number |
| PageSize | integer | yes | Number of entries displayed per page |
| Topic | string | no | Set when querying alarm rules for a specified topic |

### Query historical alert records. By default, alert information within the last 30 days is retained
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/list-mq-sofamq-warn-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | Target cell |
| GroupId | string | no | Group ID |
| InstanceId | string | yes | Instance ID |
| PageNum | integer | yes | Page number |
| PageSize | integer | yes | Number of entries per page |
| Topic | string | no | Topic name |
| WarnId | integer | no | Alert rule ID |

### Unregisters the registry service corresponding to the server IP addresses in the specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/logout-ms-registry-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The tenant instance ID |
| ServerIpsRepeatList | string | yes | The list of server IP addresses for which the service is to be unregistered (JSON-encoded) |

### Pushes a property value. After the push, all clients that subscribe to the corresponding property update the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/push-ms-config-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AttributeId | integer | yes | The auto-increment ID of the property |
| Cells | string | no | The list of cells to which the value is published, separated by commas. If this parameter is left empty, the value is pushed to all cells |
| Data | string | no | The property value to push |
| InstanceId | string | yes | The environment instance ID. This is a system field |
| Operator | string | no | The operator who performs the push |

### Provides a rough assessment of message consumption and latency
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-mq-sofamq-consumer-accumulate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell where the Group ID to query resides |
| Detail | string | no | Specifies whether to query detailed information. Valid values: true: Query detailed information. false: Do not query detailed information.… |
| GroupId | string | yes | The Group ID of the consumer to query |
| InstanceId | string | yes | The instance ID. This parameter is required for instances that have independent namespaces |

### Determines whether the consumer of a specified Group ID is online and retrieves the detailed list of client…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-mq-sofamq-consumer-connection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell in which the specified Group ID resides |
| GroupId | string | yes | The Group ID to query |
| InstanceId | string | yes | The instance ID that corresponds to the Group ID. This parameter is required for instances that have independent namespaces |

### Queries the earliest and latest message timestamps currently stored on the server for a specified topic, as…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-mq-sofamq-consumer-timespan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell where the consumer group ID to query resides |
| GroupId | string | yes | The consumer group ID to query |
| InstanceId | string | yes | The instance ID that corresponds to the consumer group ID to query. This parameter is required for instances that have independent… |
| Topic | string | yes | The topic subscribed to by the consumer group ID to query |

### Queries all dead-letter messages within a specified Group ID during a specified time range by paging
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-mq-sofamq-dlqmessage-by-group-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| BeginTime | integer | yes | The beginning timestamp of the query range |
| Cell | string | no | The cell to query |
| EndTime | integer | yes | The ending timestamp of the query range |
| GroupId | string | yes | The consumer Group ID to query |
| InstanceId | string | yes | The instance ID corresponding to the messages to query. This parameter is required for instances that have independent namespaces |
| PageNum | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |
| TaskId | string | no | The ID of the query task. This parameter is not required for the first query. For subsequent queries, this parameter is required. Obtain… |

### Queries the subscription information of a group. If the consumer instances corresponding to the Group ID are…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-mq-sofamq-group-sub-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell in which the Group ID to query resides |
| GroupId | string | yes | The Group ID to query |
| InstanceId | string | yes | The instance ID corresponding to the Group ID to query. This parameter is required for instances that have independent namespaces |

### Performs a fuzzy query. Because the Message Key of a business may not be unique, the query result may…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-mq-sofamq-message-by-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell in which the message to query resides |
| InstanceId | string | yes | The ID of the instance to which the message belongs. This parameter is required for instances that have independent namespaces |
| Key | string | yes | The Message Key of the message to query |
| Topic | string | yes | The topic of the message to query |

### Queries all messages within a specified topic during a specified time range by paging. You can pass in the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-mq-sofamq-message-by-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| BeginTime | integer | yes | The start timestamp of the query range |
| Cell | string | no | The cell to query |
| EndTime | integer | yes | The end timestamp of the query range |
| InstanceId | string | yes | The ID of the instance to which the messages belong. This parameter is required for instances that have independent namespaces |
| PageNum | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |
| TaskId | string | no | The ID of the query task. This parameter is not required for the first query. For subsequent queries, this parameter is required. Obtain… |
| Topic | string | yes | The topic name of the messages to query |

### Retrieves detailed property information, including the property ID, based on the domain, application name,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-ms-config-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AppName | string | yes | The application name |
| AttributeName | string | yes | The property name |
| InstanceId | string | yes | The environment instance ID. This is a system field |
| Region | string | yes | The domain to which the resource belongs |
| ResourceId | string | yes | The resource ID, similar to a file name |

### Queries the memory value of a specified client by property ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-ms-config-client-values` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AttributeId | integer | yes | The auto-increment ID of the property. You can obtain the ID by calling the query property operation |
| InstanceId | string | yes | The environment instance ID, which is a system field |
| Ips | string | yes | The list of IP addresses to query, separated by commas (,) |

### Queries the information about all clients that subscribe to a property. When a dynamic configuration client…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-ms-config-clients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AttributeId | integer | yes | The auto-increment ID of the property. You can obtain the ID by querying the property |
| InstanceId | string | yes | The environment instance ID |
| PageNum | integer | yes | The page number |
| PageSize | string | no | The number of entries per page |

### Queries the last pushed value of a property by property ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-ms-config-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AttributeId | integer | yes | The auto-increment ID of the property. You can obtain the ID by calling the query property operation |
| InstanceId | string | yes | The environment instance ID. This is a system field |

### Queries resource metadata by fuzzy matching an application name or resource ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-ms-config-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AppName | string | no | The application name |
| InstanceId | string | yes | The environment instance ID. This is a system field |
| Keyword | string | no | The keyword for fuzzy matching by resource ID |
| PageNum | integer | yes | The page number for pagination |
| PageSize | string | no | The number of entries per page. Default value: 10 |

### Performs a conditional query on the timing data of monitoring metrics based on filter conditions such as the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-rmsmetrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Start | integer | yes | The start time |
| End | integer | yes | The end time |
| Plugin | string | yes | The plugin type |
| DsId | string | yes | The unique ID of the monitoring metrics |
| ContentType | string | no | The data type of the metric |
| WorkspaceName | string | yes | The workspace name |
| PeriodType | string | no | The statistical period type of the metric data |
| FieldsRepeatList | string | no | The filter conditions for metric dimensions. This parameter is optional in most cases (JSON-encoded) |
| Where | string | no | The additional filter conditions (JSON-encoded) |

### Queries the history of unified alert events based on specified conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-rmsunified-alarm-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| WorkspaceName | string | yes | The name of the workspace |
| CurrentPage | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |
| AlarmLevel | integer | no | The alert level |
| Status | integer | no | The trigger status |
| AlarmTargetType | string | no | The type of the alert target |
| Keyword | string | no | The keyword used to query alert content |
| StartTime | integer | yes | The start time |
| EndTime | integer | yes | The end time |
| AlarmRuleId | integer | no | The ID of the alert rule |
| AlarmStackInfoJsonStr | string | no | The JSON string used to filter data based on the application stack. The JSON format includes the following fields:… |
| AlarmRuleUuid | string | no | The UUID of the alert rule |
| AlarmTargetKeyword | string | no | The keyword used to search for the alert target |
| AlarmStatusRepeatList | string | no | The alert status (JSON-encoded) |

### Queries unified alerting history records based on conditions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-rmsunified-alarm-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| WorkspaceName | string | yes | The name of the workspace |
| Start | integer | yes | The start time of the query, which is a UNIX timestamp in milliseconds. The start time must fall within the storage duration of SQL… |
| End | integer | yes | The end time of the query, which is a UNIX timestamp in milliseconds. The end time must be later than the start time, and the latest… |
| CurrentPage | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |
| AlarmTargetType | string | no | The alerting object type |
| AlarmTarget | string | no | The alert target |
| AlarmLevel | integer | no | The alert level |
| Status | integer | no | The alert status |
| AlarmStackInfoJsonStr | string | no | The JSON string used to filter alert history by application. The string contains the following fields:… |

### Queries the alert notification history, including notification records for DingTalk, phone calls, text…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-rmsunified-alarm-notify-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Status | integer | no | The delivery status |
| Channel | string | no | The notification channel |
| Subscriber | string | no | The ID of the recipient |
| CurrentPage | integer | no | The current page number |
| PageSize | integer | no | The number of entries per page |
| WorkspaceName | string | yes | The name of the workspace |
| EventId | string | no | The event ID |
| StartTime | integer | yes | The start time |
| EndTime | integer | yes | The end time |
| Keyword | string | no | The keyword used to query alert content |
| AlarmRuleId | integer | no | The ID of the alert rule |
| AlarmStatus | integer | no | The alert status |
| AlarmStackInfoJsonStr | string | no | The JSON string used to filter alert history by application. The string contains the following fields: datasource_type STRING No… |
| DashboardQueryParamJsonStr | string | no | The JSON string of dashboard alert query parameters |
| AlarmSubscribers | string | no | The notification recipients used to filter alerts (JSON-encoded) |

### QueryRMSUnifiedAlarmRule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/query-rmsunified-alarm-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Keyword | string | no | Fuzzy search by alert rule name |
| Level | integer | no | Alert Level |
| AlarmTargetJsonStr | string | no | Alarm object search in JSON format. The following fields are included: rule_statusNUMBERNo1: enabled, 0: disabled Rule status… |
| RuleStatus | integer | no | Rule status: 1 for enabled, 0 for disabled |
| AlarmStatus | integer | no | Alert Status |
| OnlyMe | string | no | View only my items |
| CurrentPage | integer | no | Current page |
| PageSize | integer | no | Page size |
| WorkspaceName | string | yes | Workspace name |
| RuleId | integer | no | Alert rule ID |
| RuleUniqueIdentity | string | no | Alert UUID |
| Category | string | yes | Rule category |
| RefDatasourceType | string | no | datasource |

### Resends dead-letter messages with specified message IDs in batches so that consumers can consume these…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/resend-mq-sofamq-dlqmessage-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell to query |
| GroupId | string | yes | The Group ID of the consumer to query |
| InstanceId | string | yes | The instance ID that corresponds to the messages to query |
| MsgIds | string | yes | The IDs of the messages to resend, that is, the message IDs. Separate multiple message IDs with commas (,) |

### Resurrects a dead-letter message so that the message can be consumed by a consumer again
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/resend-mq-sofamq-dlqmessage-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell to query |
| GroupId | string | yes | The group ID of the consumer to query |
| InstanceId | string | yes | The ID of the instance to which the message belongs. This parameter is required for instances that have independent namespaces |
| MsgId | string | yes | The ID of the message to query, that is, the message ID |

### Resets the consumer offset of a specified Group ID to a specified timestamp. This operation is typically…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/reset-mq-sofamq-consumer-offset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Cell | string | no | The cell to query |
| GroupId | string | yes | The Group ID of the consumer to query |
| InstanceId | string | yes | The instance ID that corresponds to the Group ID to query. This parameter is required for instances that have independent namespaces |
| ResetTimestamp | integer | no | The timestamp to which the consumer offset is reset. This parameter takes effect only when Type is set to 1. Unit: milliseconds |
| Topic | string | yes | The name of the topic for which you want to reset the consumer offset |
| Type | integer | yes | The message cleanup type. Valid values: 0: clears all messages. 1: clears messages up to a specified time |

### Modifies or updates the description of a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/update-mq-sofamq-group-remark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| GroupId | string | yes | The ID of the group to update |
| InstanceId | string | yes | The instance ID |
| Remark | string | yes | The description |

### Updates the description of a topic
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/update-mq-sofamq-topic-remark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Remark | string | yes | The description of the topic |
| Topic | string | yes | The name of the topic to update. The topic name must be unique within a user account |

### Updates the configuration of the specified alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/update-mq-sofamq-warn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AlertTime | string | no | Alert time range |
| Contacts | string | no | Alert notification contact information |
| DelayTime | integer | no | Delay in seconds before triggering an alert |
| Frequency | integer | no | Alert frequency, in minutes |
| InstanceId | string | yes | Instance ID |
| Threshold | integer | no | Threshold |
| WarnId | integer | yes | Specified alert rule to modify |

### Updates the metadata of a property by property ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/update-ms-config-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AttributeName | string | yes | The property name |
| Desc | string | no | The property description |
| Id | integer | yes | The auto-increment ID of the property |
| InstanceId | string | yes | The environment instance ID. This is a system field |

### When update_attribute is set to false, only the resource metadata is updated, and the property information…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/update-ms-config-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| AppName | string | yes | The application name |
| Attributes | string | no | The property information of the resource, passed in as a JSON string |
| Desc | string | yes | The description of the resource |
| Id | integer | yes | The auto-increment ID of the resource to update |
| InstanceId | string | yes | The system field: environment instance ID |
| Region | string | yes | The domain for resource search |
| ResourceId | string | yes | The unique identifier of the resource |
| UpdateAttribute | string | no | Specifies whether to perform a full update of properties. Default value: false |

### Updates the specified alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/update-rmsunified-alarm-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |
| Id | integer | yes | The ID of the alert rule |
| Name | string | yes | The name of the alert rule |
| Category | string | yes | The type of the rule |
| RuleConfig | string | yes | The configuration of the alert rule |
| AlarmNodata | integer | yes | Specifies whether to trigger an alert when no data is found. Valid values: 1 (enabled) and 0 (disabled) |
| Level | integer | yes | The alert level. A value of 0 corresponds to P0, 1 corresponds to P1, and so on |
| Emergency | string | no | The emergency contact |
| EmergencyUrl | string | no | The emergency handling URL |
| PendingHit | integer | yes | The trigger period |
| RecoveredHit | integer | yes | The recovery period |
| Step | integer | yes | The check frequency |
| SilenceTime | integer | yes | The notification silence period |
| NotifyFiring | integer | yes | Specifies whether to send notifications when an alert is triggered. Valid values: 1 (selected) and 0 (unselected) |
| NotifyRecovered | integer | yes | Specifies whether to send notifications when an alert is recovered. Valid values: 1 (selected) and 0 (unselected) |
| NotifyNodata | integer | yes | The number of alert rules to be modified |
| NotifyTimeFilterJsonStr | string | no | The time range for querying alert rules |
| Status | string | no | The delivery status |
| SuspendedStartTime | integer | no | The start time of the suspension |
| SuspendedEndTime | integer | no | The end time of the suspension |
| SuspendedReason | string | no | The reason for the suspension |
| WorkspaceName | string | yes | The name of the workspace |
| ChannelsRepeatList | string | yes | The alert notification channels. Valid values: DD_WEBHOOK, SMS, PHONE, MAIL, and WEBHOOK (JSON-encoded) |
| NotifyTarget | string | no | The notification recipients for quota alerts (JSON-encoded) |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://sofa.cn-hangzhou.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-sofa/add-ms-config-attributes" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud 金融分布式架构 SOFAStack API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-sofa/add-ms-config-attributes with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud 金融分布式架构 SOFAStack API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud 金融分布式架构 SOFAStack itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud 金融分布式架构 SOFAStack 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-sofa.

### What is the status of the Alibaba Cloud 金融分布式架构 SOFAStack API?
Needs your own provider key (bring your own key)