すべてのプロダクト
Search

このプロダクト

    :DescribeDocument

    ドキュメントセンター

    :DescribeDocument

    最終更新日:Jul 04, 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:DescribeDocument

    create

    *Document

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID です。

    説明

    特定のリージョンにあるすべての AnalyticDB for PostgreSQL インスタンスの詳細 (インスタンス ID を含む) を照会するには、DescribeDBInstances API を呼び出します。

    gp-xxxxxxxxx
    Namespace

    string

    任意

    名前空間の名前です。デフォルト値は public です。

    説明

    名前空間を作成するには CreateNamespace API を呼び出します。既存の名前空間を照会するには ListNamespaces API を呼び出します。

    mynamespace
    NamespacePassword

    string

    必須

    名前空間のパスワードです。

    説明

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

    testpassword
    Collection

    string

    必須

    ドキュメントコレクションの名前です。

    説明

    ドキュメントコレクションを作成するには CreateDocumentCollection API を呼び出します。既存のドキュメントコレクションを照会するには ListDocumentCollections API を呼び出します。

    document
    RegionId

    string

    必須

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

    cn-hangzhou
    FileName

    string

    必須

    ファイル名です。

    説明

    ドキュメントを照会するには、ListDocuments API を呼び出します。

    music.txt

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスオブジェクトです。

    RequestId

    string

    リクエスト ID です。

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

    string

    返されるメッセージです。

    success
    Status

    string

    API リクエストのステータスです。有効な値：

    • success：リクエストは成功です。

    • fail：リクエストは失敗です。

    success
    FileName

    string

    ファイル名です。

    music.txt
    FileExt

    string

    ファイルの拡張子です。

    txt
    FileVersion

    integer

    ドキュメントバージョンです。ドキュメントが更新されるたびに、この値は 1 増加します。

    1
    FileMtime

    string

    ドキュメントが最後に変更された時刻です。

    2023-11-01 10:01:01.123456
    Source

    string

    ドキュメントのソースです。

    OSS

    DocumentLoader

    string

    ドキュメントローダーの名前です。

    RapidOCRPDFLoader
    TextSplitter

    string

    テキストスプリッターの名前です。

    ChineseRecursiveTextSplitter
    FileSize

    integer

    ファイルサイズです。単位はバイトです。

    10000
    FileMd5

    string

    ファイルの MD5 ハッシュ値です。

    b8078c9591413550f8963e37e24abcea
    DocsCount

    integer

    ドキュメントを分割した際のチャンク数です。

    100
    FileUrl

    string

    ドキュメントのダウンロード URL です。この URL の有効期限は 2 時間です。

    http://oss.xxx/music.txt
    PlainChunkFileUrl

    string

    メタデータなしのドキュメントチャンクを含むプレーンテキストファイルのダウンロード URL です。ファイル内の各行が 1 つのチャンクです。この URL の有効期限は 2 時間です。

    http://oss.xxx/music_plain_chunk.txt
    ChunkFileUrl

    string

    チャンクを含むファイルのダウンロード URL です。この URL の有効期限は 2 時間です。ファイルは JSONL フォーマットです。各行は JSON オブジェクトで、次の構造になります：{"page_content":"*****", "metadata": {"**":"***","**":"***"}}。

    http://oss.xxx/music_chunk.jsonl
    DocumentLoaderResultFileUrl

    string

    ADBPGLoader ドキュメントローダーで解析された Markdown ファイルのダウンロード URL です。この URL の有効期限は 2 時間です。

    http://oss.xxx/adbpg_loader_result.md

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "FileName": "music.txt",
  "FileExt": "txt",
  "FileVersion": 1,
  "FileMtime": "2023-11-01 10:01:01.123456",
  "Source": "OSS\n",
  "DocumentLoader": "RapidOCRPDFLoader",
  "TextSplitter": "ChineseRecursiveTextSplitter",
  "FileSize": 10000,
  "FileMd5": "b8078c9591413550f8963e37e24abcea",
  "DocsCount": 100,
  "FileUrl": "http://oss.xxx/music.txt",
  "PlainChunkFileUrl": "http://oss.xxx/music_plain_chunk.txt",
  "ChunkFileUrl": "http://oss.xxx/music_chunk.jsonl",
  "DocumentLoaderResultFileUrl": "http://oss.xxx/adbpg_loader_result.md"
}

    エラーコード

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

    変更履歴

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