全部產品
Search
文件中心

OpenSearch:DescribeDataCollction - DescribeDataCollection

更新時間:Nov 24, 2025

擷取指定應用的資料擷取詳情。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱

類型

描述

樣本值

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 電商

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

樣本

正常返回樣本

JSON格式

{
  "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"
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情