编辑数据库实例 - UpdateInstance
功能介绍
功能介绍:编辑数据库实例
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/asset-center/database/instance/{instance_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32。 默认取值: 不涉及 |
| instance_id | 是 | String | 参数解释: 子网ID 约束限制: 不涉及 取值范围: 1到64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ds_type | 否 | String | 参数解释: 数据源类型 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| ds_address | 否 | String | 参数解释: 数据源地址 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| ds_port | 否 | Integer | 参数解释: 数据源端口 约束限制: 不涉及 取值范围: 0~2147483647 默认取值: 不涉及 |
| ds_name | 否 | String | 参数解释: 数据源名称 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| ds_user | 否 | String | 参数解释: 数据源用户 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| ds_password | 否 | String | 参数解释: 数据源密码 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| ds_version | 否 | String | 参数解释: 数据源版本 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| ins_name | 否 | String | 参数解释: 实例名称 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| ins_id | 否 | String | 参数解释: 实例ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| subnet_id | 否 | String | 参数解释: 子网ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| vpc_id | 否 | String | 参数解释: 虚拟私有云ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| security_group_id | 否 | String | 参数解释: 安全组ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| asset_name | 否 | String | 参数解释: 资产名称 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| owner_account_id | 否 | String | 参数解释: 拥有者账号ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| owner_project_id | 否 | String | 参数解释: 拥有者项目ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| id | 否 | String | 参数解释: 资源ID,唯一标识 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| project_id | 否 | String | 参数解释: 项目ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| ins_type | 否 | String | 参数解释: 实例类型 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| region | 否 | String | 参数解释: 区域 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| service_name | 否 | String | 参数解释: 实例名称 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| sid | 否 | String | 参数解释: 会话ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
| rds_one_key_authorization | 否 | Boolean | 参数解释: RDS一键授权 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| scan_metadata | 否 | Boolean | 参数解释: 扫描元数据 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| create_time | 否 | Long | 参数解释: 创建时间 约束限制: 不涉及 取值范围: 0~2147483647 默认取值: 不涉及 |
| is_external | 否 | Boolean | 参数解释: 是否外部 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| label_id | 否 | String | 参数解释: 实例ID 约束限制: 最大长度1024字符 取值范围: 0到1024个字符 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
资产中心更新操作:UpdateInstance
{
"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" : "1.0.0",
"ins_name" : "rds-instance-01",
"ins_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"subnet_id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"vpc_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"security_group_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70",
"asset_name" : "asset-db-01",
"owner_account_id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"owner_project_id" : "f7e6d5c4-b3a2-1908-7f6e-5d4c3b2a1908",
"id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d",
"project_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
"ins_type" : "RDS",
"region" : "cn-north-4",
"service_name" : "service-resource-01",
"sid" : "asset-value-01",
"rds_one_key_authorization" : true,
"scan_metadata" : true,
"create_time" : 1700000000000,
"is_external" : true,
"label_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70"
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "操作成功",
"id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。