GetQueueAttributes - - Centre de documentation Alibaba Cloud

Obtient les attributs d'une file d'attente spécifiée.

Description de l'opération

Avertissement

Afin d'optimiser les performances du service, Simple Message Queue dépréciera prochainement les valeurs de retour des champs suivants, qui auront 0 comme valeur par défaut :
- ActiveMessages
- InactiveMessages
- DelayMessages

Utilisez les méthodes suivantes pour obtenir des alternatives :

Utilisez l'OpenAPI CloudMonitor pour récupérer les métriques de la file d'attente. Pour plus d'informations, consultez la documentation de l'OpenAPI CloudMonitor.
Documentation des métriques CloudMonitor. Le mappage des champs dépréciés vers les métriques alternatives est le suivant :
- ActiveMessages → métrique CloudMonitor NumberOfMessagesVisible
- InactiveMessages → métrique CloudMonitor NumberOfMessagesInvisible
- DelayMessages → métrique CloudMonitor NumberOfMessagesDelayed

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

mns:GetQueueAttributes

get

*File d'attente.

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

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
QueueName	string	Oui	Le nom de la file d'attente.	demo-queue
Tag	array<object>	Non	La liste des balises de ressource.
	object	Non	La valeur de balise correspondant à la clé de balise.
Key	string	Non	La clé de balise.	tag1
Value	string	Non	La valeur de balise.	test

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant de la requête.	06273500-249F-5863-121D-74D51123****
Code	integer	Le code de réponse.	200
Status	string	L'état de la réponse.	Success
Message	string	Le message de réponse.	operation success
Success	boolean	Indique si la requête a réussi.	true
Data	object	Les données de réponse.
QueueName	string	Le nom de la file d'attente.	demo-queue
CreateTime	integer	L'heure de création de la file d'attente. La valeur est un horodatage UNIX en secondes en UTC.	1250700999
LastModifyTime	integer	L'heure de la dernière modification des attributs de la file d'attente. La valeur est un horodatage UNIX en secondes en UTC.	1250700999
DelaySeconds	integer	Le délai pour tous les messages envoyés à la file d'attente. Les messages envoyés à la file d'attente ne peuvent être consommés qu'après l'expiration du délai spécifié par ce paramètre. Unité : secondes.	30
MaximumMessageSize	integer	La longueur maximale du corps du message pouvant être envoyé à la file d'attente. Unité : octets.	65536
MessageRetentionPeriod	integer	La durée de rétention maximale des messages dans la file d'attente. Une fois le délai spécifié par ce paramètre écoulé à partir de l'envoi d'un message à la file d'attente, le message est supprimé, qu'il ait été consommé ou non. Unité : secondes.	65536
VisibilityTimeout	integer	La durée pendant laquelle un message reste à l'état Inactive après avoir été consommé depuis la file d'attente. Valeurs valides : 1 à 43200. Unité : secondes. Valeur par défaut : 30.	60
PollingWaitSeconds	integer	Le temps d'attente maximal pour une requête ReceiveMessage lorsque la file d'attente est vide. Unité : secondes.	0
ActiveMessages	integer	Le nombre total approximatif de messages à l'état Active dans la file d'attente. Avertissement Ce champ sera déprécié et aura 0 comme valeur par défaut. Nous vous recommandons d'utiliser l'API CloudMonitor pour obtenir les métriques.	0
InactiveMessages	integer	Le nombre total approximatif de messages à l'état Inactive dans la file d'attente. Avertissement Ce champ sera déprécié et aura 0 comme valeur par défaut. Nous vous recommandons d'utiliser l'API CloudMonitor pour obtenir les métriques.	0
DelayMessages	integer	Le nombre total approximatif de messages à l'état Delayed dans la file d'attente. Avertissement Ce champ sera déprécié et aura 0 comme valeur par défaut. Nous vous recommandons d'utiliser l'API CloudMonitor pour obtenir les métriques.	0
LoggingEnabled	boolean	Indique si la fonctionnalité de gestion des journaux est activée. True : Activée. False : Désactivée.	True
Tags	array<object>	La liste des balises de ressource.
	object	La valeur de balise correspondant à la clé de balise.
TagKey	string	La clé de balise.	tag1
TagValue	string	La valeur de balise.	test
DlqPolicy	object	La stratégie de file d'attente de lettres mortes.
Enabled	boolean	Indique si la distribution des messages de lettres mortes est activée.	true
DeadLetterTargetQueue	string	La file d'attente de destination pour la distribution des messages de lettres mortes.	deadLetterTargetQueue
MaxReceiveCount	string	Le nombre maximal de tentatives de distribution pour un message.	3
TenantRateLimitPolicy	object	La stratégie de limitation.
Enabled	boolean	Indique si la limitation est activée. Valeurs valides : true false	true
MaxReceivesPerSecond	integer	Le nombre maximal de réceptions par seconde.	1000
QueueType	string	Le type de file d'attente. Valeurs valides : normal : File d'attente standard. fifo : File d'attente FIFO.	normal
EnableSSE	boolean	Indique si le chiffrement côté serveur est activé. Valeurs valides : true et false.	true
SseType	string	La méthode de chiffrement côté serveur. Valeurs valides : SMQ et KMS.	KMS
SseAlgorithm	string	L'algorithme de chiffrement côté serveur. Actuellement, seul AES-256-GCM est pris en charge. Si ce paramètre n'est pas spécifié, l'algorithme par défaut est utilisé.	AES-256-GCM
KmsKeyId	string	L'identifiant de la clé KMS.	key-xxx
EncryptionEnabled	boolean	Indique si le chiffrement côté serveur est activé.	true

Exemples

JSON format

{
  "RequestId": "06273500-249F-5863-121D-74D51123****",
  "Code": 200,
  "Status": "Success",
  "Message": "opération réussie",
  "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",
    "EnableSSE": true,
    "SseType": "KMS",
    "SseAlgorithm": "AES-256-GCM",
    "KmsKeyId": "key-xxx",
    "EncryptionEnabled": true
  }
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.