更新数据库资产
功能介绍
更新指定数据库资产的信息,支持修改数据库实例的配置和属性。
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/sdg/asset/databases/{db_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
db_id |
是 |
String |
数据库资产ID,用于唯一标识需要更新的数据库资产。 |
|
project_id |
是 |
String |
项目ID,用于标识具体的项目。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
asset_name |
否 |
String |
资产名称,用于标识具体的资产。 |
|
create_time |
否 |
Long |
数据库的创建时间,表示数据库创建的时间戳。 |
|
ds_address |
否 |
String |
数据源地址,表示数据库的网络地址。 |
|
ds_name |
否 |
String |
数据源名称,用于标识具体的数据库。 |
|
ds_password |
否 |
String |
数据源密码,用于访问数据库的密码信息。 |
|
ds_port |
否 |
Integer |
数据源端口,表示数据库的网络服务端口。 |
|
ds_type |
否 |
String |
数据源类型,表示数据库的种类,包括:MYSQL、SQLSERVER、MSSQL、MS-SQL、POSTGRESQL、GREENPLUM、ES、ELASTICSEARCHF、ORACLE、DWS、DLI、LTS、HIVE、MRS_HIVE、MONGODB、OPENGAUSS、KINGBASE、DMDBMS、HBASE、TDSQL。 |
|
ds_user |
否 |
String |
数据源用户名,用于访问数据库的用户名。 |
|
ds_version |
否 |
String |
数据源版本,表示数据库的软件版本信息。 |
|
id |
否 |
String |
数据库的唯一标识符,用于唯一标识具体的数据库。 |
|
ins_id |
否 |
String |
实例的唯一标识符,用于唯一标识具体的实例。 |
|
ins_name |
否 |
String |
实例的名称,用于标识实例的名称。 |
|
ins_type |
否 |
String |
实例的类型,表示实例的分类,如'RDS'表示关系型数据库服务。包括:PUB、RDS、ECS、CCE、CSS、OUTSIDE、OBS、MRS、MRS_HWS、DWS、DLI、LTS、GAUSSDB、EXTERNAL、DDS、CLOUDDB。 |
|
is_external |
否 |
Boolean |
是否为外部实例,表示实例是否位于外部网络。 |
|
project_id |
否 |
String |
项目ID,用于唯一标识实例所属的项目。 |
|
rds_one_key_authorization |
否 |
Boolean |
是否启用一键授权,表示是否允许快速授权访问数据库。 |
|
region |
否 |
String |
实例所在的区域,表示实例的地理位置信息。 |
|
scan_metadata |
否 |
Boolean |
是否扫描元数据,表示是否需要扫描数据库的元数据信息。 |
|
security_group_id |
否 |
String |
安全组ID,用于唯一标识实例所属的安全组。 |
|
service_name |
否 |
String |
服务名称,用于标识实例所属的服务。 |
|
sid |
否 |
String |
会话ID,用于标识实例的会话信息。 |
|
subnet_id |
否 |
String |
子网ID,用于唯一标识实例所属的子网。 |
|
vpc_id |
否 |
String |
虚拟私有云(VPC)的唯一标识符,用于唯一标识实例所属的VPC。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
msg |
String |
返回消息,用于描述操作的结果或错误信息。 |
|
status |
String |
返回状态,如'200','400' |
状态码:201
数据库资产更新成功。
请求示例
PUT /v1/{project_id}/sdg/asset/databases/{db_id}
{
"asset_name" : "string",
"create_time" : 0,
"ds_address" : "string",
"ds_name" : "string",
"ds_password" : "string",
"ds_port" : 0,
"ds_type" : "string",
"ds_user" : "string",
"ds_version" : "string",
"id" : "string",
"ins_id" : "string",
"ins_name" : "string",
"ins_type" : "string",
"is_external" : true,
"project_id" : "string",
"rds_one_key_authorization" : true,
"region" : "string",
"scan_metadata" : true,
"security_group_id" : "string",
"service_name" : "string",
"sid" : "string",
"subnet_id" : "string",
"vpc_id" : "string"
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
更新数据库资产成功。 |
|
201 |
数据库资产更新成功。 |
|
401 |
未授权访问,请求被拒绝。 |
|
403 |
无权限进行此操作,请求被拒绝。 |
|
404 |
数据库资产不存在,更新失败。 |
错误码
请参见错误码。