GetInstance - - Centre de documentation Alibaba Cloud

Obtient les détails d'une instance spécifiée.

Description de l'opération

Important Les opérations OpenAPI fournies par Alibaba Cloud sont des API de gestion utilisées pour gérer et interroger les ressources des services Alibaba Cloud. Utilisez-les uniquement dans les flux de travail de gestion et de contrôle. Ne vous appuyez pas sur OpenAPI dans les flux de travail principaux de liaison de données pour l'envoi et la réception de messages, car cela pourrait introduire des risques pour la liaison de données.

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.

rocketmq:GetInstance

get

*Instance.

acs:rocketmq:{#regionId}:{#accountId}:instance/{#InstanceId}

Aucune

Syntaxe de la requête

GET /instances/{instanceId} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance à interroger.	rmq-cn-7e22ody****

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Les données de réponse.
requestId	string	L'identifiant de la requête. Chaque requête possède un identifiant unique que vous pouvez utiliser pour dépanner et localiser les problèmes.	05AB7FBD-F1D3-5D87-BF78-BD782249****
success	boolean	Indique si l'opération a réussi.	true
data	object	Le résultat de la réponse.
regionId	string	L'identifiant de la région où se trouve l'instance.	cn-hangzhou
instanceId	string	L'identifiant de l'instance.	rmq-cn-7e22ody****
instanceName	string	Le nom de l'instance.	instance de test
status	string	L'état de l'instance. Valeurs valides : RELEASED : Libérée. RUNNING : En cours d'exécution. STOPPED : Arrêtée. CHANGING : En cours de modification. CREATING : En cours de création.	RUNNING
startTime	string	L'heure à laquelle l'instance a été démarrée. Le format est AAAA-MM-JJ HH:mm:ss.	2022-08-01 00:00:00
expireTime	string	L'heure à laquelle l'instance expire. Le format est AAAA-MM-JJ HH:mm:ss.	2022-09-01 00:00:00
releaseTime	string	L'heure à laquelle l'instance a été libérée. Le format est AAAA-MM-JJ HH:mm:ss.	2022-09-07 00:00:00
userId	string	L'identifiant de l'utilisateur auquel l'instance appartient.	111111111111111
bid	string	Le BID du canal de vente du produit.	26842
commodityCode	string	Le code produit d'une instance de la série MSMQ for RocketMQ 5.x, tel que ons_rmqsub_public_cn.	ons_rmqsub_public_cn
serviceCode	string	Le code de service de l'instance. Le code de service pour MSMQ for RocketMQ est rmq.	rmq
seriesCode	string	Le code de la série principale de l'instance. Pour connaître les différences entre les séries principales, consultez Sélection de produit. Valeurs valides : standard : Édition Standard. shared : Édition Partagée. dedicated : Édition Dédiée. ultimate : Édition Platinum. professional : Édition Professionnelle.	standard
subSeriesCode	string	Le code de la sous-série de l'instance. Pour connaître les différences entre les sous-séries, consultez Sélection de produit. Valeurs valides : serverless : Édition Serverless. cluster_ha : Édition haute disponibilité en cluster. single_node : Édition à nœud unique.	cluster_ha
paymentType	string	Le type de paiement de l'instance. Valeurs valides : PayAsYouGo : Paiement à l'usage (postpayé) Subscription : Abonnement (prépayé)	Subscription
remark	string	Les remarques de l'instance.	Ceci est une remarque pour l'instance
networkInfo	object	Les informations réseau.
vpcInfo	object	Les informations VPC.
vpcId	string	L'identifiant du VPC associé à l'instance.	vpc-uf6of9452b2pba82c****
vSwitchId `deprecated`	string	L'identifiant du vSwitch associé à l'instance. Important Ce champ n'est pas recommandé. Utilisez plutôt le champ vSwitches. Pour des raisons de compatibilité, ce champ ne renvoie actuellement qu'un seul vSwitch.	vsw-uf6gwtbn6etadpvz7****
vSwitches	array<object>	La liste des vSwitches.
	object
vSwitchId	string	L'identifiant du vSwitch.	vsw-uf6gwtbn6etadpvz7****
zoneId	string	L'identifiant de la zone.	cn-hangzhou
securityGroupIds	string	Les identifiants des groupes de sécurité.	sg-hp35r2hc3a3sv8q2sb16
endpoints	array<object>	Les informations sur les points de terminaison.
	object	Les informations sur les points de terminaison.
endpointType	string	Le type de point de terminaison de l'instance. Valeurs valides : TCP_VPC : Point de terminaison VPC. TCP_INTERNET : Point de terminaison Internet.	TCP_INTERNET
endpointUrl	string	Le point de terminaison de l'instance.	rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
ipWhitelist	array	La liste blanche d'adresses IP pour l'accès au réseau public. Les listes blanches d'adresses IP sont prises en charge uniquement pour les points de terminaison Internet et ne le sont pas pour les points de terminaison VPC. Si aucune liste blanche d'adresses IP n'est configurée, toutes les plages d'adresses IP sont autorisées à accéder au broker MSMQ for RocketMQ via Internet par défaut. Si une liste blanche d'adresses IP est configurée, seules les adresses IP figurant dans la liste blanche sont autorisées à accéder au broker MSMQ for RocketMQ via Internet. Ce champ n'est plus recommandé. Utilisez plutôt le champ internetInfo.ipWhitelist.	192.168.x.x/24
	string	La liste blanche d'adresses IP pour l'accès au réseau public.	192.168.x.x/24
endpointId	string	L'instance de point de terminaison PrivateLink associée.	ep-bpxxx
internetInfo	object	Les informations sur le réseau public de l'instance.
internetSpec	string	Indique si l'accès au réseau public est activé. L'instance prend en charge l'accès VPC par défaut. Si l'accès au réseau public est activé, ApsaraMQ for RocketMQ facture des frais pour la bande passante descendante sur le réseau public. Pour plus d'informations sur la facturation, consultez Frais d'accès au réseau public. Valeurs valides : enable : L'accès au réseau public est activé. disable : L'accès au réseau public est désactivé.	enable
flowOutType	string	Le type de facturation pour l'utilisation du réseau public. Valeurs valides : payByBandwidth : Facturation à bande passante fixe. Cette valeur est renvoyée lorsque l'accès au réseau public est activé. uninvolved : Non applicable. Cette valeur est renvoyée lorsque l'accès au réseau public n'est pas activé.	payByBandwidth
flowOutBandwidth	integer	La spécification de la bande passante Internet. Unité : Mbit/s.	1
ipWhitelist	array	La liste blanche d'adresses IP pour l'accès au réseau public. Si la liste blanche d'adresses IP n'est pas configurée, toutes les plages d'adresses IP sont autorisées à accéder au broker ApsaraMQ for RocketMQ via le réseau public par défaut. Si la liste blanche d'adresses IP est configurée, seules les adresses IP figurant dans la liste blanche sont autorisées à accéder au broker ApsaraMQ for RocketMQ via le réseau public.
	string	L'adresse IP dans la liste blanche d'accès au réseau public.	192.168.x.x/24
accountInfo	object	Les informations sur le compte.
username	string	Le nom d'utilisateur de l'instance. Lorsque vous utilisez l'accès au réseau public, vous devez configurer le nom d'utilisateur et le mot de passe de l'instance dans le code du SDK pour la vérification d'identité.	6W0xz2uPfiwp****
instanceQuotas	array<object>	Les informations sur la capacité.
	object	Les informations sur la capacité.
quotaName	string	Le nom du quota de l'instance. Valeurs valides : TOPIC_COUNT : Le quota de création de topics de l'instance.	TOPIC_COUNT
usedCount	number	Le quota utilisé. Unité : nombre.	10
freeCount	number	Le quota disponible. Unité : nombre.	20
totalCount	number	Le quota total. Unité : nombre.	100
createTime	string	L'heure à laquelle l'instance a été créée. La valeur est au format AAAA-MM-JJ HH:mm:ss.	2022-08-01 00:00:00
updateTime	string	L'heure de la dernière modification de l'instance. La valeur est au format AAAA-MM-JJ HH:mm:ss.	2022-08-02 00:00:00
extConfig `deprecated`	object	[Obsolète] La configuration étendue. Ce champ n'est plus recommandé. Utilisez plutôt les champs productInfo, internetInfo et aclInfo.
aclType	string	Le type d'authentification de l'instance. Valeurs valides : default : Reconnaissance d'identité intelligente. apache_acl : ACL Apache RocketMQ.	default
sendReceiveRatio	number	Le ratio entre l'envoi et la réception des messages.	0.5
autoScaling	boolean	Indique si la capacité élastique extensible au-delà de la spécification de base est activée. Ce paramètre prend effet uniquement lorsque la valeur de supportAutoScaling est enable, ce qui signifie que l'instance prend en charge l'activation de la capacité élastique. Valeurs valides : true : La capacité élastique est activée. false : La capacité élastique n'est pas activée.	true
messageRetentionTime	integer	La période de rétention des messages. Unité : heures. Pour la plage de valeurs, consultez Limites > Quotas de ressources > Période de rétention des messages. Le stockage des messages d'ApsaraMQ for RocketMQ est entièrement sans serveur et élastique. Vous êtes facturé en fonction de l'espace de stockage réellement utilisé. Vous pouvez contrôler la capacité de stockage en ajustant la période de rétention des messages. Pour plus d'informations, consultez Frais de stockage.	72
supportAutoScaling	boolean	Indique si l'instance prend en charge l'activation d'une capacité élastique extensible au-delà de la spécification de base. Une fois la capacité élastique extensible activée, ApsaraMQ for RocketMQ permet à l'instance de dépasser la limite de TPS de la spécification de base dans une certaine mesure. Des frais de spécification élastique supplémentaires sont facturés pour la partie qui dépasse la spécification de base. Pour plus d'informations sur la facturation, consultez Frais de calcul. Remarque Seules les instances de spécifications spécifiques prennent en charge la capacité élastique extensible. Pour plus d'informations sur les instances prises en charge, consultez Spécifications des instances. Valeurs valides : true : L'activation de la capacité élastique est prise en charge. false : L'activation de la capacité élastique n'est pas prise en charge.	true
internetSpec	string	Indique si l'accès au réseau public est activé. L'instance prend en charge l'accès VPC par défaut. Si l'accès au réseau public est activé, ApsaraMQ for RocketMQ facture des frais pour la bande passante descendante sur le réseau public. Pour plus d'informations sur la facturation, consultez Frais d'accès au réseau public. Valeurs valides : enable : L'accès au réseau public est activé. disable : L'accès au réseau public est désactivé.	enable
flowOutType	string	Le type de facturation pour l'utilisation du réseau public. Valeurs valides : payByTraffic : Facturation par trafic. payByBandwidth : Facturation par bande passante. uninvolved : Non applicable.	payByBandwidth
flowOutBandwidth	integer	La spécification de la bande passante Internet. Unité : Mbit/s.	10
msgProcessSpec	string	La spécification de traitement des messages. Pour la limite supérieure de TPS d'envoi et de réception des messages, consultez Spécifications des instances.	rmq.s2.2xlarge
resourceGroupId	string	L'identifiant du groupe de ressources.	rg-acfm3tmjruyribi
productInfo	object	La configuration étendue de l'instance.
msgProcessSpec	string	La spécification de traitement des messages. Pour la limite supérieure de TPS d'envoi et de réception des messages, consultez Spécifications des instances.	rmq.s2.2xlarge
sendReceiveRatio	number	Le ratio entre l'envoi et la réception des messages.	0.5
autoScaling	boolean	Indique si la capacité élastique extensible au-delà de la spécification de base est activée pour une mise à l'échelle transparente. Ce paramètre prend effet uniquement lorsque la valeur de supportAutoScaling est enable, ce qui signifie que l'instance prend en charge l'activation de la capacité élastique. Valeurs valides : true : La capacité élastique est activée. false : La capacité élastique n'est pas activée.	true
messageRetentionTime	integer	La période de rétention des messages. Unité : heures. Pour la plage de valeurs, consultez Limites > Quotas de ressources > Période de rétention des messages. Le stockage des messages d'ApsaraMQ for RocketMQ est entièrement sans serveur et élastique. Vous êtes facturé en fonction de l'espace de stockage réellement utilisé. Vous pouvez contrôler la capacité de stockage en ajustant la période de rétention des messages. Pour plus d'informations, consultez Frais de stockage.	72
supportAutoScaling	boolean	Indique si la capacité élastique extensible au-delà de la spécification de base est activée. Une fois la capacité élastique extensible activée, ApsaraMQ for RocketMQ permet à l'instance de dépasser la limite de TPS de la spécification de base dans une certaine mesure. Des frais de spécification élastique supplémentaires sont facturés pour la partie qui dépasse la spécification de base. Pour plus d'informations sur la facturation, consultez Frais de capacité de calcul. Remarque Seules les instances de spécifications spécifiques prennent en charge la capacité élastique extensible. Pour plus d'informations sur les instances prises en charge, consultez Spécifications des instances. Valeurs valides : true : L'activation de la capacité élastique est prise en charge. false : L'activation de la capacité élastique n'est pas prise en charge.	true
traceOn	boolean	Indique si la fonctionnalité de traçage des messages est activée. true : la fonctionnalité de traçage des messages est activée. false : la fonctionnalité de traçage des messages est désactivée. Ce paramètre n'est pas pris en compte. Les instances prennent en charge la fonctionnalité de traçage des messages par défaut, que ce paramètre soit activé ou non.	true
storageEncryption	boolean	Indique si le chiffrement du stockage est activé.	false
storageSecretKey	string	La clé de chiffrement du stockage.	xxxxx
capacityType	string	Le mode de capacité. Valeurs valides : provisioned : provisionné + élastique. ondemand : à la demande.	provisioned
provisionedCapacity	integer	La capacité provisionnée.	3000
drReplicationMode	string	Le mode de réplication interrégionale.	async_cross_az
maxDelayTime	integer	L'intervalle maximum pour les messages planifiés. Unité : secondes.	3456000
adaptiveElasticity	boolean	L'élasticité adaptative.	false
aclInfo	object	Les informations de contrôle d'accès.
aclTypes	array	Les types d'authentification de l'instance.
	string	Le type d'authentification de l'instance. Valeurs valides : default : Reconnaissance d'identité intelligente. apache_acl : Reconnaissance d'identité ACL.	default
defaultVpcAuthFree	boolean	Indique si la fonctionnalité sans authentification dans le VPC est activée. Valeurs valides : true : Activée. false : Désactivée.	true
aclType `deprecated`	string	Le type d'authentification de l'instance. Ce paramètre est obsolète. Utilisez plutôt le paramètre aclTypes. Valeurs valides : default : Reconnaissance d'identité intelligente. apache_acl : Reconnaissance d'identité ACL.	default
software	object	Les informations sur le logiciel de l'instance.
softwareVersion	string	La version du logiciel.	5.0-rmq-20230619-1
maintainTime `deprecated`	string	La fenêtre de temps de mise à niveau, au format HH:mm-HH:mm.	02:00-06:00
upgradeMethod	string	La méthode de mise à niveau. Valeurs valides : auto : Mise à niveau automatique. maunal : Mise à niveau manuelle.	auto
topicCount	integer	Le nombre de sujets.	10
groupCount	integer	Le nombre de groupes de consommateurs.	10
tags	array<object>	Les balises de ressource.
	object	La balise de ressource.
key	string	La clé de la balise de ressource.	key
value	string	La valeur de la balise de ressource.	value
autoRenew	boolean	Indique si le renouvellement automatique est activé.	false
autoRenewPeriod	integer	Indique si le renouvellement automatique est activé.	false
code	string	Le code d'erreur.	MissingInstanceId
message	string	Le message d'erreur.	Le paramètre instanceId est obligatoire pour cette action
httpStatusCode	integer	Le code d'état HTTP.	400
dynamicCode	string	Le code d'erreur dynamique.	InstanceId
dynamicMessage	string	Le message d'erreur dynamique.	instanceId

Exemples

JSON format

{
  "requestId": "05AB7FBD-F1D3-5D87-BF78-BD782249****",
  "success": true,
  "data": {
    "regionId": "cn-hangzhou",
    "instanceId": "rmq-cn-7e22ody****",
    "instanceName": "instance de test",
    "status": "RUNNING",
    "startTime": "2022-08-01 00:00:00",
    "expireTime": "2022-09-01 00:00:00",
    "releaseTime": "2022-09-07 00:00:00",
    "userId": "111111111111111",
    "bid": "26842",
    "commodityCode": "ons_rmqsub_public_cn",
    "serviceCode": "rmq",
    "seriesCode": "standard",
    "subSeriesCode": "cluster_ha",
    "paymentType": "Subscription",
    "remark": "Ceci est une remarque pour l'instance",
    "networkInfo": {
      "vpcInfo": {
        "vpcId": "vpc-uf6of9452b2pba82c****",
        "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
        "vSwitches": [
          {
            "vSwitchId": "vsw-uf6gwtbn6etadpvz7****",
            "zoneId": "cn-hangzhou"
          }
        ],
        "securityGroupIds": "sg-hp35r2hc3a3sv8q2sb16"
      },
      "endpoints": [
        {
          "endpointType": "TCP_INTERNET",
          "endpointUrl": "rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080",
          "ipWhitelist": [
            "192.168.x.x/24"
          ],
          "endpointId": "ep-bpxxx"
        }
      ],
      "internetInfo": {
        "internetSpec": "enable",
        "flowOutType": "payByBandwidth",
        "flowOutBandwidth": 1,
        "ipWhitelist": [
          "192.168.x.x/24"
        ]
      }
    },
    "accountInfo": {
      "username": "6W0xz2uPfiwp****"
    },
    "instanceQuotas": [
      {
        "quotaName": "TOPIC_COUNT",
        "usedCount": 10,
        "freeCount": 20,
        "totalCount": 100
      }
    ],
    "createTime": "2022-08-01 00:00:00 ",
    "updateTime": "2022-08-02 00:00:00 ",
    "extConfig": {
      "aclType": "default",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "internetSpec": "enable",
      "flowOutType": "payByBandwidth",
      "flowOutBandwidth": 10,
      "msgProcessSpec": "rmq.s2.2xlarge"
    },
    "resourceGroupId": "rg-acfm3tmjruyribi",
    "productInfo": {
      "msgProcessSpec": "rmq.s2.2xlarge",
      "sendReceiveRatio": 0.5,
      "autoScaling": true,
      "messageRetentionTime": 72,
      "supportAutoScaling": true,
      "traceOn": true,
      "storageEncryption": false,
      "storageSecretKey": "xxxxx",
      "capacityType": "provisioned",
      "provisionedCapacity": 3000,
      "drReplicationMode": "async_cross_az",
      "maxDelayTime": 3456000,
      "adaptiveElasticity": false
    },
    "aclInfo": {
      "aclTypes": [
        "default"
      ],
      "defaultVpcAuthFree": true,
      "aclType": "default"
    },
    "software": {
      "softwareVersion": "5.0-rmq-20230619-1",
      "maintainTime": "02:00-06:00",
      "upgradeMethod": "auto"
    },
    "topicCount": 10,
    "groupCount": 10,
    "tags": [
      {
        "key": "key",
        "value": "value"
      }
    ],
    "autoRenew": false,
    "autoRenewPeriod": 0
  },
  "code": "MissingInstanceId",
  "message": "Le paramètre instanceId est obligatoire pour cette action",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.