All Products
Search
Document Center

ApsaraMQ for RabbitMQ:CreateVirtualHost

Last Updated:Sep 12, 2024

Creates a vhost. A vhost is used to logically isolate resources. Each vhost manages its own exchanges, queues, and bindings. Applications can run on independent vhosts in a secure manner. This way, the business of an application is not affected by other applications. Before you connect producers and consumers to an ApsaraMQ for RabbitMQ instance, you must specify vhosts for the producers and consumers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
amqp:CreateVhostcreate
  • VirtualHost
    acs:amqp:{#regionId}:{#accountId}:/instances/{#instanceId}/vhosts/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the ApsaraMQ for RabbitMQ instance.

amqp-cn-v0h1kb9n***
VirtualHoststringYes

The name of the vhost that you want to create. Valid values:

  • The name can contain letters, digits, hyphens (-), underscores (_), periods (.), number signs (#), forward slash (/), and at signs (@).
  • The name must be 1 to 255 characters in length.
  • After the vhost is created, you cannot change its name. If you want to change the name of a vhost, delete the vhost and create another vhost.
Demo

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

628705FD-03EE-4ABE-BB21-E1672960***

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history