华为云用户手册

请求消息 请求参数 无。 URI样例 GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/cee5265e1e5845649e354841234567dfin01/auditlog?start_time=2019-11-06T09:00:00+0800&end_time=2019-11-07T10:40:15+0800&offset=0&limit=10

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/auditlog?start_time={start_time}&end_time={end_time}&offset={offset}&limit={limit} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 要查询的实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 start_time 是 参数解释： 查询开始时间。 约束限制： 不涉及。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 end_time 是 参数解释： 查询结束时间。 约束限制： 不涉及。 取值范围： 格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间，时间跨度不超过30天。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 默认取值： 不涉及。 offset 是 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，值为0表示从第一条数据开始查询）。 约束限制： 必须为数字，不能为负数。 取值范围： 大于等于0的整数。 默认取值： 0 limit 是 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： [1, 50] 默认取值： 不涉及。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 keep_days Integer 审计日志保存天数，审计日志策略关闭时为0。 audit_types Array of strings 审计记录的实际操作类型，空表示不过滤任何操作类型。 all_audit_log_action String 审计记录的所有操作类型。 正常响应样例 { "keep_days":7, "audit_types":["CREATE_USER"], "all_audit_log_action": '{"DCL":"CREATE_USER,DROP_USER,RENAME_USER,GRANT,REVOKE,ALTER_USER,ALTER_USER_DEFAULT_ROLE","DDL":"CREATE,ALTER,DROP,RENAME,TRUNCATE,REPAIR,OPTIMIZE","DML":"INSERT,DELETE,UPDATE,REPLACE,SELECT","OTHER":"BEGIN/COMMIT/ROLLBACK,PREPARED_STATEMENT,CALL_PROCEDURE,KILL,SET_OPTION,CHANGE_DB,UNINSTALL_PLUGIN,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 参数说明 名称 是否必选 参数类型 说明 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,UNINSTALL_PLUGIN,INSTALL_PLUGIN,SHUTDOWN,SLAVE_START,SLAVE_STOP,LOCK_TABLES,UNLOCK_TABLES,FLUSH,XA

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 node_id String 参数解释： 实例的节点ID。 取值范围： 不涉及。 used String 参数解释： 磁盘空间使用量（单位GB）。 取值范围： 不涉及。 正常响应样例 { "node_id" : "0314958daf6904c478d17c642ac209abbin01" "used" : "14.21" } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/instances/{instance_id}/storage-used-space 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 参数解释： 要查询的实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

响应消息 正常响应要素说明 表1 要素说明 名称 参数类型 说明 versions Array of objects API版本详细信息列表。 详情请参见表2。 表2 versions字段数据结构说明 名称 参数类型 说明 id String API版本号。 各个版本号，对应如下： v1：API v1版本。 v3：API v3版本。 links Array of objects 对应API的链接信息，v1、v3版本该字段为空。 详情请参见表3。 status String 版本状态。 取值“CURRENT”，表示该版本为主推版本。 取值“DEPRECATED”，表示为废弃版本，存在后续删除的可能。 updated String 版本更新时间，格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。 表3 links字段数据结构说明 名称 参数类型 说明 href String 对应该API的URL，该字段为""。 rel String 取值为“self”，表示href为本地链接。 正常响应样例 { "versions": [{ "id": "v3", "links": [], "status": "CURRENT", "updated": "2019-01-15T12:00:00Z" }, { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" } ] } 异常响应 请参见异常请求结果。

响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 versions Object API版本详细信息列表。 详情请参见表3。 version Object API版本详细信息列表。 详情请参见表3。 表3 versions字段数据结构说明 名称 参数类型 说明 id String API版本号。 links Array 对应该API版本的链接信息，该字段为空。 详情请参见表4。 status String 版本状态。 updated String 版本更新时间，格式为“yyyy-mm-dd Thh:mm:ssZ”。 其中，T指某个时间的开始；Z指UTC时间。 表4 links字段数据结构说明 名称 参数类型 说明 href String 对应该API的URL，该字段为""。 rel String 取值为“self”，表示href为本地链接。 正常响应样例 { "version": { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" }, "versions": { "id": "v1", "links": [], "status": "DEPRECATED", "updated": "2017-02-07T17:34:02Z" } } 异常响应 请参见异常请求结果。

URI URI格式 GET /v3/{project_id}/storage-type/{database_name}?version_name={version_name}&ha_mode={ha_mode} 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 database_name 是 数据库引擎名。支持如下数据库引擎，不区分大小写： MySQL PostgreSQL SQLServer version_name 是 数据库版本号，获取方法请参见查询数据库引擎的版本。 ha_mode 否 主备模式，取值如下： single：单机模式。 ha：主备模式。 replica：只读模式。

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_code": "AS.0001", "error_msg": "The format of message is error" } 其中，“error_code”表示错误码，“error_msg”表示错误描述信息。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如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 请求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

请求消息头 附加请求头字段，如指定的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

调用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": "project_name", "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" } }

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

API概览 通过使用RDS接口，您可以使用RDS的所有功能，包括创建实例、备份恢复、获取日志信息等。 类型 子类型 说明 RDS 接口 v3.1 API v3.1（推荐） 包括应用参数模板、修改指定实例的参数、恢复到已有实例等接口。 RDS 接口 v3 查询API版本 包括查询API版本列表和查询API版本信息接口。 RDS 接口 v3 查询数据库引擎的版本 获取指定数据库引擎对应的数据库版本信息。 RDS 接口 v3 查询数据库规格 获取指定数据库引擎版本对应的规格信息。 RDS 接口 v3 查询数据库磁盘类型 获取指定数据库引擎版本对应的磁盘类型。 RDS 接口 v3 实例管理 包括创建实例、调整实例容量、调整实例规格、重启实例、删除实例、获取实例列表、获取指定实例详细信息等接口。 RDS 接口 v3 灾备实例 包括配置主实例容灾能力、配置灾备实例容灾能力、灾备实例升主等接口。 RDS 接口 v3 数据库安全性 包括设置SSL 数据加密 、修改数据库端口、修改安全组、修改内网地址等接口。 RDS 接口 v3 备份与恢复 包括设置自动备份策略、获取自动备份策略、创建手动备份、删除手动备份等接口。 RDS 接口 v3 大版本升级 包括查询实例可升级的目标版本、大版本升级检查、查询大版本检查状态或升级状态等接口。 RDS 接口 v3 获取日志信息 包括查询数据库错误日志和查询数据库慢日志接口。 RDS 接口 v3 实例诊断 包括获取诊断后的实例数和获取指定诊断项的诊断结果接口。 RDS 接口 v3 SQL限流（PostgreSQL） 包括新增SQL限流、删除SQL限流、修改SQL限流等接口。 RDS 接口 v3 数据库代理（MySQL） 包括开启数据库代理、关闭数据库代理、查询数据库代理信息等接口。 RDS 接口 v3 管理数据库和用户（MySQL） 包括创建数据库、查询数据库、创建用户、查询用户、删除数据库用户、授权数据库账号和解除账号权限等接口。 RDS 接口 v3 管理数据库和用户（PostgreSQL） 包括创建数据库、查询数据库、创建用户、查询用户等接口。 RDS 接口 v3 管理数据库和用户（SQL Server） 包括创建数据库、查询数据库、创建用户、查询用户、删除数据库用户、授权数据库账号和解除账号权限等接口。 RDS 接口 v3 参数管理 包括获取参数列表、获取配置参数信息、获取实例默认参数、设置配置参数、恢复默认参数、获取参数模板列表、获取参数模板等接口。 RDS 接口 v3 插件管理（PostgreSQL） 包括创建插件、查询插件、更新插件等接口。 RDS 接口 v3 配置只读延迟库（PostgreSQL） 包括获取wal日志延迟回放状态、中止/恢复wal日志回放接口。 RDS 接口 v3 回收站 包括设置回收站策略、查询回收站策略、查询回收站实例信息接口。 RDS 接口 v3 标签管理 包括批量添加标签、批量删除标签、查询项目标签等接口。 RDS 接口 v3 配额管理 包括查询配额接口。 RDS 接口 v3 获取任务信息 获取云数据库 RDS任务中心指定任务的信息。

请求示例 变更MySQL、PostgreSQL按需单机实例为主备实例。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action { "single_to_ha": { "az_code_new_node": "az2xahz" } } 变更MySQL、PostgreSQL包周期单机实例为主备实例。 { "single_to_ha": { "az_code_new_node": "az1xahz", "is_auto_pay": true } } 变更SQL Server按需单机实例为主备实例。 { "single_to_ha": { "az_code_new_node": "az2xahz", "ad_domain_info": { "dns_server_ip": "192.168.0.1", "domain_admin_account_name": "Administrator", "domain_admin_pwd": "password@123", "dc_domain_name": "test.com" } } } 变更SQL Server包周期单机实例为主备实例。 { "single_to_ha": { "az_code_new_node": "az2xahz", "is_auto_pay": true, "ad_domain_info": { "dns_server_ip": "192.168.0.1", "domain_admin_account_name": "Administrator", "domain_admin_pwd": "password@123", "dc_domain_name": "test.com" } } } 变更DeC用户单机实例为主备实例。 { "single_to_ha": { "az_code_new_node": "az2xahz", "password": "Test@1234567", "dsspool_id":"23728728428374823748327482r" } }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 single_to_ha 是 Object 详情请参见表3。 表3 single_to_ha字段数据结构说明 名称 是否必选 参数类型 说明 az_code_new_node 是 String 实例节点可用区码（AZ）。 dsspool_id 否 String Dec用户专属存储ID，每个az配置的专属存储不同，实例节点所在专属存储ID，仅支持DEC用户创建时使用。 is_auto_pay 否 Boolean 仅包周期实例进行单机转主备时可指定，表示是否自动从客户的账户中支付。 true，为自动支付。 false，为手动支付，默认该方式。 ad_domain_info 否 Object 域信息，加域实例单机转主备时必填，非加域实例不需要填写。 仅RDS for SQL Server支持。 详细字段结构请参见表4。 表4 ADDomainInfo字段数据结构说明 参数 是否必选 参数类型 描述 domain_admin_account_name 是 String 域管理员账号名。 domain_admin_pwd 是 String 域管理员密码。

请求示例 扩容数据库实例的磁盘空间到400GB。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action { "enlarge_volume": { "size": 400, "is_auto_pay": true } }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 enlarge_volume 是 Object 所需扩容到的磁盘容量大小。 详情请参见表3。 表3 enlarge_volume字段数据结构说明 名称 是否必选 参数类型 说明 size 是 Integer 每次扩容最小容量为10GB，实例所选容量大小必须为10的整数倍，取值范围：40GB~4000GB。 RDS for PostgreSQL部分用户支持40GB~15000GB，如果您想开通该功能，请联系客服。 is_auto_pay 否 Boolean 扩容包周期实例的磁盘空间时可指定，表示是否自动从客户的账户中支付。 true，为自动支付。 false，为手动支付，默认该方式。

请求示例 变更MySQL数据库实例的规格为rds.mysql.m1.xlarge。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action { "resize_flavor": { "spec_code": "rds.mysql.m1.xlarge", "is_auto_pay": true, "is_delay": true } } 变更PostgreSQL数据库实例的规格为rds.pg.c2.medium.ha。 { "resize_flavor": { "spec_code": "rds.pg.c2.medium.ha", "is_auto_pay": true } } 变更SQL Server数据库实例的规格为rds.mssql.2014.se.s3.large.2。 { "resize_flavor": { "spec_code": "rds.mssql.2014.se.s3.large.2", "is_auto_pay": true } }

请求消息 表2 参数说明 名称 是否必选 参数类型 说明 resize_flavor 是 Object 请参见表3。 表3 resize_flavor字段数据结构说明 名称 是否必选 参数类型 说明 spec_code 是 String 资源规格编码。例如：rds.mysql.m1.xlarge。其中，rds代表RDS产品，mysql代表数据库引擎，m1.xlarge代表性能规格，为高内存类型。带"rr"的表示只读实例规格，反之表示单实例和HA实例规格。 is_auto_pay 否 Boolean 变更包周期实例的规格时可指定，表示是否自动从客户的账户中支付。 true，为自动支付。 false，为手动支付，默认该方式。 is_delay 否 Boolean 是否进行定时规格变更，该参数目前仅支持MySQL。 true，为定时变更，将在运维时间窗内进行变更操作。 false，为即时变更，默认该方式。

请求消息 请求参数 无。 URI样例 查询所有实例列表 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances 根据指定条件查询实例列表 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances?id=ed7cc6166ec24360a5ed5c5c9c2ed726in01&name=hy&type=Ha&datastore_type=MySQL&vpc_id=19e5d45d-70fd-4a91-87e9-b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7&offset=0&limit=10&tags=rds001=001,rds002=002

URI URI格式 GET /v3/{project_id}/instances?id={id}&name={name}&type={type}&datastore_type={datastore_type}&vpc_id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}&tags={key}={value} 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 参数解释： 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 id String 否 参数解释： 实例ID。 “*”为系统保留字符，如果id是以“*”起始，表示按照*后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入“*”。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 name String 否 参数解释： 实例名称。 “*”为系统保留字符，如果name是以“*”起始，表示按照*后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 type String 否 参数解释： 实例类型。 约束限制： 不涉及。 取值范围： Single：单机实例 Ha：主备实例 Replica：只读实例 Enterprise：分布式实例（企业版） 默认取值： 不涉及。 datastore_type String 否 参数解释： 数据库类型。 约束限制： 区分大小写。 取值范围： MySQL PostgreSQL SQLServer 默认取值： 不涉及。 vpc_id String 否 参数解释： 虚拟私有云ID，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 subnet_id String 否 参数解释： 子网的网络ID信息，获取方法如下： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 offset Integer 否 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 必须为数字，不能为负数。 取值范围： 大于等于0的整数。 默认取值： 0 limit Integer 否 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： 默认为100，不能为负数，最小值为1，最大值为100。 默认取值： 100 tags Array of objects 否 参数解释： 根据实例标签键值对进行查询。 {key}表示标签键，不可以为空或重复。 {value}表示标签值，可以为空。 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，最多包含10组。 详情请参见表2。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 tags字段数据结构说明 名称 参数类型 是否必选 说明 key String 是 参数解释： 标签键。 约束限制： 不涉及。 取值范围： 长度为1-128个unicode字符。 可以包含任何语种字母、数字、空格和_.:=+-@，但首尾不能含有空格，不能以_sys_开头。 默认取值： 不涉及。 value String 否 参数解释： 标签值。 约束限制： 不涉及。 取值范围： 最大长度255个unicode字符，可以为空字符串。 可以包含任何语种字母、数字、空格和_.:=+-@。 默认取值： 不涉及。

功能介绍 该接口由“创建数据库实例（v3）”接口派生而来，接口请求体新增了“subscription_agency”字段，该字段用于使用 RAM 共享密钥创建包周期RDS实例的场景。该接口用于创建RDS实例，可分为单实例、HA实例和只读副本。 调用接口前，您需要了解API 认证鉴权。 本接口仅支持AK/SK认证。本接口支持在HTTP请求消息头中设置X-Client-Token请求头，保证请求幂等性。详细信息请参考请求幂等性说明。

请求示例 创建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.6" }, "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.6" }, "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", "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.6" }, "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" } }

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读