すべてのプロダクト
Search

このプロダクト

    Identity as a Service:ListBrands

    ドキュメントセンター

    Identity as a Service:ListBrands

    最終更新日:Jun 22, 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    eiam:ListBrands

    list

    *Brand

    acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/brand/*

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンスID。

    idaas_ue2jvisn35ea5lmthk267xxxxx
    NextToken

    string

    任意

    ページネーショントークン。

    NTxxxxxexample
    PreviousToken

    string

    任意

    前のページのページネーショントークン。

    PTxxxxxexample
    MaxResults

    integer

    任意

    ページングクエリのページあたりのエントリ数。

    20

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエストID。

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    TotalCount

    integer

    リスト内のエントリの合計数。

    100
    NextToken

    string

    今回の呼び出しで返されたページネーショントークン。

    NTxxxexample
    PreviousToken

    string

    今回の呼び出しで返されたページネーショントークン。

    PTxxxexample
    MaxResults

    integer

    ページングクエリのページあたりのエントリ数。

    20
    Brands

    array<object>

    ブランドデータのリスト。

    object

    ブランドデータ。

    InstanceId

    string

    インスタンスID。

    idaas_ue2jvisn35ea5lmthk267xxxxx
    BrandId

    string

    ブランドID。

    brand_xxxx
    BrandName

    string

    ブランド名。

    Custom Brand
    BrandType

    string

    ブランドタイプ。

    列挙値:

    • system_init :

      システム初期化。

    • user_custom :

      ユーザー定義。

    user_custom
    Status

    string

    ブランドステータス。

    列挙値:

    • disabled :

      無効。

    • enabled :

      有効。

    enabled

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "PreviousToken": "PTxxxexample",
  "MaxResults": 20,
  "Brands": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "BrandId": "brand_xxxx",
      "BrandName": "Custom Brand",
      "BrandType": "user_custom",
      "Status": "enabled"
    }
  ]
}

    エラーコード

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

    変更履歴

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