Tous les produits
Search

Ce produit

    :GetInstance

    Centre de documentation

    :GetInstance

    Dernière mise à jour :Aug 06, 2026

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

    Description de l'opération

    Important L'OpenAPI fournie par Alibaba Cloud est une API de gestion et de contrôle utilisée pour gérer et interroger les ressources associées des services Alibaba Cloud. Elle est recommandée uniquement pour l'intégration dans les liens de gestion et de contrôle. L'utilisation de l'OpenAPI dans le lien de données principal pour l'envoi et la réception de messages est strictement interdite. Dans le cas contraire, des risques peuvent survenir sur le lien.

    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 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, qui peut être utilisé pour résoudre les problèmes.

    05AB7FBD-F1D3-5D87-BF78-BD782249****
    success

    boolean

    Indique si l'opération a réussi.

    true
    data

    object

    Les données de réponse.

    regionId

    string

    L'identifiant de la région de 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 de démarrage de l'instance.

    2022-08-01 00:00:00
    expireTime

    string

    L'heure d'expiration de l'instance.

    2022-09-01 00:00:00
    releaseTime

    string

    L'heure de libération de l'instance.

    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 du produit de l'instance de file d'attente MSMQ pour 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 la file d'attente MSMQ pour 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 du 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 du produit.

    Valeurs valides :

    • serverless :

      Édition Serverless.

    • cluster_ha :

      Édition haute disponibilité en cluster.

    • single_node :

      Édition nœud unique.

    cluster_ha
    paymentType

    string

    La méthode de facturation 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

    The VPC information.

    vpcId

    string

    The ID of the VPC associated with the instance.

    vpc-uf6of9452b2pba82c****
    vSwitchId deprecated

    string

    The ID of the vSwitch associated with the instance.

    vsw-uf6gwtbn6etadpvz7****
    vSwitches

    array<object>

    The vSwitch list.

    object

    vSwitchId

    string

    The vSwitch ID.

    vsw-uf6gwtbn6etadpvz7****
    zoneId

    string

    The zone ID.

    cn-hangzhou
    securityGroupIds

    string

    The security group ID.

    sg-hp35r2hc3a3sv8q2sb16
    endpoints

    array<object>

    The endpoint information.

    object

    The endpoint information.

    endpointType

    string

    The endpoint type of the instance.

    Valeurs valides :

    • TCP_VPC :

      VPC endpoint.

    • TCP_INTERNET :

      Public endpoint.

    TCP_INTERNET
    endpointUrl

    string

    The endpoint of the instance.

    rmq-cn-c4d2tbk****-vpc.cn-hangzhou.rmq.aliyuncs.com:8080
    ipWhitelist

    array

    The public network access IP whitelist. Only public endpoints support IP whitelist configuration. VPC endpoints do not support this feature.

    192.168.x.x/24

    string

    The public network access IP whitelist.

    192.168.x.x/24
    endpointId

    string

    The associated PrivateLink endpoint instance.

    ep-bpxxx
    internetInfo

    object

    The public network information of the instance.

    internetSpec

    string

    Indicates whether public network access is enabled.

    Valeurs valides :

    • enable :

      Public network access is enabled.

    • disable :

      Public network access is disabled.

    enable
    flowOutType

    string

    The billing type for public network usage.

    Valeurs valides :

    • payByBandwidth :

      Fixed bandwidth billing. This value is returned when public network access is enabled.

    • uninvolved :

      Not applicable. This value is returned when public network access is not enabled.

    payByBandwidth
    flowOutBandwidth

    integer

    The Internet bandwidth specification. Unit: Mbit/s.

    1
    ipWhitelist

    array

    The IP whitelist for public network access.

    string

    The IP whitelist entry for public network access.

    192.168.x.x/24
    accountInfo

    object

    Les informations du compte.

    username

    string

    The username of the instance. When you use public network access, you must configure the username and password of the instance in the SDK code for identity verification.

    6W0xz2uPfiwp****
    instanceQuotas

    array<object>

    Les informations sur la capacité.

    object

    Les informations sur la capacité.

    quotaName

    string

    The quota name of the instance.

    Valeurs valides :

    • TOPIC_COUNT :

      The topic creation quota of the instance.

    TOPIC_COUNT
    usedCount

    number

    The used quota. Unit: count.

    10
    freeCount

    number

    The free quota. Unit: count.

    20
    totalCount

    number

    The total quota. Unit: count.

    100
    createTime

    string

    L'heure de création de l'instance.

    2022-08-01 00:00:00

    updateTime

    string

    L'heure de la dernière modification de l'instance.

    2022-08-02 00:00:00

    extConfig deprecated

    object

    La configuration étendue. Ce champ est obsolète. Utilisez plutôt les champs productInfo, internetInfo et aclInfo.

    aclType

    string

    The authentication type of the instance.

    Valeurs valides :

    • default :

      Intelligent identity recognition.

    • apache_acl :

      Apache RocketMQ ACL

    default
    sendReceiveRatio

    number

    The ratio of message sending to message receiving.

    0.5
    autoScaling

    boolean

    Indicates whether out-of-specification burstable elastic capacity is enabled.

    Valeurs valides :

    • true :

      Burstable elastic capacity is enabled.

    • false :

      Burstable elastic capacity is not enabled.

    true
    messageRetentionTime

    integer

    The message retention period. Unit: hours.

    72
    supportAutoScaling

    boolean

    Indicates whether the instance supports out-of-specification burstable elastic capacity.

    Valeurs valides :

    • true :

      Burstable elastic capacity is supported.

    • false :

      Burstable elastic capacity is not supported.

    true
    internetSpec

    string

    Indicates whether public network access is enabled.

    Valeurs valides :

    • enable :

      Public network access is enabled.

    • disable :

      Public network access is disabled.

    enable
    flowOutType

    string

    The billing type for public network usage.

    Valeurs valides :

    • payByTraffic :

      Pay-by-traffic.

    • payByBandwidth :

      Pay-by-bandwidth.

    • uninvolved :

      Not applicable.

    payByBandwidth
    flowOutBandwidth

    integer

    The Internet bandwidth specification. Unit: Mbit/s.

    10
    msgProcessSpec

    string

    The message processing specification. For the TPS upper limit of message sending and receiving, see Instance specifications.

    rmq.s2.2xlarge
    resourceGroupId

    string

    L'identifiant du groupe de ressources.

    rg-acfm3tmjruyribi
    productInfo

    object

    La configuration étendue de l'instance.

    msgProcessSpec

    string

    The message processing specification. For the TPS upper limit of message sending and receiving, see Instance specifications.

    rmq.s2.2xlarge
    sendReceiveRatio

    number

    The ratio of message sending to message receiving.

    0.5
    autoScaling

    boolean

    Indicates whether out-of-specification burstable elastic capacity is enabled for lossless scaling.

    Valeurs valides :

    • true :

      Burstable elastic capacity is enabled.

    • false :

      Burstable elastic capacity is not enabled.

    true
    messageRetentionTime

    integer

    The message retention period. Unit: hours.

    72
    supportAutoScaling

    boolean

    Indicates whether the burstable elasticity capability beyond the specification is supported.

    Valeurs valides :

    • true :

      Burstable elastic capacity is supported.

    • false :

      Burstable elastic capacity is not supported.

    true
    traceOn

    boolean

    Indicates whether the message trace feature is enabled.

    true
    storageEncryption

    boolean

    Indicates whether storage encryption is enabled.

    false
    storageSecretKey

    string

    The storage encryption key.

    xxxxx
    capacityType

    string

    The capacity mode.

    Valeurs valides :

    • provisioned :

      reserved + elastic.

    • ondemand :

      pay-as-you-go.

    provisioned
    provisionedCapacity

    integer

    The reserved capacity.

    3000
    drReplicationMode

    string

    The cross-region replication mode.

    async_cross_az
    maxDelayTime

    integer

    The maximum interval for scheduled messages. Unit: seconds.

    3456000
    adaptiveElasticity

    boolean

    The adaptive elasticity configuration.

    false
    aclInfo

    object

    Les informations de contrôle d'accès.

    aclTypes

    array

    The list of authentication types for the instance.

    string

    The authentication type of the instance.

    Valeurs valides :

    • default :

      Intelligent identity recognition.

    • apache_acl :

      ACL identity recognition.

    default
    defaultVpcAuthFree

    boolean

    Indicates whether authentication-free access over the internal network is enabled.

    Valeurs valides :

    • true :

      enabled.

    • false :

      disabled.

    true
    aclType deprecated

    string

    The authentication type of the instance. This field is deprecated. Use the aclTypes field instead.

    Valeurs valides :

    • default :

      Intelligent identity recognition.

    • apache_acl :

      ACL identity recognition.

    default
    software

    object

    Les informations logicielles de l'instance.

    softwareVersion

    string

    The software version.

    5.0-rmq-20230619-1
    maintainTime deprecated

    string

    The upgrade time window.

    02:00-06:00
    upgradeMethod

    string

    The upgrade method.

    Valeurs valides :

    • auto :

      Automatic upgrade.

    • maunal :

      Manual upgrade.

    auto
    topicCount

    integer

    Le nombre de sujets.

    10
    groupCount

    integer

    Le nombre de groupes de consommateurs.

    10
    tags

    array<object>

    La liste des balises de ressource.

    object

    La balise de ressource.

    key

    string

    The key of the resource tag.

    key
    value

    string

    The value of the resource tag.

    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": "test instance",
    "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": "This is remark for 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": "Parameter instanceId is mandatory for this 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.