すべてのプロダクト
Search

このプロダクト

    :GetInstance

    ドキュメントセンター

    :GetInstance

    最終更新日:Feb 04, 2026

    指定されたインスタンスの詳細を取得します。

    操作説明

    重要 Alibaba Cloud OpenAPI は、Alibaba Cloud サービスリソースを管理・照会するための管理用アプリケーションプログラミングインターフェイス (API) です。この API は管理目的でのみ使用してください。データリンクにリスクをもたらす可能性があるため、メッセージの送受信などコアデータパス上での使用は避けてください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    rocketmq:GetInstance

    get

    *Instance

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

    		 なし なし

    リクエスト構文

    GET /instances/{instanceId} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    照会対象のインスタンス ID。

    rmq-cn-7e22ody****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    requestId

    string

    リクエスト ID。各リクエストには一意の ID が割り当てられます。問題のトラブルシューティング時にこの ID を使用してください。

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

    boolean

    リクエストが成功したかどうかを示します。

    true
    data

    object

    返された結果。

    regionId

    string

    インスタンスが配置されているリージョンの ID。

    cn-hangzhou
    instanceId

    string

    インスタンス ID。

    rmq-cn-7e22ody****
    instanceName

    string

    インスタンス名。

    test instance
    status

    string

    インスタンスのステータス。

    有効値：

    • RELEASED：インスタンスはリリース済みです。

    • RUNNING：インスタンスは実行中です。

    • STOPPED：インスタンスは停止しています。

    • CHANGING：インスタンスは変更中です。

    • CREATING：インスタンスは作成中です。

    列挙値:

    • RELEASED :

      リリース済み

    • RUNNING :

      実行中

    • STOPPED :

      停止中

    • CHANGING :

      変更中

    • CREATING :

      作成中

    RUNNING
    startTime

    string

    インスタンスの起動時刻。

    2022-08-01 00:00:00
    expireTime

    string

    インスタンスの有効期限。

    2022-09-01 00:00:00
    releaseTime

    string

    インスタンスのリリース時刻。

    2022-09-07 00:00:00
    userId

    string

    インスタンスの所有者ユーザー ID。

    111111111111111
    bid

    string

    販売チャネルの BID。

    26842
    commodityCode

    string

    ApsaraMQ for RocketMQ 5.x シリーズインスタンスの商品コード（例：ons_rmqsub_public_cn）。

    ons_rmqsub_public_cn
    serviceCode

    string

    インスタンスのサービスコード。ApsaraMQ for RocketMQ のサービスコードは rmq です。

    rmq
    seriesCode

    string

    インスタンスのプライマリシリーズコード。プライマリシリーズ間の違いについては、「プロダクト選択」をご参照ください。

    有効値：

    • standard：Standard Edition

    • ultimate：Platinum Edition

    • professional：Professional Edition

    • shared：Shared Edition

    • dedicated：Exclusive Edition

    列挙値:

    • standard :

      Standard Edition

    • ultimate :

      Platinum Edition

    • professional :

      Professional Edition

    standard
    subSeriesCode

    string

    インスタンスのサブシリーズコード。サブシリーズ間の違いについては、「プロダクト選択」をご参照ください。

    有効値：

    • cluster_ha：High-availability Edition

    • single_node：Single Node Edition

    • serverless：Serverless Edition

    列挙値:

    • cluster_ha :

      High-availability Edition

    • single_node :

      Single Node Edition

    cluster_ha
    paymentType

    string

    インスタンスの課金方法。

    有効値：

    • PayAsYouGo：従量課金

    • Subscription：サブスクリプション

    列挙値:

    • PayAsYouGo :

      従量課金

    • Subscription :

      サブスクリプション

    Subscription
    remark

    string

    インスタンスに関する備考。

    This is remark for instance.
    networkInfo

    object

    ネットワーク情報。

    vpcInfo

    object

    Virtual Private Cloud (VPC) 情報。

    vpcId

    string

    インスタンスに関連付けられた VPC の ID。

    vpc-uf6of9452b2pba82c****
    vSwitchId deprecated

    string

    インスタンスに関連付けられた vSwitch の ID。

    重要 このフィールドは非推奨です。代わりに vSwitches フィールドを使用してください。互換性のため、このフィールドは現在 1 つの vSwitch のみを返します。

    vsw-uf6gwtbn6etadpvz7****
    vSwitches

    array<object>

    vSwitch のリスト。

    object

    vSwitchId

    string

    vSwitch ID。

    vsw-uf6gwtbn6etadpvz7****
    zoneId

    string

    ゾーン ID。

    cn-hangzhou
    securityGroupIds

    string

    セキュリティグループ ID。

    sg-hp35r2hc3a3sv8q2sb16
    endpoints

    array<object>

    エンドポイント情報。

    object

    エンドポイント情報。

    endpointType

    string

    インスタンスエンドポイントのタイプ。

    列挙値:

    • TCP_VPC :

      VPC エンドポイント

    • TCP_INTERNET :

      パブリックエンドポイント

    TCP_INTERNET
    endpointUrl

    string

    インスタンスのエンドポイント。

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

    array

    パブリックネットワークアクセス用の IP アドレスホワイトリスト。IP アドレスホワイトリストはパブリックエンドポイントに対してのみ設定可能です。VPC エンドポイントではこの機能はサポートされていません。

    • IP アドレスホワイトリストを設定しない場合、デフォルトですべての IP アドレスから ApsaraMQ for RocketMQ サーバーにパブリックネットワーク経由でアクセスできます。

    • IP アドレスホワイトリストを設定した場合、ホワイトリスト内の IP アドレスからのみ ApsaraMQ for RocketMQ サーバーにパブリックネットワーク経由でアクセスできます。

    このフィールドは非推奨です。代わりに internetInfo.ipWhitelist フィールドを使用してください。

    192.168.x.x/24

    string

    パブリックネットワークアクセス用の IP アドレスホワイトリスト。

    192.168.x.x/24
    endpointId

    string

    関連付けられた PrivateLink エンドポイント (EP) インスタンス。

    ep-bpxxx
    internetInfo

    object

    インスタンスのパブリックネットワーク情報。

    internetSpec

    string

    パブリックネットワークアクセスを有効にするかどうかを示します。

    有効値：

    • enable：パブリックネットワークアクセスが有効です。

    • disable：パブリックネットワークアクセスが無効です。

    インスタンスはデフォルトで VPC アクセスをサポートしています。パブリックネットワークアクセスを有効にすると、ApsaraMQ for RocketMQ はパブリック帯域幅のダウンストリームに対して課金されます。課金の詳細については、「パブリックネットワークアクセス料金」をご参照ください。

    列挙値:

    • enable :

      有効

    • disable :

      無効

    enable
    flowOutType

    string

    パブリックネットワーク利用の課金方法。

    有効値：

    • payByBandwidth：帯域幅課金。この値はパブリックネットワークアクセスが有効な場合に適用されます。

    • uninvolved：該当なし。この値はパブリックネットワークアクセスが無効な場合に適用されます。

    列挙値:

    • payByBandwidth :

      帯域幅課金

    • uninvolved :

      該当なし

    payByBandwidth
    flowOutBandwidth

    integer

    パブリック帯域幅仕様。単位：Mbps。

    1
    ipWhitelist

    array

    パブリックアクセスホワイトリスト内の IP アドレスのリスト。

    • IP アドレスホワイトリストを設定しない場合、デフォルトですべての IP アドレスから ApsaraMQ for RocketMQ サーバーにパブリックネットワーク経由でアクセスできます。

    • IP アドレスホワイトリストを設定した場合、ホワイトリスト内の IP アドレスからのみ ApsaraMQ for RocketMQ サーバーにパブリックネットワーク経由でアクセスできます。

    string

    パブリックネットワークアクセス用の IP アドレスホワイトリスト。

    192.168.x.x/24
    accountInfo

    object

    アカウント情報。

    username

    string

    インスタンスのユーザー名。パブリックネットワーク経由でインスタンスにアクセスする際は、SDK コード内でユーザー名とパスワードを設定して本人確認を行ってください。

    6W0xz2uPfiwp****
    instanceQuotas

    array<object>

    容量情報。

    object

    容量情報。

    quotaName

    string

    インスタンスクォータの名前。

    有効値：

    • TOPIC_COUNT：インスタンスの Topic クォータ。

    列挙値:

    • TOPIC_COUNT :

      インスタンスの Topic クォータ。

    TOPIC_COUNT
    usedCount

    number

    使用量。単位：個。

    10
    freeCount

    number

    未使用クォータ。単位：個。

    20
    totalCount

    number

    合計クォータ。単位：個。

    100
    createTime

    string

    インスタンスの作成時刻。

    2022-08-01 00:00:00

    updateTime

    string

    インスタンスの最終更新時刻。

    2022-08-02 00:00:00

    extConfig deprecated

    object

    拡張構成。このフィールドは非推奨です。代わりに productInfo、internetInfo、aclInfo などのフィールドを使用してください。

    aclType

    string

    インスタンスの認証タイプ。

    有効値：

    • default：インテリジェント本人確認

    列挙値:

    • default :

      インテリジェント本人確認

    default
    sendReceiveRatio

    number

    送信メッセージ数と受信メッセージ数の比率。

    0.5
    autoScaling

    boolean

    仕様を超えたエラスティックスケーリングを有効にするかどうかを示します。

    有効値：

    • true：有効

    • false：無効

    このパラメーターは、supportAutoScaling パラメーターが enable（インスタンスがエラスティックスケーリングをサポート）に設定されている場合にのみ有効です。

    列挙値:

    • true :

      有効

    • false :

      無効

    true
    messageRetentionTime

    integer

    メッセージ保存期間。単位：時間。

    値の範囲については、「制限事項」＞「リソースクォータ」のメッセージ保存期間に関する制限をご参照ください。

    ApsaraMQ for RocketMQ のメッセージストレージは完全にサーバーレスかつエラスティックです。実際の使用ストレージ容量に対して課金されます。メッセージ保存期間を調整することでストレージ容量を制御できます。詳細については、「ストレージ料金」をご参照ください。

    72
    supportAutoScaling

    boolean

    インスタンスが仕様を超えたエラスティックスケーリングをサポートしているかどうかを示します。

    有効値：

    • true：サポート

    • false：非サポート

    エラスティックスケーリングを有効にすると、ApsaraMQ for RocketMQ は基本仕様の TPS 制限を超えて一定範囲内でインスタンスの処理能力を拡張します。基本仕様を超えるエラスティックスペックに対しては追加料金が発生します。課金の詳細については、「コンピューティング容量料金」をご参照ください。

    説明

    特定の仕様のインスタンスのみがエラスティックスケーリングをサポートしています。サポート対象のインスタンスについては、「インスタンスタイプ」をご参照ください。

    列挙値:

    • true :

      サポート

    • false :

      非サポート

    true
    internetSpec

    string

    パブリックネットワークアクセスを有効にするかどうかを示します。

    有効値：

    • enable：有効

    • disable：無効

    インスタンスはデフォルトで VPC アクセスをサポートしています。パブリックネットワークアクセスを有効にすると、ApsaraMQ for RocketMQ はパブリック帯域幅のダウンストリームに対して課金されます。課金の詳細については、「パブリックネットワークアクセス料金」をご参照ください。

    列挙値:

    • enable :

      有効

    • disable :

      無効

    enable
    flowOutType

    string

    パブリックネットワーク利用の課金方法。

    有効値：

    • payByTraffic：トラフィック課金

    • payByBandwidth：帯域幅課金

    • uninvolved：該当なし

    列挙値:

    • payByTraffic :

      トラフィック課金

    • payByBandwidth :

      帯域幅課金

    • uninvolved :

      該当なし

    payByBandwidth
    flowOutBandwidth

    integer

    パブリック帯域幅仕様。単位：Mbps。

    10
    msgProcessSpec

    string

    メッセージ送受信のコンピューティング仕様。メッセージ送受信の TPS 上限については、「インスタンスタイプ」をご参照ください。

    rmq.s2.2xlarge
    resourceGroupId

    string

    リソースグループ ID。

    rg-acfm3tmjruyribi
    productInfo

    object

    インスタンスの拡張構成。

    msgProcessSpec

    string

    メッセージ送受信のコンピューティング仕様。メッセージ送受信の TPS 上限については、「インスタンスタイプ」をご参照ください。

    rmq.s2.2xlarge
    sendReceiveRatio

    number

    送信メッセージ数と受信メッセージ数の比率。

    0.5
    autoScaling

    boolean

    仕様を超えたエラスティックスケーリングを有効にするかどうかを示します。

    有効値：

    • true：有効

    • false：無効

    このパラメーターは、supportAutoScaling パラメーターが enable（インスタンスがエラスティックスケーリングをサポート）に設定されている場合にのみ有効です。

    列挙値:

    • true :

      有効

    • false :

      無効

    true
    messageRetentionTime

    integer

    メッセージ保存期間。単位：時間。

    値の範囲については、「制限事項」＞「リソースクォータ」のメッセージ保存期間に関する制限をご参照ください。

    ApsaraMQ for RocketMQ のメッセージストレージは完全にサーバーレスかつエラスティックです。実際の使用ストレージ容量に対して課金されます。メッセージ保存期間を調整することでストレージ容量を制御できます。詳細については、「ストレージ料金」をご参照ください。

    72
    supportAutoScaling

    boolean

    インスタンスが仕様を超えたエラスティックスケーリングをサポートしているかどうかを示します。

    有効値：

    • true：サポート

    • false：非サポート

    エラスティックスケーリングを有効にすると、ApsaraMQ for RocketMQ は基本仕様の TPS 制限を超えて一定範囲内でインスタンスの処理能力を拡張します。基本仕様を超えるエラスティックスペックに対しては追加料金が発生します。課金の詳細については、「コンピューティング容量料金」をご参照ください。

    説明

    特定の仕様のインスタンスのみがエラスティックスケーリングをサポートしています。サポート対象のインスタンスについては、「インスタンスタイプ」をご参照ください。

    列挙値:

    • true :

      サポート

    • false :

      非サポート

    true
    traceOn

    boolean

    メッセージトレース機能が有効かどうかを示します。

    • true：有効

    • false：無効

    このパラメーターはまだ有効ではありません。メッセージトレース機能は、このパラメーターの設定に関係なくデフォルトでサポートされています。

    true
    storageEncryption

    boolean

    ストレージ暗号化が有効かどうかを示します。

    false
    storageSecretKey

    string

    ストレージ暗号化のキー。

    xxxxx
    capacityType

    string

    容量モード：

    • provisioned：プロビジョニング + エラスティック

    • ondemand：オンデマンド

    列挙値:

    • provisioned :

      プロビジョニング + エラスティック

    • ondemand :

      オンデマンド

    provisioned
    provisionedCapacity

    integer

    プロビジョニングされた容量。

    3000
    aclInfo

    object

    アクセスの制御情報。

    aclTypes

    array

    インスタンスの認証タイプのリスト。

    string

    インスタンスの認証タイプ。

    列挙値:

    • default :

      インテリジェント本人確認

    • apache_acl :

      ACL ベースの本人確認

    default
    defaultVpcAuthFree

    boolean

    内部ネットワーク経由での認証不要アクセスのスイッチ。

    列挙値:

    • true :

      有効

    • false :

      無効

    true
    aclType deprecated

    string

    インスタンスの認証タイプ。このフィールドは非推奨です。代わりに aclTypes フィールドを使用してください。

    列挙値:

    • default :

      インテリジェント本人確認

    • apache_acl :

      ACL ベースの本人確認

    default
    software

    object

    インスタンスのソフトウェア情報。

    softwareVersion

    string

    ソフトウェアバージョン。

    5.0-rmq-20230619-1
    maintainTime

    string

    アップグレードタイムウィンドウ。

    02:00-06:00
    upgradeMethod

    string

    アップグレード方法。

    有効値：

    • auto：自動

    • manual：手動

    列挙値:

    • auto :

      自動

    • maunal :

      手動

    auto
    topicCount

    integer

    Topic 数。

    10
    groupCount

    integer

    使用者グループ数。

    10
    tags

    array<object>

    リソースタグのリスト。

    object

    リソースタグ。

    key

    string

    リソースタグのキー。

    key
    value

    string

    リソースタグの値。

    value
    code

    string

    エラーコード。

    MissingInstanceId
    message

    string

    エラーメッセージ。

    Parameter instanceId is mandatory for this action .
    httpStatusCode

    integer

    HTTP ステータスコード。

    400
    dynamicCode

    string

    動的エラーコード。

    InstanceId
    dynamicMessage

    string

    動的エラーメッセージ。

    instanceId

    例

    成功レスポンス

    JSONJSON

    {
  "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
    },
    "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"
      }
    ]
  },
  "code": "MissingInstanceId",
  "message": "Parameter instanceId is mandatory for this action .",
  "httpStatusCode": 400,
  "dynamicCode": "InstanceId",
  "dynamicMessage": "instanceId"
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。