获取存储空间的数据列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

获取存储空间的数据列表

最近更新时间：2024.07.04 17:48:32首次发布时间：2023.08.11 19:22:04

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

请求说明

请求方式：GET
请求地址：https://veefedge.volcengineapi.com/?Action=ListKvKey&Version=2021-04-30

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	ListKvKey	公共参数。该参数表示接口名称。取值：ListKvKey
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。
namespace_name	String	是	test-kv1	数据所属存储空间的名称。
page	Int32	否	1	页码
limit	Int32	否	10	每页条数。目前每次最多获取50个。
order_by	Int32	否	2	查询出来的数据的排列顺序，按照创建时间排序。取值范围： 1：按照降序排列。 2（默认值）：按照升序排列。

返回参数

参数	类型	示例值	描述
namespace_keys	[]KeyDetail	见下文说明	存储空间中的数据详情
total_count	Int64	2	存储空间中的数据总数

KeyDetail

参数	类型	示例值	描述
namespace_name	String	test-kv1	数据所属存储空间的名称。
namespace_id	String	14776510402228****	数据所属存储空间的id。
key	String	testkey	键（Key）
key_status	Int32	200	数据状态。 100：过期 200：正常
ddl_time	Int64	0	数据到期时间。数据到期之后，Key中的Value将无法被访问。以 UNIX 时间戳格式显示。 0：永久储存
create_time	Int64	1662005890	数据创建时间。以UNIX时间戳格式显示。
update_time	Int64	1664337001	数据更新时间。以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
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。