华为云用户手册

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn

响应示例 状态码： 200 Success. { "storage_type" : [ { "name" : "ULTRAHIGH", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" }, "min_volume_size" : 50 }, { "name" : "ESSD", "az_status" : { "cn-southwest-244d" : "unsupported", "cn-southwest-244c" : "unsupported", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" }, "min_volume_size" : 40 } ]} 状态码： 400 Client error. { "error_msg" : "The DB engine or version is not supported.", "error_code" : "DBS.280238"}

URI GET /v3/{project_id}/htap/storage-type/{database} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 database 是 String HTAP数据库名。 取值范围： star-rocks click-house 表2 Query参数 参数 是否必选 参数类型 描述 version_name 是 String 数据库大版本号

响应示例 状态码： 200 Success. { "flavors" : [ { "type" : "x86", "vcpus" : "4", "ram" : "16", "id" : "de565db8-0a96-37ea-9388-61167624712c", "spec_code" : "gaussdb.sr-be.xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "4", "ram" : "16", "id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a", "spec_code" : "gaussdb.sr-fe.xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "8", "ram" : "32", "id" : "c50e8e15-f2fc-3b40-aca6-c98f07ce2ce0", "spec_code" : "gaussdb.sr-be.2xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "8", "ram" : "32", "id" : "24059750-4280-3ee5-a44b-488b924633b4", "spec_code" : "gaussdb.sr-fe.2xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "16", "ram" : "64", "id" : "a48c63dc-5563-3813-9e13-39d3301e56f4", "spec_code" : "gaussdb.sr-be.4xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "16", "ram" : "64", "id" : "0ef44c01-f7a1-30f5-9f05-9e47094e8c1f", "spec_code" : "gaussdb.sr-fe.4xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "32", "ram" : "128", "id" : "2bf6aa50-50da-3f27-91af-a8c873070537", "spec_code" : "gaussdb.sr-fe.8xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" } }, { "type" : "x86", "vcpus" : "32", "ram" : "128", "id" : "9f52a065-aa93-371a-9975-959fedf6e24f", "spec_code" : "gaussdb.sr-be.8xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "normal" } }, { "type" : "x86", "vcpus" : "64", "ram" : "256", "id" : "709822e4-567f-3e85-b4af-cb099206c8e2", "spec_code" : "gaussdb.sr-fe.16xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } }, { "type" : "x86", "vcpus" : "64", "ram" : "256", "id" : "4e56e208-0226-34bb-b84d-035ab0497824", "spec_code" : "gaussdb.sr-be.16xlarge.x86.4", "version_name" : "8.0", "instance_mode" : "Cluster", "az_status" : { "cn-southwest-244d" : "normal", "cn-southwest-244c" : "normal", "cn-southwest-244b" : "normal", "cn-southwest-244a" : "unsupported" } } ]} 状态码： 400 Client error. { "error_msg" : "Invalid specification code.", "error_code" : "DBS.280434"}

URI GET /v3/{project_id}/htap/flavors/{engine_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 engine_name 是 String HTAP引擎名。 取值范围： star-rocks click-house 表2 Query参数 参数 是否必选 参数类型 描述 availability_zone_mode 否 String 可用区模式，当前仅支持single。 spec_code 否 String 规格码，提供后仅查询指定规格码规格信息。 version_name 否 String 数据库版本号，不填默认3.1.6.0。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn

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

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不同，使用时请注意。

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....”加到请求消息头即可，如下所示。 123 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ....

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 是 application/json Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ X-Language 请求语言类型。默认en-us。 取值范围： en-us zh-cn 否 en-us 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 12 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokensContent-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。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求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-1.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-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

响应消息体（可选） 该部分可选。响应消息体通常以结构化格式（如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”表示错误描述信息。

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

请求示例 开启新增节点自动加入该Proxy。 POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/new-node-auto-add{ "switch_status" : "ON", "weight" : 100}

URI POST /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/new-node-auto-add 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 proxy_id 是 String 数据库代理ID，严格匹配UUID规则。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 switch_status 是 String 是否开启新增节点自动加入该Proxy。 取值范围： ON：开启。 OFF：关闭。 weight 否 Integer 新增节点的读权重： 新增节点自动加入为ON，取值为0~1000。 新增节点自动加入为OFF，则可不输入读权重。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 开启或关闭新增节点自动加入该Proxy的操作结果。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_databases Integer 数据库总数。 databases Array of RestoreDatabaseInfos objects 数据库信息。 表5 RestoreDatabaseInfos 参数 参数类型 描述 name String 数据库名称。 total_tables Integer 总表数。 tables Array of RestoreDatabaseTableInfo objects 表信息。 表6 RestoreDatabaseTableInfo 参数 参数类型 描述 name String 表名。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/instances/{instance_id}/backups/restore/tables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 instance_id 是 String 参数解释： 实例ID，此参数是实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 restore_time 是 String 参数解释： 备份时间点。 约束限制： 格式为UNIX时间戳，单位是毫秒，时区为UTC标准时区。传参时需要将对应时区的时间转为标准时区对应的时间戳，比如，北京时区的时间点需要-8h后再转为时间戳。 取值范围： 通过查询可恢复时间段获取。 默认取值： 不涉及。 last_table_info 是 String 参数解释： 是否是最新库表。 约束限制： 不涉及。 取值范围： true：是最新库表。 false：是恢复时间点库表。 默认取值： 不涉及。 database_name 否 String 参数解释： 数据库名称，模糊匹配。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 table_name 否 String 参数解释： 表名称，模糊匹配。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 查询表级时间点恢复可选表。 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/restore/tables?database_name=test&last_table_info=true&restore_time=1690890940000&table_name=t

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制： 不涉及。 取值范围： 不涉及。 默认值： 不涉及。 X-Language 否 String 参数解释： 请求语言类型。 约束限制： 不涉及。 取值范围： en-us zh-cn 默认值： en-us。

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 “√”表示支持，“x”表示暂不支持。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 quota_list 是 Array of setQuota objects 资源列表对象。 表4 setQuota 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 instance_quota 是 Integer 实例个数配额。取值范围0~1000。(如果已经存在实例，应该大于已经存在的实例个数) vcpus_quota 是 Integer CPU核数配额。取值范围0~3600000。(如果已经存在实例，应该大于已经占用的cpu个数) ram_quota 是 Integer 内存使用配额，单位为GB。取值范围0~19200000。(如果已经存在实例，应该大于已经占用的内存数)

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 quota_list Array of setQuota objects 资源列表对象。 表6 setQuota 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 instance_quota Integer 实例个数配额。取值范围0~1000。(如果已经存在实例，应该大于已经存在的实例个数) vcpus_quota Integer CPU核数配额。取值范围0~3600000。(如果已经存在实例，应该大于已经占用的cpu个数) ram_quota Integer 内存使用配额，单位为GB。取值范围0~19200000。(如果已经存在实例，应该大于已经占用的内存数) 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 POST https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/quotas{ "quota_list" : [ { "enterprise_project_id" : "0", "instance_quota" : 20, "vcpus_quota" : 20, "ram_quota" : 40 } ]}

状态码 状态码列表： 表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协议的版本，无法完成处理。 父主题： 附录

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 node_id 是 String 只读节点ID，倒换后为主节点。