You need to enable JavaScript to run this app.
文档中心
消息队列 RabbitMQ版

消息队列 RabbitMQ版

复制全文
下载 pdf
白名单管理
DescribeAllowListDetail - 查询单个访问白名单详情
复制全文
下载 pdf
DescribeAllowListDetail - 查询单个访问白名单详情
调用 DescribeAllowListDetail 接口查询指定白名单的详细信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeAllowListDetail​
要执行的操作,取值:DescribeAllowListDetail。​
​
Version string 必选 示例值:2022-01-01​
API的版本,取值:2022-01-01。​
​
AllowListId string 必选 示例值:acl-d1d6af207f3d41f69af8bc5136a7****​
待查询的白名单 ID。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
AllowListId string 示例值:acl-d1d6af207f3d41f69af8bc5136a7****​
白名单 ID。​
​
AllowListName string 示例值:testlist​
白名单名称。​
​
AllowListDesc string 示例值:for-test​
白名单描述。​
​
AllowListType string 示例值:IPv4​
白名单类型。默认为 IPv4,表示允许白名单中的 IPv4 地址访问。​
​
AllowList string 示例值:["127.0.0.1"]​
IP 地址列表。​
​
AssociatedInstances object[] 示例值:详情请参见返回示例​
白名单绑定的实例信息列表,返回null表示未绑定任何实例。​
InstanceId string 示例值:rbtmq-6033c8a0****​
实例 ID。​
​
InstanceName string 示例值:test​
实例名称。​
​
VPC string 示例值:vpc-3ret6bva9k54w****​
实例所属 VPC 的 ID。​
​
​
​
​
请求示例​
​
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****"​
}​
​
返回示例​
​
{​
"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****"​
}​
]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
200​
OK​
OK​
成功。​
400​
InvalidParameter​
The specified parameter %s is not valid.​
参数值%s无效。​
400​
MissingParameter​
The request body is missing a required parameter %s.​
缺少%s参数。​
400​
InvalidPara​
The specified parameter is not valid.​
参数值无效。​
400​
UnsupportedParameter​
The specified parameter %s is unsupported.​
不支持%s参数。​
400​
OperationDenied.InvalidRequest​
The request that you specified is not valid.​
请求异常,请检查后重试。​
403​
OperationDenied.AccountNotAuthorized​
You are not authorized to perform this operation.​
您不具备相关权限 ,请授权或切换账号后重试。​
403​
OperationDenied.ResourceOccupied​
The resource is busy now, please try again later.​
资源繁忙,可能由于指定资源正在被访问或回收。​
403​
OperationDenied.InvalidInstanceStatus​
The operation is not valid for the current status of the instance.​
当前实例状态不允许执行该操作。​
403​
OperationDenied.TaskIsRunning​
An operation is currently in progress. Try again later.​
后台任务正在运行中,请稍后再试。​
403​
OperationDenied.VersionUnsupported​
The current instance version does not support this operation.Please upgrade the instance and try again.​
当前实例版本不支持指定操作,请升级实例后再试。​
404​
InvalidInstanceId.NotFound​
The specified Instance ID does not exist.​
实例不存在。​
404​
InvalidMessageId.NotFound​
The message ID does not exist in the instance %s.​
Message ID 不存在。​
404​
InvalidAccessKeyId.NotFound​
The specified accessKey does not exist.​
AccessKey 不存在。​
500​
InternalError​
The request failed due to some unknown error, exception or failure.​
内部错误,请稍后重试。​
500​
ResourceIsBusy​
The resource is busy now, please try again later.​
资源繁忙,可能由于指定资源正在被访问或回收。​
​
​
最近更新时间:2026.02.05 18:09:46
这个页面对您有帮助吗?
有用
有用
无用
无用