CreateVirtualHost - ApsaraMQ for RabbitMQ - Alibaba Cloud Documentation Center

A vhost, or virtual host, provides logical isolation by managing its own exchanges, queues, and bindings. This allows applications to run securely on different vhosts without interfering with each other. Producers and consumers must specify a vhost to connect to an ApsaraMQ for RabbitMQ instance.

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

amqp:CreateVhost

create

*VirtualHost

acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the ApsaraMQ for RabbitMQ instance.	amqp-cn-v0h1kb9n***
VirtualHost	string	Yes	The name of the vhost to create. The name must meet the following requirements: The name can contain only letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slashes (/), and at signs (@). The name must be 1 to 255 characters in length. The vhost name cannot be changed after creation. To use a different name, delete the vhost and create a new one.	Demo

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	628705FD-03EE-4ABE-BB21-E1672960***

Examples

Success response

JSON format

{
  "RequestId": "628705FD-03EE-4ABE-BB21-E1672960***"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.