すべてのプロダクト
Search

このプロダクト

    :ListProduct

    ドキュメントセンター

    :ListProduct

    最終更新日:Nov 13, 2025

    カタログ内のプロダクトのリストをクエリします。

    操作説明

    この API は、各ユーザーに 1 秒あたり 10 クエリ (QPS) の制限を設けています。この制限を超えると、システムは 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cams:ListProduct

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    CatalogId

    string

    必須

    カタログ ID。カタログ ID は Meta プラットフォームから取得できます。

    2939838xxxx
    Fields

    string

    任意

    返すフィールドのリスト。複数のフィールドはコンマ (,) で区切ります。 詳細については、「プロダクトフィールド」をご参照ください。

    id,name
    Before

    string

    任意

    結果の前ページの末尾を指すカーソル。

    wiidkd939kek93
    After

    string

    任意

    結果の次のページの先頭を指すカーソル。

    kdkii48jfjjei3
    Limit

    integer

    任意

    返すアイテムの数。有効な値: 1～1000。

    73
    CustSpaceId

    string

    任意

    ISV サブカスタマーのスペース ID。

    C2939838xxxx
    WabaId

    string

    必須

    WhatsApp Business Account (WABA) ID。

    3848747xxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    AccessDeniedDetail

    string

    アクセス拒否に関する詳細。

    None
    Message

    string

    リクエストが失敗した場合に返されるメッセージ。

    None
    RequestId

    string

    リクエスト ID。

    90E63D28-E31D-1EB2-8939-A94866411B2O
    Model

    object

    返されたデータ。

    Paging

    object

    ページングの詳細。

    Cursors

    object

    ページング用のカーソル。

    Before

    string

    前のページを指すカーソル。

    sjjsjdjjdjd83883
    After

    string

    次のページを指すカーソル。

    sjsuueu83838
    Data

    array<object>

    返されたデータ。

    object

    プロダクトデータ。

    {"id":"293983883", "name":"product1"}
    Code

    string

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

    • `OK` の値は、リクエストが成功したことを示します。

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

    OK
    Success

    boolean

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

    • true: リクエストは成功しました。

    • false: リクエストは失敗しました。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Model": {
    "Paging": {
      "Cursors": {
        "Before": "sjjsjdjjdjd83883",
        "After": "sjsuueu83838"
      }
    },
    "Data": [
      {
        "id": "293983883",
        "name": "product1"
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

    エラーコード

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

    変更履歴

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