Docs

Message Queue for RabbitMQ

Allowlist management

DescribeAllowListDetail - Query allowlist details

Call DescribeAllowListDetail to query detailed information of the specified allowlist.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Only the unique request parameters of this interface and some common parameters are listed below. For more information, see common parameters.

Action string requiredExample: DescribeAllowListDetail

Operation to perform: DescribeAllowListDetail.

Version string requiredExample value: 2022-01-01

API version, value: 2022-01-01.

AllowListId string required Example value: acl-d1d6af207f3d41f69af8bc5136a7****

ID of the allowlist to query.

Response parameters

Only the unique response parameters of this API are listed below. For more details, see response structure.

AllowListId string Example value: acl-d1d6af207f3d41f69af8bc5136a7****

Allowlist ID.

AllowListName string Example: testlist

Allowlist name.

Allowlist description string Example: for-test

Allowlist description.

AllowListType string Example: IPv4

Allowlist type. The default is IPv4, allowing access from IPv4 addresses in the allowlist.

AllowList string Example value: ["127.0.0.1"]

IP address list.

AssociatedInstances object[] Example: See response example

List of instance information associated with the allowlist returnednullNo instances are bound.

Instance ID string Example: rbtmq-6033c8a0****

Instance ID.

Instance name string Example: test

Instance name.

VPC string Example: vpc-3ret6bva9k54w****

ID of the VPC where the instance belongs.

Request example

POST /?Action=DescribeAllowListDetail&Version=2022-01-01 HTTP/1.1​
Host: rabbitmq.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260107T103901Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260107/cn-beijing/RabbitMQ/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{​
  "AllowListId": "acl-d1d6af207f3d41f69af8bc5136a7****"​
}​

Response example

{​
  "ResponseMetadata": {​
    "RequestId": "20260107185628222151079043DD****",​
    "Action": "DescribeAllowListDetail",​
    "Version": "2022-01-01",​
    "Service": "RabbitMQ",​
    "Region": "cn-beijing"​
  },​
  "Result": {​
    "AllowListId": "acl-d1d6af207f3d41f69af8bc5136a7****",​
    "AllowListName": "testlist",​
    "AllowListDesc": "for-test",​
    "AllowListType": "IPv4",​
    "AllowList": "[\"1270.0.0.1\"]",​
    "AssociatedInstances": [​
      {​
        "InstanceId": "rbtmq-6033c8a0****",​
        "InstanceName": "test",​
        "VPC": "vpc-3ret6bva9k54w****"​
      }​
    ]​
  }​
}​

Error code

Error codesThe following table lists error codes related to this interface and business logic. Refer to the Public error codes section for common error codes.

Status code	Error code	Error message	description
200	OK	OK	Success.
400	InvalidParameter	The specified parameter %s is not valid.	The parameter value %s is invalid.
400	MissingParameter	The request body is missing a required parameter %s.	Missing %s parameter.
400	InvalidPara	The specified parameter is not valid.	The parameter value is invalid.
400	UnsupportedParameter	The specified parameter %s is unsupported.	The %s parameter is not supported.
400	OperationDenied.InvalidRequest	The request that you specified is not valid.	Request error. Check and try again.
403	OperationDenied.AccountNotAuthorized	You are not authorized to perform this operation.	You are not authorized. Authorize or switch accounts and try again.
403	OperationDenied.ResourceOccupied	The resource is busy now, please try again later.	The resource is busy, possibly because it is being accessed or reclaimed.
403	OperationDenied.InvalidInstanceStatus	The operation is not valid for the current status of the instance.	The current instance state does not allow this operation.
403	OperationDenied.TaskIsRunning	An operation is currently in progress. Try again later.	Background tasks are running, please try again later.
403	OperationDenied.VersionUnsupported	The current instance version does not support this operation.Please upgrade the instance and try again.	The current instance version does not support this operation. Upgrade the instance and try again.
404	InvalidInstanceId.NotFound	The specified Instance ID does not exist.	Instance does not exist.
404	InvalidMessageId.NotFound	The message ID does not exist in the instance %s.	Message ID does not exist.
404	InvalidAccessKeyId.NotFound	The specified accessKey does not exist.	AccessKey does not exist.
500	InternalError	The request failed due to some unknown error, exception or failure.	Internal error, please try again later.
500	ResourceIsBusy	The resource is busy now, please try again later.	The resource is busy, possibly because it is being accessed or reclaimed.

Last updated: 2026.02.06 14:27:45