You need to enable JavaScript to run this app.
导航
获取存储空间的数据列表
最近更新时间:2023.08.14 17:40:49首次发布时间:2023.08.11 19:22:04

本接口用于获取存储空间下的数据列表。

请求方法

GET

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

名称类型是否必填示例值描述
ActionStringListKvKey公共参数。该参数表示接口名称。取值:ListKvKey
VersionString2021-04-30公共参数。该参数表示接口版本。取值:2021-04-30。
namespace_nameStringtest-kv1数据所属存储空间的名称。
pageInt321页码

limit

Int32

10

每页条数。
目前每次最多获取50个。

order_by

Int32

2

查询出来的数据的排列顺序,按照创建时间排序。取值范围:

  • 1:按照降序排列。

  • 2(默认值):按照升序排列。

返回数据

名称类型示例值描述
namespace_keys[]KeyDetail见下文说明存储空间中的数据详情
total_countInt642存储空间中的数据总数

KeyDetail

名称类型示例值描述
namespace_nameStringtest-kv1数据所属存储空间的名称。
namespace_idString14776510402228****数据所属存储空间的id。
keyStringtestkey键(Key)

key_status

Int32

200

数据状态。

  • 100:过期

  • 200:正常

ddl_time

Int64

0

数据到期时间。数据到期之后,Key中的Value将无法被访问。

  • 以 UNIX 时间戳格式显示。

  • 0:永久储存

create_timeInt641662005890数据创建时间。以UNIX时间戳格式显示。
update_timeInt641664337001数据更新时间。以UNIX时间戳格式显示。

请求示例

GET https://veefedge.volcengineapi.com/?Action=ListKvKey
&namespace_name=test-kv1
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230810210051741B321D8****",
        "Action": "ListKvKey",
        "Version": "2021-04-30",
        "Service": "veefedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "namespace_keys": [
            {
                "namespace_name": "test-kv1",
                "namespace_id": "14776510402****",
                "key": "testkey",
                "key_status": 200, // 100 过期;200 正常
                "ddl_time": 0,
                "create_time": 1678085786,
                "update_time": 1678085786
            },
            {
                "namespace_name": "test-kv1",
                "namespace_id": "14776510402****",
                "key": "key",
                "key_status": 100,
                "ddl_time": 1678259532,
                "create_time": 1678092385,
                "update_time": 1682327035
            },
        ],
        "total_count": 2
    }
}