huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20250523

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"BigKeysInfoResponseBody":{"properties":{"db_id":{"description":"大Key所在的DB。","format":"int32","type":"integer"},"key_name":{"description":"大Key名。","type":"string"},"key_size":{"description":"大Key的长度。","type":"integer"},"key_type":{"description":"大Key类型。","type":"string"}},"type":"object"},"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"ShowRedisBigKeysRequestBody":{"properties":{"key_types":{"description":"大key的类型,一个字符串列表,支持\"string\",\"hash\",\"zset\",\"set\",\"list\",\"stream\"六种类型。","items":{"type":"string"},"type":"array"},"limit":{"description":"查询个数上限值。 取值范围:1~100。不传该参数时,默认查询前100条大key。","format":"int32","type":"integer"},"offset":{"description":"索引位置偏移量,表示从查询到的大key列表偏移offset条数据后查询对应的大key信息。 取值大于或等于0。不传该参数时,查询偏移量默认为0,表示从第一条大key开始查询。","format":"int32","type":"integer"}},"type":"object"},"ShowRedisBigKeysResponseBody":{"properties":{"count":{"description":"大Key的总数。","format":"int32","type":"integer"},"keys":{"description":"查询到的大Key列表。","items":{"$ref":"#/definitions/BigKeysInfoResponseBody"},"type":"array"}},"type":"object"}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"4758181ff0b04d919c9132aec60420a1","info_version":"v3","method":"post","name":"ShowRedisBigKeys","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/big-keys":{"post":{"description":"支持查询Redis实例的大key。value长度大于bigkeys-string-threshold参数的string类型的key或者元素数大于bigkeys-composite-threshold参数的hash/list/zset/set/stream类型key,会被判断为大key。","operationId":"ShowRedisBigKeys","parameters":[{"description":"租户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"用户Token。","in":"header","name":"x-auth-token","required":true,"type":"string"},{"description":"查询Redis大key的请求体。","in":"body","name":"ShowRedisBigKeysRequestBody","required":false,"schema":{"$ref":"#/definitions/ShowRedisBigKeysRequestBody"}}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"count":1,"keys":[{"db_id":0,"key_name":"a","key_size":12,"key_type":"String"}]}},"schema":{"$ref":"#/definitions/ShowRedisBigKeysResponseBody"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"查询Redis实例的大key","tags":["实例管理"],"x-constraint":"[该接口支持如下数据库实例:]\n  - [GeminiDB Redis]","x-is-registered":"Y","x-request-examples-1":{"key_types":["string","hash","zset","set","list","stream"]},"x-request-examples-description-1":"支持查询Redis实例的大key。value长度大于bigkeys-string-threshold参数的string类型的key或者元素数大于bigkeys-composite-threshold参数的hash/list/zset/set/stream类型key,会被判断为大key。","x-request-examples-text-1":{"key_types":["string","hash","zset","set","list","stream"]},"x-request-examples-url-1":"POST https://{endpoint}/v3/instances/91b5c48e11bf4913b35814f28b8f79f2in12/big-keys","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"查询Redis实例的大key","tags":"实例管理","uri":null,"version":"2.0"}