GetQueueAttributes - 获取队列属性_轻量消息队列（原 MNS）(SMQ)-阿里云帮助中心

获取某个已创建队列的属性。

接口说明

警告

为优化服务性能，轻量消息队列即将下线以下字段的返回值（后续默认为 0）：
- ActiveMessages
- InactiveMessages
- DelayMessages

请通过以下方式获取替代方案：

使用云监控 OpenAPI 获取队列指标，请参考云监控 OpenAPI 文档
云监控指标说明文档，替代字段对应关系：
- ActiveMessages → 云监控指标 NumberOfMessagesVisible
- InactiveMessages → 云监控指标 NumberOfMessagesInvisible
- DelayMessages → 云监控指标 NumberOfMessagesDelayed

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mns:GetQueueAttributes

get

*Queue

acs:mns:{#regionId}:{#accountId}:/queues/{#QueueName}

无

请求参数

名称	类型	必填	描述	示例值
QueueName	string	是	队列名称。	demo-queue
Tag	array<object>	否	资源标签列表。
	object	否	标签键对应的标签值。
Key	string	否	标签的 key。	tag1
Value	string	否	标签值。	test

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求的 ID。	06273500-249F-5863-121D-74D51123****
Code	integer	响应 code。	200
Status	string	响应的状态。	Success
Message	string	响应信息。	operation success
Success	boolean	请求是否成功。	true
Data	object	响应数据。
QueueName	string	Queue 的名称。	demo-queue
CreateTime	integer	Queue 的创建时间。	1250700999
LastModifyTime	integer	修改 Queue 属性信息最近时间，从 1970-01-01 00:00:00 到现在的时间。	1250700999
DelaySeconds	integer	发送到该 Queue 的所有消息的延迟时间，发送到队列的消息经过此参数设定的延时时间后，才能被消费，单位为秒。	30
MaximumMessageSize	integer	发送到该 Queue 的消息体的最大长度，单位为 Byte。	65536
MessageRetentionPeriod	integer	消息在该 Queue 中最长的存活时间，从发送到该队列开始经过此参数指定的时间后，不论消息是否被取出过都将被删除，单位为秒。	65536
VisibilityTimeout	integer	消息从该 Queue 中取出后从 Active 状态变成 Inactive 状态后的持续时间。取值范围：1~43200，单位为秒。默认值：30。	60
PollingWaitSeconds	integer	当 Queue 消息量为空时，针对该 Queue 的 ReceiveMessage 请求最长的等待时间，单位为秒。	0
ActiveMessages	integer	在该 Queue 中处于 Active 状态的消息总数，为近似值。警告后续会下线，默认为 0，不推荐使用，请使用云监控 api 获取指标。	0
InactiveMessages	integer	在该 Queue 中处于 Inactive 状态的消息总数，为近似值。警告后续会下线，默认为 0，不推荐使用，请使用云监控 api 获取指标。	0
DelayMessages	integer	在该 Queue 中处于 Delayed 状态的消息总数，为近似值。警告后续会下线，默认为 0，不推荐使用，请使用云监控 api 获取指标。	0
LoggingEnabled	boolean	是否开启日志管理功能。 True：启用。 False：停用。	True
Tags	array<object>	资源标签列表。
	object	标签键对应的标签值。
TagKey	string	标签的 key。	tag1
TagValue	string	标签值。	test
DlqPolicy	object	死信队列策略。
Enabled	boolean	是否开启死信消息投递。	true
DeadLetterTargetQueue	string	死信消息投递目标队列。	deadLetterTargetQueue
MaxReceiveCount	string	消息最大投递次数。	3
TenantRateLimitPolicy	object	限流策略
Enabled	boolean	是否启用限流。取值范围： true false	true
MaxReceivesPerSecond	integer	每秒最大接收次数	1000
QueueType	string	队列类型。可取值如下： normal: 普通队列 fifo: FIFO 队列	normal

示例

正常返回示例

JSON格式

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "operation success",
  "Success": true,
  "Data": {
    "QueueName": "demo-queue",
    "CreateTime": 1250700999,
    "LastModifyTime": 1250700999,
    "DelaySeconds": 30,
    "MaximumMessageSize": 65536,
    "MessageRetentionPeriod": 65536,
    "VisibilityTimeout": 60,
    "PollingWaitSeconds": 0,
    "ActiveMessages": 0,
    "InactiveMessages": 0,
    "DelayMessages": 0,
    "LoggingEnabled": true,
    "Tags": [
      {
        "TagKey": "tag1",
        "TagValue": "test"
      }
    ],
    "DlqPolicy": {
      "Enabled": true,
      "DeadLetterTargetQueue": "deadLetterTargetQueue",
      "MaxReceiveCount": "3"
    },
    "TenantRateLimitPolicy": {
      "Enabled": true,
      "MaxReceivesPerSecond": 1000
    },
    "QueueType": "normal"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。