-
请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/cold-volume 扩容实例的冷数据存储空间至1000GB {
"size" : 1000
}
-
请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 参数解释： 待扩容后冷存储空间大小，单位：GB。 约束限制： 用户每次至少选择1GB扩容量，且必须为整数。 待扩容后的冷数据存储空间最大规格为100000GB。 取值范围： 不涉及。 默认取值： 不涉及。 is_auto_pay 否 String 参数解释： 扩容包年/包月实例的冷数据存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 约束限制： 不涉及。 取值范围： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 默认取值： 不涉及。
-
URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/cold-volume 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 用户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。
-
请求示例 URI样例 DELETE https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/c865f921f3dd45198f209a607533a779in06/enlarge-failed-nodes 请求体样例 {
"node_id" : "b60f00f19cd044fc8d7b52908978f629no06"
}
-
URI DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/enlarge-failed-nodes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。
-
请求示例 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/copy 复制参数模板 {
"name" : "paramsGroup-2434",
"description" : "复制参数模板"
}
-
请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 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），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。
-
请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Content-Type 发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 是 application/json Content-Length 请求body长度，单位为Byte。 POST请求为可选，GET请求该字段值留空。 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 e9993fc787d94b6c886cbaa340f9c0f4 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为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“”“cn-north-1”，您可以从地区和终端节点获取。 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": "domainname"
}
}
}
},
"scope": {
"project": {
"name": "xxxxxxxxxxxxxxxxxx"
}
}
}
} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。
-
请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in10/slowlog-desensitization 关闭脱敏状态 {
"desensitization_status" : "off"
}
-
URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog-desensitization 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。
-
响应示例 状态码： 200 Success {
"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"
}
}, {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "8",
"ram" : "32",
"spec_code" : "geminidb.cassandra.2xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "unsupported",
"az2" : "normal"
}
}, {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "16",
"ram" : "64",
"spec_code" : "geminidb.cassandra.4xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "normal",
"az2" : "sellout"
}
}, {
"engine_name" : "cassandra",
"engine_version" : "3.11",
"vcpus" : "32",
"ram" : "128",
"spec_code" : "geminidb.cassandra.8xlarge.4",
"availability_zone" : [ "az1", "az2" ],
"az_status" : {
"az1" : "normal",
"az2" : "normal"
}
} ]
}
-
URI GET https://{Endpoint}/v3.1/{project_id}/flavors 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 engine_name 否 String 参数解释： 数据库类型。 约束限制： 不涉及。 取值范围： 取值为“cassandra”，表示查询GeminiDB Cassandra数据库实例支持的规格。 取值为“mongodb”，表示查询GeminiDB Mongo数据库实例支持的规格。 取值为“influxdb”，表示查询GeminiDB Influx数据库实例支持的规格。 取值为“redis”，表示查询GeminiDB Redis数据库实例支持的规格。 默认取值： 不传该参数，默认为“cassandra”。 mode 否 String 参数解释： 实例类型。 约束限制： 不涉及。 取值范围： 取值为“CloudNativeCluster”, 表示查询云原生部署模式支持的规格。 默认取值： 不传该参数表示查询数据库类型下的所有经典部署模式支持的规格。 product_type 否 String 参数解释： 产品类型。 约束限制： 当创建GeminiDB Redis云原生部署模式集群类型必传此参数。 取值范围： Standard 标准型 Capacity 容量型 默认取值： 不涉及。 offset 否 Integer 参数解释： 索引位置，偏移量。 约束限制： 不涉及。 取值范围： 取值必须为数字，且不能为负数。 默认取值： 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 limit 否 Integer 参数解释： 查询规格信息上限值。 约束限制： 不涉及。 取值范围： 1~100。 默认取值： 不传该参数时，默认查询前100条规格信息。
-
响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 参数解释： 总记录数。 取值范围： 不涉及。 flavors Array of Flavors objects 参数解释： 实例规格信息列表。 表5 Flavors 参数 参数类型 描述 engine_name String 参数解释： 接口名称。 取值范围： 取值为“cassandra”，表示响应结果为GeminiDB Cassandra数据库实例支持的规格。 取值为“mongodb”，表示响应结果为GeminiDB Mongo数据库实例支持的规格。 取值为“influxdb”，表示响应结果为GeminiDB Influx数据库实例支持的规格。 取值为“redis”，表示响应结果为GeminiDB Redis数据库实例支持的规格。 engine_version String 参数解释： 接口版本。 取值范围： 不涉及。 默认取值： 不涉及。 vcpus String 参数解释： CPU核数。 取值范围： 不涉及。 默认取值： 不涉及。 ram String 参数解释： 内存大小，单位为兆字节。 取值范围： 不涉及。 默认取值： 不涉及。 spec_code String 参数解释： 资源规格编码。 例如：geminidb.cassandra.8xlarge.4 说明： “geminidb.cassandra”表示Cassandra数据库产品。 “8xlarge.4”表示节点性能规格。 取值范围： 不涉及。 availability_zone Array of strings 参数解释： 支持该规格的可用区ID。 说明： 该字段已废弃，请不要使用。 取值范围： 不涉及。 az_status Object 参数解释： 规格在可用区内的状态。 取值范围： normal，表示在售。 unsupported，表示暂不支持该规格。 sellout，表示售罄。
