变更实例规格_云数据库 GaussDB NoSQL _API参考_API v3（推荐）_实例管理_华为云

(1)

API 参考

文档版本 17

发布日期 2022-01-27

(2)

非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标，由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。

由于产品版本升级或其他原因，本文档内容会不定期进行更新。除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

(3)

1 ^{使用前必读}

1.1 概述

欢迎使用云数据库 GaussDB NoSQL。您可以使用本文档提供的API对云数据库 GaussDB NoSQL进行相关操作，如创建实例、删除实例、查询实例列表等。支持的全部操作请参见API概览。

在调用云数据库 GaussDB NoSQL API之前，请确保已经充分了解云数据库 GaussDB NoSQL相关概念，详细信息请参见产品介绍。

1.2 调用说明

云数据库 GaussDB NoSQL提供了REST（Representational State Transfer）风格 API，支持您通过HTTPS请求调用，调用方法请参见如何调用API。

1.3 终端节点

终端节点（Endpoint）即调用API的请求地址，不同服务不同区域的终端节点不同，您可以从地区和终端节点中查询所有服务的终端节点。

1.4 约束限制

更详细的限制请参见具体API的说明。

1.5 基本概念

● 帐号

用户的帐号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于帐号是付费主体，为了确保帐号安全，建议您不要直接使用帐号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。

● 用户

由帐号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。

(6)

在我的凭证下，您可以查看帐号ID和用户ID。通常在调用API的鉴权过程中，您需要用到帐号、用户和密码等信息。

● 区域

指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。

● 可用区

一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。

● 项目

区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您帐号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。

图1-1 项目隔离模型

● 企业项目

企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。

(7)

2 ^{API 概览}

云数据库 GaussDB NoSQL所提供的接口为扩展接口。通过使用云数据库 GaussDB NoSQL接口，您可以使用云数据库 GaussDB NoSQL的部分功能，具体如下表所示。

表2-1 接口说明

类型描述

查询API版本 ● 查询API版本列表

● 查询API版本信息

查询数据库版本信息查询指定实例类型的数据库版本信息。

查询所有实例规格信息

查询指定条件下的所有实例规格信息。

实例管理包括创建实例、删除实例、查询实例列表、扩容实例存储容

量、扩容集群实例的节点数量、缩容集群实例的节点数量、

变更实例规格、修改实例管理员密码、修改实例名称和变更实例安全组接口。

备份和恢复包括查询自动备份策略、设置自动备份策略接口。

参数管理包括获取参数模板列表、创建参数模板、修改参数模板的参

数、应用参数模板、修改指定实例的参数、获取指定实例的参数、获取指定参数模板的参数、删除参数模板接口。

标签管理包括查询资源实例、批量添加或删除资源标签、查询资源标

签接口。

日志管理包括查询数据库慢日志接口。

(8)

3 ^{如何调用 API}

3.1 构造请求

本节介绍REST API请求的组成，并以调用IAM服务的获取用户Token说明如何调用 API，该API获取用户的Token，Token可以用于调用其他API时鉴权。

您还可以通过这个视频教程了解如何构造请求调用API：https://

bbs.huaweicloud.com/videos/102987。

请求 URI

请求URI由如下部分组成：

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

表3-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条数据。

(9)

例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。

https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

图3-1 URI 示意图

说明

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。

这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。

表3-2 HTTP 方法

方法说明

GET 请求服务器返回指定资源。

PUT 请求服务器更新指定资源。

POST 请求服务器新增资源或执行特殊操作。

DELETE 请求服务器删除指定资源，如删除对象等。

在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

详细的公共请求消息头字段请参见表3-3。

(10)

表3-3 公共请求消息头

名称描述是否必选示例

Content-Type 发送的实体的MIME 类型。推荐用户默认使用application/

json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

是 application/json

Content-

Length 请求body长度，单

位为Byte。 POST请求为可选，GET请求该字段值留空。

3495

X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。

否 e9993fc787d94b6c886cb aa340f9c0f4

X-Auth-Token 用户Token。

请求响应成功后在响应消息头中包含的“X-Subject- Token”的值即为 Token值。

是注：以下仅为Token示例片

段

MIIPAgYJKoZIhvcNAQcCo ...ggg1BBIINPXsidG9rZ

对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体（可选）

该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中 Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中

username

为用户名，

domianname

为用户所属的帐号名称，

********

为用户登录密码，

xxxxxxxxxxxxxxxxxx

为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。

(11)

说明

scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个帐号下所有资源或帐号的某个project下的资源，详细定义请参见获取用户Token。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

{ "auth": { "identity": { "methods": [ "password"

],

"password": { "user": {

"name": "username", "password": "********", "domain": {

"name": "domianname"

} } } }, "scope": { "project": {

"name": "xxxxxxxxxxxxxxxxxx"

} } } }

到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x- subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

3.2 认证鉴权

云数据库 GaussDB NoSQL支持通过Token认证的方式进行认证鉴权。

说明

Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。

Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。

Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。

当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加

“X-Auth-Token”到业务接口请求消息头中。

Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的 Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择 project，如下所示：

{ "auth": { "identity": { "methods": [ "password"

],

(12)

"password": { "user": {

"name": "username", "password": "password", "domain": {

"name": "domainname"

} } } },

"scope": { "project": {

"name": "xxxxxxxx"

} } } }

获取Token后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，

其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token:

ABCDEFJ....”加到请求消息头即可，如下所示。

POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json

X-Auth-Token: ABCDEFJ....

您还可以通过这个视频教程了解如何使用Token认证：https://

bbs.huaweicloud.com/videos/101333 。

3.3 返回结果

状态码

请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。

对于获取用户Token接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

对应请求消息头，响应同样也有消息头，如“Content-type”。

对于获取用户Token接口，返回如图3-2所示的消息头，其中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

(13)

图3-2 获取用户 Token 响应消息头

响应消息体（可选）

该部分可选。响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中 Content-Type对应，传递除响应消息头之外的内容。

对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。

{ "token": {

"expires_at": "2019-02-13T06:52:13.855000Z", "methods": [

"password"

],

"catalog": [ {

"endpoints": [ {

"region_id": "aaa", ...

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{ "error_msg": "Parameter error", "error_code": "DBS.200001"

}

其中，error_code表示错误码，error_msg表示错误描述信息。

(14)

4 ^快速入门

本节通过调用API创建GaussDB(for Cassandra)数据库实例。

说明

通过IAM服务获取到的Token有效期为24小时，需要使用同一个Token鉴权时，可以先将Token 缓存，避免频繁调用。

涉及 API

当您使用Token认证方式完成认证鉴权时，需要获取用户Token并在调用接口时增加

“X-Auth-Token”到业务接口请求消息头中。

● IAM获取Token的API

● 创建GaussDB(for Cassandra)实例的API

具体步骤

1. Token认证，具体操作请参考认证鉴权。

2. 发送“POST https://{Endpoint}/v3/{project_id}/instances”。

3. 在Request Header中增加“X-Auth-Token”。

4. 在Request Body中传入参数如下：

说明

样例中参数“region”和“availability_zone”的值为示例值。

关于创建实例接口的详细说明，请参见创建实例。

{ "name": "test-cassandra-01", //实例名称 "datastore": {

"type": "cassandra", //数据库类型 "version": "3.11", //数据库版本

"storage_engine": "rocksDB" //存储引擎 },

"region": "aaa", //区域名称

"availability_zone": "bbb", //可用区名称

"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", //虚拟私有云ID "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", //子网ID

"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", //安全组ID "password": "Test@123", //管理员密码

(15)

"mode": "Cluster", //实例类型 "flavor": [

{

"num": 3, //节点数量 "size": 500, //磁盘大小

"storage": "ULTRAHIGH", //磁盘类型

"spec_code": "geminidb.cassandra.4xlarge.4" //资源规格编码 }

],

"backup_strategy": {

"start_time": "08:00-09:00", //备份时间段 "keep_days": "8" //备份文件的保留天数 },

"enterprise_project_id": "0" //企业项目ID }

请求成功后，返回如下信息：

{ "id": "39b6a1a278844ac48119d86512e0000bin06", "name": "test-cassandra-01",

"datastore": { "type": "cassandra", "version": "3.11",

"storage_engine": "rocksDB"

},

"created": "2019-10-28 14:10:54", "status": "creating",

"region": "aaa",

"availability_zone": "bbb",

"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", "subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b",

"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "mode": "Cluster",

"flavor": [ {

"num": 3, "size": 500,

"storage": "ULTRAHIGH",

"spec_code": "geminidb.cassandra.4xlarge.4"

} ],

"start_time": "08:00-09:00", "keep_days": "8"

} ,

"job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f", "enterprise_project_id": "0"

}

若请求失败，会返回错误码及对应的错误信息说明，详细错误码信息请参见错误码。

(16)

5 API v3（推荐）

5.1 查询 API 版本

5.1.1 查询 API 版本列表

功能介绍

查询当前支持的API版本信息列表。

调试

您可以在API Explorer中调试该接口。

URI

● URI格式

GET https://{Endpoint}/

● URI样例

https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/

● 参数说明 N/A

请求消息

无。

响应消息

● 正常响应要素说明

(17)

表5-1 要素说明

名称参数类型描述

versions Array of objects API版本详细信息列表。详情请参见表5-2。

表5-2 versions 字段数据结构说明

id String API版本号。

links Array of objects 对应该API的链接信息。详情请参见表5-3。

说明v3版本该字段为[]。

status String 版本状态。

version String API版本的子版本信息。

min_version String API版本的最小版本号。

updated String 版本更新时间。

格式为“yyyy-mm- ddThh:mm:ssZ”。

其中，T指某个时间的开始，Z指 UTC时间。

表5-3 links 字段数据结构说明

href String 对应该API的URL，该字段为""。

rel String 取值为“self”，表示URL为本地

链接。

● 正常响应样例 { "versions": [ {

"id": "v3", "links": [],

"status": "CURRENT", "version": "",

"min_version": "",

"updated": "2019-10-30T17:34:02Z"

} ] }

(18)

● 异常响应

请参见异常请求结果。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

5.1.2 查询 API 版本信息

功能介绍

查询指定API版本信息。

调试

URI

● URI格式

GET https://{Endpoint}/v3

● URI样例

https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3

● 参数说明 N/A

请求消息

无。

响应消息

表5-4 要素说明

version Object API版本详细信息列表。详情请参

见表5-5。

(19)

表5-5 version 字段数据结构说明

id String API版本号。

links Array of objects 对应该API版本的链接信息。详情请参见表5-6。

说明v3版本该字段为[]。

status String 版本状态。取值为

“CURRENT”，表示该版本目前已对外公布。

version String API版本的子版本信息。

min_version String API版本的最小版本号。

updated String 版本更新时间。

格式为“yyyy-mm- ddThh:mm:ssZ”。

其中，T指某个时间的开始，Z指 UTC时间。

表5-6 links 字段数据结构说明

href String 对应该API的URL，该字段为""。

rel String 取值为“self”，表示URL为本地

链接。

● 正常响应样例 { "version": { "id": "v3", "links": [],

"status": "CURRENT", "version": "",

"min_version": "",

"updated": "2019-10-30T17:34:02Z"

} }

● 异常响应

状态码

(20)

错误码

5.2 查询数据库版本信息

功能介绍

查询指定实例类型的数据库版本信息。

接口约束

该接口支持如下数据库实例：

● GaussDB(for Cassandra)

● GaussDB(for Mongo)副本集4.0

● GaussDB(for Influx)

● GaussDB(for Redis)

调试

URI

● URI格式

GET https://{Endpoint}/v3/{project_id}/datastores/{datastore_name}/versions

● URI样例

v3/375d8d8fad1f43039e23d3b6c0f60a19/datastores/cassandra/versions

● 参数说明

表5-7 参数说明

名称是否必选描述

project_id 是租户在某一region下的project ID。

datastore_name 是数据库类型。

GaussDB(for Cassandra)数据库实例，取值为“cassandra”。

GaussDB(for Mongo)数据库实例，

取值为“mongodb”。

GaussDB(for Influx)数据库实例，取值为“influxdb”。

GaussDB(for Redis)数据库实例，取值为“redis”。

(21)

请求消息

无。

响应消息

表5-8 要素说明

versions Array of strings 数据库版本。

GaussDB(for Cassandra)实例支持 3.11版本。

GaussDB(for Mongo)实例支持副本集4.0版本。

GaussDB(for Influx)实例支持1.7版本。

GaussDB(for Redis)实例支持5.0版本。

● 正常响应样例 { "versions": [ "3.11"

] }

● 异常响应

状态码

错误码

5.3 查询数据库规格

功能介绍

查询指定条件下的实例规格信息。

接口约束

(22)

调试

URI

● URI格式

GET https://{Endpoint}/v3.1/{project_id}/flavors?

engine_name={engine_name}&offset={offset}&limit={limit}

● URI样例

v3.1/375d8d8fad1f43039e23d3b6c0f60a19/flavors?

engine_name=cassandra&offset=0&limit=10

● 参数说明

表5-9 参数说明

engine_name 否数据库类型。

● 取值为“cassandra”，表示查询 GaussDB(for Cassandra)数据库实例支持的规格。

● 取值为“mongodb”，表示查询 GaussDB(for Mongo)数据库实例支持的规格。

● 取值为“influxdb”，表示查询 GaussDB(for Influx)数据库实例支持的规格。

● 取值为“redis”，表示查询 GaussDB(for Redis)数据库实例支持的规格。

● 如果不传该参数，默认为

“cassandra”。

offset 否索引位置，偏移量。

● 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。

● 取值必须为数字，且不能为负数。

(23)

limit 否查询规格信息上限值。

● 取值范围：1~100。

● 不传该参数时，默认查询前100条规格信息。

请求消息

无。

响应消息

表5-10 要素说明

total_count Integer 总记录数。

flavors Array of objects 实例规格信息列表。详情请参见表 5-11。

表5-11 flavors 字段数据结构说明

engine_name String 引擎名称。

engine_version String 引擎版本。

vcpus String CPU核数。

ram String 内存大小，单位为兆字节。

spec_code String 资源规格编码。

示例：geminidb.cassandra.8xlarge.4 说明

● “geminidb.cassandra”表示云数据库 GaussDB NoSQL的Cassandra数据库产品。

● “8xlarge.4”表示节点性能规格。

availability_zone Array of strings 支持该规格的可用区ID。

说明

● 该字段已废弃，请不要使用。

(24)

az_status Object 规格在可用区内的状态，包含以下状态：

● normal，在售。

● unsupported，暂不支持该规格。

● sellout，售罄。

说明

响应样例中“az_status”字段下可用区的值为示例值。

● 正常响应样例 { "total_count": 4, "flavors": [ {

"engine_name": "cassandra", "engine_version": "3.11", "vcpus": "4",

"ram": "16",

"spec_code": "geminidb.cassandra.xlarge.4", "availability_zone": [

"az1", "az2"

],

"az_status": { "az1":"normal", "az2":"unsupported"

} }, {

"ram": "32",

"spec_code": "geminidb.cassandra.2xlarge.4", "availability_zone": [

"az1", "az2"

],

"az_status": {

"az1":"unsupported", "az2":"normal"

} }, {

"ram": "64",

"az1", "az2"

],

"az_status": { "az1":"normal",

(25)

"az2":"sellout"

} }, {

"ram": "128",

"az1", "az2"

],

"az_status": { "az1":"normal", "az2":"normal"

} } ] }

● 异常响应

状态码

错误码

5.4 查询专属资源列表

功能介绍

查询用户创建的专属资源列表。

接口约束

该接口支持GaussDB(for Cassandra)数据库实例。

调试

URI

● URI格式

GET https://{Endpoint}/v3/{project_id}/dedicated-resources?

offset={offset}&limit={limit}

● URI样例

(26)

v3/375d8d8fad1f43039e23d3b6c0f60a19/dedicated-resources?

offset=0&limit=10

● 参数说明

表5-12 参数说明

offset 否索引位置偏移量，表示从指定project

ID下最新的专属资源创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。

● 取值大于或等于0。

● 不传该参数时，查询偏移量默认为 0，表示从最新的创建时间对应的专属资源开始查询。

limit 否查询专属资源个数上限值。

● 取值范围：1~100。

● 不传该参数时，默认查询前100条实例信息。

请求消息

无。

响应消息

表5-13 要素说明

resources Array of objects 专属资源信息列表。参见表5-14。

表5-14 resources 字段数据结构说明

id String 专属资源ID。

resource_name String 专属资源名称。

(27)

名称参数类型描述 engine_name String 引擎名称。

availability_zone String 可用区信息。

architecture String 专属资源中计算主机的类型，目前类型取值有"X86"和"ARM"。

capacity Object 专属资源的容量信息。参见表5-15。

status String 专属资源的状态信息，包含以下状

态。

● NORMAL，可用。

● BUILDING，建设中。

表5-15 capacity 字段数据结构说明

vcpus Integer CPU核数。

ram Integer 内存大小，单位GB。

volume Long 数据存储大小，单位GB。

● 正常响应样例 { "resources": [ {

"id": "300acc71-eca9-4c6b-9a4e-0d25e20fe54c", "resource_name": "nosql-dedicated-resource-1", "engine_name": "cassandra",

"availability_zone": "az1xahz,az2xahz,az3xahz", "architecture": "X86",

"capacity": { "vcpus": 192, "ram": 1536, "volume": 2000000 },

"status": "NORMAL"

}, {

"id": "4c423cd8-551f-4b74-934f-8534e4a9bf2b", "resource_name": "nosql-dedicated-resource-2", "engine_name": "cassandra",

"availability_zone": "az1xahz,az2xahz,az3xahz", "architecture": "X86",

"capacity": { "vcpus": 192, "ram": 1536, "volume": 2000000 },

"status": "BUILDING"

} ],

(28)

"total_count": 2 }

● 异常响应

状态码

错误码

5.5 实例管理

5.5.1 创建实例

功能介绍

创建数据库实例。

接口约束

该接口支持如下数据库实例

● 该接口既支持包周期实例，也支持按需实例。

调试

URI

● URI格式

POST https://{Endpoint}/v3/{project_id}/instances

● URI样例

v3/375d8d8fad1f43039e23d3b6c0f60a19/instances

● 参数说明

(29)

表5-16 参数说明

请求消息

● 参数说明

表5-17 参数说明

名称是否必选参数类型描述

name 是 String 实例名称，允许和已有名称

重复。

取值范围：

● 实例名称不包含中文时，

长度为4~64位，包含中文时，长度为4~20位。

● 必须以中文或字母开头

（A~Z或a~z），区分大小写，可以包含中文、字母、数字（0~9）、中划线（-）或者下划线

（_），不能包含其他特殊字符。

datastore 是 Object 数据库信息。详情请参见表

5-18。

region 是 String 区域ID。

取值：非空，请参见地区和终端节点。

availability_zo

ne 是 String 可用区ID。

取值：请参见查询数据库规格中返回的

“az_status” ，支持创建3 可用区实例，中间以逗号隔开。

(30)

vpc_id 是 String 虚拟私有云ID，获取方法如

下：

● 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找 VPC ID。

● 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

subnet_id 是 String 子网的网络ID，获取方法如下：

● 方法1：登录虚拟私有云服务的控制台界面，单击 VPC下的子网，进入子网详情页面，查找网络ID。

● 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

security_grou

p_id 是 String 安全组ID，获取方法如下：

● 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。

● 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。

password 是 String 数据库密码。

取值范围：长度为8~32位，

必须是大写字母（A~Z）、

小写字母（a~z）、数字

（0~9）、特殊字符~!@#

%^*-_=+?的组合。

建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。

(31)

mode 是 String 实例类型。

● GaussDB(for Cassandra) 支持集群类型，取值为

“Cluster”。

● GaussDB(for Mongo) 4.0版本支持副本集类型，取值为

“ReplicaSet”。

● GaussDB(for Influx)支持集群类型，取值为

“Cluster”。

● GaussDB(for Redis)支持集群类型，取值为

“Cluster”。

flavor 是 Array of

objects 实例规格详情。详情请参见表5-19。

获取方法请参见查询数据库规格中响应“flavors”字段下参数的值。

configuration

_id 否 String 参数模板ID。

backup_strate

gy 否 Object 高级备份策略。详情请参见

表5-20。

enterprise_pr

oject_id 否 String 企业项目ID。

● 对于未开通企业多项目服务的用户，不传该参数。

● 对于已开通企业多项目服务的用户，不传该参数时，表示为default企业项目。

获取方式请参见《企业管理 API参考》的“查询企业项目列表”响应消息表

“enterprise_project字段数据结构说明”的“id”。

ssl_option 否 String SSL开关选项。

取值：

● 取“0”，表示默认不启用SSL连接。

● 取“1”，表示默认启用 SSL连接。

● 不传该参数时，默认不启用SSL连接。

(32)

charge_info 否 Object 计费类型信息，支持包年包月和按需计费，默认为按需计费。详细信息请参见表 5-21。

dedicated_res

ource_id 否 String 专属资源ID，只有开通专属

资源池后才可以下发此参数。

表5-18 datastore 字段数据结构说明

type 是 String 数据库类型。

支持GaussDB(for

Cassandra)，GaussDB(for Mongo)，GaussDB(for Influx), GaussDB(for Redis) 数据库实例。

取值为“cassandra”，表示创建GaussDB(for

Cassandra)数据库实例。

取值为“mongodb”，表示创建GaussDB(for Mongo)数据库实例。

取值为“influxdb”，表示创建GaussDB(for Influx)数据库实例。

取值为“redis”，表示创建 GaussDB(for Redis)数据库实例。

version 是 String 数据库版本。

GaussDB(for Cassandra)实例支持3.11版本，取值为

“3.11”。

GaussDB(for Mongo)实例支持4.0版本，取值为"4.0"。

GaussDB(for Influx)实例支持1.7版本，取值为“1.7”。

GaussDB(for Redis)实例支持5.0版本，取值为“5.0”。

(33)

名称是否必选参数类型描述 storage_engi

ne 是 String 存储引擎。

GaussDB(for Cassandra)实例支持RocksDB存储引擎，

取值为“rocksDB”。

GaussDB(for Mongo)实例支持RocksDB存储引擎，取值为“rocksDB”。

GaussDB(for Influx)实例支持RocksDB存储引擎，取值为“rocksDB”。

GaussDB(for Redis)实例支持RocksDB存储引擎，取值为“rocksDB”。

表5-19 flavor 字段数据结构说明

num 是 String 节点数量。

● GaussDB(for Cassandra) 实例的节点数量可取 3~12。

● GaussDB(for Mongo) 4.0版本副本集实例的节点数量可取3。

● GaussDB(for Influx)实例的节点数量可取3~16。

● GaussDB(for Redis)实例的节点数量可取3~12。

(34)

size 是 String 磁盘大小。必须为整数，单

位为GB。

GaussDB(for Cassandra)，

GaussDB(for Mongo)，

GaussDB(for Influx)的最小磁盘容量100GB，最大磁盘容量与实例的性能规格有关。GaussDB(for Redis)的最大和最小磁盘容量与节点数和实例的性能规格有关。

● GaussDB(for Cassandra) 请参见数据库实例规格。

● GaussDB(for Mongo)请参见数据库实例规格。

● GaussDB(for Influx)请参见数据库实例规格。

● GaussDB(for Redis)请参见数据库实例规格。

storage 是 String 磁盘类型。

取值为“ULTRAHIGH”，表示SSD盘。

spec_code 是 String 资源规格编码。

获取方法请参见查询数据库规格中响应参数

“spec_code”的值。

表5-20 backup_strategy 字段数据结构说明

start_time 是 String 备份时间段。自动备份将在该时间段内触发。

取值范围：非空，格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。

● HH取值必须比hh大1。

● mm和MM取值必须相同，且取值必须为00、

15、30或45。

● 不传该参数，默认的备份时间段为00:00-01:00。

● 取值示例：23:00-00:00

(35)

keep_days 否 String 指定已生成的备份文件可以

保存的天数。

取值范围：0~35。

● 取0值，表示不设置自动备份策略。

● 不传该参数，默认开启自动备份策略，备份文件默认保存7天。

表5-21 charge_info 字段数据结构说明

charge_mode 是 String 计费模式。

取值范围：

● prePaid：预付费，即包年/包月。

● postPaid：后付费，即按需付费。

period_type 否 String 订购周期类型。

取值范围：

● month：包月。

● year：包年。

说明“charge_mode”为

“prePaid”时生效，且为必选值。

period_num 否 String “charge_mode”为

“prePaid”时生效，且为必选值，指定订购的时间。

取值范围：

● 当“period_type”为

“month”时，取值为 1~9。

● 当“period_type”为

“year”时，取值为 1~3。

(36)

名称是否必选参数类型描述 is_auto_rene

w 否 String 创建包周期实例时可指定，

表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。

● true，表示自动续订。

● false，表示不自动续订，

默认为该方式。

is_auto_pay 否 String 创建包周期实例时可指定，

表示是否自动从账户中支付，该字段不影响自动续订的支付方式。

● true，表示自动从账户中支付。

● false，表示手动从账户中支付，默认为该支付方式。

说明

请求体样例中参数“region”和“availability_zone”的值为示例值，具体取值请以实际环境为准。

● 请求体样例

创建按需实例请求样例：

{ "name": "test-cassandra-01", "datastore": {

"type": "cassandra", "version": "3.11",

},

"region": "aaa",

"availability_zone": "bbb,ccc,ddd",

"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "Test@123",

"mode": "Cluster", "flavor": [

{

"num": "3", "size": "500",

} ],

}, "enterprise_project_id": "0",

(37)

"ssl_option": "1"

}

创建包周期实例请求样例：

{ "name": "test-cassandra-01", "datastore": {

"type": "cassandra", "version": "3.11",

}, "region": "aaa",

"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", "password": "Test@123",

"mode": "Cluster", "flavor": [

{

"num": "3", "size": "500",

}

], "backup_strategy": {

}, "enterprise_project_id": "0", "ssl_option": "1",

"charge_info": {

"charge_mode": "prePaid", "period_type": "year", "period_num": 3, "is_auto_renew": "true", "is_auto_pay": "true"

}}

响应消息

表5-22 要素说明

id String 实例ID。

name String 实例名称，与请求参数相同。

datastore Object 数据库信息，与请求参数相

同。详情请参见表5-18。

created String 创建时间为本地时间，格式为

“yyyy-mm-dd hh:mm:ss”。

(38)

status String 实例状态，取值为

“creating”。

region String 区域ID，与请求参数相同。

availability_zone String 可用区ID，与请求参数相同。

vpc_id String 虚拟私有云ID，与请求参数相

同。

subnet_id String 子网的网络ID，与请求参数相

同。

security_group_id String 安全组ID，与请求参数相同。

mode String 实例类型，与请求参数相同。

flavor Array of objects 实例规格详情，与请求参数相同。详情请参见表5-19。

backup_strategy Object 高级备份策略，与请求参数相同。详情请参见表5-20。

enterprise_project_i

d String 企业项目ID。取值为“0”，

表示为default企业项目。

ssl_option String SSL开关选项，与请求参数相同。

job_id String 创建实例的任务ID, 仅创建按需

实例时会返回该参数。

order_id String 创建实例的订单ID，仅创建包

年包月时返回该参数。

charge_info Object 付费方式信息，与请求参数相同。

dedicated_resource_

id String 专属资源ID。

说明

响应样例中参数“region”和“availability_zone”的值为示例值。

● 正常响应样例

创建按需实例响应样例：

},

"created": "2019-10-28 14:10:54",

(39)

"status": "creating", "region": "aaa",

"flavor": [ {

"num": "3", "size": "500",

} ],

} ,

"enterprise_project_id": "0", "ssl_option": "1",

"job_id": "c010abd0-48cf-4fa8-8cbc-090f093eaa2f"

}

创建包周期实例响应样例：

}, "created": "2019-10-28 14:10:54", "status": "creating",

"region": "aaa",

"flavor": [ {

"num": "3", "size": "500",

}

], "backup_strategy": {

}, "enterprise_project_id": "0", "ssl_option": "1",

"order_id": "CS20070721568OVO9", "charge_info": {

"charge_mode": "prePaid", "period_type": "year", "period_num": 3, "is_auto_renew": "true", "is_auto_pay": "true"

(40)

}}

● 异常响应

状态码

错误码

5.5.2 删除实例

功能介绍

删除数据库实例。

接口约束

调试

URI

● URI格式

DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}

● URI样例

v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/

9136fd2a9fcd405ea4674276ce36dae8in02

● 参数说明

表5-23 参数说明

instance_id 是实例ID。

(41)

请求消息

无。

响应消息

表5-24 要素说明

job_id String 工作流ID。

● 正常响应样例

{ "job_id": "252f11f1-2912-4c06-be55-1999bde659c5"

}

● 异常响应

状态码

错误码

5.5.3 查询实例列表和详情

功能介绍

根据指定条件查询数据库实例列表和详情。

接口约束

调试

URI

● URI格式

(42)

GET https://{Endpoint}/v3/{project_id}/instances?

id={id}&name={name}&mode={mode}&datastore_type={datastore_type}&vpc_

id={vpc_id}&subnet_id={subnet_id}&offset={offset}&limit={limit}

● URI样例

– 查询所有实例列表和详情

v3/0483b6b16e954cb88930a360d2c4e663/instances – 根据指定条件查询实例列表和详情

v3/0483b6b16e954cb88930a360d2c4e663/instances?

offset=0&limit=10&id=ed7cc6166ec24360a5ed5c5c9c2ed726in06&name=

hy&mode=Cluster&datastore_type=cassandra&vpc_id=19e5d45d-70fd-4a9 1-87e9-

b27e71c9891f&subnet_id=bd51fb45-2dcb-4296-8783-8623bfe89bb7

● 参数说明

表5-25 参数说明

名称是否

必选

参数类型

描述

project_id 是 String 租户在某一region下的project ID。

id 否 String 实例ID。

如果id以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的id精确匹配查询。

name 否 String 实例名称。

如果name以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照实际填写的name 精确匹配查询。

说明

如果实例名称中包含中文，暂时不支持通过中文模糊搜索。

datastore_t

ype 否 String 数据库类型。

取值为“cassandra”，表示查询GaussDB(for Cassandra)数据库实例。

取值为“mongodb”，表示查询GaussDB(for Mongo)数据库实例。

取值为“influxdb”，表示查询GaussDB(for Influx)数据库实例。

取值为“redis”，表示查询GaussDB(for Redis)数据库实例。

如果不传该参数，表示查询所有数据库实例。

(43)

名称是否必选

参数类型

描述

mode 否 String 实例类型。

● 取值为“Cluster”，表示GaussDB(for Cassandra)、GaussDB(for Influx)、

GaussDB(for Redis)集群实例类型。

● 取值为“ReplicaSet”，表示GaussDB(for Mongo)副本集实例类型。

如果不传datastore_type参数，自动忽略该参数设置。

vpc_id 否 String 虚拟私有云ID，获取方法如下：

● 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。

● 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

subnet_id 否 String 子网的网络ID，获取方法如下：

● 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。

● 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

offset 否 Integer 索引位置偏移量，表示从指定project ID下最新的实例创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的实例信息。

取值大于或等于0。不传该参数时，查询偏移量默认为0，表示从最新的实例创建时间对应的实例开始查询。

limit 否 Integer 查询实例个数上限值。

取值范围：1~100。不传该参数时，默认查询前100条实例信息。

请求消息

无。

响应消息

(44)

表5-26 要素说明

instances Array of objects 实例信息。详情请参见表5-27。

表5-27 instances 字段数据结构说明

id String 实例ID。

name String 实例名称。

status String 实例状态。

取值：

● normal，表示实例正常。

● abnormal，表示实例异常。

● creating，表示实例创建中。

● data_disk_full，表示实例磁盘已满。

● createfail，表示实例创建失败。

● enlargefail，表示实例扩容节点个数失败。

port String 数据库端口。

mode String 实例类型。与请求参数相同。

region String 实例所在区域。

datastore Object 数据库信息。详情请参见表

5-28。

engine String 存储引擎。

取值为“rocksDB”。

created String 实例创建时间。

updated String 实例操作最新变更的时间。

db_user_name String 默认用户名。取值为“rwuser”。

vpc_id String 虚拟私有云ID。

subnet_id String 子网的网络ID。

security_group_id String 安全组ID。

backup_strategy Object 备份策略。详情请参见表5-29。

(45)

pay_mode String 计费方式。

● 取值为“0”，表示按需计费。

● 取值为“1”，表示包年/包月计费。

maintenance_win

dow String 系统可维护时间窗。

groups Array of objects 组信息。详情请参见表5-30。

enterprise_project

_id String 企业项目ID。

取值为“0”，表示为default企业项目。

time_zone String 时区。

actions Array of strings 实例正在执行的动作。

dedicated_resourc

e_id String 专属资源ID，只有数据库实例属于

专属资源池才会返回该参数。

lb_ip_address String 负载均衡IP地址，只有存在负载均衡IP地址才会返回该参数。

表5-28 datastore 字段数据结构说明

type String 数据库类型。

version String 数据库版本。

表5-29 backup_strategy 字段数据结构说明

start_time String 备份时间段。自动备份将在该时间段内触发。当前时间指UTC时间。

keep_days Integer 已生成备份文件可以保存的天数。取值范围：0~35。

表5-30 groups 字段数据结构说明

id String 组ID。

(46)

status String 组状态。

volume Object volume信息。详情请参见表5-31。

nodes Array of objects 节点信息。详情请参见表5-32。

表5-31 volume 字段数据结构说明

size String 磁盘大小。单位：GB。

used String 磁盘使用量。单位：GB。

表5-32 nodes 字段数据结构说明

id String 节点ID。

name String 节点名称。

status String 节点状态。

role String 节点角色。

该参数仅对GaussDB(for Mongo)引擎的副本集实例有效。

private_ip String 节点内网IP。在弹性云服务器创建成功后参数值存在，否则，值为""。

public_ip String 绑定的公网IP。该参数仅针对绑定了公网 IP的节点有效。

spec_code String 资源规格编码。

关于实例的规格信息，请参见查询数据库规格中响应参数“flavors.spec_code”的值。

availability_zon

e String 可用区。

support_reduce Boolean 是否支持节点缩容。

true，表示该节点支持节点缩容。

false，表示该节点不支持节点缩容。

变更实例规格_云数据库 GaussDB NoSQL _API参考_API v3（推荐）_实例管理_华为云

API 参考

目 录

1 使用前必读... 1

2 API 概览... 3

3 如何调用 API...4

4 快速入门...10

5 API v3（推荐）...12

6 API v3（即将下线）... 96

7 权限策略和授权项...107

8 附录... 113

A 修订记录... 188

1 使用前必读

1.1 概述

1.2 调用说明

1.3 终端节点

1.4 约束限制

1.5 基本概念

2 API 概览

3 如何调用 API

3.1 构造请求

请求 URI

请求方法

请求消息头

请求消息体（可选）

username

domianname

********

xxxxxxxxxxxxxxxxxx

3.2 认证鉴权

3.3 返回结果

状态码

响应消息头

响应消息体（可选）

4 快速入门

涉及 API

具体步骤

5 API v3（推荐）

5.1 查询 API 版本

5.1.1 查询 API 版本列表

功能介绍

调试

URI

请求消息

响应消息

状态码

错误码

5.1.2 查询 API 版本信息

功能介绍

调试

URI

请求消息

响应消息

状态码

错误码

5.2 查询数据库版本信息

功能介绍

接口约束

调试

URI

请求消息

响应消息

状态码

错误码

5.3 查询数据库规格

功能介绍

接口约束

调试

URI

请求消息

响应消息

状态码

错误码

5.4 查询专属资源列表

功能介绍

接口约束

调试

URI

请求消息

响应消息

目录

1 ^{使用前必读}

2 ^{API 概览}

3 ^{如何调用 API}

4 ^快速入门