更新时间:2023-07-24 GMT+08:00
分享

任务名称校验

功能介绍

创建任务时对任务名称进行校验。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

接口约束

仅支持部分Region使用,详情参考终端节点

URI

POST /v5/{project_id}/jobs/name-validation

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的Project ID。

获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。

缺省值:application/json

X-Auth-Token

String

从IAM服务获取的用户Token。

用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。

缺省值:en-us

枚举值:

  • en-us
  • zh-cn
表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

任务名称,名称在4位到50位之间,必须以字母开头,可以包含字母、数字、中划线或下划线,不能包含其他特殊字符。

type

String

任务类型。

  • trans:实时迁移、同步、灾备使用
  • subscription:数据订阅使用
  • offline:备份迁移使用

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

is_valid

Boolean

任务名称是否有效。

状态码: 422

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

最小长度:12

最大长度:12

error_msg

String

错误描述。

最小长度:1

最大长度:512

请求示例

校验任务名称请求示例。

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jobs/name-validation
{
  "name": "DRS-211",
  "type": "trans"
}

响应示例

状态码: 200

OK
{
  "is_valid": true
}

状态码: 422

Bad Request

{
  "error_code": "DRS.M00277",
  "error_msg": "该任务名称已存在"
}

错误码

请参见错误码

相关文档