ListDataCollections - ListDataCollections - 智能开放搜索 OpenSearch

获取OpenSearch应用的数据采集清单。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
opensearch:ListDataCollections	get	DataCollection acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
appGroupIdentity	string	是	应用名称	my_app_group_name
pageNumber	integer	否	页码，默认 pageNumber = 1	1
pageSize	integer	否	每页返回数目，默认 pageSize = 10	10

返回参数

名称	类型	描述	示例值
	object
totalCount	integer	总条数	1
requestId	string	请求 ID	959D8782-B130-95EB-86CC-1F6ED447981F
result	array<object>	数据采集信息参考： DataCollection
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格式

{
  "totalCount": 1,
  "requestId": "959D8782-B130-95EB-86CC-1F6ED447981F",
  "result": [
    {
      "created": 1581065837,
      "dataCollectionType": "BEHAVIOR",
      "type": "server",
      "industryName": "GENERAL",
      "status": 2,
      "updated": 1581065904,
      "name": "os_function_test_v1",
      "sundialId": "1755",
      "id": "286"
    }
  ]
}

JSON格式

{
  "totalCount": 1,
  "requestId": "959D8782-B130-95EB-86CC-1F6ED447981F",
  "result": [
    {
      "created": 1581065837,
      "dataCollectionType": "BEHAVIOR",
      "type": "server",
      "industryName": "GENERAL",
      "status": 2,
      "updated": 1581065904,
      "name": "os_function_test_v1",
      "sundialId": "1755",
      "id": "286"
    }
  ]
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史