すべてのプロダクト
Search

このプロダクト

    :ListInstance

    ドキュメントセンター

    :ListInstance

    最終更新日:Mar 20, 2026

    インスタンスの一覧を取得します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cams:ListInstance

    list

    *Instance

    acs:cams:{#regionId}:{#accountId}:instance/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    ChannelType

    string

    任意

    チャネルの種類。有効な値は以下のとおりです。

    • whatsapp

    • messenger

    • instagram

    • viber

    VIBER
    InstanceName

    string

    任意

    インスタンス名。

    viber_ins
    SubmitTime

    string

    任意

    提出時刻（YYYY-MM-DD HH:MM:SS 形式）。

    2023-12-12 00:00:00
    PageSize

    integer

    任意

    1 ページあたりに返す項目数。

    87
    PageIndex

    integer

    任意

    返すページ番号。

    92
    ResourceGroupId

    string

    任意

    インスタンスを含むリソースグループの ID。

    11
    InstanceId

    string

    任意

    インスタンス ID。このパラメーターは、Alibaba Cloud 以外のホストでのみ使用します。

    r-uf6wd7pkyjwxvlxfhk
    FilterStr

    string

    任意

    クエリのフィルター文字列。

    aa

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答データ。

    AccessDeniedDetail

    string

    アクセス拒否の詳細情報。

    {}
    TotalCount

    integer

    指定された条件に一致するエントリの合計数。

    15
    RequestId

    string

    リクエスト ID。

    2993*****
    Message

    string

    応答メッセージ。

    NULL
    Data

    array<object>

    各要素がインスタンスを表すオブジェクトの配列。

    object

    インスタンスの詳細情報。

    CountryId

    string

    国 ID。

    1
    ContactMail

    string

    連絡先メールアドレス。

    ma**@gmail.com
    ResourceRegionId

    string

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

    11
    ResourceGroupId

    string

    リソースグループ ID。

    12
    InstanceId

    string

    インスタンス ID。

    29339****
    OfficeAddress

    string

    オフィス住所。

    example
    SubmitTime

    string

    インスタンスの提出時刻。

    2023-12-12 00:00:00
    InstanceName

    string

    インスタンス名。

    viber_ins
    CustSpaceId

    string

    カスタマースペース ID。

    dad-gf**
    IsvTerms

    string

    ISV / クライアント利用規約ファイルの名称。

    aa
    FacebookBmId

    string

    関連付けられた Facebook Business Manager アカウントの ID。

    1
    InstanceDescription

    string

    インスタンスの説明。

    ins
    ChannelType

    string

    チャネルの種類。

    VIBER
    State

    string

    インスタンスの状態。

    published
    Code

    string

    リクエストのステータスコード。

    • OK：リクエストが正常に完了したことを示します。

    • その他のエラーコードについては、「エラーコード一覧」をご参照ください。

    OK
    Success

    boolean

    呼び出しの成功 を示します。

    • true：呼び出しが成功しました。

    • false：呼び出しが失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "AccessDeniedDetail": "{}",
  "TotalCount": 15,
  "RequestId": "2993*****",
  "Message": "NULL",
  "Data": [
    {
      "CountryId": "1",
      "ContactMail": "ma**@gmail.com",
      "ResourceRegionId": "11",
      "ResourceGroupId": "12",
      "InstanceId": "29339****",
      "OfficeAddress": "example",
      "SubmitTime": "2023-12-12 00:00:00",
      "InstanceName": "viber_ins",
      "CustSpaceId": "dad-gf**",
      "IsvTerms": "aa",
      "FacebookBmId": "1",
      "InstanceDescription": "ins",
      "ChannelType": "VIBER",
      "State": "published"
    }
  ],
  "Code": "OK",
  "Success": true
}

    エラーコード

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

    変更履歴

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