华为云用户手册

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为 IAM 的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "xxxxxxxx", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID。可在查询实例列表接口的ID字段获取。 securitygroup_ids 是 Array of strings 安全组ID列表(目前只支持传一个ID)

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 database 是 database object 数据库信息 表4 database 参数 是否必选 参数类型 描述 db_classification 是 String 数据库分类 E CS ：自建数据库 name 是 String 数据库名称 type 是 String 数据库类型 MYSQL ORACLE POSTGRESQL SQLSERVER DAMENG TAURUS DWS KINGBASE GAUSSDBOPENGAUSS GREENPLUM HIGHGO SHENTONG GBASE8A GBASE8S GBASEXDM MONGODB DDS version 是 String 数据库版本 charset 是 String 字符集，默认设置UTF8。 GBK UTF8 ip 是 String 数据库IP port 是 String 数据库端口 os 是 String 数据库操作系统 LINUX64 WINDOWS64 UNIX instance_name 否 String 数据库实例名称

请求示例 /v1/{project_id}/{instance_id}/audit/databases{ "database" : { "name" : "test", "type" : "POSTGRESQL", "version" : "7.4", "charset" : "UTF8", "ip" : "1.1.1.1", "port" : "66", "instance_name" : "testaaa", "os" : "LINUX64", "db_classification" : "ECS" }}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 id String 数据库ID 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应参数 状态码： 204 表6 响应Body参数 参数 参数类型 描述 - String - 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

URI POST /v1/{project_id}/{resource_type}/{resource_id}/tags/create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID resource_type 是 String 资源类型。 auditInstance resource_id 是 String 资源ID。可在查询实例列表接口的resource_id字段获取。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of tags objects 标签列表 租户权限时该字段必选，op_service权限时和sys_tags二选一 sys_tags 否 Array of sys_tags objects 系统标签列表 op_service权限可以访问，和tags二选一。 目前TMS调用时只包含一个resource_tag结构体 ，key固定为：_sys_enterprise_project_id value是UUID或0,value为0表示默认企业项目 表4 tags 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个字符。 value 是 String 值。每个值最大长度255个字符。 表5 sys_tags 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个字符。 value 是 String 值。每个值最大长度255个字符。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 ret_list Array of ret_list objects 结果列表 表6 ret_list 参数 参数类型 描述 id String rds数据库id ret_status String 状态 SUC CES S FAILED ret_message String 描述 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 databases 是 Array of databases objects 数据库列表 表4 databases 参数 是否必选 参数类型 描述 id 是 String rds数据库id，可在查询rds数据库列表接口的ID字段获取。 type 是 String 数据库类型 MYSQL ORACLE POSTGRESQL SQLSERVER DAMENG TAURUS DWS KINGBASE MARIADB GAUSSDBOPENGAUSS

响应示例 状态码： 200 成功 { "ret_list" : [ { "id" : "123751d3ee2f47aea64822e98318c6a8in01", "ret_status" : "SUCCESS", "ret_message" : null }, { "id" : "2343f7285d684fed8b09fac201c3fc7ain01", "ret_status" : "FAILED", "ret_message" : "Unknown error." } ]} 状态码： 400 失败 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 db_id 是 String 数据库ID, 可在查询数据库列表接口的ID字段获取。 mode 是 Integer 模式 0：创建agent 1：选择已有agent agent_id 否 String 选择已有agent时必输 agent_type 是 String agent类型 APP：应用端 DB：数据库端 agent_os 是 String agent OS类型: LINUX64_X86 LINUX64_ARM WINDOWS64 agent_ip 否 String agent IP，安装节点类型为应用端时必输。 agent_nic 否 String agent审计网卡名称 cpu_threshold 否 Integer CPU阈值 mem_threshold 否 Integer 内存阈值

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 否 Array of tags objects 标签列表 租户权限时该字段必选，op_service权限时和sys_tags二选一 sys_tags 否 Array of sys_tags objects 系统标签列表 op_service权限可以访问，和tags二选一。 目前TMS调用时只包含一个resource_tag结构体 ，key固定为：_sys_enterprise_project_id value是UUID或0,value为0表示默认企业项目。 现在仅支持create操作。 表4 tags 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个字符。 value 否 String 值。每个值最大长度255个字符。 表5 sys_tags 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个字符。 value 否 String 值。每个值最大长度255个字符。

响应参数 状态码： 204 表6 响应Body参数 参数 参数类型 描述 - String - 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

URI DELETE /v1/{project_id}/{resource_type}/{resource_id}/tags/delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID resource_type 是 String 资源类型。 auditInstance resource_id 是 String 资源ID。可在查询实例列表接口的resource_id字段获取。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

URI DELETE /v2/{project_id}/{instance_id}/audit/agents/{agent_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID instance_id 是 String 实例ID。可在查询实例列表接口的ID字段获取。 agent_id 是 String agent ID。可在查询数据库agent列表接口ID字段获取。 表2 Query参数 参数 是否必选 参数类型 描述 db_id 是 String 数据库ID, 可在查询数据库列表接口ID字段获取。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表5 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 响应状态 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 实例ID。可在查询实例列表接口的ID字段获取。 delete_publicip 否 Boolean 是否删除弹性IP delete_volume 否 Boolean 是否删除磁盘

Python 1 2 3 4 5 6 7 8 910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758 # coding: utf-8from huaweicloudsdkcore.auth.credentials import BasicCredentialsfrom huaweicloudsdkdbss.v1.region.dbss_region import DbssRegionfrom huaweicloudsdkcore.exceptions import exceptionsfrom huaweicloudsdkdbss.v1 import *if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.getenv("CLOUD_SDK_AK") sk = os.getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = DbssClient.new_builder() \ .with_credentials(credentials) \ .with_region(DbssRegion.value_of("xx-xx")) \ .build() try: request = AddRdsNoAgentDatabaseRequest() listDatabasesbody = [ RdsNoAgentDbRequestDatabases( id="123751d3ee2f47aea64822e98318c6a8in01", db_name="rds1", status="ACTIVE", port="3306", ip="192.168.0.119", instance_name="rds1", version="8.0", type="MySQL", enterprise_id="0", enterprise_name="default" ), RdsNoAgentDbRequestDatabases( id="2343f7285d684fed8b09fac201c3fc7ain01", db_name="rds2", status="ACTIVE", port="3306", ip="192.168.0.92", instance_name="rds2", version="8.0", type="MySQL", enterprise_id="0", enterprise_name="default" ) ] request.body = RdsNoAgentDbRequest( databases=listDatabasesbody ) response = client.add_rds_no_agent_database(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)

Go 1 2 3 4 5 6 7 8 9101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566 package mainimport ("fmt""github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dbss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dbss/v1""github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dbss/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dbss/v1/region")func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dbss.NewDbssClient( dbss.DbssClientBuilder(). WithRegion(region.ValueOf("xx-xx")). WithCredential(auth). Build()) request := &model.AddRdsNoAgentDatabaseRequest{}enterpriseNameDatabases:= "default"enterpriseNameDatabases1:= "default"var listDatabasesbody = []model.RdsNoAgentDbRequestDatabases{ { Id: "123751d3ee2f47aea64822e98318c6a8in01", DbName: "rds1", Status: "ACTIVE", Port: "3306", Ip: "192.168.0.119", InstanceName: "rds1", Version: "8.0", Type: "MySQL", EnterpriseId: "0", EnterpriseName: &enterpriseNameDatabases, }, { Id: "2343f7285d684fed8b09fac201c3fc7ain01", DbName: "rds2", Status: "ACTIVE", Port: "3306", Ip: "192.168.0.92", InstanceName: "rds2", Version: "8.0", Type: "MySQL", EnterpriseId: "0", EnterpriseName: &enterpriseNameDatabases1, }, }request.Body = &model.RdsNoAgentDbRequest{Databases: listDatabasesbody,}response, err := client.AddRdsNoAgentDatabase(request)if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) }}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 illegal_db_id Array of strings 添加失败的数据库实例id legal_db_id Array of strings 添加成功的数据库实例id 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码。 error_msg String 错误请求返回的错误信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 表3 请求Body参数 参数 是否必选 参数类型 描述 databases 是 Array of databases objects 添加数据库信息列表 total_count 否 Integer 总数 表4 databases 参数 是否必选 参数类型 描述 id 是 String 数据库ID db_name 是 String 数据库名称 status 是 String 数据库状态 port 是 String 数据库端口 ip 是 String 数据库IP instance_name 是 String 数据库实例名称 version 是 String 数据库版本 type 是 String 数据库类型 enterprise_id 是 String 企业项目ID enterprise_name 否 String 企业项目名称

请求示例 /v1/{project_id}/{instance_id}/dbss/audit/databases/rds{ "databases" : [ { "id" : "123751d3ee2f47aea64822e98318c6a8in01", "db_name" : "rds1", "status" : "ACTIVE", "port" : "3306", "ip" : "192.168.0.119", "instance_name" : "rds1", "version" : "8.0", "type" : "MySQL", "enterprise_id" : "0", "enterprise_name" : "default" }, { "id" : "2343f7285d684fed8b09fac201c3fc7ain01", "db_name" : "rds2", "status" : "ACTIVE", "port" : "3306", "ip" : "192.168.0.92", "instance_name" : "rds2", "version" : "8.0", "type" : "MySQL", "enterprise_id" : "0", "enterprise_name" : "default" } ]}

响应示例 状态码： 200 成功 { "illegal_db_id" : [ ], "legal_db_id" : [ "123751d3ee2f47aea64822e98318c6a8in01", "2343f7285d684fed8b09fac201c3fc7ain01" ]} 状态码： 400 失败 { "error" : { "error_code" : "DBSS.XXXX", "error_msg" : "XXX" }}

请求示例 /v1/{project_id}/{resource_type}/resource-instances/count{ "matches" : [ { "key" : "resource_name", "value" : "resource1" } ], "not_tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags" : [ { "key" : "key1", "values" : [ "*value1", "value2" ] } ], "tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "not_tags_any" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "values" : [ "5aa119a8-d25b-45a7-8d1b-88e127885635" ] } ]}