すべてのプロダクト
Search

このプロダクト

    OpenSearch:DescribeDataCollction

    ドキュメントセンター

    OpenSearch:DescribeDataCollction

    最終更新日:Nov 24, 2025

    指定されたアプリケーションのデータ収集の詳細を取得します。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    opensearch:DescribeDataCollection

    get

    *DataCollection

    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

    		 なし なし

    リクエスト構文

    GET /v4/openapi/app-groups/{appGroupIdentity}/data-collections/{dataCollectionIdentity} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    appGroupIdentity

    string

    必須

    アプリケーションの名前。

    my_app_group_name
    dataCollectionIdentity

    string

    必須

    データ収集の ID。

    286

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    requestId

    string

    リクエスト ID。

    72FAD77B-83F9-F393-BA8E-5834E2427BF8
    result

    object

    データ収集情報。

    created

    integer

    データ収集が作成された時間。

    1581065837
    dataCollectionType

    string

    データ収集のタイプ。

    • behavior: ユーザーの動作データ。

    • item_info: アイテム情報。

    • industry_specific: 業界固有の属性。

    BEHAVIOR
    type

    string

    データ収集クライアントのタイプ。

    • server

    • web

    • app server のみがサポートされています。

    server
    industryName

    string

    業界の名前。

    • general: 一般

    • ecommerce: E コマース

    GENERAL
    status

    integer

    ステータス。

    • 0: データ収集は有効になっていません。

    • 1: データ収集は有効化中です。

    • 2: データ収集は有効です。

    • 3: データ収集の有効化に失敗しました。

    2
    updated

    integer

    データ収集が最後に更新された時間。

    1581065904
    name

    string

    データ収集の名前。

    os_function_test_v1
    sundialId

    string

    sundial の ID。

    1755
    id

    string

    データ収集の ID。

    286

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "72FAD77B-83F9-F393-BA8E-5834E2427BF8",
  "result": {
    "created": 1581065837,
    "dataCollectionType": "BEHAVIOR",
    "type": "server",
    "industryName": "GENERAL",
    "status": 2,
    "updated": 1581065904,
    "name": "os_function_test_v1",
    "sundialId": "1755",
    "id": "286"
  }
}

    エラーコード

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

    変更履歴

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