huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20240116

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"RedisDbUserInfo":{"description":"数据库用户信息。","properties":{"databases":{"description":"账号已授权的数据库名称列表。","items":{"type":"string"},"type":"array"},"name":{"description":"账号名称。\n\n小于36个字符,以字母开头,仅包含数字、字母、中划线、下划线。","type":"string"},"privilege":{"description":"账号权限。\n\n- 取值\"ReadOnly\":账号为只读权限;\n- 取值\"ReadWrite\":账号为读写权限。","type":"string"},"type":{"description":"账号类型。\n\n- rwuser:管理员用户\n- acluser:普通用户","type":"string"}},"required":["name","type","privilege","databases"],"type":"object"},"RedisListDbUsersResponse":{"properties":{"total_count":{"description":"总记录数。","type":"integer"},"users":{"description":"数据库用户信息列表。","items":{"$ref":"#/definitions/RedisDbUserInfo"},"type":"array"}},"required":["users","total_count"],"type":"object"}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"e18b0f11ac5c493981b7fcba5fd2956a","info_version":"v3","method":"get","name":"ListDbUsers","parameters":{},"paths":{"/v3/{project_id}/redis/instances/{instance_id}/db-users":{"get":{"description":"获取Redis数据库账号列表和详情。","operationId":"ListDbUsers","parameters":[{"description":"用户Token。","in":"header","name":"X-Auth-Token","required":true,"type":"string","x-example":"******"},{"description":"租户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"054e292c9880d4992f02c0196d3ea468"},{"description":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"054e292c9880d4992f02c0196d3ein12"},{"description":"数据库账号名。若传此参数,则查询指定账号的信息,否则返回所有数据库账号信息。","in":"query","name":"name","required":false,"type":"string"},{"description":"索引位置,偏移量。\n\n  - 从第一条数据偏移offset条数据后开始查询,默认为0。\n  - 取值必须为数字,且不能为负数。","in":"query","name":"offset","required":false,"type":"integer"},{"description":"查询个数上限值。\n\n- 取值范围:1~100。\n- 不传该参数时,默认查询前100条信息。","in":"query","name":"limit","required":false,"type":"integer"}],"responses":{"200":{"description":"Success.","examples":{"application/json":{"total_count":2,"users":[{"databases":["1","2"],"name":"db_user1","privilege":"ReadWrite","type":"rwuser"},{"databases":["1","2"],"name":"db_user2","privilege":"ReadWrite","type":"acluser"}]}},"schema":{"$ref":"#/definitions/RedisListDbUsersResponse"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"获取Redis数据库账号列表和详情","tags":["数据库账号管理"],"x-apigateway-ratelimit":"nosql_default_policy","x-constraint":"- 只支持GeminiDB Redis引擎。\n- 实例在创建、变更规格、修改端口、异常状态或冻结状态下不能执行该操作。","x-is-registered":"Y","x-request-examples-url-1":"GET https://{endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/redis/instances/9136fd2a9fcd405ea4674276ce36dae8in12/db-users","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"获取Redis数据库账号列表和详情","tags":"数据库账号管理","uri":null,"version":"2.0"}