DescribeDataSources - 查询数据源列表

更新时间:
复制为 MD 格式

查询数据源列表。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

分页页码。从 1 开始,默认值为 1。

1

PageSize

integer

每页的查询数据量。

10

DataSourceType

string

数据源类型。

COMMON_NAS

ClusterId

string

访问数据源使用的客户端组 ID。

cl-0003jyv******fsku5m

DataSourceId

string

数据源 ID

ds-000******2nqeo

DataSourceName

string

数据源名称

MyLocalNas

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

36A5CD24-****-****-****-5F30C3F1753F

Success

boolean

请求是否成功。

  • true 表示成功。

  • false 表示失败。

true

Code

string

返回码。200 表示成功。

200

Message

string

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful

PageNumber

integer

分页页码。从 1 开始,默认值为 1。

1

PageSize

integer

分页大小。最小值为 1,最大值为 99,默认值为 10。

10

TotalCount

integer

数据源总数。

20

DataSources

array<object>

数据源列表。

object

数据源信息。

IndexLevel

string

索引等级。

  • OFF:不创建索引

  • META:元数据索引

  • ALL:全文索引(已废弃)

META

Schedule

string

执行周期。仅用于归档功能中的数据源分析,其他场景请勿使用。 格式:I{startTime}{interval}。表示从{startTime}开始每隔{interval}的时间执行一次任务。startTime:起始时间,UNIX 时间,单位为秒。 interval: ISO8601 时间间隔。例如:PT1H 表示间隔一小时。P1D 表示间隔一天。

I|1729493847|P1D

DataSourceName

string

数据源名称。

COMMON_NAS

DataSourceId

string

数据源 ID。

ds-000******2nqeo

Options

string

数据源分析选项。仅用于归档功能中的数据源分析,其他场景请勿使用。

{}

SpeedLimit

string

限流。仅用于归档功能中的数据源分析,其他场景请勿使用。

6:21:10240

PlanId

string

分析计划 ID。仅用于归档功能中的数据源分析,其他场景请勿使用。

plan-123***7890

IndexUpdateTime

boolean

索引更新时间。仅用于归档功能中的数据源分析,其他场景请勿使用。

1745454604

Exclude

string

用于描述排除哪些文件的过滤器。仅用于归档功能中的数据源分析,其他场景请勿使用。

[ "/home/alice/log" ]

Indexing

boolean

是否正在建立索引。仅用于归档功能中的数据源分析,其他场景请勿使用。

false

UpdatedTime

integer

更新时间

1745454604

DataSourceType

string

数据源类型。

COMMON_NAS

ConnectionInfo

string

数据源连接信息,描述如何访问这个数据源。

{ "dataServerAddresses": [ { "host": "123.123.123.123", "port": "8080" } ], "sharePath": "/share", "mountOptions": "vers=3", "fileSystemType": "nfs" }

IndexAvailable

boolean

索引是否可用。仅用于归档功能中的数据源分析,其他场景请勿使用。

true

CreatedTime

integer

创建时间。

1770257653

Include

string

用于描述包含哪些文件的过滤器。仅用于归档功能中的数据源分析,其他场景请勿使用。

[ "/home/alice", "/home/bob" ]

ClusterId

string

访问数据源使用的客户端组 ID。

cl-0003jyv******fsku5m

Paths

array

数据源分析的路径列表。仅用于归档功能中的数据源分析,其他场景请勿使用。

string

数据源分析的路径。仅用于归档功能中的数据源分析,其他场景请勿使用。

/home

示例

正常返回示例

JSON格式

{
  "RequestId": "36A5CD24-****-****-****-5F30C3F1753F",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 20,
  "DataSources": [
    {
      "IndexLevel": "META",
      "Schedule": "I|1729493847|P1D\t",
      "DataSourceName": "COMMON_NAS",
      "DataSourceId": "ds-000******2nqeo",
      "Options": "{}",
      "SpeedLimit": "6:21:10240",
      "PlanId": "plan-123***7890",
      "IndexUpdateTime": true,
      "Exclude": "[\n      \"/home/alice/log\"\n]",
      "Indexing": false,
      "UpdatedTime": 1745454604,
      "DataSourceType": "COMMON_NAS",
      "ConnectionInfo": "{\n    \"dataServerAddresses\": [\n        {\n            \"host\": \"123.123.123.123\",\n            \"port\": \"8080\"\n        }\n    ],\n    \"sharePath\": \"/share\",\n    \"mountOptions\": \"vers=3\",\n    \"fileSystemType\": \"nfs\"\n}",
      "IndexAvailable": true,
      "CreatedTime": 1770257653,
      "Include": "[\n      \"/home/alice\",\n      \"/home/bob\"\n]",
      "ClusterId": "cl-0003jyv******fsku5m",
      "Paths": [
        "/home"
      ]
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情