OnsInstanceBaseInfo - - Centre de documentation Alibaba Cloud

Consulte les informations de base d'une instance et ses points de terminaison pour l'envoi et la réception de messages.

Description de l'opération

Important

L'OpenAPI fournie par Alibaba Cloud est une API de gestion utilisée pour gérer et interroger les ressources des services Alibaba Cloud. Intégrez l'OpenAPI uniquement à des fins de gestion. N'utilisez pas l'OpenAPI pour les liaisons de données principales qui envoient et reçoivent des messages. Cela peut créer des menaces de sécurité pour vos liaisons de données.

Les clients se connectent à ApsaraMQ for RocketMQ via des points de terminaison pour envoyer et recevoir des messages. Vous pouvez appeler cette opération pour interroger les points de terminaison d'une instance.

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.

mq:QueryInstanceBaseInfo

get

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
InstanceId	string	Oui	L'identifiant de l'instance à interroger.	MQ_INST_138015630679****_BAAy1Hac

Éléments de réponse

Élément	Type	Description	Exemple
	object
InstanceBaseInfo	object	L'objet d'informations de l'instance.
Endpoints	object	Les points de terminaison pour les différents protocoles.
TcpEndpoint	string	The internal endpoint for the TCP protocol.	http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080
TcpInternetEndpoint	string	The public endpoint for the TCP protocol. Only instances in the China (Chengdu), China (Qingdao), and China (Shenzhen) regions support public endpoints for the TCP protocol. To use the public endpoint for the TCP protocol, upgrade the client software development kit (SDK) to one of the following versions: Java SDK for TCP: 2.0.0.Final or later. For more information, see the Java SDK Version Guide. C++ SDK for TCP: 3.0.0 or later. For more information, see the C++ SDK Version Guide. Data transfer costs are incurred when you use the public endpoint for the TCP protocol. For more information, see Data transfer cost.	http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80
HttpInternetEndpoint	string	The public endpoint for the HTTP protocol.	http://138015630679****.mqrest.cn-chengdu.aliyuncs.com
HttpInternalEndpoint	string	The internal endpoint for the HTTP protocol.	http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com
HttpInternetSecureEndpoint	string	The public endpoint for the HTTPS protocol.	https://138015630679****.mqrest.cn-chengdu.aliyuncs.com
IndependentNaming	boolean	Indique si l'instance dispose d'un espace de noms. Valeurs valides : true : l'instance dispose d'un espace de noms indépendant. Les noms de ressources doivent être uniques au sein de l'instance. Les noms de ressources peuvent être identiques d'une instance à l'autre. false : l'instance ne dispose pas d'espace de noms indépendant. Les noms de ressources doivent être globalement uniques.	true
MaxTps	integer	Le nombre maximal de transactions par seconde (TPS) pour l'envoi et la réception de messages. Valeurs valides : 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000 et 1000000. Pour plus d'informations, consultez la page d'achat des instances. Remarque Ce paramètre s'applique uniquement aux instances ApsaraMQ for RocketMQ Platinum Edition.	10000
Remark	string	Les remarques sur l'instance.	ons-cn-m7r1r5f****
InstanceName	string	Le nom de l'instance. Le nom doit comporter entre 3 et 64 caractères et peut contenir des lettres, des chiffres, des tirets (-) et des traits de soulignement (_).	test
ReleaseTime	integer	L'heure d'expiration de l'instance Platinum Edition.	1603555200000
TopicCapacity	integer	Le nombre maximal de topics pouvant être créés sur l'instance. Valeurs valides : 25, 50, 100, 300 et 500. Remarque Ce paramètre s'applique uniquement aux instances ApsaraMQ for RocketMQ Platinum Edition.	50
InstanceStatus	integer	L'état de l'instance. Valeurs valides : 0 : l'instance Platinum Edition est en cours de déploiement. 2 : le paiement de l'instance Standard Edition est en retard. 5 : l'instance Standard Edition ou Platinum Edition est en service. 7 : l'instance Platinum Edition est en cours de mise à niveau et est disponible.	5
InstanceId	string	L'identifiant de l'instance.	MQ_INST_138015630679****_BAAy1Hac
InstanceType	integer	Le type de l'instance. Valeurs valides : 1 : instance Standard Edition (à la demande) 2 : instance Platinum Edition (abonnement) Pour plus d'informations sur les types et les spécifications des instances ApsaraMQ for RocketMQ, consultez Types d'instances.	2
CreateTime	string	L'heure de création de l'instance. La valeur de ce paramètre est un horodatage UNIX en millisecondes.	1570701259403
spInstanceId	string	L'identifiant de produit de l'instance.	ons-cn-m7r1r5f****
spInstanceType	integer	Le type de vente de l'instance. Valeurs valides : 1 : Instance Standard Edition (à la demande) 2 : Instance Platinum Edition (abonnement)	1
SupportClassic	integer		2
RequestId	string	Le paramètre commun. Chaque requête possède un identifiant unique que vous pouvez utiliser pour résoudre les problèmes.	6CC46974-65E8-4C20-AB07-D20D102E****

Exemples

JSON format

{
  "InstanceBaseInfo": {
    "Endpoints": {
      "TcpEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080",
      "TcpInternetEndpoint": "http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80",
      "HttpInternetEndpoint": "http://138015630679****.mqrest.cn-chengdu.aliyuncs.com",
      "HttpInternalEndpoint": "http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com",
      "HttpInternetSecureEndpoint": "https://138015630679****.mqrest.cn-chengdu.aliyuncs.com"
    },
    "IndependentNaming": true,
    "MaxTps": 10000,
    "Remark": "ons-cn-m7r1r5f****",
    "InstanceName": "test",
    "ReleaseTime": 1603555200000,
    "TopicCapacity": 50,
    "InstanceStatus": 5,
    "InstanceId": "MQ_INST_138015630679****_BAAy1Hac",
    "InstanceType": 2,
    "CreateTime": "1570701259403",
    "spInstanceId": "ons-cn-m7r1r5f****",
    "spInstanceType": 1,
    "SupportClassic": 2
  },
  "RequestId": "6CC46974-65E8-4C20-AB07-D20D102E****"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.