ListKvs - 列出KV存储空间的键值对

列出账号下指定KV存储空间的所有键值对。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Namespacestring

调用 CreatevNamespace 时指定的名称。

test_namespace
PageSizeinteger

指定返回的页大小。默认:50,最大:100

50
PageNumberinteger

指定页码,PageNumber*PageSize 最大不可超过 50000。

10
Prefixstring

指定查找前缀。

prefix-

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

0AEDAF20-4DDF-4165-8750-47FF9C1929C9
PageSizeinteger

每页包含的记录数。

50
PageNumberinteger

总页数。

100
TotalCountinteger

总记录数。

1024
Keysarray<object>

本次遍历获取的键值对列表。

Keyobject
Namestring

键的名字。

Key1
UpdateTimestring

键的更新时间。

2021-12-13T07:46:03Z

示例

正常返回示例

JSON格式

{
  "RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9",
  "PageSize": 50,
  "PageNumber": 100,
  "TotalCount": 1024,
  "Keys": [
    {
      "Name": "Key1",
      "UpdateTime": "2021-12-13T07:46:03Z"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidAccount.MalformedThe specified account is invalid.账号输入不对,比如输入为空。
400InvalidNameSpace.MalformedThe specified namespace is invalid.存储空间名输入错误,比如输入空字符串。
400InvalidKey.MalformedThe specified key is invalid.Key名输入错误,比如输入空字符串。
400InvalidKey.ExceedsMaximumThe size of the key cannot exceed 512 bytes.请求的Key的长度过大。
400InvalidValue.ExceedsMaximumThe size of the value cannot exceed 2,000,000 bytes.存入的值过大。
403InvalidKey.ExceedsCapacityThe maximum capacity of a single namespace cannot exceed 1 GB.存储空间的容量超过限制。
403Unauthorized.InvalidParametersThe specified authentication parameters are invalid.鉴权参数输入错误。
403Unauthorized.InvalidTimeThe specified authentication time is invalid.您输入的鉴权时间参数无效,请检查参数值后重试。
403Unauthorized.InvalidTokenToken authentication failed.您输入的token无效,请检查并输入正确的token后进行重试。
404InvalidAccount.NotFoundThe specified account does not exist.指定的账号不存在。
404InvalidNameSpace.NotFoundThe specified namespace does not exist.指定的存储空间不存在。
404InvalidKey.NotFoundThe specified key does not exist.指定的键值对不存在。
406InvalidNameSpace.DuplicateThe specified namespace already exists.指定的存储空间已经存在。
406InvalidNameSpace.QuotaFullThe maximum number of namespaces is exceeded.存储空间的个数超过容量限制。
429TooManyRequestsToo many requests are submitted.提交太频繁,请稍候再试
429TooQuickRequestsRequest for putting or deleting keys are frequently submitted.键值对的修改或者删除操作太频繁。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-09-20OpenAPI 错误码发生变更查看变更详情