# Alibaba Cloud ApsaraMQ for Kafka API

> Alibaba Cloud ApsaraMQ for Kafka API on Apizie: 55 endpoints (Transfers a resource to a different resource group, Converts a pay-as-you-go instance to a subscription instance, Creates an ACL, Calls CreateConsumerGroup to create a consumer group, …) 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://apizie.tech/v1/cloud:aliyun-alikafka/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-alikafka`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/alikafka
- Page: https://apizie.tech/api/cloud/aliyun-alikafka
- OpenAPI: https://apizie.tech/api/cloud/aliyun-alikafka/openapi.json

Alibaba Cloud OpenAPI for ApsaraMQ for Kafka (alikafka, version 2019-09-16). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Transfers a resource to a different resource group
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| ResourceId | string | yes | The ID of the resource that you want to tag. Only instance-level resources are supported. Example: If the instance ID is… |
| NewResourceGroupId | string | yes | The ID of the resource group to which you want to transfer the cloud resource instance. A resource group is a mechanism for managing… |

### Converts a pay-as-you-go instance to a subscription instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/convert-post-pay-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The ID of the instance |
| Duration | integer | no | The subscription duration. Unit: months. Default value: 1. Valid values: 1 to 12 24 36 |
| PaidType | integer | no | The billing type. Valid values: 0: subscription. 4: Confluent series subscription |

### Creates an ACL
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |
| Username | string | yes | The username. Before calling this API, you must create a SASL user by calling CreateSaslUser. You can query existing users by calling… |
| AclResourceType | string | yes | The resource type. Valid values: Topic: topic Group: consumer group Cluster: instance TransactionalId: transactional ID |
| AclResourceName | string | yes | The resource name. The name of the resource. It can be a topic name, a group ID, a cluster name, or a transactional ID. You can use an… |
| AclResourcePatternType | string | yes | The matching mode. Valid values: LITERAL: exact match PREFIXED: prefix match |
| AclOperationType | string | yes | The operation type. Valid values: Write: write Read: read Describe: read a transactional ID IdempotentWrite: perform an idempotent write… |
| AclOperationTypes | string | no | The operation types for batch authorization. Separate multiple operations with commas (,). Valid values: Write: write Read: read Describe:… |
| AclPermissionType | string | no | The authorization method. Valid values: DENY: deny. ALLOW: allow. This parameter is supported only for serverless instances |
| Host | string | no | The source IP address. Only specific IP addresses or an asterisk (*) (which allows all IP addresses) are supported. CIDR blocks are not… |

### Calls CreateConsumerGroup to create a consumer group
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ConsumerId | string | yes | The consumer group name. Reserved instances: Can contain letters, digits, underscores (_), hyphens (-), and periods (.). The value must be… |
| RegionId | string | yes | The region ID of the instance |
| Remark | string | no | The description |
| Tag | string | no | The tags (JSON-encoded) |

### Creates a pay-as-you-go instance and returns the instance ID and order ID
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-post-pay-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DiskType | string | no | The cloud disk type. Valid values: 0: premium performance disk 1: SSD This parameter is not required when you create a Serverless instance |
| DiskSize | integer | no | The cloud disk capacity. For valid values, see https://help.aliyun.com/document_detail/84737.html. This parameter is not required when you… |
| DeployType | integer | yes | The deployment type. Valid values: 4: Internet- and VPC-connected instance 5: VPC-connected instance |
| EipMax | integer | no | The Internet traffic. Required if DeployType is set to 4. For valid values, see https://help.aliyun.com/document_detail/84737.html. This… |
| PartitionNum | integer | no | The number of partitions to purchase. For valid values, see https://help.aliyun.com/document_detail/84737.html. This parameter is not… |
| PaidType | integer | no | The billing method. Valid values: 1 (default): pay-as-you-go for reserved instances. 3: pay-as-you-go for reserved capacity of Serverless… |
| SpecType | string | no | The instance type. When PaidType is set to 1 (pay-as-you-go for reserved instances), valid values are: normal: Standard Edition… |
| IoMaxSpec | string | no | The traffic specification. For valid values, see https://help.aliyun.com/document_detail/84737.html. This parameter is not required when… |
| ResourceGroupId | string | no | The resource group ID. If not specified, the instance is added to the default resource group. You can view resource group IDs in the… |
| Tag | string | no | The list of tags (JSON-encoded) |
| ServerlessConfig | string | no | The settings for the Serverless instance. Required when creating a Serverless instance (JSON-encoded) |

### Pay-as-you-go instances are billed based on the actual usage of purchased resource specifications. You use…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-post-pay-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DiskType | string | no | The disk type. Valid values: 0: ultra cloud disk 1: SSD If you create a serverless instance, you do not need to set this parameter |
| DiskSize | integer | no | The disk capacity. For the value range, see https://help.aliyun.com/document_detail/84737.html. If you create a serverless instance, you… |
| DeployType | integer | yes | The deployment type. Valid values: 4: Internet/VPC-connected instance 5: VPC-connected instance |
| EipMax | integer | no | The Internet traffic. If DeployType is set to 4, you must set this parameter. For the value range, see… |
| IoMax | integer | no | The maximum traffic (not recommended). You must specify one of the maximum traffic and traffic specification parameters. If you specify… |
| PartitionNum | integer | no | The number of partitions (recommended). You must specify one of the number of partitions and topic specification parameters. Specify only… |
| TopicQuota | integer | no | The number of topics (not recommended). You must specify one of the number of partitions and topic specification parameters. Specify only… |
| PaidType | integer | no | The billing type. Valid values: 1 (default): Reserved instance with pay-as-you-go billing. 3: Serverless instance with reserved… |
| SpecType | string | no | The specification type. Valid values when PaidType is set to 1 (reserved instance with pay-as-you-go billing): normal: Standard Edition… |
| IoMaxSpec | string | no | The traffic specification (recommended). You must specify one of the maximum traffic and traffic specification parameters. If you specify… |
| ResourceGroupId | string | no | The resource group ID. If you do not specify this parameter, the instance is placed in the default resource group. You can view the… |
| Tag | string | no | The tag list (JSON-encoded) |
| ServerlessConfig | string | no | The settings for the serverless instance. This parameter is required when you create a serverless instance (JSON-encoded) |

### Creates a subscription instance and returns the instance ID and order ID
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-pre-pay-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DiskType | string | no | The disk type. Valid values: 0: Ultra disk 1: SSD If you create a Confluent instance, you do not need to specify this parameter |
| DiskSize | integer | no | The disk capacity. Unit: GB. For the valid values, see https://help.aliyun.com/document_detail/84737.html. If you create a Confluent… |
| PartitionNum | integer | no | The number of partitions to purchase. For the valid values, see https://help.aliyun.com/document_detail/84737.html. If the instance is a… |
| DeployType | integer | no | The deployment type. Valid values: 4: Internet- and VPC-connected instance 5: VPC-connected instance If you create a Confluent instance,… |
| EipMax | integer | no | The Internet traffic bandwidth. If DeployType is set to 4, this parameter is required. For the valid values, see… |
| SpecType | string | no | The edition type. Valid values for ApsaraMQ for Kafka instances: normal: Standard Edition (High Write) professional: Professional Edition… |
| IoMaxSpec | string | no | The traffic specification. For the valid values, see https://help.aliyun.com/document_detail/84737.html. If you create a Confluent… |
| ResourceGroupId | string | no | The resource group ID. If you do not specify this parameter, the instance is added to the default resource group. You can view the… |
| Tag | string | no | The list of tags (JSON-encoded) |
| PaidType | integer | no | The billing method. Valid values: 0: Subscription 4: Subscription for Confluent instances |
| ConfluentConfig | string | no | The configurations of Confluent components. This parameter is required when you create a Confluent instance (JSON-encoded) |
| Duration | integer | no | The subscription duration. Unit: months. Default value: 1. Valid values: Confluent instance: 1 or 12 ApsaraMQ for Kafka instance: 1 |

### Creates a subscription instance. Subscription instances require upfront payment and are suitable for…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-pre-pay-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| DiskType | string | no | The disk type. Valid values: 0: Ultra disk 1: Standard SSD If you create a Confluent instance, you do not need to specify this parameter |
| DiskSize | integer | no | The disk capacity. Unit: GB. For more information about the valid values, see https://help.aliyun.com/document_detail/84737.html. If you… |
| PartitionNum | integer | no | The number of partitions. We recommend that you specify this parameter. You must specify either the number of partitions or the topic… |
| TopicQuota | integer | no | The number of topics. We do not recommend that you specify this parameter. You must specify either the number of partitions or the topic… |
| DeployType | integer | no | The deployment type. Valid values: 4: Internet- and VPC-connected instance 5: VPC-connected instance If you create a Confluent instance,… |
| EipMax | integer | no | The Internet traffic bandwidth. If DeployType is set to 4, you must specify this parameter. For more information about the valid values,… |
| SpecType | string | no | The edition. Valid values for ApsaraMQ for Kafka instances: normal: Standard Edition (High Write) professional: Professional Edition (High… |
| IoMaxSpec | string | no | The traffic specification. We recommend that you specify this parameter. You must specify at least one of IoMax and IoMaxSpec. If you… |
| IoMax | integer | no | The peak traffic. We do not recommend that you specify this parameter. You must specify at least one of IoMax and IoMaxSpec. If you… |
| ResourceGroupId | string | no | The ID of the resource group. If you do not specify this parameter, the instance is added to the default resource group. You can view the… |
| Tag | string | no | The list of tags (JSON-encoded) |
| PaidType | integer | no | The billing method. Valid values: 0: Subscription 4: Subscription for Confluent instances |
| ConfluentConfig | string | no | The configurations of Confluent components. This parameter is required when you create a Confluent instance (JSON-encoded) |
| Duration | integer | no | The subscription duration. Unit: months. Default value: 1. Valid values: Confluent instances: 1 or 12 ApsaraMQ for Kafka instances: 1 |

### Creates a Simple Authentication and Security Layer (SASL) user by calling CreateSaslUser
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-sasl-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |
| Username | string | yes | The username |
| Password | string | yes | The password |
| Type | string | no | The type. Valid values: plain: a simple username and password verification mechanism. ApsaraMQ for Kafka has optimized the PLAIN mechanism… |
| Mechanism | string | no | The encryption mechanism. Valid values: SCRAM-SHA-512 (selected by default) SCRAM-SHA-256 This parameter is supported only for Serverless… |

### Creates a scheduled elastic scaling policy for a serverless instance after deployment
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-scheduled-scaling-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The instance ID |
| RuleName | string | yes | The name of the scheduled policy rule. The name must be unique among all rules of the same instance |
| ReservedPubFlow | integer | yes | The reserved production specification for scheduled elastic scaling (unit: MB/s). At least one of ReservedPubFlow and ReservedSubFlow must… |
| ReservedSubFlow | integer | yes | The reserved consumption specification for scheduled elastic scaling (unit: MB/s). At least one of ReservedSubFlow and ReservedPubFlow… |
| ScheduleType | string | yes | The schedule type. Valid values: at: scheduled once only. repeat: scheduled repeatedly |
| DurationMinutes | integer | yes | The duration (unit: minutes) of a single scheduled elastic scaling task. The value must be at least 15 minutes |
| TimeZone | string | yes | The time zone (Coordinated Universal Time) |
| FirstScheduledTime | integer | yes | The time when the scheduled policy starts to take effect. If the schedule type is single execution, the start time must be at least 30… |
| Enable | string | no | Specifies whether to enable or disable the scheduled policy. Valid values: true: Enabled. false: Disabled |
| RepeatType | string | no | The repeat type. This parameter is required when ScheduleType is set to repeat. Valid values: Daily: timed scheduling every day. Weekly:… |
| WeeklyTypes | string | no | The days of the week. Multiple days are supported for repeated execution (JSON-encoded) |

### Creates a topic
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/create-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Topic | string | yes | The name of the topic. Reserved instances: The name can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name… |
| Remark | string | yes | The description of the topic. The description can contain only letters, digits, underscores (_), and hyphens (-). The description must be… |
| RegionId | string | yes | The region ID of the instance to which the topic belongs |
| CompactTopic | string | no | The cleanup policy that is configured when the storage engine of the topic is set to local storage. Valid values: false: delete cleanup… |
| PartitionNum | string | no | The number of partitions for the topic. Valid values: 1 to 360. The console provides different configuration suggestions based on the… |
| LocalTopic | string | no | The storage engine of the topic. Valid values: false: cloud storage. true: local storage |
| ReplicationFactor | integer | no | The number of replicas for the topic. This parameter takes effect only when LocalTopic is set to true. Valid values: 1 to 3. If the number… |
| MinInsyncReplicas | integer | no | The minimum number of in-sync replicas (ISR). This parameter takes effect only when LocalTopic is set to true. The value must be less than… |
| Config | string | no | The supplementary configuration. The value must be in JSON format. This parameter takes effect only when LocalTopic is set to true.… |
| Tag | string | no | The tag list (JSON-encoded) |

### Deletes an ACL
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/delete-acl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |
| Username | string | yes | The username |
| AclResourceType | string | yes | The resource type. Valid values: Topic: Message topic. Group: Consumer group. Cluster: Instance. TransactionalId: Transaction ID |
| AclResourceName | string | yes | The resource name. You can specify the name of a topic or a consumer group. An asterisk (*) indicates all topics or consumer groups |
| AclResourcePatternType | string | yes | The matching mode. Valid values: LITERAL: Exact match. PREFIXED: Prefix match |
| AclOperationType | string | yes | The operation type. Valid values: Write: Write. Read: Read. Describe: Read a transaction ID. IdempotentWrite: Idempotent write to a… |
| AclOperationTypes | string | no | The operation types for batch authorization. Separate multiple operations with commas (,). Valid values: Write: Write. Read: Read.… |
| AclPermissionType | string | no | The authorization method. Valid values: DENY: Deny. ALLOW: Allow. This parameter is supported only for serverless instances |
| Host | string | no | The source IP address. Only specific IP addresses or an asterisk (*) to allow all IP addresses are supported. CIDR blocks are not… |

### Deletes a consumer group
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/delete-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ConsumerId | string | yes | The name of the consumer group |
| RegionId | string | yes | The region ID of the instance |

### Deletes an instance after a subscription or pay-as-you-go instance is released. This topic describes how to…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID of the instance |

### Deletes a Simple Authentication and Security Layer (SASL) user
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/delete-sasl-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |
| Username | string | yes | The username |
| Type | string | no | The type. Valid values: plain: a simple username and password verification mechanism. ApsaraMQ for Kafka has an optimization for the PLAIN… |
| Mechanism | string | no | The encryption mechanism. Valid values: SCRAM-SHA-512 (selected by default) SCRAM-SHA-256 This parameter is supported only for Serverless… |

### After a Serverless instance is deployed, you can call this API operation to delete its scheduled scaling…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/delete-scheduled-scaling-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The instance ID |
| RuleName | string | yes | The policy name. Only policies that are disabled or one-time policies that have been executed can be deleted |

### Deletes a topic
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/delete-topic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Topic | string | yes | The topic name |
| RegionId | string | yes | The region ID of the instance |

### Queries ACL resource names
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/describe-acl-resource-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |
| AclResourceType | string | yes | The resource type. Topic: Message topic. Group: Consumer group. Cluster: Instance. TransactionalId: Transaction ID |
| AclResourcePatternType | string | yes | The matching pattern. Valid values: LITERAL: Exact match. PREFIXED: Prefix match |

### Queries access control lists (ACLs)
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/describe-acls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The ID of the region |
| InstanceId | string | yes | The ID of the instance |
| Username | string | yes | The username. An asterisk (*) can be used to represent all users. A query with an asterisk (*) returns authorizations only if… |
| AclResourceType | string | yes | The type of the resource. Valid values: Topic Group Cluster TransactionalId |
| AclResourceName | string | yes | The name of the resource. The name can be a topic name or a group name. You can use an asterisk (*) to represent all topic names or group… |
| AclResourcePatternType | string | no | The match mode. Valid values: LITERAL: an exact match PREFIXED: a prefix match |
| Host | string | no | The source IP address. You can set this parameter to a specific IP address or an asterisk (). An asterisk () indicates all IP addresses.… |
| AclPermissionType | string | no | The authorization method. Valid values: DENY ALLOW This parameter is available only for Serverless instances |
| AclOperationType | string | no | The operation type. Valid values: Write Read Describe: reads a transactional ID. IdempotentWrite: performs an idempotent write to a… |

### Queries SASL users
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/describe-sasl-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |

### Enables or disables automatic group creation
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/enable-auto-group-creation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID. You can call the https://help.aliyun.com/document_detail/437663.html operation to query the instance ID |
| Enable | string | yes | Specifies whether to enable automatic group creation. Valid values: true: Enabled. false: Disabled |

### This topic describes how to call EnableAutoTopicCreation to enable or shut down automatic topic creation and…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/enable-auto-topic-creation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |
| Operate | string | no | Only the following three values are supported: enable: Enables automatic automatic creation. disable: Disables automatic automatic… |
| PartitionNum | integer | no | The default number of partitions for automatically created topics. Specify this parameter only when Operate is set to updatePartition or… |
| UpdatePartition | string | no | Specifies whether to modify the number of partitions for automatic creation. If this parameter is set to true, the Operate parameter must… |

### Queries the instance IDs of all instances under the current account
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-all-instance-id-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID of the instance. This is a reserved parameter |

### Retrieves the IP whitelist
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-allowed-ip-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |

### Queries the scheduled elastic scaling policy configurations of a serverless instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-auto-scaling-configuration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| InstanceId | string | yes | The instance ID |

### Retrieves consumer group information by calling GetConsumerList
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-consumer-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance to which the consumer group belongs |
| RegionId | string | yes | The region ID of the instance to which the consumer group belongs |
| CurrentPage | integer | no | The current page number |
| PageSize | integer | no | The number of consumer groups to display per page |
| ConsumerId | string | no | The ID of the consumer group. If you do not specify this parameter, all consumer groups are queried |

### Queries the consumption status of a consumer group
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-consumer-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ConsumerId | string | yes | The name of the consumer group |
| RegionId | string | yes | The region ID of the instance |
| HideLastTimestamp | string | no | Specifies whether to hide the \`LastTimestamp\` parameter. The default value is false. Set this parameter to true for better performance.… |

### Queries instance information in a specified region
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-instance-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| OrderId | string | no | The order ID. You can obtain the order ID from the Orders (https://usercenter2.aliyun.com/order/list?pageIndex=1&pageSize=20) Order… |
| InstanceId | string | no | The list of instance IDs (JSON-encoded) |
| Tag | string | no | The list of tags (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID. You can query the ID in the Resource Management console |
| Series | string | no | The instance edition identity. You can filter instances of different editions based on the edition number. Valid values: v2 v3 confluent |

### Retrieves the IP addresses of Kafka clients
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-kafka-client-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The instance ID |
| Topic | string | no | The topic name. This parameter is required if Type is set to byTopic |
| Group | string | no | The consumer group ID. This parameter is required if Type is set to byGroup |
| Type | string | yes | The type of client IP address to query. Valid values: byInstance: Queries the client IP addresses within a specified time range for the… |
| StartTime | integer | yes | The start time of the query range. The value is a UNIX timestamp in milliseconds |
| EndTime | integer | yes | The end time of the query range. The value is a UNIX timestamp in milliseconds |

### Retrieves the usage quotas for topics and partitions
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-quota-tip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | Region ID |
| InstanceId | string | yes | Instance ID |

### Queries the risk list of an instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-risk-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The ID of the instance |
| StartIndex | integer | no | The start index for pagination |
| PageSize | integer | no | The page size |

### Retrieves topic information
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-topic-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance to which the topic belongs |
| CurrentPage | string | no | The current page number. Default value: 1 |
| PageSize | string | no | The page size. Default value: 10 |
| RegionId | string | no | The region ID of the instance to which the topic belongs |
| Topic | string | no | The name of the topic whose information you want to retrieve |

### Retrieves the message sending and receiving status of a topic
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-topic-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Topic | string | yes | The topic name |
| RegionId | string | no | The region ID |

### Retrieves the subscription status of Groups for a topic
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/get-topic-subscribe-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | Region ID |
| InstanceId | string | yes | Instance ID. You can call https://help.aliyun.com/document_detail/437663.html to obtain it |
| Topic | string | yes | Topic name. You can call https://help.aliyun.com/document_detail/437677.html to obtain it |

### Queries the details of rebalancing tasks
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/list-rebalance-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ConsumerId | string | yes | The name of the consumer group |
| RegionId | string | yes | The region ID of the instance |

### Queries the list of tags that are attached to resources
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| ResourceType | string | yes | The resource type. Enumeration type. Valid values: INSTANCE: instance. TOPIC: topic. CONSUMERGROUP: consumer group |
| NextToken | string | no | The token for the next query |
| ResourceId | string | no | The ID of the resource to be tagged. Resource ID rules: Instance: instanceId Topic: Kafka_alikafka_instanceId_topic Group:… |
| Tag | string | no | The tag list (JSON-encoded) |

### You can modify the name of an ApsaraMQ for Kafka instance after it is deployed. This topic describes how to…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/modify-instance-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| RegionId | string | yes | The region ID of the instance |
| InstanceName | string | yes | The name of the instance. The value must meet the following requirements: The name can contain only letters, digits, underscores (_), and… |

### This operation modifies the number of partitions in a topic
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/modify-partition-num` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Topic | string | yes | Topic name |
| RegionId | string | yes | Region ID of the instance |
| AddPartitionNum | integer | yes | Number of partitions to add. Must be greater than 0. It is recommended that the number of partitions is a multiple of 6 to reduce the risk… |

### After you deploy Serverless instances, you can call this API operation to modify their scheduled scaling…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/modify-scheduled-scaling-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The instance ID |
| RuleName | string | yes | The policy name |
| Enable | string | yes | Enable or disable the scheduled task policy. Valid values: true: Enable. false: Disable. For a one-time scheduling policy type, the start… |

### Modifies the remark of a topic
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/modify-topic-remark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Topic | string | yes | The name of the topic |
| RegionId | string | yes | The region ID of the instance |
| Remark | string | no | Remark |

### Queries messages stored in a topic by message creation time or offset
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/query-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| InstanceId | string | yes | The instance ID |
| Topic | string | yes | The topic name |
| QueryType | string | yes | The query type. Valid values: byOffset: Queries messages by offset. If you select this value, you must specify the partition ID and… |
| Partition | string | no | The partition ID |
| Offset | string | no | The partition offset |
| BeginTime | integer | no | The start timestamp of the query range. Unit: milliseconds |

### Releases a pay-as-you-go instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/release-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| RegionId | string | yes | The region ID of the instance |
| ForceDeleteInstance | string | no | Specifies whether to immediately release the physical resources of the instance. Valid values: true: Immediately releases the physical… |

### Enables an instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/reopen-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The instance ID |

### You must purchase and deploy an ApsaraMQ for Kafka instance before you can send and receive messages. This…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/start-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| RegionId | string | yes | The region ID of the instance |
| VpcId | string | yes | The ID of the VPC in which the instance is deployed |
| VSwitchId | string | yes | The ID of the vSwitch to which the instance is deployed |
| DeployModule | string | no | The deployment mode of the instance. This parameter is required for provisioned instances. This parameter is not required for Serverless… |
| ZoneId | string | no | The ID of the zone in which the instance is deployed. The value must be the zone ID of the vSwitch. The value can be in the zoneX or… |
| IsEipInner | string | no | Specifies whether to enable elastic IP addresses (EIPs). Valid values: true: The instance is an Internet/VPC instance. false: The instance… |
| IsSetUserAndPassword | string | no | Specifies whether to set a new username and password. Valid values: true: Set a new username and password. false: Do not set a new… |
| Username | string | no | The username. For provisioned and Serverless instances, this parameter is supported only for Internet/VPC instances. For Confluent… |
| Password | string | no | The password. For provisioned and Serverless instances, this parameter is supported only for Internet/VPC instances. This parameter is… |
| Name | string | no | The name of the instance. This parameter is not supported for Serverless and Confluent instances. If you specify this parameter, make sure… |
| CrossZone | string | no | Specifies whether to deploy the instance across zones. true: Deploy the instance across zones. false: Do not deploy the instance across… |
| SecurityGroup | string | no | The security group of the instance. If you do not specify this parameter, ApsaraMQ for Kafka automatically configures a security group for… |
| ServiceVersion | string | no | The version of the ApsaraMQ for Kafka instance that you want to deploy. For provisioned instances, valid values are 2.2.0 and 2.6.2. For… |
| Config | string | no | The initial configurations of the ApsaraMQ for Kafka instance. The value must be a valid JSON string. If you do not specify this… |
| KMSKeyId | string | no | The ID of the key that is used for disk encryption in the same region. You can view the key ID in the Key Management Service (KMS) console… |
| Notifier | string | no | The alert contact |
| UserPhoneNum | string | no | The mobile phone number of the alert contact |
| SelectedZones | string | no | A two-dimensional array that consists of the candidate set of the primary zone and the candidate set of the secondary zone. The values can… |
| IsForceSelectedZones | string | no | Specifies whether to forcibly deploy the instance in the selected zones |
| VSwitchIds | string | no | The list of vSwitch IDs. This parameter is required for provisioned and Serverless instances. This parameter is supported for Confluent… |

### Stops an instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/stop-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| RegionId | string | yes | Region ID of the instance |

### You can call the TagResources operation to attach tags to resources
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resources |
| ResourceType | string | yes | The resource type. Valid values: INSTANCE TOPIC CONSUMERGROUP The value is case-insensitive |
| ResourceId | string | yes | A list of resource IDs (JSON-encoded) |
| Tag | string | yes | A list of tags (JSON-encoded) |
| InstanceId | string | no | The ID of the instance that contains the specified resources |

### You can call UntagResources to detach tags from resources
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| ResourceType | string | yes | The resource type. Enumeration type, currently supported resource types: INSTANCE TOPIC CONSUMERGROUP Case-insensitive |
| All | string | no | Specifies whether to detach all tags from the resource. This parameter takes effect when TagKey.N is empty. The default value is false |
| ResourceId | string | yes | The IDs of resources from which you want to detach tags (JSON-encoded) |
| TagKey | string | no | The tag keys of the resource (JSON-encoded) |

### You can call the UpdateAllowedIp operation to edit the IP whitelist for an ApsaraMQ for Kafka instance. The…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/update-allowed-ip` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| UpdateType | string | yes | The update type. Valid values: add: add. delete: delete |
| PortRange | string | yes | The port range. Valid values: 9092/9092: virtual private cloud (VPC) - PLAINTEXT protocol. 9093/9093: Internet - SASL_SSL protocol.… |
| AllowedListType | string | yes | The type of the whitelist. Valid values: vpc: virtual private cloud (VPC). internet: Internet |
| AllowedListIp | string | yes | The IP list. It can be a CIDR block, for example: 192.168.0.0/16. When UpdateType is set to add, you can specify multiple items separated… |
| InstanceId | string | yes | The instance ID |
| Description | string | no | The description of the whitelist |

### The UpdateConsumerOffset operation resets the consumer offset of a consumer group
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/update-consumer-offset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Topic | string | yes | Topic name. Can only contain letters, numbers, underscores (_), and hyphens (-). Length must be 3-64 characters. If more than 64… |
| RegionId | string | yes | Region ID of the instance to which the Group belongs |
| ConsumerId | string | yes | Consumer Group name. Can only contain letters, numbers, hyphens (-), and underscores (_). Length must be 3-64 characters. If more than 64… |
| ResetType | string | no | Type of consumer group offset reset, supporting the following two types: timestamp (default) offset |
| Time | string | no | Time parameter in Unix timestamp format, in milliseconds. The parameter range should be less than 0 or within the retention period of the… |
| Offsets | string | no | When resetType is offset, this parameter is used to set the consumer offset for each partition of a topic for the consumer group… |

### After an instance is deployed, you can modify configurations such as enabling Access Control List (ACL) and…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/update-instance-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| Config | string | yes | The configuration of ApsaraMQ for Kafka that needs to be updated. The configuration information must be a valid JSON string |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The ID of the instance |

### After a topic is created, you can modify its configurations, such as the message retention period and…
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/update-topic-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the instance |
| InstanceId | string | yes | The instance ID |
| Topic | string | yes | The topic name |
| Config | string | yes | The key of the topic configuration. You can modify the configurations only for topics that use the local storage engine on reserved… |
| Value | string | yes | The value of the topic configuration. The following configurations are supported for Serverless instances: `retention.hours` specifies the… |

### Upgrades the version of an instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/upgrade-instance-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| TargetVersion | string | yes | The target open source version. Valid values: 0.10.2 2.2.0 If the value is the same as the current version, a minor version update will be… |
| RegionId | string | yes | The region ID of the instance |

### Upgrades a pay-as-you-go instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/upgrade-post-pay-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| DiskSize | integer | no | The disk capacity. Unit: GB. The specified disk capacity must be greater than or equal to the current disk capacity of the instance. For… |
| RegionId | string | yes | The region ID of the instance |
| IoMaxSpec | string | no | The traffic specification. We recommend that you specify this parameter. The specified traffic specification must be greater than or equal… |
| IoMax | integer | no | The peak traffic. We do not recommend that you specify this parameter. The specified peak traffic must be greater than or equal to the… |
| SpecType | string | no | The specification type. Valid values when the PaidType parameter of the instance is set to 1 (pay-as-you-go): normal: Standard Edition… |
| PartitionNum | integer | no | The number of partitions. We recommend that you specify this parameter. You must specify either the number of partitions or the topic… |
| TopicQuota | integer | no | The number of topics. We do not recommend that you specify this parameter. You must specify either the number of partitions or the topic… |
| EipModel | string | no | Specifies whether to enable Internet access. Valid values: true: enables Internet access. false: disables Internet access. You can specify… |
| EipMax | integer | no | The Internet traffic. The specified Internet traffic must be greater than or equal to the current Internet traffic of the instance. For… |
| ServerlessConfig | string | no | The settings for the serverless instance. This parameter is required when you change the specifications of a serverless instance… |

### Upgrades a subscription instance
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/upgrade-pre-pay-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://alikafka.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| DiskSize | integer | no | The disk capacity. The disk capacity that you specify must be greater than or equal to the current disk capacity of the instance. For… |
| RegionId | string | yes | The region ID of the instance |
| IoMax | integer | no | The peak traffic (not recommended). The peak traffic that you specify must be greater than or equal to the current peak traffic of the… |
| SpecType | string | no | The specification type. Valid values for ApsaraMQ for Kafka instances: normal: Standard Edition (shared throughput) professional:… |
| PartitionNum | integer | no | The number of partitions (recommended). You must specify one of the number of partitions and the topic specification. Specify only the… |
| TopicQuota | integer | no | The number of topics (not recommended). You must specify one of the number of partitions and the topic specification. Specify only the… |
| EipModel | string | no | Specifies whether public network access is required. Valid values: true: Public network access is required. false: Public network access… |
| EipMax | integer | no | The public network traffic. The public network traffic that you specify must be greater than or equal to the current public network… |
| IoMaxSpec | string | no | The traffic specification (recommended). The traffic specification that you specify must be greater than or equal to the current traffic… |
| ConfluentConfig | string | no | The Confluent component configurations (JSON-encoded) |
| PaidType | integer | no | The billing type. Valid values: 0: subscription. 4: Confluent series subscription |

### version
`POST https://apizie.tech/v1/cloud:aliyun-alikafka/version` (byok)

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

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-alikafka/change-resource-group" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ApsaraMQ for Kafka API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-alikafka/change-resource-group with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ApsaraMQ for Kafka 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 Kafka itself also needs your own key from aliyuncs.com.

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

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