华为云用户手册

  • 请求示例 修改实例shared_preload_libraries参数的值。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/f569f1358436479dbcba8603c32cc4aein03/parameter/shared_preload_libraries { "value" : "passwordcheck.so,pg_stat_statements,pg_sql_history" }
  • 响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 job_id String 任务ID。 restart_required Boolean 实例是否需要重启。 true,需要重启。 false,不需要重启。 正常响应样例 { "job_id" : "e7a7535b-eb9b-45ac-a83a-020dc5016d94", "restart_required" : true } 异常响应 请参见异常请求结果。
  • URI URI格式 PUT /v3/{project_id}/instances/{instance_id}/parameter/{name} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 name 是 参数名称。当前只支持修改shared_preload_libraries。
  • 请求示例 创建数据库db1的插件pg_stat_statements。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/extensions { "database_name" : "db1", "extension_name" : "pg_stat_statements" }
  • 请求示例 DELETE https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/extensions { "database_name" : "db1", "extension_name" : "pg_stat_statements" }
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 extensions Array of objects 插件列表信息。 详情请参见表3。 total_count Integer 总插件数。 表3 extensions元素结构说明 名称 参数类型 说明 name String 插件名称。 database_name String 数据库名称。 version String 插件版本。 version_update String 可更新的插件版本。如果和version字段值不一致,说明插件可更新。 shared_preload_libraries String 依赖预加载库。 created Boolean 插件是否已创建。 description String 插件描述。 正常响应样例 { "extensions" : [ { "name" : "pg_cron", "database_name" : "db1", "version" : "1.0", "version_update" : "1.0", "shared_preload_libraries" : "pg_cron", "created" : false, "description" : "pg_cron access method - signature file based index" }, { "name" : "dblink", "database_name" : "db1", "version" : "1.2", "version_update" : "1.2", "shared_preload_libraries" : "", "created" : false, "description" : "connect to other PostgreSQL databases from within a database" } ], "total_count" : 2 } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/extensions?database_name={database_name}&offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 database_name 是 数据库名称。 offset 否 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 limit 否 查询记录数。默认为100,不能为负数,最小值为1,最大值为100。
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 all_users 是 Boolean 是否设置全部数据库用户。 true:设置全部数据库用户读写权限,忽略user_name参数。 false:单独设置user_name用户读写权限。 user_name 否 String 数据库用户名称。 数据库用户名称在1到63个字符之间,由字母、数字、或下划线组成,不能包含其他特殊字符,不能以“pg”和数字开头,不能和系统用户名称相同。系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”,“ rdsProxy”, “rdsDdm”。 readonly 是 Boolean 是否为只读权限: true:只读。 false:可读可写。
  • 请求示例 设置全部数据库用户只读。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/user-privilege { "all_users": true, "readonly": true } 设置全部数据库用户可读可写。 { "all_users": true, "readonly": false } 设置单个数据库用户只读。 { "all_users": false, "user_name": "test1234", "readonly": true } 设置单个数据库用户可读可写 { "all_users": false, "user_name": "test1234", "readonly": false }
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 database_schemas Array of objects 列表中每个元素表示一个数据库schema。 详情请参见表3。 total_count Integer 数据库schema总数。 表3 users元素结构说明 名称 参数类型 说明 schema_name String schema名称。 owner String schema所属用户。 正常响应样例 { "database_schemas": [{ "schema_name": "rds_user1", "owner": "root" }], "total_count": 1 }
  • 接口约束 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。 除RDS界面和API以外的其他方式创建的数据库和账号,如果创建的数据库名和账号名不满足数据库命名规则(参见表2)和账号命名规则(参见表2),例如包含中文或不支持的特殊字符,那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。 如果源库的数据库名和账号名不满足数据库命名规则(参见表2)和账号命名规则(参见表2),迁移到目标库RDS for MySQL后,该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 users Array of objects 列表中每个元素表示一个数据库用户。 详情请参见表3。 total_count Integer 数据库用户总数。 表3 users元素结构说明 名称 参数类型 说明 name String 账号名。 attributes Object 用户的权限属性。 详情请参见表4。 memberof Array of strings 用户的默认权限。 comment String 用户备注。 表4 attributes 元素结构说明 名称 参数类型 说明 rolsuper Boolean 用户是否具有超级用户权限,取值为“false”。 rolinherit Boolean 用户是否自动继承其所属角色的权限,取值为“true”或“false”。 rolcreaterole Boolean 用户是否支持创建其他子用户,取值为“true”或“false”。 rolcreatedb Boolean 用户是否可以创建数据库,取值为“true”或“false”。 rolcanlogin Boolean 用户是否可以登录数据库,取值为“true”或“false”。 rolconnlimit Integer 用户连接实例的最大并发连接数。-1表示没有限制。 rolreplication Boolean 用户是否属于复制角色,取值为“true”或“false”。 rolbypassrls Boolean 用户是否绕过每个行级安全策略,取值为“true”或“false”。 正常响应样例 { "users": [ { "name": "rdsuser", "attributes": { "rolsuper": false, "rolinherit": true, "rolcreaterole": true, "rolcreatedb": true, "rolcanlogin": true, "rolconnlimit": -1, "rolreplication": true, "rolbypassrls": false }, "memberof": ["pg_monitor", "pg_read_all_stats", "pg_stat_scan_tables", "pg_signal_backend"] }, { "name": "rdsuser1", "attributes": { "rolsuper": false, "rolinherit": true, "rolcreaterole": true, "rolcreatedb": true, "rolcanlogin": true, "rolconnlimit": -1, "rolreplication": true, "rolbypassrls": false }, "memberof": [] }], "total_count": 2 }
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 databases Array of objects 列表中每个元素表示一个数据库。 详情请参见表3。 total_count Integer 数据库总数。 表3 databases元素结构说明 名称 参数类型 说明 name String 数据库名称。 owner String 数据库所属用户。 character_set String 数据库使用的字符集,例如UTF8。 collate_set String 数据库排序集,例如en_US.UTF-8等。 size Integer 数据库大小(单位:字节)。 comment String 数据库备注。 正常响应样例 { "databases": [ { "name": "rds_test", "owner": "root", "character_set": "UTF8", "collate_set":"en_US.UTF-8", "size":10777247, "comment":"comment" }, { "name": "rds_test2", "owner":"root", "character_set": "UTF8", "collate_set":"en_US.UTF-8", "size":1055623, "comment":"comment" }, { "name": "rds_test3", "owner":"root", "character_set": "UTF8", "collate_set":"en_US.UTF-8", "size":107772488, "comment":"comment" } ], "total_count": 3 } 异常响应 请参见异常请求结果。
  • 请求示例 创建数据库schema。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/schema { "db_name": "rds_test", "schemas": [ { "schema_name": "teste123", "owner": "teste123" } ] }
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 数据库名称在1到63个字符之间,由字母、数字、或下划线组成,不能包含其他特殊字符,不能以“pg”和数字开头,且不能和RDS for PostgreSQL模板库重名。 RDS for PostgreSQL模板库包括postgres, template0 ,template1。 schemas 是 Array of objects 每个元素都是与数据库相关联的schmea信息。单次请求最多支持20个元素。 每个元素结构请参见表3。 表3 schemas列表元素数据结构说明 名称 是否必选 参数类型 说明 schema_name 是 String schema名称。 schema名称在1到63个字符之间,由字母、数字、或下划线组成,不能包含其他特殊字符,不能以“pg”和数字开头,且不能和RDS for PostgreSQL模板库和已存在的schema重名。 RDS for PostgreSQL模板库包括postgres, template0 ,template1,。 已存在的schema包括public,information_schema。 owner 是 String 数据库属主用户。 数据库属主名称在1到63个字符之间,不能以“pg”和数字开头,不能和系统用户名称相同。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”,“ rdsProxy”, “rdsDdm”。
  • 请求示例 授权数据库账号读写权限,rds账号可读可写、rds001账号只读、rds002账号可读可写。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/db_privilege {"db_name": "rds_test", "users": [ { "name": "rds", "readonly": false, "schema_name": "teste123" }, { "name": "rds001", "readonly": true, "schema_name": "teste123" }, { "name": "rds002", "readonly": false, "schema_name": "teste123" } ] }
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 db_name 是 String 数据库名称。 数据库名称在1到63个字符之间,由字母、数字、或下划线组成,不能包含其他特殊字符,不能以“pg”和数字开头,且不能和RDS for PostgreSQL模板库重名。 RDS for PostgreSQL模板库包括postgres, template0 ,template1。 users 是 Array of objects 每个元素都是与数据库相关联的账号。单次请求最多支持50个元素。 每个元素结构请参见表3。 表3 users列表元素数据结构说明 名称 是否必选 参数类型 说明 name 是 String 数据库账号名称。 数据库账号名称在1到63个字符之间,由字母、数字、或下划线组成,不能包含其他特殊字符,不能以“pg”和数字开头,不能和系统用户名称相同且账号名称必须存在。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”,“ rdsProxy”, “rdsDdm”。 readonly 是 Boolean 数据库账号权限。 true:只读。 false:可读可写。 schema_name 是 String schema名称。 schema名称在1到63个字符之间,由字母、数字、或下划线组成,不能包含其他特殊字符,不能以“pg”和数字开头,不能和RDS for PostgreSQL模板库重名,且schema名称必须存在。 RDS for PostgreSQL模板库包括postgres, template0 ,template1。
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 name 是 String 数据库用户名称。 数据库用户名称在1到63个字符之间,由字母、数字、或下划线组成,不能包含其他特殊字符,不能以“pg”和数字开头,不能和系统用户名称相同。 系统用户包括“rdsAdmin”,“ rdsMetric”, “rdsBackup”, “rdsRepl”,“ rdsProxy”, “rdsDdm”。 password 是 String 数据库用户密码。 取值范围:非空,密码长度在8到32个字符之间,至少包含大写字母、小写字母、数字、特殊字符~!@#%^*-_=+?,三种字符的组合,不能包含数据库账号名称或名称的逆序。 建议您输入高强度密码,以提高安全性,防止出现密码被暴力破解等安全风险。 comment 否 String 数据库账号备注。 取值范围:长度1~512个字符。
  • 请求示例 创建数据库用户rds。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/db_user { "name": "rds", "password": "****", "comment":"comment" }
  • 请求示例 创建数据库rds_test。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/f569f1358436479dbcba8603c32cc4aein03/database { "name": "rds_test", "owner": "test", "template": "template0", "character_set": "UTF8", "lc_collate": "en_US.UTF-8", "lc_ctype": "en_US.UTF-8", "is_revoke_public_privilege": true, "comment":"comment" }
  • 如何保证请求幂等性 客户端在发送请求时,可以在HTTP请求消息头中增加X-Client-Token作为幂等性标识,字段描述参见表1。 表1 幂等标识消息头 名称 描述 是否必选 示例 X-Client-Token 保证客户端请求幂等性的标识。 该标识为32位UUID格式,由客户端生成,且需确保不同请求之间该标识具有唯一性。 否 46436810-d999-454c-bd85-e515fd258600 通常情况下,客户端只需要在服务端内部异常、连接超时等响应状态码为5xx的错误,或者无法获取响应结果重试请求。重试请求仍然使用相同的幂等标识和请求参数,则服务端会返回与第一次请求相同的请求结果。 幂等标识的详细信息如下所示: 幂等标识是一个大小写敏感的32位UUID,其格式为:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (8-4-4-4-12),其中每个 x 是 0-9 或 a-f 范围内的一个十六进制的数字。如果您提供了一个非UUID格式的标识,则服务端会返回DBS.280497错误码。 幂等标识需要具有唯一性,如果您提供了一个已经使用过的标识,但请求参数有变化,则服务端会返回DBS.280495错误码。 幂等标识具有时效性(8小时),如果您提供了一个已经失效的标识,则服务端会返回DBS.280498错误码。 使用幂等标识后: 返回结果状态码为2xx时,重试后客户端可以得到与上次相同的结果,但对您的服务端状态没有影响。 返回结果状态码为4xx时,重试不会成功。您需要根据错误信息排查问题后再重试请求。
  • 调用样例 通过API接口来检索RDS监控指标数据,具体调用方法及参数说明请参见《 云监控服务 API参考》中的查询监控数据章节。 调用样例如下: 请求样例: /V1.0/{project_id}/metric-data?namespace=SYS.RDS&metric_name=rds001_cpu_util&dim.0=rds_cluster_id,5ea170ad-cc6b-49cd-9020-e94fdbeea391&from=1484123686000&to=1568188853000&period=300&filter=average 响应样例: { "datapoints": [ { "average": 0.35, "timestamp": 1484123400000, "unit": "Ratio" }, { "average": 0.11, "timestamp": 1484123700000, "unit": "Ratio" } ], "metric_name": "rds001_cpu_util", "httpcode" : 200, "header" : { "Transfer-Encoding" : "chunked", "Server" : "Web Server", "X-Request-Id" : "te-I- CES -APISVR25.id-0418d62a-1e76-46ff-9a5f-9ce40b336e29.ts-1484123744291.c-15046", "X-Content-Type-Options" : "nosniff", "Connection" : "keep-alive", "X-Download-Options" : "noopen", "Date" : "Wed, 11 Jan 2017 08:35:44 GMT", "X-Frame-Options" : "DENY", "Strict-Transport-Security" : "max-age=31536000; includeSubdomains;", "Cache-Control" : "no-cache", "X-XSS-Protection" : "1; mode=block;", "Content-Length" : "165", "Content-Type" : "application/json" } }
  • 监控指标 表1 RDS性能监控列表 指标ID 指标名称 指标含义 取值范围 测量对象&监控实例类型 rds001_cpu_util CPU使用率 该指标用于统计测量对象的CPU使用率,以百分比为单位。 0-100% 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds002_mem_util 内存使用率 该指标用于统计测量对象的内存使用率,以百分比为单位。 0-100% 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds003_iops IOPS 该指标用于统计当前实例,单位时间内系统处理的I/O请求数量(平均值)。 ≥ 0 counts/s 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds004_bytes_in 网络输入吞吐量 该指标用于统计平均每秒从测量对象的所有网络适配器输入的流量,以字节/秒为单位。 ≥ 0 bytes/s 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds005_bytes_out 网络输出吞吐量 该指标用于统计平均每秒从测量对象的所有网络适配器输出的流量,以字节/秒为单位。 ≥ 0 bytes/s 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds006_conn_count 数据库总连接数 该指标用于统计试图连接到MySQL服务器的总连接数,以个为单位。 ≥ 0 counts 测量对象:数据库 监控实例类型:MySQ L实例 rds007_conn_active_count 当前活跃连接数 该指标用于统计当前打开的连接的数量,以个为单位。 ≥ 0 counts 测量对象:数据库 监控实例类型:MySQL实例 rds008_qps QPS 该指标用于统计SQL语句查询次数,含存储过程,以次/秒为单位。 ≥ 0 queries/s 测量对象:数据库 监控实例类型:MySQL实例 rds009_tps TPS 该指标用于统计事务执行次数,含提交的和回退的,以次/秒为单位。 ≥ 0 transactions/s 测量对象:数据库 监控实例类型:MySQL实例 rds010_innodb_buf_usage 缓冲池利用率 该指标用于统计空闲的页与InnoDB缓存中缓冲池页面总数的比例,以比率为单位。 0-1 测量对象:数据库 监控实例类型:MySQL实例 rds011_innodb_buf_hit 缓冲池命中率 该指标用于统计读命中与读请求数比例,以比率为单位。 0-1 测量对象:数据库 监控实例类型:MySQL实例 rds012_innodb_buf_dirty 缓冲池脏块率 该指标用于统计InnoDB缓存中脏数据与InnoDB缓存中使用的页比例,以比率为单位。 0-1 测量对象:数据库 监控实例类型:MySQL实例 rds013_innodb_reads InnoDB读取吞吐量 该指标用于统计Innodb平均每秒读字节数,以字节/秒为单位。 ≥ 0 bytes/s 测量对象:数据库 监控实例类型:MySQL实例 rds014_innodb_writes InnoDB写入吞吐量 该指标用于统计Innodb平均每秒写字节数,以字节/秒为单位。 ≥ 0 bytes/s 测量对象:数据库 监控实例类型:MySQL实例 rds015_innodb_read_count InnoDB文件读取频率 该指标用于统计Innodb平均每秒从文件中读的次数,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds016_innodb_write_count InnoDB文件写入频率 该指标用于统计Innodb平均每秒向文件中写的次数,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds017_innodb_log_write_req_count InnoDB日志写请求频率 该指标用于统计平均每秒的日志写请求数,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds018_innodb_log_write_count InnoDB日志物理写频率 该指标用于统计平均每秒向日志文件的物理写次数,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds019_innodb_log_fsync_count InnoDB日志fsync()写频率 该指标用于统计平均每秒向日志文件完成的fsync()写数量,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds020_temp_tbl_rate 临时表创建速率 该指标用于统计每秒在硬盘上创建的临时表数量,以个/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds021_myisam_buf_usage Key Buffer利用率 该指标用于统计MyISAM Key buffer的利用率,以比率为单位。 0-1 测量对象:数据库 监控实例类型:MySQL实例 rds022_myisam_buf_write_hit Key Buffer写命中率 该指标用于统计MyISAM Key buffer写命中率,以比率为单位。 0-1 测量对象:数据库 监控实例类型:MySQL实例 rds023_myisam_buf_read_hit Key Buffer读命中率 该指标用于统计MyISAM Key buffer读命中率,以比率为单位。 0-1 测量对象:数据库 监控实例类型:MySQL实例 rds024_myisam_disk_write_count MyISAM硬盘写入频率 该指标用于统计向磁盘写入索引的次数,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds025_myisam_disk_read_count MyISAM硬盘读取频率 该指标用于统计从磁盘读取索引的次数,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds026_myisam_buf_write_count MyISAM缓冲池写入频率 该指标用于统计向缓冲池写入索引的请求次数,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds027_myisam_buf_read_count MyISAM缓冲池读取频率 该指标用于统计从缓冲池读取索引的请求次数,以次/秒为单位。 ≥ 0 counts/s 测量对象:数据库 监控实例类型:MySQL实例 rds028_comdml_del_count Delete语句执行频率 该指标用于统计平均每秒Delete语句执行次数,以次/秒为单位。 ≥ 0 queries/s 测量对象:数据库 监控实例类型:MySQL实例 rds029_comdml_ins_count Insert语句执行频率 该指标用于统计平均每秒Insert语句执行次数,以次/秒为单位。 ≥ 0 queries/s 测量对象:数据库 监控实例类型:MySQL实例 rds030_comdml_ins_sel_count Insert_Select语句执行频率 该指标用于统计平均每秒Insert_Select语句执行次数,以次/秒为单位。 ≥ 0 queries/s 测量对象:数据库 监控实例类型:MySQL实例 rds031_comdml_rep_count Replace语句执行频率 该指标用于统计平均每秒Replace语句执行次数,以次/秒为单位。 ≥ 0 queries/s 测量对象:数据库 监控实例类型:MySQL实例 rds032_comdml_rep_sel_count Replace_Selection语句执行频率 该指标用于统计平均每秒Replace_Selection语句执行次数,以次/秒为单位。 ≥ 0 queries/s 测量对象:数据库 监控实例类型:MySQL实例 rds033_comdml_sel_count Select语句执行频率 该指标用于统计平均每秒Select语句执行次数。 ≥ 0 queries/s 测量对象:数据库 监控实例类型:MySQL实例 rds034_comdml_upd_count Update语句执行频率 该指标用于统计平均每秒Update语句执行次数,以次/秒为单位。 ≥ 0 queries/s 测量对象:数据库 监控实例类型:MySQL实例 rds035_innodb_del_row_count 行删除速率 该指标用于统计平均每秒从InnoDB表删除的行数,以行/秒为单位。 ≥ 0 rows/s 测量对象:数据库 监控实例类型:MySQL实例 rds036_innodb_ins_row_count 行插入速率 该指标用于统计平均每秒向InnoDB表插入的行数,以行/秒为单位。 ≥ 0 rows/s 测量对象:数据库 监控实例类型:MySQL实例 rds037_innodb_read_row_count 行读取速率 该指标用于统计平均每秒从InnoDB表读取的行数,以行/秒为单位。 ≥ 0 rows/s 测量对象:数据库 监控实例类型:MySQL实例 rds038_innodb_upd_row_count 行更新速率 该指标用于统计平均每秒向InnoDB表更新的行数,以行/秒为单位。 ≥ 0 rows/s 测量对象:数据库 监控实例类型:MySQL实例 rds039_disk_util 磁盘利用率 该指标用于统计测量对象的磁盘利用率,以百分比为单位。 0-100% 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds040_transaction_logs_usage 事务日志使用量 事务日志所占用的磁盘容量。 ≥ 0 MB 测量对象:数据库 监控实例类型:PostgreSQL实例 rds041_replication_slot_usage 复制插槽使用量 复制插槽文件所占磁盘容量。 ≥ 0 MB 测量对象:数据库 监控实例类型:PostgreSQL实例 rds042_database_connections 数据库连接数 当前连接到数据库的后端量。 ≥ 0 counts 测量对象:数据库 监控实例类型:PostgreSQL实例 rds043_maximum_used_transaction_ids 事务最大已使用ID数 事务最大已使用ID。 ≥ 0 counts 测量对象:数据库 监控实例类型:PostgreSQL实例 rds044_transaction_logs_generations 事务日志生成速率 平均每秒生成的事务日志大小。 ≥ 0 MB/s 测量对象:数据库 监控实例类型:PostgreSQL实例 rds045_oldest_replication_slot_lag 最滞后副本滞后量 多个副本中最滞后副本(依据接收到的WAL数据)滞后量。 ≥ 0 MB 测量对象:数据库 监控实例类型:PostgreSQL实例 rds046_replication_lag 复制时延 副本滞后时延。 ≥ 0 ms 测量对象:数据库 监控实例类型:PostgreSQL实例 read_count_per_second 读IOPS 该指标用于统计当前实例,单位时间内系统处理的读I/O请求数量(平均值)。 ≥ 0 counts/s 测量对象:弹性云服务器 监控实例类型:PostgreSQL实例 write_count_per_second 写IOPS 该指标用于统计当前实例,单位时间内系统处理的写I/O请求数量(平均值)。 ≥ 0 counts/s 测量对象:弹性云服务器 监控实例类型:PostgreSQL实例 inactive_logical_replication_slot 非活跃逻辑复制槽数量 该指标用于统计当前数据库中存在的非活跃逻辑复制槽数量。 ≥ 0 测量对象:数据库 监控实例类型:PostgreSQL实例 pgaudit_log_size 审计日志大小 该指标为获取当前审计日志的大小。 ≥ 0 GB 测量对象:数据库 监控实例类型:PostgreSQL实例 rds047_disk_total_size 磁盘总大小 该指标用于统计测量对象的磁盘总大小。 40GB~4000GB 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds048_disk_used_size 磁盘使用量 该指标用于统计测量对象的磁盘使用大小。 0GB~4000GB 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds049_disk_read_throughput 硬盘读吞吐量 该指标用于统计每秒从硬盘读取的字节数。 ≥ 0 bytes/s 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds050_disk_write_throughput 硬盘写吞吐量 该指标用于统计每秒写入硬盘的字节数。 ≥ 0 bytes/s 测量对象:弹性云服务器,监控实例类型: MySQL PostgreSQL Microsoft SQL Server rds054_db_connections_in_use 使用中的数据库连接数 用户连接到数据库的连接数量。 ≥ 0 counts 测量对象:数据库 监控实例类型:Microsoft SQL Server实例 rds075_avg_disk_ms_per_read 硬盘读耗时 该指标用于统计某段时间平均每次读取磁盘所耗时间。 ≥ 0 ms 测量对象:弹性云服务器 监控实例类型:MySQL实例 rds076_avg_disk_ms_per_write 硬盘写耗时 该指标用于统计某段时间平均写入磁盘所耗时间。 ≥ 0 ms 测量对象:弹性云服务器 监控实例类型:MySQL实例
  • 错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 错误码列表: 表1 v3错误码说明 状态码 错误码 说明 400 DBS.01010220 当前实例不是只读状态。 500 DBS.01010221 解除节点只读状态失败。 500 DBS.108000 服务器错误。 500 DBS.108002 服务器错误。 500 DBS.108005 服务器错误。 400 DBS.200001 参数错误。 404 DBS.200002 RDS实例不存在。 400 DBS.200004 参数错误。 500 DBS.200005 服务器错误。 400 DBS.200006 请求为空,请输入请求参数。 404 DBS.200008 请检查数据库,确认实例的虚拟机信息,找不到该实例的虚拟机信息。 403 DBS.200010 实例ID和用户ID可能为空,或者操作越权。 409 DBS.200011 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 404 DBS.200013 源实例不存在。 409 DBS.200019 该实例正在进行其他操作或该实例故障,无法执行该操作,请稍后重试。 400 DBS.200021 实例名非法。 409 DBS.200022 实例名称已存在。 400 DBS.200023 卷大小超出允许范围。 400 DBS.200024 Region非法。 400 DBS.200025 非法的可用区。 400 DBS.200026 卷类型非法。 400 DBS.200027 卷大小不是10的整数倍。 400 DBS.200037 实例引擎版本不一致。 400 DBS.200038 当前实例数据库主备同步关系异常,无法执行该操作。 400 DBS.200039 当前实例主备同步延时大于5分钟,不允许此操作。 400 DBS.200040 不支持的数据库类型或版本。 400 DBS.200041 数据库版本非法。 400 DBS.200042 Datastore不存在。 400 DBS.200043 HA同步模式非法。 403 DBS.200044 访问资源不存在,或者无访问权限。 404 DBS.200045 RDS实例不存在。 413 DBS.200046 实例数量达到配额。 409 DBS.200047 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 400 DBS.200048 VPC id非法。 400 DBS.200049 子网的网络id非法。 404 DBS.200050 安全组不存在,或不属于该VPC。 400 DBS.200051 不合法的ha模式 400 DBS.200052 数据库root密码非法。 400 DBS.200053 所选规格不存在。 400 DBS.200054 所选规格非法。 400 DBS.200055 replica_of_id非法。 400 DBS.200056 节点个数达到最大值。 400 DBS.200062 数据库用户名非法。 400 DBS.200063 集群模式非法。 400 DBS.200076 实例或节点非正常状态。 400 DBS.200080 主备节点正在进行数据同步,请稍后重试。 400 DBS.200086 实例状态不允许做该操作。 400 DBS.200087 单个实例标签数量达到最大配额。 400 DBS.200098 该资源标签已存在。 400 DBS.200121 请选择不同于备机的可用区做迁移。 400 DBS.200203 查询实例失败。 500 DBS.200208 服务器错误。 400 DBS.200302 卷大小不是10的整数倍。 400 DBS.200303 扩容次数达到最大限制。 400 DBS.200306 扩容参数不合法。 400 DBS.200308 备机扩容后的大小不能超过主机。 400 DBS.200311 节点状态异常, 不允许扩容, 请联系技术服务处理。 409 DBS.200316 当前实例状态为存储空间满,不能进行该操作 409 DBS.200402 操作不合法。 400 DBS.200405 参数错误。 404 DBS.200408 节点信息填写错误。 400 DBS.200461 参数值超出范围。 404 DBS.200470 Region或可用区不存在。 404 DBS.200501 子网不存在,或不属于该VPC。 404 DBS.200503 VPC不存在,或不属于该用户。 400 DBS.200504 数据库版本非法。 400 DBS.200506 KMS非法。 400 DBS.200507 密钥失效或已删除。 400 DBS.200543 任务不存在。 404 DBS.200602 该实例不存在。 403 DBS.200604 实例ID和用户ID可能为空,或者操作越权。 403 DBS.200810 不能在只读实例中创建数据库。 403 DBS.200819 不能在只读实例中删除数据库用户。 500 DBS.200821 修改数据库用户权限失败 400 DBS.200823 数据库不存在 400 DBS.200824 数据库账号不存在 400 DBS.200825 不能在只读实例上修改权限操作。 409 DBS.200826 数据库名称已存在 409 DBS.200827 账号名称已存在。 409 DBS.200828 数据库内置账号,用户不可创建。 500 DBS.200835 删除数据库失败,数据库锁等待超时。 500 DBS.200811 创建数据库失败。 403 DBS.201003 访问资源不存在,或者无访问权限。 400 DBS.201006 参数错误。 404 DBS.201010 备份信息不存在。 400 DBS.201014 实例状态不允许做该操作。 404 DBS.201028 实例不存在或已删除。 400 DBS.201035 输入的数据库名重复或者输入的数据库名与目标库上的重复。 400 DBS.201041 带有外键的表不允许该操作 400 DBS.201101 备份周期非法。 400 DBS.201103 备份开始时间非法。 400 DBS.201106 保留天数非法。 409 DBS.201201 对象已存在。 409 DBS.201202 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试 400 DBS.201203 备份文件不存在。 409 DBS.201205 正在备份中,请稍等。 400 DBS.201207 不支持该数据库引擎或版本。 400 DBS.201208 备份状态不允许该操作。 404 DBS.212001 参数组不存在。 400 DBS.212002 参数组配额错误。 400 DBS.212003 不支持此操作。 400 DBS.212004 参数组更新错误。 400 DBS.212005 节点不属于组。 409 DBS.212006 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 400 DBS.212007 引擎不存在。 400 DBS.212008 不支持的引擎。 400 DBS.212009 任务处理失败。 400 DBS.212010 绑定正在执行。 400 DBS.212011 绑定失败。 400 DBS.212012 参数不存在。 404 DBS.212013 对象不存在。 400 DBS.212014 节点没有默认参数组。 400 DBS.212015 部分成功。 400 DBS.212016 参数更新失败。 400 DBS.212017 参数错误。 422 DBS.212019 请求中的参数或对象不能被正确识别。 400 DBS.212025 更新失败。 400 DBS.212030 参数错误。 400 DBS.212032 已被应用。 400 DBS.212037 参数设置不正确。 500 DBS.213002 请求处理失败。 500 DBS.213004 请求处理失败。 400 DBS.216028 内部资源配额不足。 400 DBS.280001 参数错误。 409 DBS.280011 该实例正在进行其它操作或该实例故障,无法执行该操作,请稍后重试。 403 DBS.280015 访问资源不存在,或者无访问权限。 403 DBS.280020 账户受限。 401 DBS.280058 当前用户没有操作权限,请通过 IAM 检查账户权限。 403 DBS.280056 Token非法。 404 DBS.280110 所选实例不存在。 400 DBS.280127 备份描述非法。 400 DBS.280128 数据库名不存在。 400 DBS.280204 输入参数不合法。 400 DBS.280214 备份不存在。 400 DBS.280216 备份开始时间非法。 400 DBS.280235 数据库类型非法 400 DBS.280237 Datastore为空。 400 DBS.280238 不支持的数据库类型或版本。 400 DBS.280239 所选规格非法。 400 DBS.280241 卷类型非法。 400 DBS.280242 卷大小超出允许范围。 400 DBS.280246 数据库root密码非法 400 DBS.280250 备份保留期非法。 400 DBS.280251 备份周期不合法。 400 DBS.280253 备份开始时间非法。 400 DBS.280262 Ha同步模式非法。 400 DBS.280270 参数不存在。 400 DBS.280271 参数值超出范围。 400 DBS.280272 新增tag存在重复的key。 404 DBS.280275 源实例不存在。 400 DBS.280277 备份名称非法。 400 DBS.280285 可用区取值非法 400 DBS.280288 规格非法 400 DBS.280311 存储空间大小非法 400 DBS.280325 硬盘信息不合法 400 DBS.280328 当前实例类型不支持此操作。 400 DBS.280342 集群模式非法 400 DBS.280364 数据库端口号无效 400 DBS.280402 Ha模式非法。 400 DBS.280404 实例ID非法。 409 DBS.280406 实例类型或状态受限,操作不允许。 400 DBS.280434 所选规格码非法。 400 DBS.280448 当前卷类型已售罄。 400 DBS.280449 不能对冻结的对象执行该操作。 400 DBS.280450 当前规格已售罄。 400 DBS.280457 协调节点数量非法。 400 DBS.280458 分片数量非法 400 DBS.280461 扩容分片数非法 400 DBS.280489 实例已关联DDM组件,请先在DDM界面删除。 400 DBS.280490 备份已关联DDM组件,请先在DDM界面删除。 400 DBS.280649 实例名长度非法。 400 DBS.280810 设置数据库用户读写权限失败,用户可能不存在,请检查配置。 400 DBS.280812 实例已处于该状态,请勿重复点击。 400 DBS.280813 当前实例存在大事务或DDL等场景,不能进行该操作。 400 DBS.280816 当前实例处于DRS迁移任务中,请稍后重试。 400 DBS.290000 参数错误。 400 DBS.290001 参数错误。 404 DBS.290002 所选规格不存在。 413 DBS.290003 实例数量达到配额。 404 DBS.290005 该实例不存在。 500 DBS.290006 请求处理失败。 404 DBS.290011 RDS实例不存在。 404 DBS.290013 未找到资源。 500 DBS.290015 请求处理失败。 400 DBS.301051 该实例不存在容灾关系。 400 DBS.301132 实例已经是停止状态。 400 DBS.301133 实例已经是开启状态。 父主题: 附录
  • 状态码 状态码如表1所示: 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 200 OK 请求成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 203 Non-Authoritative Information 非授权信息,请求成功。 204 NoContent 请求完全成功,同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容,服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置,相应可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择。 301 Moved Permanently 永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长(URI通常为网址),服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确,但是由于含有语义错误,无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部,然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时(Timeout)参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本,无法完成处理。 父主题: 附录
  • RDS授权分类 表1 公共查询 权限 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 实例授权 查询数据库引擎版本 GET /v3/{projectId}/datastores/{database_name} 无需授权 √ √ × 查询数据库规格 GET /v3/{project_id}/flavors/{database_name}?version_name={version_name} 无需授权 √ √ × 查询数据库存储规格 GET /v3/{project_id}/storage-type/{database_name}?version_name={version_name} 无需授权 √ √ × 表2 实例管理 API功能 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 实例授权 创建数据库实例 POST /v3/{project_id}/instances rds:instance:create (创建加密实例需要在项目上配置KMS Administrator权限。) √ √ × 修改实例名称 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/name rds:instance:modify √ √ √ 修改实例备注 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/alias rds:instance:modify √ √ √ 申请内网 域名 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/create-dns rds:instance:createDns √ √ × 修改内网域名 PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-dns rds:instance:modifyDns √ √ √ 变更数据库实例的规格 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:modifySpec √ √ × 扩容数据库实例的磁盘空间 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:extendSpace √ √ √ 单机转主备实例 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:singleToHa (加密实例需要在项目上配置KMS Administrator权限。) √ √ √ 重启数据库实例 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:restart √ √ √ 删除数据库实例 DELETE /v3/{project_id}/instances/{instance_id} rds:instance:delete √ √ √ 查询数据库实例列表 GET /v3/{project_id}/instances rds:instance:list √ √ √ 查询跨区域备份实例列表 GET /v3/{project_id}/backups/offsite-backup-instance rds:instance:list √ √ √ 绑定和解绑弹性公网IP PUT /v3/{project_id}/instances/{instance_id}/public-ip rds:instance:modifyPublicAccess √ √ × 修改数据库实例密码 PUT /v3/{project_id}/instances/{instance_id}/password rds:password:update √ √ √ 手动主备倒换 PUT /v3/{project_id}/instances/{instance_id}/failover rds:instance:switchover √ √ √ 修改主备切换策略 PUT /v3/{project_id}/instances/{instance_id}/failover/strategy rds:instance:modifyStrategy √ √ √ 修改主备同步模式 PUT /v3/{project_id}/instances/{instance_id}/failover/mode rds:instance:modifySynchronizeModel √ √ √ 修改运维时间窗 PUT /v3/{project_id}/instances/{instance_id}/ops-window rds:instance:modify √ √ √ 备机可用区迁移 POST /v3/{project_id}/instances/{instance_id}/migrateslave rds:instance:create √ √ × 表3 灾备实例 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 配置主实例容灾能力 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:buildDrRelation √ √ × 配置灾备实例容灾能力 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:buildDrRelation √ √ √ 灾备升主 POST /v3/{project_id}/instances/{instance_id}/action rds:instance:modifyDRRole √ √ √ 查询跨云容灾复制状态 GET /v3/{project_id}/instances/{instance_id}/disaster-recovery rds:instance:list √ √ × 表4 数据库安全性 API功能 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 实例授权 设置SSL 数据加密 PUT /v3/{project_id}/instances/{instance_id}/ssl rds:instance:modifySSL √ √ √ 修改数据库端口 PUT /v3/{project_id}/instances/{instance_id}/port rds:instance:modifyPort √ √ √ 修改内网地址 PUT /v3/{project_id}/instances/{instance_id}/ip rds:instance:modifyIp √ √ √ 修改安全组 PUT /v3/{project_id}/instances/{instance_id}/security-group rds:instance:modifySecurityGroup √ √ √ 表5 参数配置 API功能 对应API接口 授权项(Action) IAM项目(Project) 企业项目(Enterprise Project) 实例授权 获取参数模板列表 GET /v3/{project_id}/configurations rds:param:list √ √ √ 创建参数模板 POST /v3/{project_id}/configurations rds:param:create √ √ × 修改参数模板参数 PUT /v3/{project_id}/configurations/{config_id} rds:param:modify √ √ √ 应用参数模板 PUT /v3/{project_id}/configurations/{config_id}/apply rds:param:apply √ √ × 修改指定实例的参数 PUT /v3/{project_id}/instances/{instance_id}/configurations rds:param:modify √ √ √ 获取指定实例的参数模板 GET /v3/{project_id}/instances/{instance_id}/configurations rds:param:list √ √ √ 获取指定参数模板的参数 GET /v3/{project_id}/configurations/{config_id} rds:param:list √ √ √ 删除参数模板 DELETE /v3/{project_id}/configurations/{config_id} rds:param:delete √ √ × 表6 备份与恢复 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 设置自动备份策略 PUT /v3/{project_id}/instances/{instance_id}/backups/policy rds:instance:modifyBackupPolicy √ √ √ 设置跨区域备份策略 PUT /v3/{project_id}/instances/{instance_id}/backups/offsite-policy rds:instance:modifyBackupPolicy √ √ √ 查询自动备份策略 GET /v3/{project_id}/instances/{instance_id}/backups/policy rds:instance:list √ √ √ 查询跨区域备份策略 GET /v3/{project_id}/instances/{instance_id}/backups/offsite-policy rds:instance:list √ √ √ 创建手动备份 POST /v3/{project_id}/backups rds:backup:create √ √ × 获取备份列表 GET /v3/{project_id}/backups?instance_id={instance_id} rds:backup:list √ √ × 获取跨区域备份列表 GET /v3/{project_id}/offsite-backups?instance_id={instance_id} rds:backup:list √ √ × 获取备份下载链接 GET /v3/{project_id}/backup-files?backup_id={backup_id} rds:backup:download √ √ × 删除手动备份 DELETE /v3/{project_id}/backups/{backup_id} rds:backup:delete √ √ × 查询可恢复时间段 GET /v3/{project_id}/instances/{instance_id}/restore-time rds:instance:list √ √ × 查询跨区域备份可恢复时间段 GET /v3/{project_id}/instances/{instance_id}/offsite-restore-time rds:instance:list √ √ × 恢复到新实例 POST /v3/{project_id}/instances rds:instance:create (加密实例需要在项目上配置KMS Administrator权限。) √ √ × 恢复到已有或当前实例 POST /v3/{project_id}/instances/recovery rds:instance:restoreInPlace √ √ × 表7 获取日志信息 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 查询数据库错误日志 GET /v3/{project_id}/instances/{instance_id}/errorlog?start_date={start_date}&end_date={end_date} rds:log:list √ √ √ 查询数据库慢日志 GET /v3/{project_id}/instances/{instance_id}/slowlog?start_date={start_date}&end_date={end_date} rds:log:list √ √ √ 设置审计日志策略 PUT /v3/{project_id}/instances/{instance_id}/auditlog-policy rds:auditlog:operate √ √ √ 查询审计日志策略 GET /v3/{project_id}/instances/{instance_id}/auditlog-policy rds:auditlog:list √ √ √ 获取审计日志列表 GET /v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}&offset={offset}&limit={limit} rds:auditlog:list √ √ √ 生成审计日志下载链接 POST /v3/{project_id}/instances/{instance_id}/auditlog-links rds:auditlog:download √ √ √ 获取慢日志下载链接 POST /v3/{project_id}/instances/{instance_id}/slowlog-download rds:log:download √ √ √ 获取binlog本地保留时长 GET /v3/{project_id}/instances/{instance_id}/binlog/clear-policy rds:binlog:get √ √ √ 设置binlog本地保留时长 PUT /v3/{project_id}/instances/{instance_id}/binlog/clear-policy rds:binlog:setPolicy √ √ √ 表8 管理数据库和用户(MySQL) API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 创建数据库 POST /v3/{project_id}/instances/{instance_id}/database rds:database:create √ √ √ 查询数据库列表 GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit} rds:database:list √ √ √ 查询指定用户的已授权数据库 GET /v3/{project_id}/instances/{instance_id}/db_user/database?user-name={user-name}&page={page}&limit={limit} rds:database:list √ √ √ 删除数据库 DELETE /v3/{project_id}/instances/{instance_id}/database/{db_name} rds:database:drop √ √ √ 创建数据库用户 POST /v3/{project_id}/instances/{instance_id}/db_user rds:databaseUser:create √ √ √ 查询数据库用户列表 GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit} rds:databaseUser:list √ √ √ 查询指定数据库的已授权用户 GET /v3/{project_id}/instances/{instance_id}/database/db_user?db-name={db-name}&page={page}&limit={limit} rds:databaseUser:list √ √ √ 修改数据库用户的备注 PUT /v3/{project_id}/instances/{instance_id}/db-users/{user_name}/comment rds:databaseUser:update √ √ √ 删除数据库用户 DELETE /v3/{project_id}/instances/{instance_id}/db_user/{user_name} rds:databaseUser:drop √ √ √ 授权数据库账号 POST /v3/{project_id}/instances/{instance_id}/db_privilege rds:databasePrivilege:grant √ √ √ 修改数据库账号密码 POST /v3/{project_id}/instances/{instance_id}/db_user/resetpwd rds:password:update √ √ √ 解除数据库账号权限 DELETE /v3/{project_id}/instances/{instance_id}/db_privilege rds:databasePrivilege:revoke √ √ √ 表9 管理数据库和用户(PostgreSQL) API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 创建数据库 POST /v3/{project_id}/instances/{instance_id}/database rds:database:create √ √ √ 创建数据库用户 POST /v3/{project_id}/instances/{instance_id}/db_user rds:databaseUser:create √ √ √ 授权数据库账号 POST /v3/{project_id}/instances/{instance_id}/db_privilege rds:databasePrivilege:grant √ √ √ 创建数据库 schema POST /v3/{project_id}/instances/{instance_id}/schema rds:database:create √ √ √ 查询数据库列表 GET /v3/{project_id}/instances/{instance_id}/database/detail?page={page}&limit={limit} rds:database:list √ √ √ 查询数据库用户列表 GET /v3/{project_id}/instances/{instance_id}/db_user/detail?page={page}&limit={limit} rds:databaseUser:list √ √ √ 查询数据库SCHEMA列表 GET /v3/{project_id}/instances/{instance_id}/schema/detail?db_name={name}page={page}&limit={limit} rds:database:list √ √ √ 修改数据库用户的备注 PUT /v3/{project_id}/instances/{instance_id}/db-users/{user_name}/comment rds:databaseUser:update √ √ √ 表10 回收站 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 设置回收站策略 PUT https://{Endpoint}/v3/{project_id}/instances/recycle-policy rds:instance:setRecycleBin √ × × 表11 标签管理 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 批量添加删除标签 POST /v3/{project_id}/instances/{instance_id}/tags/action rds:instance:dealTag √ √ √ 查询项目标签 GET /v3/{project_id}/tags rds:tag:list √ √ × 表12 配额管理 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 查询配额 GET https://{Endpoint}/v3/{project_id}/quotas rds:instance:list √ √ √ 表13 任务功能 API功能 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 实例授权 获取任务信息 GET /v3/{project_id}/jobs?id={id} rds:task:list √ √ × 父主题: 权限和授权项
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。
  • 响应消息 正常响应要素说明 表2 要素说明 参数 参数类型 描述 total_count Integer 历史记录总数。 histories Array of objects 参数修改历史。 详情请参见表3。 表3 histories字段数据结构说明 名称 参数类型 说明 parameter_name String 参数名称。 old_value String 旧参数值。 new_value String 新参数值。 update_result String 更新结果。 SUCCESS:成功。 FAILED:失败。 applied Boolean 是否已应用。 true:已应用。 false:未应用。 update_time String 参数修改时间。 apply_time String 参数应用时间。 正常响应样例 { "total_count" : 3, "histories" : [ { "parameter_name" : "fill factor (%)", "old_value" : "0", "new_value" : "2", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:39:21+0000", "apply_time" : "2022-10-31T01:46:29+0000" }, { "parameter_name" : "remote login timeout (s)", "old_value" : "10", "new_value" : "20", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:38:36+0000", "apply_time" : "2022-10-29T09:38:36+0000" }, { "parameter_name" : "remote query timeout (s)", "old_value" : "600", "new_value" : "601", "update_result" : "SUCCESS", "applied" : true, "update_time" : "2022-10-29T09:40:30+0000", "apply_time" : "2022-10-29T09:40:30+0000" } ] } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/configuration-histories?offset={offset}&limit={limit}&start_time={start_time}&end_time={end_time}¶m_name={param_name} 参数说明 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 offset 否 Integer 分页参数。 缺省值:0 limit 否 Integer 分页参数。 缺省值:10 start_time 否 String 开始时间默认为当前时间的前7天,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 end_time 否 String 结束时间默认为当前时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 param_name 否 String 参数名称。
  • 响应消息 正常响应要素说明 表3 要素说明 名称 参数类型 说明 id String 参数模板ID。 name String 参数模板名称。 description String 描述。 datastore_version_name String 数据库版本名称。 datastore_name String 数据库名称。 create_time String 创建时间,格式为“yyyy-MM-ddTHH:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 update_time String 更新时间,格式为“yyyy-MM-ddTHH:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 正常响应样例 { "id" : "a73a272e50ba427397e90992fbb96f3cpr04", "name" : "copy_by_v31", "description" : "copy", "datastore_version_name" : "2017_EE", "datastore_name" : "sqlserver", "create_time" : "2022-10-31T08:24:06+0000", "update_time" : "2022-10-31T08:24:06+0000" } 异常响应 请参见异常请求结果。
共100000条