文档

ListDataCollections - ListDataCollections

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

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

请求参数

名称类型必填描述示例值
appGroupIdentitystring

应用名称

my_app_group_name
pageNumberinteger

页码,默认 pageNumber = 1

1
pageSizeinteger

每页返回数目,默认 pageSize = 10

10

返回参数

名称类型描述示例值
object
totalCountinteger

总条数

1
requestIdstring

请求 ID

959D8782-B130-95EB-86CC-1F6ED447981F
resultobject []

数据采集信息

参考: DataCollection

createdinteger

创建时间

1581065837
dataCollectionTypestring

数据采集的类型

  • behavior 行为
  • item_info 项目信息
  • industry_specific 工业特性
BEHAVIOR
typestring

数据采集端的类型

  • server
  • web
  • app

注:目前只支持 server

server
industryNamestring

行业名称

  • general 通用
  • ecommerce 电商
GENERAL
statusinteger

状态

  • 0 未开通
  • 1 开通中
  • 2 开通成功
  • 3 开通失败
2
updatedinteger

更新时间

1581065904
namestring

数据采集名称

os_function_test_v1
sundialIdstring

sundial 的 ID

1755
idstring

数据采集 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"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史