Updated on 2022-12-07 GMT+08:00

Binding a Queue

Function

This API is used to bind a queue to a created enhanced datasource connection.

URI

  • URI format

    POST /v2.0/{project_id}/datasource/enhanced-connections/{connection_id}/associate-queue

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

    connection_id

    Yes

    String

    Connection ID. Identifies the UUID of a datasource connection. Set the value to the connection ID returned by Creating an Enhanced Datasource Connection.

Request

Table 2 Request parameters

Parameter

Mandatory

Type

Description

queues

Yes

Array of Strings

List of queue names that are available for datasource connections.

Response

Table 3 Response parameters

Parameter

Type

Description

is_success

Boolean

Indicates whether the request is successfully executed. Value true indicates that the request is successfully executed.

message

String

System prompt. If execution succeeds, the message may be left blank.

Example Request

{
  "queues": [
    "q1",
    "q2"
  ]
}

Example Response

{
  "is_success": true,
  "message": "associated peer connection for queues: {q1,q2}."
}

Status Codes

Table 4 describes the status code.

Table 4 Status codes

Status Code

Description

200

Resource bound succeeded.

400

Request error.

500

Internal service error.

Error Codes

If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Code.