华为云用户手册

  • URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/password 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 String 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 resize 是 ResizeInstanceOption object 参数解释: 目标规格信息。 is_auto_pay 否 String 参数解释: 创建包周期实例时可指定,表示是否自动从账户中支付,此字段不影响自动续订的支付方式。 约束限制: 仅支持扩大规格场景,对于降低规格场景,该字段无效。 取值范围: true,表示自动从账户中支付。 false,表示手动从账户中支付,默认为该方式。 默认取值: false 表4 ResizeInstanceOption 参数 是否必选 参数类型 描述 target_spec_code 是 String 参数解释: 变更至新规格的资源规格编码。 获取方法请参见查询数据库规格中响应参数“flavors.spec_code”的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in06/resize 变更实例规格,实例目标规格为16U64G { "resize" : { "target_spec_code" : "geminidb.cassandra.4xlarge.4" } }
  • URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/resize 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 instance_id 是 String 参数解释: 实例ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 接口约束 该接口支持如下数据库实例: GeminiDB Cassandra GeminiDB Redis GeminiDB Influx 云原生部署模式 该接口既支持包周期实例,也支持按需实例。 该接口既支持扩大规格,也支持降低规格。 需要变更的规格不能与原规格一样。 实例状态仅为“normal”时,可以变更实例规格。 如果变更结果无法满足实例运行所需要的大小,将无法进行规格变更。 该接口支持GeminiDB Redis搭建双活关系的主实例和备实例。
  • URI PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/monitoring-by-seconds/switch 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 dbcache_mapping_id String 内存加速映射ID。 rules Array of 表5objects 内存加速规则详情。 表5 QueryDBCacheRuleResponse 参数 参数类型 描述 id String 内存加速规则ID。 name String 内存加速规则名称。 status String 内存加速规则状态。 normal,正常; createfail, 创建失败; source_db_schema String 源端数据库。 source_db_table String 源端数据表。 storage_type String 目标数据存储类型。取值为: hash。 target_database String 目标数据库。 key_columns Array of strings 映射的key使用的column列表。 value_columns Array of strings 映射的value使用的column列表。 ttl String key的生存时间。单位:ms。不传该值,默认取-1,表示永久存储。 key_separator String 映射的key分隔符。 value_separator String 映射的value分隔符。 key_prefix String 键前缀。
  • 响应示例 状态码: 200 Success. { "total_count" : 1, "dbcache_mapping_id" : "0231e002-d278-4df8-815c-8284164168e5", "rules" : [ { "id" : "0231e002-d278-4df8-815c-8284164168e5", "name" : "dbcache_rule_01", "source_db_schema" : "test", "source_db_table" : "student_t", "status" : "normal", "storage_type" : "hash", "target_database" : "0", "key_columns" : [ "sno", "sname", "age" ], "value_columns" : [ "sno", "sname", "age" ], "ttl" : "10000", "key_separator" : ":" } ] }
  • 请求示例 查询映射ID为1094e5d3-c140-4095-9b13-242de267c175下的前10条内存加速规则记录。 GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/rule?offset=0&limit=10 { "dbcache_mapping_id" : "1094e5d3-c140-4095-9b13-242de267c175" }
  • URI GET https://{Endpoint}/v3/{project_id}/dbcache/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 dbcache_mapping_id 是 String 内存加速映射ID。 rule_id 否 String 内存加速规则ID。 rule_name 否 String 内存加速规则名称。名称以“”起始,表示按照“”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。 source_db_schema 否 String 源端数据库名。名称以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。 source_db_table 否 String 源端数据表名。名称以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。 offset 否 String 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。取值必须为数字,不能为负数。 limit 否 String 查询个数上限值。取值范围:1~100。不传该参数时,默认查询前100条信息。
  • 请求示例 更新内存加速规则。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/rule { "dbcache_rule_id" : "0231e002-d278-4df8-815c-8284164168e5", "value_columns" : [ "sno", "sname", "age" ], "ttl" : 3000, "value_separator" : "_" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 dbcache_rule_id 是 String 内存加速规则ID。 value_columns 是 Array of strings 映射的value使用的column列表。 ttl 否 String key的生存时间。单位:ms。不传该值,默认取2592000000,表示30天。 value_separator 否 String 映射的value分隔符。只允许一个字符。
  • 请求示例 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/mapping { "source_instance_id": "356cf333ab77413f9d2526605227be08in01" , "target_instance_id": "2bb234c7175c400aab91de7c62174c0ein12" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 source_instance_id 是 String 内存加速源实例ID。当前支持云数据库RDS for MySQL和 GaussDB (for MySQL)实例。 target_instance_id 是 String 内存加速目标实例ID。当前仅支持GeminiDB Redis主备类型实例。
  • 请求示例 创建内存加速规则。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/dbcache/rule { "dbcache_mapping_id" : "e6f8526c-8b9c-4811-9218-4d2d7c1ddde1", "name" : "mysql_a1-to-redis_01", "source_db_schema" : "test", "source_db_table" : "students_info_t", "storage_type" : "hash", "target_database" : "0", "key_columns" : [ "sno", "sname" ], "value_columns" : [ "sno", "sname", "age" ], "ttl" : "-1", "key_separator" : ":", "key_prefix" : "prefix1" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 dbcache_mapping_id 是 String 内存加速映射ID。 name 是 String 内存加速规则名称。不超过256字符,需要确保在当前映射下唯一。 source_db_schema 是 String 源端数据库。 source_db_table 是 String 源端数据表。 storage_type 是 String 目标数据存储类型。取值为: hash。 target_database 是 String 目标数据库。取值范围: [0-999]。 key_columns 是 Array of strings 映射的key使用的column列表。 value_columns 是 Array of strings 映射的value使用的column列表。 ttl 否 String key的生存时间。单位:ms。不传该值,默认取2592000000,表示30天。 key_separator 是 String 映射的key分隔符。只允许一个字符。 value_separator 否 String 映射的value分隔符。只允许一个字符。 key_prefix 是 String 键前缀。最长限制1024字符。需确保key_prefix和target_database在当前映射下唯一。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 dbcache_mappings Array of 表5 QueryDBCacheMappingResponse objects 内存加速映射信息。 表5 QueryDBCacheMappingResponse 参数 参数类型 描述 id String 内存加速映射ID。 name String 内存加速映射名称。 source_instance_id String 源实例ID。 source_instance_name String 源实例名称。 target_instance_id String 目标实例ID。 target_instance_name String 目标实例名称。 status String 内存加速映射关系。 normal: 表示内存加速映射正常。 creating: 表示内存加速映射创建中。 createfail: 表示内存加速映射创建失败。 deleting: 表示内存加速映射解除中。 stopped: 表示内存加速映射停止。 deleted: 表示内存加速映射已解除。 created String 内存加速映射创建时间。 updated String 内存加速映射最新变更的时间。 rule_count Integer 该内存加速映射下的规则数量。
  • 响应示例 状态码: 200 Success. { "total_count" : 1, "dbcache_mappings" : [ { "id" : "0231e002-d278-4df8-815c-8284164168e5", "name" : "dbcache_rule_01", "source_instance_id" : "d8e6ca5a624745bcb546a227aa3ae1cfin01", "target_instance_id" : "9136fd2a9fcd405ea4674276ce36dae8in12", "source_instance_name" : "source_name", "target_instance_name" : "target_name", "status" : "normal", "rule_count" : 10, "created" : "2024-01-17T07:05:52", "updated" : "2024-01-20T08:07:02" } ] }
  • URI GET https://{Endpoint}/v3/{project_id}/dbcache/mappings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 映射ID,可以调用“查询内存加速映射列表和详情”接口获取。 name 否 String 映射名称。名称以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。 source_instance_id 否 String 源实例ID。 source_instance_name 否 String 源实例名称。名称以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。 target_instance_id 否 String 目标实例ID。 target_instance_name 否 String 目标实例名称。名称以“*”起始,表示按照“*”后面的值模糊匹配,否则,按照实际填写的名称精确匹配查询。 offset 否 Integer 索引位置,偏移量。 从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询)。取值必须为数字,不能为负数。 limit 否 Integer 查询个数上限值。取值范围:1~100。不传该参数时,默认查询前100条信息。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 config_ips Array of strings 免密配置,IP与网段的列表,仅支持ipv4的IP或网段。 total_count Integer 免密配置的总数。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • URI GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/passwordless-config 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置偏移量,表示从查询到的免密配置列表偏移offset条数据后查询对应的免密配置。 取值大于或等于0。不传该参数时,查询偏移量默认为0,表示从第一条记录开始查询。 limit 否 Integer 查询个数上限值,取值范围:1~100。不传该参数时,默认查询前100条记录。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置偏移量,表示从查询到的大Key列表偏移offset条数据后查询对应的大Key信息。 取值大于或等于0。不传该参数时,查询偏移量默认为0,表示从第一条大Key开始查询。 limit 否 Integer 查询个数上限值。取值范围:1~100。不传该参数时,默认查询前100条大Key。 key_types 否 Array of strings 大大Key的类型,一个字符串列表,支持"string"、"hash"、"zset"、"set"、"list"、"stream"六种类型。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 keys Array of 表5 objects 查询到的大Key列表。 count Integer 大Key的总数。 表5 BigKeysInfoResponseBody 参数 参数类型 描述 db_id Integer 大Key所在的DB。 key_type String 大Key类型。 key_name String 大Key名。 key_size Integer 大Key的长度。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/b31f6915c8be45e38958eac14e96a5d2in12/nodes { "action" : "shutdown", "node_ids" : [ "d96eaf85e4b44b2aa800dcf2a5981711no12", "e76f07fb1dae420791af867fc2ac4c35no12" ] }
  • 响应参数 状态码: 202 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 响应参数 状态码: 202 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。
  • 请求示例 设置实例的可维护时间段为02:00-06:00。 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/b0965c9010f44ffca9af4ee00746aa8din12/maintenance-window { "start_time" : "02:00" }
  • 请求示例 删除Redis禁用命令。 DELETE https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands { "disabled_type" : "command", "commands" : [ "keys", "hkeys" ] } 删除Redis禁用命令。 DELETE https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/redis/instances/0a9a2be86bdf493981d17626ad2f8668in12/disabled-commands { "disabled_type" : "key", "keys" : [ { "db_id" : "0", "key" : "name", "commands" : [ "get" ] }, { "db_id" : "0", "key" : "address", "commands" : [ "get", "set" ] } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 disabled_type 是 String 禁用类型。 枚举值: command key commands 否 Array of strings disabled_type为command时传入该参数。 枚举值: keys hkeys hvals hgetall smembers flushdb flushall keys 否 Array of 表4 objects disabled_type为key时传入该参数,最多20个。 表4 RedisDisabledCommandsDetail 参数 是否必选 参数类型 描述 db_id 是 String key所在的DB。 key 是 String key名。 commands 是 Array of strings 命令列表。
  • URI DELETE https://{Endpoint}/v3/{project_id}/redis/instances/{instance_id}/disabled-commands 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全