すべてのプロダクト
Search

このプロダクト

    :OnsInstanceBaseInfo

    ドキュメントセンター

    :OnsInstanceBaseInfo

    最終更新日:Dec 12, 2025

    OnsInstanceBaseInfo 操作を呼び出して、インスタンスの基本情報とメッセージを送受信するためのエンドポイントをクエリできます。

    操作説明

    重要 Alibaba Cloud が提供する OpenAPI は、Alibaba Cloud サービスリソースを管理およびクエリするための管理 API です。管理目的でのみ OpenAPI を統合してください。メッセージを送受信するコアデータリンクには OpenAPI を使用しないでください。データリンクにセキュリティ上の脅威をもたらす可能性があります。
    クライアントはエンドポイントを介して ApsaraMQ for RocketMQ に接続し、メッセージを送受信します。この操作を呼び出して、インスタンスのエンドポイントをクエリできます。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    mq:QueryInstanceBaseInfo

    get

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    クエリ対象のインスタンスの ID。

    MQ_INST_138015630679****_BAAy1Hac

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    InstanceBaseInfo

    object

    インスタンス情報オブジェクト。

    Endpoints

    object

    さまざまなプロトコルのエンドポイント。

    TcpEndpoint

    string

    TCP プロトコルの内部エンドポイント。

    http://MQ_INST_138015630679****_BAAy1Hac.cn-chengdu.mq-internal.aliyuncs.com:8080
    TcpInternetEndpoint

    string

    TCP プロトコルのパブリックエンドポイント。

    • 中国 (成都)、中国 (青島)、および中国 (深セン) リージョンのインスタンスのみが TCP プロトコルのパブリックエンドポイントをサポートします。

    • TCP プロトコルのパブリックエンドポイントを使用するには、クライアントソフトウェア開発キット (SDK) を次のいずれかのバージョンにアップグレードする必要があります。

    • TCP プロトコルのパブリックエンドポイントを使用すると、データ転送料金が発生します。詳細については、「データ転送料金」をご参照ください。

    http://MQ_INST_138015630679****_BAAy1Hac.mq.cn-chengdu.aliyuncs.com:80
    HttpInternetEndpoint

    string

    HTTP プロトコルのパブリックエンドポイント。

    http://138015630679****.mqrest.cn-chengdu.aliyuncs.com
    HttpInternalEndpoint

    string

    HTTP プロトコルの内部エンドポイント。

    http://138015630679****.mqrest.cn-chengdu-internal.aliyuncs.com
    HttpInternetSecureEndpoint

    string

    HTTPS プロトコルのパブリックエンドポイント。

    https://138015630679****.mqrest.cn-chengdu.aliyuncs.com
    IndependentNaming

    boolean

    インスタンスに名前空間があるかどうかを示します。有効な値：

    • true：インスタンスには独立した名前空間があります。リソース名はインスタンス内で一意である必要があります。リソース名はインスタンス間で同じにすることができます。

    • false：インスタンスには独立した名前空間がありません。リソース名はグローバルに一意である必要があります。

    true
    MaxTps

    integer

    メッセージを送受信するための 1 秒あたりの最大トランザクション数 (TPS)。有効な値： 5000、10000、20000、50000、100000、200000、300000、500000、800000、1000000。

    詳細については、インスタンスの購入ページをご参照ください。

    説明

    このパラメーターは、ApsaraMQ for RocketMQ Platinum Edition インスタンスにのみ適用されます。

    10000
    Remark

    string

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

    ons-cn-m7r1r5f****
    InstanceName

    string

    インスタンスの名前。

    名前は 3～64 文字で、英字、数字、ハイフン (-)、アンダースコア (_) を使用できます。

    test
    ReleaseTime

    integer

    Platinum Edition インスタンスの生存時間 (TTL)。

    1603555200000
    TopicCapacity

    integer

    インスタンスで作成できる Topic の最大数。有効な値： 25、50、100、300、500。

    説明

    このパラメーターは、ApsaraMQ for RocketMQ Platinum Edition インスタンスにのみ適用されます。

    50
    InstanceStatus

    integer

    インスタンスのステータス。有効な値：

    • 0：Platinum Edition インスタンスはデプロイ中です。

    • 2：Standard Edition インスタンスの支払いが期限切れです。

    • 5：Standard Edition または Platinum Edition インスタンスはサービス中です。

    • 7：Platinum Edition インスタンスはアップグレード中で、利用可能です。

    5
    InstanceId

    string

    インスタンスの ID。

    MQ_INST_138015630679****_BAAy1Hac
    InstanceType

    integer

    インスタンスのタイプ。有効な値：

    • 1：Standard Edition (従量課金) インスタンス

    • 2：Platinum Edition (サブスクリプション) インスタンス

    ApsaraMQ for RocketMQ インスタンスのタイプと仕様の詳細については、「インスタンスタイプ」をご参照ください。

    2
    CreateTime

    string

    インスタンスが作成された時間。 このパラメーターの値は、ミリ秒単位の UNIX タイムスタンプです。

    1570701259403
    spInstanceId

    string

    インスタンスの商品 ID。

    ons-cn-m7r1r5f****
    spInstanceType

    integer

    インスタンスの販売タイプ。

    列挙値:

    • 1 :

      Standard Edition (従量課金) インスタンス

    • 2 :

      Platinum Edition (サブスクリプション) インスタンス

    1
    RequestId

    string

    共通パラメーター。各リクエストには、問題のトラブルシューティングに使用できる一意の ID があります。

    6CC46974-65E8-4C20-AB07-D20D102E****

    例

    成功レスポンス

    JSONJSON

    {
  "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
  },
  "RequestId": "6CC46974-65E8-4C20-AB07-D20D102E****"
}

    エラーコード

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

    変更履歴

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