OnsInstanceBaseInfo - - Centre de documentation Alibaba Cloud

Remarques sur l'utilisation

Pour publier et recevoir des messages, un client doit se connecter à une instance Message Queue for Apache RocketMQ via un endpoint. Appelez cette opération pour interroger les endpoints de l'instance.

Limites des requêtes

Vous pouvez appeler cette opération jusqu'à 50 fois par seconde avec chaque compte Alibaba Cloud. Si le nombre d'appels par seconde dépasse la limite, un mécanisme de limitation du débit (throttling) est déclenché, ce qui peut affecter votre activité. Nous vous recommandons de prendre en compte cette limite lors de l'appel à cette opération. Pour plus d'informations, consultez la rubrique Limites des requêtes.

Autorisation

Par défaut, seuls les comptes Alibaba Cloud peuvent appeler cette opération. Un utilisateur RAM (Resource Access Management) ne peut appeler cette opération qu'après avoir reçu les autorisations nécessaires. Le tableau suivant décrit les autorisations à accorder à un utilisateur RAM pour appeler cette opération. Pour savoir comment accorder des autorisations, consultez la rubrique Politiques et exemples.

API	Action	Resource
OnsInstanceBaseInfo	mq:QueryInstanceBaseInfo	acs:mq:::{instanceId}

Paramètres de requête

Parameter	Type	Required	Example	Description
Action	String	Yes	OnsInstanceBaseInfo	Opération à effectuer. Définissez la valeur sur OnsInstanceBaseInfo.
InstanceId	String	Yes	MQ_INST_138015630679****_BAAy1Hac	ID de l'instance à interroger.

Paramètres de réponse

Parameter	Type	Example	Description
InstanceBaseInfo	Object		Informations relatives à l'instance.
Endpoints	Object		Endpoints correspondant aux différents protocoles.
TcpEndpoint	String	http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080	Endpoint TCP privé de l'instance.
TcpInternetEndpoint	String	http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80	Endpoint TCP public de l'instance. Seules les instances des régions Chine (Chengdu), Chine (Qingdao) ou Chine (Shenzhen) prennent en charge les endpoints TCP publics. Avant d'utiliser un endpoint TCP public, mettez à niveau le SDK client vers la version correspondante : SDK client TCP pour Java : V2.0.0.Final ou ultérieure. Pour plus d'informations, consultez les Notes de version du SDK pour Java. SDK client TCP pour C++ : V3.0.0 ou ultérieure. Pour plus d'informations, consultez les Notes de version du SDK pour C++. Des frais de transfert de données s'appliquent lors de l'utilisation d'un endpoint TCP public. Pour plus d'informations, consultez la rubrique relative aux Coûts de transfert de données.
HttpInternetEndpoint	String	http://138015630679****.mqrest.cn-chengdu.aliyuncs.com	Endpoint HTTP public de l'instance.
HttpInternalEndpoint	String	http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com	Endpoint HTTP privé de l'instance.
HttpInternetSecureEndpoint	String	https://138015630679****.mqrest.cn-chengdu.aliyuncs.com	Endpoint HTTPS public de l'instance.
IndependentNaming	Boolean	true	Indique si un namespace est configuré pour l'instance. Valeurs possibles : true : Un namespace distinct est configuré pour l'instance. Le nom de chaque ressource doit être unique au sein de l'instance. Les noms des ressources de différentes instances peuvent être identiques. false : Aucun namespace distinct n'est configuré pour l'instance. Le nom de chaque ressource doit être globalement unique parmi toutes les instances.
MaxTps	Long	10000	Nombre maximal de transactions par seconde (TPS) pour la publication et la souscription aux messages. Valeurs possibles : 5000, 10000, 20000, 50000, 100000, 200000, 300000, 500000, 800000 et 1000000. Pour plus d'informations, consultez la description sur la page d'achat. Remarque Ce paramètre est disponible uniquement pour les instances Message Queue for Apache RocketMQ de l'édition Enterprise Platinum.
Remark	String	onspre-cn-m7r1r5f****	Description de l'instance.
InstanceName	String	test	Nom de l'instance. Le nom doit comporter entre 3 et 64 caractères et peut contenir des lettres, des chiffres, des traits d'union (-) et des traits de soulignement (_).
ReleaseTime	Long	1603555200000	Date et heure d'expiration de l'instance de l'édition Enterprise Platinum.
TopicCapacity	Integer	50	Nombre maximal de topics pouvant être créés sur l'instance. Valeurs possibles : 25, 50, 100, 300 et 500. Remarque Ce paramètre est disponible uniquement pour les instances Message Queue for Apache RocketMQ de l'édition Enterprise Platinum.
InstanceStatus	Integer	5	État de l'instance. Valeurs possibles : 0 : L'instance est en cours de déploiement. Cette valeur est valide uniquement pour les instances de l'édition Enterprise Platinum. 2 : L'instance a expiré ou présente des impayés. Cette valeur est valide pour les instances de l'édition Standard. 5 : L'instance est en cours d'exécution. 7 : L'instance est en cours de mise à niveau et en cours d'exécution. Cette valeur est valide uniquement pour les instances de l'édition Enterprise Platinum.
InstanceId	String	MQ_INST_138015630679****_BAAy1Hac	ID de l'instance.
InstanceType	Integer	2	Édition de l'instance. Valeurs possibles : 1 : Édition Standard (paiement à l'utilisation) 2 : Édition Enterprise Platinum (abonnement) Pour obtenir des informations sur les éditions et les spécifications des instances Message Queue for Apache RocketMQ, consultez la rubrique relative aux Éditions d'instance.
RequestId	String	6CC46974-65E8-4C20-AB07-D20D102E****	ID de la requête. Le système génère un ID unique pour chaque requête. Vous pouvez résoudre les problèmes en vous basant sur l'ID de requête.

Exemples

Exemple de requête

http(s)://ons.cn-chengdu.aliyuncs.com/?Action=OnsInstanceBaseInfo
&InstanceId=MQ_INST_138015630679****_BAAy1Hac
&Common request parameters

Exemple de réponse réussie

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<OnsInstanceBaseInfoResponse>
    <InstanceBaseInfo>
        <Endpoints>
            <TcpEndpoint>http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080</TcpEndpoint>
            <HttpInternetEndpoint>http://138015630679****.mqrest.cn-chengdu.aliyuncs.com</HttpInternetEndpoint>
            <HttpInternalEndpoint>http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com</HttpInternalEndpoint>
            <HttpInternetSecureEndpoint>https://138015630679****.mqrest.cn-chengdu.aliyuncs.com</HttpInternetSecureEndpoint>
            <TcpInternetEndpoint>http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80</TcpInternetEndpoint>
        </Endpoints>
        <IndependentNaming>true</IndependentNaming>
        <MaxTps>10000</MaxTps>
        <Remark>onspre-cn-m7r1r5f****</Remark>
        <InstanceName>test</InstanceName>
        <ReleaseTime>1603555200000</ReleaseTime>
        <TopicCapacity>50</TopicCapacity>
        <InstanceStatus>5</InstanceStatus>
        <InstanceId>MQ_INST_138015630679****_BAAy1Hac</InstanceId>
        <InstanceType>2</InstanceType>
    </InstanceBaseInfo>
    <RequestId>6CC46974-65E8-4C20-AB07-D20D102E****</RequestId>
</OnsInstanceBaseInfoResponse>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "InstanceBaseInfo" : {
    "Endpoints" : {
      "TcpEndpoint" : "http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080",
      "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",
      "TcpInternetEndpoint" : "http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80"
    },
    "IndependentNaming" : true,
    "MaxTps" : 10000,
    "Remark" : "onspre-cn-m7r1r5f****",
    "InstanceName" : "test",
    "ReleaseTime" : 1603555200000,
    "TopicCapacity" : 50,
    "InstanceStatus" : 5,
    "InstanceId" : "MQ_INST_138015630679****_BAAy1Hac",
    "InstanceType" : 2
  },
  "RequestId" : "6CC46974-65E8-4C20-AB07-D20D102E****"
}

Codes d'erreur

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.