OnsInstanceCreate - ApsaraMQ for RocketMQ - Alibaba Cloud Documentation Center

Operation description

Important Alibaba Cloud OpenAPI is a management API. You can use it to manage and query Alibaba Cloud service resources. Integrate OpenAPI for management purposes only. Do not use OpenAPI for core data links that send and receive messages because this can introduce security threats to your data links.

An instance is a virtual machine resource for ApsaraMQ for RocketMQ that stores topic and group information. This operation is typically used to create a service resource when you publish a new service.

This operation supports only the creation of standard instances. It does not support Platinum instances. The ApsaraMQ for RocketMQ console supports the creation of both standard and Platinum instances. For more information, see Instance management.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mq:CreateInstance

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Remark	string	No	The description of the instance.	备注说明
InstanceName	string	Yes	The name of the instance. The name must meet the following requirements: The instance name must be unique in the region where the instance is deployed. The name must be 3 to 64 characters in length and can contain Chinese characters, letters, digits, hyphens (-), and underscores (_).	测试实例

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. This ID is unique to each request. You can use this ID to troubleshoot issues.	A07E3902-B92E-44A6-B6C5-6AA111111****
Data	object	The data returned.
InstanceId	string	The ID of the created instance.	MQ_INST_188077086902****_BXSuW61e
InstanceType	integer	The type of the created instance. Valid value: 1: standard instance	1

Examples

Success response

JSON format

{
  "RequestId": "A07E3902-B92E-44A6-B6C5-6AA111111****",
  "Data": {
    "InstanceId": "MQ_INST_188077086902****_BXSuW61e",
    "InstanceType": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.