华为云用户手册

  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 backups Array of objects 参数解释: 备份列表。 详情请参见表3。 total_count Integer 参数解释: 总记录数。 取值范围: 不涉及。 表3 backups字段数据结构说明 名称 参数类型 说明 id String 参数解释: 备份ID。 取值范围: 不涉及。 name String 参数解释: 备份名字。 取值范围: 不涉及。 type String 参数解释: 备份类型。 取值范围: auto:自动全量备份。 manual:手动全量备份。 fragment:差异全量备份。 incremental:自动增量备份。对于RDS for MySQL为Binlog备份。 size Long 参数解释: 备份大小,单位:KB。 取值范围: 不涉及。 status String 参数解释: 备份状态。 取值范围: BUILDING:备份中。 COMPLETED:备份完成。 FAILED:备份失败。 DELETING:备份删除中。 begin_time String 参数解释: 备份开始时间。 全量备份类型下,指备份开始时间。 MySQL增量备份类型,指备份文件中上一轮增备任务的最后一个事务的提交时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 end_time String 参数解释: 备份结束时间。 全量备份类型下,指备份结束时间。 MySQL增量备份类型,指备份文件中最后一个事务的提交时间。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”,其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 datastore Object 参数解释: 数据库版本信息。 详情请参见表4。 databases Array of objects 参数解释: 用户自建库,仅Microsoft SQL Server的局部备份。 详情请参见表5。 instance_id String 参数解释: 备份所在实例ID。 取值范围: 不涉及。 associated_with_ddm Boolean 参数解释: 是否已被DDM实例关联。 取值范围: false:表示未被DDM实例关联。 true:表示被DDM实例关联。 表4 datastore字段数据结构说明 名称 参数类型 说明 type String 参数解释: 数据库引擎。 取值范围: 不区分大小写。 MySQL PostgreSQL SQLServer version String 参数解释: 数据库版本。 取值范围: 不涉及。 表5 databases字段数据结构说明 名称 参数类型 说明 name String 参数解释: 用户自建数据库名。 取值范围: 不涉及。 正常响应样例 RDS for MySQ L实例 : { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br01", "name": "xxxx.xxx", "type": "auto", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "MySQL", "version": "5.7" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin01", "associated_with_ddm": false }], "total_count": 1 } RDS for PostgreSQL实例: { "backups": [{ "id": "43e4feaab48f11e89039fa163ebaa7e4br03", "name": "xxxx.xxx", "type": "incremental", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "PostgreSQL", "version": "1" }, "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin03 ", "associated_with_ddm": false }], "total_count": 1 } RDS for SQL Server实例: { "backups": [{ "id ": "43e4feaab48f11e89039fa163ebaa7e4br04", "name": "xxxx.xxx", "type": "manual", "size": 2803, "status": "COMPLETED", "begin_time": "2018-08-06T12:41:14+0800", "end_time": "2018-08-06T12:43:14+0800", "datastore": { "type": "SQLServer", "version": "2014_WEB" }, "databases": [{ "name": "user01" }, { "name": "user02" }], "instance_id": "a48e43ff268f4c0e879652d65e63d0fbin04", "associated_with_ddm": false }], "total_count": 1 } 异常响应 请参见异常请求结果。
  • 请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4in01&backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&backup_type=auto&offset=0&limit=10&begin_time=2018-08-06T10:41:14+0800&end_time=2018-08-16T10:41:14+0800
  • URI URI格式 GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin _time}&end_time={end_time} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 backup_id 否 参数解释: 备份ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 backup_type 否 参数解释: 备份类型。 约束限制: 不涉及。 取值范围: auto:自动全量备份。 manual:手动全量备份。 fragment:差异全量备份。 incremental:自动增量备份。对于RDS for MySQL为Binlog备份。 默认取值: 不涉及。 status 否 参数解释: 备份状态,只支持筛选RDS for SQL Server的全量备份的状态。 约束限制: 不涉及。 取值范围: BUILDING:备份中。 COMPLETED:备份完成。 FAILED:备份失败。 默认取值: 不涉及。 offset 否 参数解释: 索引位置,偏移量。 约束限制: 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。 取值范围: 大于等于0的整数。 默认取值: 0 limit 否 参数解释: 查询记录数。 约束限制: 不能为负数。 取值范围: 最小值为1,最大值为100。 默认取值: 100 begin_time 否 参数解释: 查询开始时间。 约束限制: “begin_time”有值时,“end_time”必选。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 默认取值: 不涉及。 end_time 否 参数解释: 查询结束时间。 约束限制: “end_time”有值时,“begin_time”必选。 取值范围: 格式为“yyyy-mm-ddThh:mm:ssZ”,且大于查询开始时间。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 默认取值: 不涉及。
  • 请求消息 参数说明 表2 参数说明 参数 是否必选 参数类型 描述 period_type 是 String 参数解释: 周期类型。 约束限制: 不涉及。 取值范围: MONTH:月 YEAR:年 默认取值: 不涉及。 period_num 是 int 参数解释: 周期数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 auto_pay_policy 否 String 参数解释: 是否自动支付。 约束限制: 不涉及。 取值范围: YES:自动扣费 NO:手动支付(默认) 默认取值: NO auto_renew_policy 否 String 参数解释: 是否到期自动续期。 约束限制: 不涉及。 取值范围: YES:自动续费 NO:不自动续费(默认) 默认取值: NO URI样例 POST https://rds.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/49b9dd1d6f464ba4bc91df5cbd2e52ebin03/to-period 请求示例 RDS实例按需转包周期。 { "period_type" : "MONTH", "period_num" : 6, "auto_pay_policy" : "NO", "auto_renew_policy" : "NO" }
  • URI URI格式 POST /v3/{project_id}/instances/{instance_id}/to-period 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 databases Array of objects 列表中每个元素表示一个数据库。 详情请参见表3。 表3 databases元素结构说明 名称 参数类型 说明 name String 数据库名称。 character_set String 数据库使用的字符集,例如utf8、gbk、ascii等。 users Array of objects 列表中每个元素表示一个与数据库关联的账号。 详情请参见表4。 表4 users元素结构说明 名称 参数类型 说明 name String 账号名。 readonly Boolean 是否为只读权限: true表示只读。 false表示可读写。 正常响应样例 { "databases": [ { "name": "rds-test", "character_set": "utf8", "users": [ { "name": "rds", "readonly": false } ] }, { "name": "testdb1", "character_set": "utf8", "users": [] }, { "name": "tt", "character_set": "utf8", "users": [] } ] } 异常响应 请参见异常请求结果。
  • 请求消息 请求参数 表2 参数说明 名称 参数类型 是否必选 说明 target_version String 是 目标版本。 URI样例 https://{Endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/3aa441c4c98a4b36b100a7e3e87d17cein03/major-version/inspection { "target_version": "14.9.0" }
  • URI URI格式 GET /v3/{project_id}/flavors/{database_name}?version_name={version_name}&spec_code={spec_code}&is_serverless={is_serverless} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 database_name 是 参数解释: 数据库引擎名。 约束限制: 不涉及。 取值范围: MySQL PostgreSQL SQLServer 默认取值: 不涉及。 version_name 否 参数解释: 数据库版本号,获取方法请参见查询数据库引擎的版本。(可输入小版本号) 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 is_serverless 否 参数解释: 是否查询Serverless规格。 约束限制: 不涉及。 取值范围: true:查询Serverless规格。 false:查询非Serverless规格。 默认取值: false spec_code 否 参数解释: 规格编码。 说明: RDS for MySQL规格码请参见云数据库 RDS for MySQL实例类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 keep_days 是 Integer 审计日志保存天数,取值范围0~732。 取值0,表示关闭审计日志策略。 取值1~732,表示开启审计日志策略,并设置审计日志保存天数为该值。 reserve_auditlogs 否 Boolean 仅关闭审计日志策略时有效。 true(默认),表示关闭审计日志策略的同时,延迟删除已有的历史审计日志。 false,表示关闭审计日志策略的同时,删除已有的历史审计日志。 audit_types 否 Array of strings 该参数仅针对RDS for MySQL引擎。 审计日志的操作类型,仅打开审计日志策略时有效。参数值为空时,默认为全部操作类型。 CREATE_USER,DROP_USER,RENAME_USER,GRANT,REVOKE,ALTER_USER,ALTER_USER_DEFAULT_ROLE CREATE,ALTER,DROP,RENAME,TRUNCATE,REPAIR,OPTIMIZE INSERT,DELETE,UPDATE,REPLACE,SELECT BEGIN/COMMIT/ROLLBACK,PREPARED_STATEMENT,CALL_PROCEDURE,KILL,SET_OPTION,CHANGE_DB,UNINSTALL_PLUGIN,INSTALL_PLUGIN,SHUTDOWN,SLAVE_START,SLAVE_STOP,LOCK_TABLES,UNLOCK_TABLES,FLUSH,XA
  • 请求示例 设置审计日志保存5天。 PUT https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog-policy { "keep_days":5, "audit_types": [ "CREATE_USER" ] } 关闭审计日志策略,同时删除已有的历史审计日志。 { "keep_days":0, "reserve_auditlogs":false }
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 database_limit Integer 参数解释: 每次返回的库上限数量。 取值范围: 不涉及。 total_tables Integer 参数解释: 返回的总表数量。 取值范围: 不涉及。 table_limit Integer 参数解释: 每次返回的表上限数量。 取值范围: 不涉及。 databases Array of objects 参数解释: 可恢复到主实例的数据库列表。 详情请参见表3。 表3 databases字段数据结构说明 名称 参数类型 说明 name String 参数解释: 数据库名称。 取值范围: 不涉及。 total_tables Integer 参数解释: 返回该库下的总表数量。 取值范围: 不涉及。 schemas Array of objects 参数解释: 该库下的schema列表。 详情请参见表4。 表4 schemas字段数据结构说明 名称 参数类型 说明 name String 参数解释: schema名称。 取值范围: 不涉及。 total_tables Integer 参数解释: 返回该schema下的总表数量。 取值范围: 不涉及。 tables Array of objects 参数解释: 该schema下的表列表。 详情请参见表5。 表5 tables字段数据结构说明 名称 参数类型 说明 name String 参数解释: 表名称。 取值范围: 不涉及。 正常响应样例 { "databases" : [ { "name" : "postgres", "schemas" : [ ], "total_tables" : 0 } ], "database_limit" : 2000, "table_limit" : 20000, "total_tables" : 0 } 异常响应 请参见异常请求结果。
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/log-replay/database 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 参数解释: 要查询的实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-4”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK 认证方式的接口请求或者多project场景采用AK/SK认证的接口请求则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如 IAM 服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
  • 请求示例 创建MySQL单机实例。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances { "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "ULTRAHIGH", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 12 } 创建PostgreSQL单机实例。 { "name": "rds-instance-rep2", "datastore": { "type": "PostgreSQL", "version": "10" }, "flavor_ref": "rds.pg.s1.large", "volume": { "type": "ULTRAHIGH", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.147", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "password": "Test@12345678", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] } 创建MySQL 8.0单机实例指定初始化参数。 { "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "8.0" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "ULTRAHIGH", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "unchangeable_param": { "lower_case_table_names": "1" }, "dry_run": false, "count": 12 } 创建SQL Server单机实例支持指定字符集。 { "name": "rds-instance-rep2", "datastore": { "type": "SQLServer", "version": "2014_SE" }, "flavor_ref": "rds.mssql.se.m3.large.8", "volume": { "type": "ULTRAHIGH", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "collation": "Cyrillic_General_CI_AS", "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], } DeC用户创建MySQL单机实例。 { "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.s1.large", "volume": { "type": "ULTRAHIGH", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "dsspool_id":"3278327382738217382173872183721837213", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 12 } 创建主备实例。 { "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.s1.large.ha", "volume": { "type": "ULTRAHIGH", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a,cn-north-4b", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 12 } DeC用户创建MySQL主备实例。 { "name": "rds-instance-rep2", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.s1.large.ha", "volume": { "type": "ULTRAHIGH", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a,cn-north-4b", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "data_vip": "192.168.0.1", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 8635, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "charge_info": { "charge_mode": "postPaid" }, "password": "****", "configuration_id": "452408-ef4b-44c5-94be-305145fg", "enterprise_project_id": "fdsa-3rds", "time_zone": "UTC+04:00", "dsspool_id":"327832738273821772133432,21489938273821772133432", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 12 } 创建只读实例。 { "name": "rds-instance-rep2", "replica_of_id": "afdsad-fds-fdsagin01", "flavor_ref": "rds.mysql.s1.large.rr", "volume": { "type": "ULTRAHIGH", "size": 100 }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "enterprise_project_id": "fdsa-3rds", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] } DeC用户创建只读实例。 { "name": "rds-instance-rep2", "replica_of_id": "afdsad-fds-fdsagin01", "flavor_ref": "rds.mysql.s1.large.rr", "volume": { "type": "ULTRAHIGH" }, "disk_encryption_id": "2gfdsh-844a-4023-a776-fc5c5fb71fb4", "region": "cn-north-4", "availability_zone": "cn-north-4a", "enterprise_project_id": "fdsa-3rds" "dsspool_id":"3278327382738217382173872183721837213", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ] 创建MySQL Serverless型单机实例。 { "name": "rds-instance-serverless1", "datastore": { "type": "MySQL", "version": "5.7" }, "flavor_ref": "rds.mysql.serverless", "volume": { "type": "CLOUDSSD", "size": 40 }, "region": "cn-north-4", "availability_zone": "cn-north-4a", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port": 3306, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "password": "****", "time_zone": "UTC+04:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 1, "serverless_info": { "min_cap": "0.5", "max_cap": "1" } } 创建MySQL Serverless型主备实例。 { "name": "rds-instance-serverless2", "datastore": { "type": "MySQL", "version": "5.7" }, "ha": { "mode": "ha", "replication_mode": "semisync" }, "flavor_ref": "rds.mysql.serverless.ha", "volume": { "type": "CLOUDSSD", "size": 40 }, "region": "cn-north-4", "availability_zone": "cn-north-4a,cn-north-4b", "vpc_id": "490a4a08-ef4b-44c5-94be-3051ef9e4fce", "subnet_id": "0e2eda62-1d42-4d64-a9d1-4e9aa9cd994f", "security_group_id": "2a1f7fc8-3307-42a7-aa6f-42c8b9b8f8c5", "port":3306, "backup_strategy": { "start_time": "08:15-09:15", "keep_days": 12 }, "password": "****", "time_zone": "UTC+08:00", "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" } ], "dry_run": false, "count": 1, "serverless_info": { "min_cap": "0.5", "max_cap": "1" } }
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 policy_para Array of objects 备份策略对象,包括备份类型、备份保留天数、目标区域ID和目标project ID。 详情请参见表3。 表3 policy_para字段数据结构说明 名称 参数类型 说明 backup_type String 指定备份的类型。取值如下: auto:自动全量备份。 incremental:自动增量备份。 manual:手动备份,仅RDS for SQL Server返回该备份类型 。 keep_days Integer 备份文件可以保存的天数。 destination_region String 设置跨区域备份策略的目标区域ID。 destination_project_id String 设置跨区域备份策略的目标project ID。 正常响应样例 备份策略关闭时: { "policy_para": { "keep_days": 0 } } RDS for MySQL、RDS for PostgreSQL自动备份策略和增量备份策略开启时: { "policy_para": [ { "keep_days": 7, "backup_type": "auto", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "incremental", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" } ] } RDS for SQL Server自动备份策略、增量备份策略和手动备份策略开启时: { "policy_para": [ { "keep_days": 7, "backup_type": "incremental", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "manual", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" }, { "keep_days": 7, "backup_type": "auto", "destination_region": "aaa", "destination_project_id": "0503fd7f7580d3262fc5c001170fbab9" } ] } 异常响应 请参见异常请求结果。
  • 请求示例 批量添加标签key1和key2。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/tags/action { "action": "create", "tags": [{ "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" }] }
  • URI URI格式 POST /v3/{project_id}/instances/{instance_id}/tags/action 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求消息 表2 参数说明 名称 是否必选 参数类型 说明 action 是 String 参数解释: 操作标识。 约束限制: 不涉及。 取值范围: 区分大小写,创建时为“create”。 默认取值: 不涉及。 tags 是 Array of objects 参数解释: 标签列表。单个实例总标签数上限20个。 详情请参见表3。 约束限制: 不涉及。 表3 tags字段数据结构说明 名称 是否必选 参数类型 说明 key 是 String 参数解释: 标签键。 约束限制: 不涉及。 取值范围: 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@,但首尾不能含有空格,不能以_sys_开头。 默认取值: 不涉及。 value 是 String 参数解释: 标签值。 约束限制: 不涉及。 取值范围: 最大长度255个unicode字符,可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。 默认取值: 不涉及。
  • URI URI格式 PUT /v3/{project_id}/instances/{instance_id}/slowlog-sensitization/{status} 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 String 要查询的实例ID。 status 是 String 开启或关闭慢日志敏感信息明文,取值为on或off。 on:表示开关打开。 off:表示开关关闭。
  • 请求示例 延迟库只读恢复库到主实例。 POST https://rds.cn-north-4.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/794c38e5309344818f4b33b86ebce9b4in03/log-replay/database { "databases" : [ { "old_name" : "old", "new_name" : "new" } ] }
  • URI URI格式 POST /v3/{project_id}/instances/{instance_id}/log-replay/database 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 参数解释: 要查询的实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表2 参数说明 名称 是否必选 参数类型 说明 databases 是 Array of objects 参数解释: 需要恢复的库名列表。 详情请参见表3。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 databases字段数据结构说明 名称 是否必选 参数类型 说明 old_name 是 String 参数解释: 需恢复的原库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 new_name 是 String 参数解释: 恢复后的新库名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 接口约束 实例在创建、变更规格、修改端口、异常或冻结状态下不能执行该操作。 除RDS界面和API以外的其他方式创建的数据库和账号,如果创建的数据库名和账号名不满足数据库命名规则(参见表2)和账号命名规则(参见表2),例如包含中文或不支持的特殊字符,那么该数据库和账号不支持RDS界面或API的数据库管理和账号管理功能。 如果源库的数据库名和账号名不满足数据库命名规则(参见表2)和账号命名规则(参见表2),迁移到目标库RDS for MySQL后,该数据库和账号也不支持RDS界面或API的数据库管理和账号管理功能。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 databases Array of objects 列表中每个元素表示一个数据库。 详情请参见表3。 total_count Integer 数据库总数。 表3 databases元素结构说明 名称 参数类型 说明 name String 数据库名称。 readonly Boolean 是否为只读权限: true表示只读。 false表示可读写。 正常响应样例 { "databases": [ { "name": "rds-test", "readonly": false }, { "name": "testdb1", "readonly": true }, { "name": "tt", "readonly": false } ], "total_count": 3 } 异常响应 请参见异常请求结果。
  • 接口约束 实例在异常或冻结状态下不能执行该操作。 如果用户自行使用SQL命令删除数据库,在通过API或RDS界面查询已授权数据库列表时会显示已删除的数据库。 通过SQL语句使用*.*方式授权的数据库(GRANT ALL ON *.* TO `user`@`host`),调用该接口查询结果返回为空。如需查看结果,可使用show grants for命令代替接口查询。 建议使用指定数据库方式授权:GRANT ALL ON db1.* TO `user`@`host`
  • URI URI格式 GET /v3/{project_id}/instances/{instance_id}/db_user/database?user-name={user-name}&page={page}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 instance_id 是 实例ID。 user-name 是 数据库用户名。 page 是 分页页码,从1开始。 limit 是 每页数据条数。取值范围[1, 100]。
  • 接口约束 仅支持停止存储类型为超高IO、SSD云盘、极速型SSD的按需实例,专属云RDS不支持停止实例。 已停止的实例被删除后不会进入回收站。 停止主实例时,如果存在只读实例,会同时停止只读实例。不支持单独停止只读实例。对于华东-上海一区域,主实例和只读实例均默认停止十五天。对于除华东-上海一外的其他区域,主实例和只读实例均默认停止七天。 对于华东-上海一区域,实例默认停止十五天,如果您在十五天后未手动开启实例,数据库实例将于十五天后的下一个可维护时间段内自动启动。 对于除华东-上海一外的其他区域,实例默认停止七天,如果您在七天后未手动开启实例,数据库实例将于七天后的下一个可维护时间段内自动启动。 实例停止后,虚拟机(VM)停止收费,其余资源包括弹性公网IP(EIP)、存储资源、备份正常计费。 按需付费的数据库实例停止实例后,可能会出现由于资源不足引起开启失败,如遇到无法开启的情况请联系客服人员处理。 实例在以下状态不能执行停止实例: 创建、重启、扩容、变更规格、恢复、修改端口等不能进行此操作。
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全