华为云用户手册

  • 云数据库 GEMINIDB-查询项目标签:响应示例
    响应示例 状态码： 200 Success. { "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ], "type" : "user" }, { "key" : "key2", "values" : [ "value1", "value2" ], "type" : "system" } ], "total_count" : 2 }
    云数据库 GEMINIDB 标签管理
  • 云数据库 GEMINIDB-修改企业项目配额:请求示例
    请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/enterprise-projects/quotas 修改企业项目配额，第一个实例配额修改为“1000”，vcpus配额修改为“500”，ram配额修改为“1024” { "quotas" : [ { "enterprise_project_id" : "4d05638e-d4c6-477c-9b51-9620fa257a11", "quota" : { "instance" : 1000, "vcpus" : 500, "ram" : 1024 } }, { "enterprise_project_id" : "92450d0e-8c4b-48e1-9909-4d9d2f086ce4", "quota" : { "ram" : 512 } } ] }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-修改企业项目配额:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 quotas 是 objects 需要修改的企业项目配额信息列表。详情请参考表4。 表4 NoSqlRequestEpsQuota 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 quota 是 object 需要修改的配额信息。详情请参考表5。 说明： 其中“instance”、“vcpus”和“ram” 至少需要传一个参数。 表5 NoSqlEpsQuotaRequestInfo 参数 是否必选 参数类型 描述 instance 否 Integer 实例配额。 vcpus 否 Integer vcpus配额。 ram 否 Integer ram配额。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-设置慢日志脱敏状态:请求示例
    请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in10/slowlog-desensitization 关闭脱敏状态 { "desensitization_status" : "off" }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-设置慢日志脱敏状态:URI
    URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog-desensitization 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。
    云数据库 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. { "quotas" : [ { "enterprise_project_id" : "c0348bb1-d09d-4ee2-8edd-53e496fe6b52", "enterprise_project_name" : "test1", "quota" : { "instance" : 500, "vcpus" : 1000, "ram" : 2000 }, "used" : { "instance" : 15, "vcpus" : 88, "ram" : 256 } }, { "enterprise_project_id" : "780a6b1f-58b8-4df6-a85e-326d052de704", "enterprise_project_name" : "test2", "quota" : { "instance" : 500, "vcpus" : 1000, "ram" : 2000 }, "used" : { "instance" : 36, "vcpus" : 64, "ram" : 192 } } ], "total_count" : 2 }
    云数据库 GEMINIDB 企业项目管理
  • 云数据库 GEMINIDB-查询企业项目配额:响应参数
    响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 quotas objects 企业项目配额信息列表。详情请参考表5。 表5 NoSqlQueryEpsQuotaInfo 参数 参数类型 描述 enterprise_project_id String 企业项目ID。 enterprise_project_name String 企业项目名称。 quota object 企业项目配额。详情请参考表6。 used object 企业项目已使用配额。详情请参考表7。 表6 NoSqlEpsQuotaTotal 参数 参数类型 描述 instance Integer 实例配额。 vcpus Integer vcpus配额。 ram Integer ram配额。 表7 NoSqlEpsQuotaUsed 参数 参数类型 描述 instance Integer 已使用实例配额。 vcpus Integer 已使用vcpus配额。 ram Integer 已使用ram配额。
    云数据库 GEMINIDB 企业项目管理
  • 云数据库 GEMINIDB-查询企业项目配额:URI
    URI GET https://{Endpoint}/v3/{project_id}/enterprise-projects/quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_name 否 String 企业项目名称。支持模糊搜索，若不指定则返回所有企业项目配额。 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0。 取值必须为数字，且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围：1~100。 不传该参数时，默认查询前100条信息。
    云数据库 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-修改数据库端口:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 port 是 Integer 新端口号。 GeminiDB Mongo副本集4.0数据库实例端口有效范围为2100~9500，暂不支持8636、8637和8638。 GeminiDB Cassandra数据库实例端口有效范围为2100~9500，暂不支持7000，7001，7199，8636，8479，8484，8999，8018，2180，2887，3887，8079，8091，8092。 GeminiDB Redis数据库实例端口有效范围为1024~65535,暂不支持2180、2887、3887、6377、6378、6380、8018、8079、8091、8479、8484、8999、9864、9866、9867、12017、12333、50069。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-修改数据库端口:URI
    URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/port 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询磁盘自动扩容策略:URI
    URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/disk-auto-expansion 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询磁盘自动扩容策略:响应参数
    响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 policy object 磁盘自动扩容策略。 自动扩容策略关闭时，接口无信息返回。 详情请参考表4。 表4 AutoEnlargePolicy 参数 参数类型 描述 threshold Integer 触发自动扩容阈值。 step Integer 扩容步长（step%），当触发自动扩容的时候，自动扩容当前存储空间的step%（若计算出的扩容大小非10的倍数，则向上取整至10的倍数。默认一次最小100GB）。 说明： 账户余额不足时，会导致包年包月实例扩容失败。 size Integer 实例通过自动扩容所能达到的存储空间上限，单位：GB。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询数据库错误日志信息:URI
    URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/error-log 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量，例如北京时间偏移显示为+0800。 开始时间最多不能比当前时间早30天。 end_time 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 只能查询当前时间前一个月内的错误日志。 结束时间不能晚于当前时间。 node_id 否 String 节点ID，取空值，表示查询实例下所有允许查询的节点。 type 否 String 语句类型，取空值，表示查询所有语句类型。也可指定如下日志类型： Warning Error offset 否 Integer 索引位置，偏移量。 取值范围为 [0, 1999]。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询）。 必须为数字，不能为负数。 limit 否 Integer 查询记录数。 取值范围[1, 100]，默认10 （表示默认返回10条数据）。 limit与offset的和需要满足小于等于2000的条件。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询数据库错误日志信息:响应参数
    响应参数 状态码： 202 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 error_log_list Array of 表5 objects 错误日志信息。 表5 ErrorLogList 参数 参数类型 描述 node_name String 节点名称。 level String 日志级别。 time String 发生时间，UTC时间。 content String 日志内容。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询数据库错误日志信息:响应示例
    响应示例 状态码： 202 Success { "error_log_list" : [ { "node_name" : "Test_replica_node_2", "level" : "WARNING", "time" : "2020-12-15T08:53:01.868+0000", "content" : "W NETWORK [LogicalSessionCacheReap] Unable to reach primary for set replica" } ], "total_count" : 1 }
    云数据库 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参数 参数 是否必选 参数类型 描述 client_network_ranges 是 Array of strings 客户端所在网段。 跨网段访问配置只有在客户端与副本集实例部署在不同网段的情况下才需要配置，例如访问副本集的客户端所在网段为192.168.0.0/16，副本集所在的网段为172.16.0.0/24，则需要添加跨网段配置192.168.0.0/16才能正常访问。 例如配置的源端网段为192.168.0.0/xx，则xx的输入值必须在8到32之间。 源端E CS 连接实例的前提是与实例节点网络通信正常，如果网络不通，可以参考对等连接进行相关配置。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-修改副本集跨网段访问配置:请求示例
    请求示例 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/9136fd2a9fcd405ea4674276ce36dae8in10/client-network 修改客户端所在网段为"192.168.0.0/16" { "client_network_ranges" : [ "192.168.0.0/16" ] }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-修改副本集跨网段访问配置:URI
    URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/client-network 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-创建冷数据存储:请求参数
    请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token。 表3 请求Body参数 参数 是否必选 参数类型 描述 size 是 Integer 创建的冷数据存储大小，单位：GB。 最小申请规格为500GB，最大申请规格为100000GB。 is_auto_pay 否 String 创建包年/包月实例的冷数据存储时可指定，表示是否自动从账户中支付，此字段不影响自动续订的支付方式。 true，表示自动从账户中支付。 false，表示手动从账户中支付，默认为该方式。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询支持参数模板的接口信息:响应参数
    响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 datastores Array of 表4 objects 数据库接口信息。 表4 DataStoreList 参数 参数类型 描述 datastore_name String 数据库接口。 version String 数据库接口版本。 mode String 实例类型。 取值为“Cluster”,表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis集群实例类型。 取值为“InfluxdbSingle”,表示GeminiDB Influx单节点实例类型。 取值为“ReplicaSet”,表示GeminiDB Mongo副本集实例类型。
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询支持参数模板的接口信息:响应示例
    响应示例 状态码： 200 Success { "datastores" : [ { "datastore_name" : "mongodb", "mode": "ReplicaSet", "version" : "4.0" }, { "datastore_name" : "influxdb", "mode": "InfluxdbCluster", "version" : "1.7" }, { "datastore_name" : "cassandra", "mode": "ReplicaCircle", "version" : "3.11" } ] }
    云数据库 GEMINIDB
  • 云数据库 GEMINIDB-查询慢日志脱敏状态:URI
    URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/slowlog-desensitization 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。
    云数据库 GEMINIDB 日志管理
  • 云数据库 GEMINIDB-查询创建实例或扩容节点时需要的IP数量:URI
    URI GET https://{Endpoint}/v3/{project_id}/ip-num-requirement 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 node_num 是 Integer 创建实例或扩容节点的个数。最大支持输入200。 engine_name 否 String 数据库接口名称。没有传入实例ID的时候该字段为必传。 取值为“cassandra”，表示GeminiDB Cassandra数据库接口。 取值为“mongodb”，表示GeminiDB Mongo数据库接口。 取值为“influxdb”，表示GeminiDB Influx数据库接口。 取值为“redis”，表示GeminiDB Redis数据库接口。 instance_mode 否 String 实例类型。没有传入实例ID的时候该字段为必传。 取值为“Cluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis集群实例类型。 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。 instance_id 否 String 实例ID，可以调用查询实例列表和详情接口获取。如果未申请实例，可以调用创建实例接口创建。
    云数据库 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

提交 取消

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