DescribeDataCollction - DescribeDataCollection

获取指定应用的数据采集详情。

调试

您可以在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"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情