创建订阅任务 - CreateSubscription
功能介绍
创建订阅任务。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/subscription
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 否 | String | 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 |
| X-Auth-Token | 是 | String | 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 |
| X-Language | 否 | String | 请求语言类型。 枚举值: |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 任务名称。 约束:任务名称在4位到50位之间,不区分大小写,可以包含字母、数字、中划线或下划线,不能包括其他特殊字符。 |
| description | 否 | String | 任务描述。 |
| instance_type | 否 | String | 实例类型,仅支持rds |
| enterprise_project_id | 是 | String | 企业项目ID。 缺省值:"",表示查询所有企业项目任务。 |
| tags | 否 | Array of objects | 标签。 详情请参看ResourceTag。 |
| source_endpoint_info | 是 | object | 源数据库信息。 |
| is_grant_new_agency | 否 | Boolean | 是否创建委托,取值: 默认为false |
响应参数
状态码:202
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 任务ID。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/subscription
{
"name" : "DRS-123",
"source_endpoint_info" : {
"id" : "1cb044d1ca7b41b7935d336f72a7a45cin01"
}
} 响应示例
状态码:202
{
"job_id" : "1caa1fec-ad7f-4281-b0f6-ad41e67a346c"
} 状态码:400
Bad Request
{
"error_code" : "DRS.M00202",
"error_msg" : "The value of name is invalid."
} 错误码
请参见错误码。