すべてのプロダクト
Search

このプロダクト

    :ListDocuments

    ドキュメントセンター

    :ListDocuments

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    gpdb:ListDocuments

    create

    *Document

    acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    説明

    リージョン内にあるすべての AnalyticDB for PostgreSQL インスタンス（インスタンス ID を含む）の詳細を照会するには、DescribeDBInstances 操作を呼び出してください。

    gp-xxxxxxxxx
    Namespace

    string

    任意

    名前空間の名称。デフォルト値：public。

    説明

    名前空間を作成するには CreateNamespace 操作を呼び出し、名前空間の一覧を照会するには ListNamespaces 操作を呼び出してください。

    mynamespace
    Collection

    string

    必須

    ドキュメントコレクションの名称。

    説明

    ドキュメントコレクションを作成するには CreateDocumentCollection 操作を呼び出し、ドキュメントコレクションの一覧を照会するには ListDocumentCollections 操作を呼び出してください。

    document
    RegionId

    string

    必須

    インスタンスのリージョン ID。

    cn-hangzhou
    NamespacePassword

    string

    必須

    名前空間のパスワード。

    説明

    この値は、CreateNamespace 操作を呼び出す際に指定します。

    testpassword
    MaxResults

    integer

    任意

    1 ページあたりの最大エントリ数。有効な値：1 ～ 100。

    100
    NextToken

    string

    任意

    次のリクエストで使用するページネーショントークンです。これにより、新しいページの結果を取得できます。最初のリクエストではこのパラメーターを指定する必要はありません。前のクエリから取得したトークンを NextToken の値として指定する必要があります。

    caeba0bbb2be03f84eb48b699f0a4883

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    RequestId

    string

    リクエスト ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Message

    string

    返されたメッセージ。

    Successful
    Status

    string

    リクエストが成功したかどうかを示します。有効な値：

    • success

    • fail

    success
    Items

    object

    DocumentList

    array<object>

    照会されたドキュメント。

    object

    照会されたドキュメント。

    FileName

    string

    ドキュメントの名称。

    music.txt
    Source

    string

    ドキュメントのソース。

    OSS
    NextToken

    string

    ページネーショントークン。次のリクエストで使用して、新しいページの結果を取得できます。NextToken が空の場合、次のページは存在しません。

    caeba0bbb2be03f84eb48b699f0a4883
    Count

    integer

    返されたエントリの合計数。

    3

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "Items": {
    "DocumentList": [
      {
        "FileName": "music.txt",
        "Source": "OSS"
      }
    ]
  },
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Count": 3
}

    エラーコード

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

    変更履歴

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