华为云用户手册

  • 云数据库 GEMINIDB-查询参数模板可应用的实例列表:URI
    URI GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applicable-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 config_id 是 String 参数模板id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 取值必须为数字，不能为负数。 limit 否 Integer 查询个数上限值。 取值范围: 1~100。 不传该参数时，默认查询前100条信息。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-缩容实例的节点数量:请求示例
    请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/reduce-node 缩容1个实例节点 { "num" : 1, "node_list" : [ "116ba14da34a42d28ecd83a38c218907no12" ] }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-缩容实例的节点数量:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 num 否 Integer 随机缩减的节点数量。 GeminiDB Cassandra实例该字段取值为1~10。 GeminiDB Redis该字段取值为1。 说明： 如果客户端采用直连节点方式，不推荐使用随机节点缩容。 node_list 否 Array of strings 指定缩容节点的ID，且该节点必须支持节点缩容。如果该字段不传指定缩减的节点ID，将根据系统内部策略缩减指定个数的节点。 说明： num与node_list必须有一个字段传值。 如果node_list传值时，GeminiDB Cassandra长度必须为1~10，GeminiDB Redis长度必须为1。 如果num与node_list同时传值时，则以node_list的值为主。 如果node_list取值为空时，缩容以随机节点缩容进行；node_list字段取值不为空，缩容以指定节点ID进行。 节点缩容前，请避免直连节点，以防该节点缩容导致业务中断。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-缩容实例的节点数量:接口约束
    接口约束 该接口支持如下数据库实例： GeminiDB Cassandra包年/包月实例和按需计费实例 GeminiDB Redis包年/包月实例和按需计费实例 GeminiDB Mongo包年/包月实例和按需计费实例 GeminiDB Redis实例支持的最大最小磁盘容量和节点数、规格相关，如果目标结果无法满足实例运行所需的磁盘大小，将无法缩容节点。 GeminiDB Mongo仅支持缩容只读节点。 该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-变更实例规格:请求示例
    请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize 变更实例规格，实例目标规格为16U64G { "resize" : { "target_spec_code" : "geminidb.cassandra.4xlarge.4" } }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-变更实例规格:接口约束
    接口约束 该接口支持如下数据库实例： GeminiDB Cassandra GeminiDB Redis 该接口既支持包周期实例，也支持按需实例。 该接口既支持扩大规格，也支持降低规格。 需要变更的规格不能与原规格一样。 实例状态仅为“normal”时，可以变更实例规格。 如果变更结果无法满足实例运行所需要的大小，将无法进行规格变更。 该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-变更实例规格:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 resize 是 ResizeInstanceOption object 目标规格信息。 is_auto_pay 否 String 创建包周期实例时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 对于降低规格场景，该字段无效。 对于扩大规格场景： true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。 表4 ResizeInstanceOption 参数 是否必选 参数类型 描述 target_spec_code 是 String 变更至新规格的资源规格编码。 获取方法请参见查询数据库规格中响应参数“flavors.spec_code”的值。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-应用参数模板:请求示例
    请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply 应用参数模板 { "instance_ids" : [ "73ea2bf70c73497f89ee0ad4ee008aa2in06" ] }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-批量添加或删除资源标签:请求示例
    请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/tags/action 添加2个标签 { "action" : "create", "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] } 删除2个标签 { "action" : "delete", "tags" : [ { "key" : "key1" }, { "key" : "key2", "value" : "value3" } ] }
    云数据库 GEMINIDB 标签管理
  • 云数据库 GEMINIDB-批量添加或删除资源标签:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。取值： create，表示添加标签。 delete，表示删除标签。 tags 是 Array of BatchTagActionTagOption objects 标签列表。 表4 BatchTagActionTagOption 参数 是否必选 参数类型 描述 key 是 String 标签键。最大长度36个unicode字符，不能为null或者空字符串，不能为空格，校验和使用之前会自动过滤掉前后空格。 字符集：0-9，A-Z，a-z，“_”，“-”，中文。 value 否 String 标签值。最大长度43个unicode字符，可以为空字符串。 字符集：0-9，A-Z，a-z，“_”，“.”，“-”，中文。 “action”值为“create”时，该参数必选。 “action”值为“delete”时，该参数可选。 说明： 删除标签时，如果value有值，则按照key/value匹配删除；如果value没有值，则按照key删除。
    云数据库 GEMINIDB 标签管理
  • 云数据库 GEMINIDB-批量添加或删除资源标签:接口约束
    接口约束 该接口支持如下数据库实例： GeminiDB Cassandra GeminiDB Mongo GeminiDB Influx GeminiDB Redis 一个数据库实例具有20个标签配额，且标签key唯一。 添加标签时，如果请求体中存在重复key，调用该接口将会报错。 添加标签时，如果请求体中的key与指定实例已有的key重复，将会覆盖已有key对应的value的值。 如果待删除的标签不存在，调用该接口将默认处理成功，删除时，不对标签字符集范围做校验。
    云数据库 GEMINIDB 标签管理
  • 云数据库 GEMINIDB-查询配额:响应参数
    响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 quotas ShowResourcesListResponseBody object 配额信息。 表4 ShowResourcesListResponseBody 参数 参数类型 描述 resources Array of ShowResourcesDetailResponseBody objects 资源列表对象。 表5 ShowResourcesDetailResponseBody 参数 参数类型 描述 type String 配额资源类型，当前配额类型仅支持实例类型（instance）。 quota Integer 当前配额值。 取值为0时，表示不限制当前配额值。 used Integer 已使用的资源数。
    云数据库 GEMINIDB 配额管理
  • 云数据库 GEMINIDB-容灾实例备升主:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 force 否 Boolean 是否强制备实例升主。 若为true，则强制备实例升主，用于在主实例异常的状态下，快速恢复服务的场景：允许备实例强制升为特殊主实例，独立提供读写服务。 默认为false，用于正常状态下备实例平缓升主。
    云数据库 GEMINIDB 容灾管理
  • 云数据库 GEMINIDB-修改参数模板参数:请求示例
    请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06 修改参数模板参数 请求体参数中，至少有一个非空，否则会下发失败。 { "name" : "configuration_test", "description" : "configuration_test", "values" : { "concurrent_reads" : "64" } }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询专属资源列表:响应示例
    响应示例 状态码： 200 Success { "total_count" : 2, "resources" : [ { "id" : "300acc71-eca9-4c6b-9a4e-0d25e20fe54c", "resource_name" : "nosql-dedicated-resource-1", "engine_name" : "cassandra", "availability_zone" : "az1,az2,az3", "architecture" : "X86", "capacity" : { "vcpus" : 192, "ram" : 1536, "volume" : 300000 }, "status" : "NORMAL" }, { "id" : "4c423cd8-551f-4b74-934f-8534e4a9bf2b", "resource_name" : "nosql-dedicated-resource-2", "engine_name" : "cassandra", "availability_zone" : "az1,az2,az3", "architecture" : "X86", "capacity" : { "vcpus" : 192, "ram" : 1536, "volume" : 300000 }, "status" : "BUILDING" } ] }
    云数据库 GEMINIDB 接口版本和规格
  • 云数据库 GEMINIDB-查询专属资源列表:URI
    URI GET https://{Endpoint}/v3/{project_id}/dedicated-resources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置偏移量，表示从指定project ID下最新的专属资源创建时间开始，按时间的先后顺序偏移offset条数据后查询对应的专属资源信息。 取值大于或等于0。 不传该参数时，查询偏移量默认为0，表示从最新的创建时间对应的专属资源开始查询。 limit 否 Integer 查询专属资源个数上限值。 取值范围：1~100。 不传该参数时，默认查询前100条实例信息。
    云数据库 GEMINIDB 接口版本和规格
  • 云数据库 GEMINIDB-查询专属资源列表:响应参数
    响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 resources Array of DedicatedResource objects 专属资源信息列表。 表4 DedicatedResource 参数 参数类型 描述 id String 专属资源ID。 resource_name String 专属资源的名称。 engine_name String 接口名称。 availability_zone String 可用区信息。 architecture String 专属资源中计算主机的类型，目前类型取值有"X86"和"ARM"。 capacity DedicatedResourceCapacity object 专属资源的容量信息。 status String 专属资源的状态信息，包含以下状态。 NORMAL，可用。 BUILDING，建设中。 表5 DedicatedResourceCapacity 参数 参数类型 描述 vcpus Integer CPU核数。 ram Integer 内存大小，单位GB。 volume Integer 存储大小，单位GB
    云数据库 GEMINIDB 接口版本和规格
  • 云数据库 GEMINIDB-恢复到已有实例:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_id 是 String 备份文件名称。根据备份文件恢复到已有的实例。 password 否 String 实例密码。 取值范围：长度为8~32位。必须是大写字母（A~Z）、小写字母（a~z）、数字（0~9）、特殊字符~!@#%^*-_=+?的组合。仅GeminiDB Redis至少包含以下字符中的2种：大写字母、小写字母、数字和特殊字符~！@#$%^&*()-_=+？。 不传入密码时，恢复后，备份文件中保留的密码将覆盖原有实例的密码。 传入密码时，恢复后，将使用该密码覆盖原有实例的密码。
    云数据库 GEMINIDB 备份与恢复
  • 云数据库 GEMINIDB-恢复到已有实例:请求示例
    请求示例 URI样例 POST https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/61f554065802400c9c33f87e8114f081in10/recovery 恢复到已有实例 { "backup_id" : "a8114c9b30cf42b6ba7752bfa62dee0bbr10", "password" : "******" }
    云数据库 GEMINIDB 备份与恢复
  • 云数据库 GEMINIDB-恢复到已有实例:URI
    URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/recovery 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例Id，可以调用5.3.3 查询实例列表和详情接口获取。如果未申请实例，可以调用5.3.1 创建实例接口创建。
    云数据库 GEMINIDB 备份与恢复
  • 云数据库 GEMINIDB-绑定/解绑弹性公网IP:URI
    URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 node_id 是 String 实例节点ID。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-绑定/解绑弹性公网IP:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作标识。 取值： BIND，表示绑定弹性公网IP。 UNBIND，表示解绑弹性公网IP。 public_ip 否 String 弹性公网IP。绑定弹性公网IP时必须传入。 public_ip_id 否 String 弹性公网IP的ID。绑定弹性公网IP时必须传入。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-绑定/解绑弹性公网IP:请求示例
    请求示例 绑定弹性公网IP URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61f554065802400c9c33f87e8114f081in10/nodes/1345bb07d1834f8fb0b4acbc26e989aano10/public-ip 请求体样例 { "action" : "BIND", "public_ip" : "10.154.218.161", "public_ip_id" : "45da4782-e0c8-4aa4-a290-b8740014f710" } 解绑弹性公网IP URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61f554065802400c9c33f87e8114f081in10/nodes/1345bb07d1834f8fb0b4acbc26e989aano10/public-ip 请求体样例 { "action" : "UNBIND", "public_ip" : "10.154.218.161" }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-变更实例存储容量:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 待变更到的磁盘容量。单位GB，取值为整数。 扩容场景下，必须大于当前磁盘容量。 缩容场景下，必须大于已用量的125%，向上取整。 磁盘容量的上下限与所选接口类型以及规格相关。 GeminiDB Cassandra请参见数据库实例规格。 GeminiDB Redis请参见数据库实例规格。 is_auto_pay 否 Boolean 扩容包年包月实例存储容量时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-切换实例SSL开关:请求示例
    请求示例 开启SSL开关 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 开启SSL开关 { "ssl_option" : "on" } 关闭SSL开关 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/ssl-option 关闭SSL开关 { "ssl_option" : "off" }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-设置回收策略:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 recycle_policy 是 object 回收策略。详情强参考表4。 表4 RecyclePolicy 参数 是否必选 参数类型 描述 retention_period_in_days 否 Integer 策略保持时长（1-7天），天数为正整数，默认7天。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-设置回收策略:请求示例
    请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy 设置回收站实例保留天数为3天 { "recycle_policy": { "retention_period_in_days": 3 } }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询回收站实例列表:响应示例
    响应示例 状态码： 200 Success. { "total_count" : 1, "instances" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06", "name" : "test", "mode" : "Cluster", "datastore" : { "type" : "cassandra", "version" : "3.11" }, "charge_mode" : "postPaid", "enterprise_project_id" : "0", "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", "created_at" : "2022-01-01T10:00:00", "deleted_at" : "2022-02-01T11:00:00", "retained_until" : "2022-02-02T11:00:00" } ] }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询回收站实例列表:URI
    URI GET https://{Endpoint}/v3/{project_id}/recycle-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询） 取值必须为数字，且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围：1~100。 不传该参数时，默认查询前100条信息。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询回收站实例列表:响应参数
    响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 instances Array of objects 实例信息。详情请参考表5。 表5 RecycleInstance 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 mode String 实例类型。 取值为“Cluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis集群实例类型。 取值为“InfluxdbSingle”，表示GeminiDB Influx单节点实例类型。 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。 datastore object 数据库信息。详情请参考表6。 charge_mode String 计费方式。 prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 enterprise_project_id String 企业项目ID，取值为“0”，表示为default企业项目。 backup_id String 备份ID。 created_at String 实例创建时间。 deleted_at String 实例删除时间。 retained_until String 回收备份保留截止时间。 表6 RecycleDatastore 参数 参数类型 描述 type String 数据库类型。 取值为“cassandra”，表示GeminiDB Cassandra数据库实例。 取值为“mongodb”，表示GeminiDB Mongo数据库实例。 取值为“influxdb”，表示GeminiDB Influx数据库实例。 取值为“redis”，表示GeminiDB Redis数据库实例。 version String 数据库版本。
    云数据库 GEMINIDB
共100000条
undefined

搜索反馈

您找到想要的内容了吗?

是的 没有

意见反馈

0/200

提交 取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好 反馈提交失败！请稍后重试！
精选内容
推荐文章