AddDataSource - 创建数据源

更新时间:
复制为 MD 格式

创建数据源。

接口说明

  • 对于本地 NAS 备份功能,支持数据源类型:本地 NAS(COMMON_NAS)。

  • 对于 CPFS 备份功能,支持数据源类型:文件存储 CPFS(CPFS),CPFS 智算版(BMCPFS),其他大规模文件系统(COMMON_FILE_SYSTEM)

  • 对于归档功能,支持数据源类型:本地 NAS(COMMON_NAS),HDFS(HDFS),S3(S3)

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

DataSourceType

string

数据源类型。

COMMON_NAS

DataSourceName

string

数据源名称。

MyLocalNas

Credential

string

数据源访问凭证。对于 SMB 协议的本地 NAS 数据源、OSS 协议兼容数据源和 S3 协议兼容数据源按需填写。示例:

  • 本地 NAS 数据源(SMB 协议): { "mountUsername": "*****", "mountPassword": "*****" }

  • OSS 协议兼容数据源/S3 协议兼容数据源: { "accessKeyId": "*****", "accessKeySecret": "*****" }

{ "mountUsername": "*****", "mountPassword": "*****" }

ConnectionInfo

string

数据源连接信息,描述如何访问这个数据源。填写示例:

  • 本地 NAS 数据源: { "dataServerAddresses": [ { "host": "123.123.123.123", "port": "8080" } ], "sharePath": "/share", "mountOptions": "vers=3", "fileSystemType": "nfs" }

  • 智算 CPFS 数据源: {"vpcMountTarget":"cpfs-010wn***wy-vpc-ta***8.cn-shanghai.cpfs.aliyuncs.com","sharePath":"/"}

  • 其他大规模文件系统数据源: {"path":"/mnt"}

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

IndexLevel

string

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

  • OFF:不创建索引

  • META:元数据索引

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

META

ClusterId

string

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

cl-0004i0nlngorvgjpl7ck

Schedule

string

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

I|1729493847|P1D

SpeedLimit

string

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

6:21:10240

Options

string

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

{}

Include

string

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

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

Exclude

string

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

["/home/alice/log"]

Path

array

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

string

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

/home

返回参数

名称

类型

描述

示例值

object

Code

string

错误码。

200

Message

string

添加数据源返回消息

successful

RequestId

string

请求 id。

53167AD3-****-****-92C7-CF69A000BA45

Success

boolean

请求是否成功。

true

DataSourceId

string

数据源 id。

ds-000*******xzj

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "53167AD3-****-****-92C7-CF69A000BA45",
  "Success": true,
  "DataSourceId": "ds-000*******xzj"
}

错误码

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

变更历史

更多信息,参考变更详情