Create an AMQP Queue

Function

This API is used by an application to create an AMQP queue on the IoT platform. Each tenant can create up to 100 queues. If the number of queues exceeds 100 or the name of a queue to create is the same as an existing queue name, the creation fails.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v5/iot/{project_id}/amqp-queues

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Parameter description: user token. You can obtain the token by calling the IAM API Obtaining a User Token Through Password Authentication. X-Subject-Token in the response header returned by the API is the desired user token. For details about how to obtain the token, see Token Authentication.
Instance-Id	No	String	Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
queue_name	Yes	String	Parameter description: queue name, which must be unique for a tenant. Value: The value can contain 8 to 128 characters. Only letters, digits, underscores (_), hyphens (-), periods (.), and colons (:) are allowed. Minimum: 8 Maximum: 128

Response Parameters

Status code: 201

**Table 4** Response body parameters
Parameter	Type	Description
queue_id	String	Unique queue ID.
queue_name	String	Queue name, which must be unique for the same tenant. Minimum: 8 Maximum: 128
create_time	String	Time when the queue was created on the platform. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.
last_modify_time	String	Time when the queue was last modified on the platform. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

Example Requests

Creates an AMQP queue named myQueue.

POST https://{endpoint}/v5/iot/{project_id}/amqp-queues

{
  "queue_name" : "myQueue"
}

Example Responses

Status code: 201

Created

{
  "queue_id" : "d4922d8a-6c8e-4396-852c-164aefa6638f",
  "queue_name" : "myQueue0",
  "create_time" : "20190303T081011Z",
  "last_modify_time" : "20190303T081011Z"
}