使用ListKvs列出KV存储空间的键值对-边缘安全加速-阿里云-边缘安全加速(ESA)-阿里云帮助中心

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:ListKvs

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Namespace	string	是	调用 CreatevNamespace 时指定的名称。	test_namespace
PageSize	integer	否	指定返回的页大小。默认：50，最大：100。	50
PageNumber	integer	否	指定页码，PageNumber*PageSize 最大不可超过 50000。	10
Prefix	string	否	指定查找前缀。	prefix-

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	0AEDAF20-4DDF-4165-8750-47FF9C1929C9
PageSize	integer	每页包含的记录数。	50
PageNumber	integer	总页数。	100
TotalCount	integer	总记录数。	1024
Keys	array<object>	本次遍历获取的键值对列表。
	object
Name	string	键的名字。	Key1
UpdateTime	string	键的更新时间，格式为 ISO 8601（如 2024-01-01T00:00:00+Z）。	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	错误码	错误信息	描述
400	InvalidAccount.Malformed	The specified account is invalid.	账号输入不对，比如输入为空。
400	InvalidNameSpace.Malformed	The specified namespace is invalid.	存储空间名输入错误，比如输入空字符串。
400	InvalidKey.Malformed	The specified key is invalid.	Key名输入错误，比如输入空字符串。
400	InvalidKey.ExceedsMaximum	The size of the key cannot exceed 512 bytes.	请求的Key的长度过大。
400	InvalidValue.ExceedsMaximum	The size of the value cannot exceed 2,000,000 bytes.	存入的值过大。
403	InvalidKey.ExceedsCapacity	The maximum capacity of a single namespace cannot exceed 1 GB.	存储空间的容量超过限制。
403	Unauthorized.InvalidParameters	The specified authentication parameters are invalid.	鉴权参数输入错误。
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	您输入的鉴权时间参数无效，请检查参数值后重试。
403	Unauthorized.InvalidToken	Token authentication failed.	您输入的token无效，请检查并输入正确的token后进行重试。
404	InvalidAccount.NotFound	The specified account does not exist.	指定的账号不存在。
404	InvalidNameSpace.NotFound	The specified namespace does not exist.	指定的存储空间不存在。
404	InvalidKey.NotFound	The specified key does not exist.	指定的键值对不存在。
406	InvalidNameSpace.Duplicate	The specified namespace already exists.	指定的存储空间已经存在。
406	InvalidNameSpace.QuotaFull	The maximum number of namespaces is exceeded.	存储空间的个数超过容量限制。
429	TooManyRequests	Too many requests are submitted.	提交太频繁，请稍候再试
429	TooQuickRequests	Request for putting or deleting keys are frequently submitted.	键值对的修改或者删除操作太频繁。

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

变更历史

更多信息，参考变更详情。