批量添加数据库 - BatchCreateDatabases
功能介绍
功能介绍:批量添加数据库
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/sdg/asset/databases/batch-authorize
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| readonly | 否 | Boolean | 参数解释: 是否只读 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| [数组元素] | 是 | Array of DBRequest objects | 参数解释: 批量添加数据库请求体,数组中每个元素为一条待添加的数据库信息 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ds_type | 是 | String | 参数解释: 数据源类型 约束限制: 不涉及 取值范围: 须为已支持的数据源类型(如 MYSQL、SQLSERVER、POSTGRESQL、ORACLE、DWS、DLI、LTS、HIVE、MRS_HIVE、MONGODB、OPENGAUSS、KINGBASE、DMDBMS、HBASE、TDSQL、GREENPLUM、ELASTICSEARCH) 默认取值: 不涉及 |
| ds_address | 是 | String | 参数解释: 数据源地址 约束限制: 不涉及 取值范围: 合法的 IPv4 或 IPv6 地址 默认取值: 不涉及 |
| ds_port | 是 | Integer | 参数解释: 数据源端口 约束限制: 不涉及 取值范围: 0~65535 默认取值: 不涉及 |
| ds_name | 是 | String | 参数解释: 数据源名称 约束限制: 不涉及 取值范围: 0到30个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| ds_user | 否 | String | 参数解释: 数据源用户 约束限制: 不涉及 取值范围: 1到30个字符,只能由英文字母、数字、下划线、@、连字符组成 默认取值: 不涉及 |
| ds_password | 否 | String | 参数解释: 数据源密码 约束限制: 不涉及 取值范围: 1到30个字符,由英文字母、数字及特殊字符(!@#$%^&*()_+{}:"'|\~=><?/)组成 默认取值: 不涉及 |
| ds_version | 是 | String | 参数解释: 数据源版本 约束限制: 不涉及 取值范围: 须为对应数据源类型支持的版本(如 MYSQL 支持 5.8、5.7、5.6、8.0) 默认取值: 不涉及 |
| ins_name | 否 | String | 参数解释: 实例名称 约束限制: 不涉及 取值范围: 0到1024个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| ins_id | 否 | String | 参数解释: 实例ID 约束限制: 不涉及 取值范围: 4到255个字符,只能由英文字母、数字、中文、下划线、连字符组成 默认取值: 不涉及 |
| subnet_id | 否 | String | 参数解释: 子网ID,可通过虚拟私有云服务查询子网列表获取 约束限制: 不涉及 取值范围: 0到1024个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| vpc_id | 否 | String | 参数解释: 虚拟私有云ID 约束限制: 不涉及 取值范围: 0到1024个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| security_group_id | 否 | String | 参数解释: 安全组ID 约束限制: 不涉及 取值范围: 0到1024个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| asset_name | 是 | String | 参数解释: 资产名称 约束限制: 不涉及 取值范围: 4到255个字符,中英文字母开头,由中英文字母、数字、下划线、连字符组成 默认取值: 不涉及 |
| owner_account_id | 否 | String | 参数解释: 拥有者账号ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| owner_project_id | 否 | String | 参数解释: 拥有者的项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| id | 否 | String | 参数解释: 资源ID,唯一标识 约束限制: 不涉及 取值范围: 0到1024个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| project_id | 否 | String | 参数解释: 项目ID 约束限制: 不涉及 取值范围: 0到1024个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| ins_type | 是 | String | 参数解释: 实例类型 约束限制: 不涉及 取值范围: 须为已支持的实例类型枚举值(如 PUB、RDS、ECS、CCE、CSS、OUTSIDE、OBS、MRS、MRS_HWS、DWS、DLI、LTS、GAUSSDB、EXTERNAL、DDS、CLOUDDB) 默认取值: 不涉及 |
| region | 否 | String | 参数解释: 区域 约束限制: 不涉及 取值范围: 0到1024个字符 默认取值: 不涉及 |
| service_name | 否 | String | 参数解释: 服务名称(Oracle 使用) 约束限制: ds_type 为 Oracle 时与 sid 至少填一个 取值范围: 不涉及 默认取值: 不涉及 |
| sid | 否 | String | 参数解释: 会话ID 约束限制: 不涉及 取值范围: 0到1024个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| rds_one_key_authorization | 否 | Boolean | 参数解释: RDS一键授权 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
| scan_metadata | 否 | Boolean | 参数解释: 是否扫描元数据 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| create_time | 否 | Long | 参数解释: 创建时间,Unix时间戳,单位为毫秒 约束限制: 该字段由服务端生成,请求中传入将被忽略 取值范围: 不涉及 默认取值: 不涉及 |
| is_external | 否 | Boolean | 参数解释: 是否外部 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| label_id | 否 | String | 参数解释: 标签ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态,标识操作的处理结果,如成功、失败等 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源唯一标识ID,唯一标识一条资源记录,可通过查询资源列表接口获取 取值范围: 0到1024个字符,只能由英文字母、数字组成 |
请求示例
资产中心创建操作:CreateBatchAuthorizeV2
[ {
"ds_type" : "MYSQL",
"ds_address" : "192.168.1.100",
"ds_port" : 3306,
"ds_name" : "mysql-datasource-01",
"ds_user" : "asset-admin",
"ds_password" : "********",
"ds_version" : "8.0",
"ins_name" : "rds-instance-01",
"ins_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"subnet_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"vpc_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"security_group_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"ins_type" : "RDS",
"asset_name" : "asset-db-01"
} ] 响应示例
状态码:200
{
"status" : "success",
"msg" : "操作成功",
"id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。