ListProject - 获取项目列表--边缘智能-火山引擎

文档中心

立即注册

导航

ListProject - 获取项目列表

最近更新时间：2025.04.22 15:34:59首次发布时间：2025.04.22 11:47:45

调用本接口获取边缘智能项目信息列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListProject	要执行的操作，取值：ListProject。
Version	String	是	2022-01-01	API的版本，取值：2022-01-01。
page_index	Integer	是	1	设置要返回的页码。
page_size	Integer	是	10	设置单页包含的最大项目数。
created_orderby	Integer	是	0	设置项目排序方式。该参数有以下取值： 0：按创建时间降序 1：按创建时间升序
project_name	String	否	my_first_project	指定要查询的项目的名称。
created_to	String	否	1767110400	项目创建的最晚时间。使用秒级时间戳格式。
created_from	Integer	否	1735660800	项目创建的最早时间。使用秒级时间戳格式。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
items	Array of Object		项目对象列表。
pageinator	Object		分页信息。

请求示例

POST /?Action=ListProject&Version=2022-01-01 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250402T032931Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250402/cn-beijing/vei_api/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "page_index": 1,
  "page_size": 10,
  "created_orderby": 0,
  "created_to": "1767110400",
  "created_from": 1735660800
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250402112937254075192019056058",
    "Action": "ListProject",
    "Version": "2022-01-01",
    "Service": "vei_api",
    "Region": "cn-beijing"
  },
  "Result": {
    "items": [
      {
        "id": "p-2100001281-zf9ll",
        "name": "my_first_project",
        "created_at": "1743487886",
        "desc": "我的第一个项目",
        "status": "ps-2100001281-z8h6h",
        "tags": {
          "key": "env",
          "value": "test"
        }
      }
    ],
    "pageinator": {
      "total_pages": 1,
      "index": 1,
      "total_items": 1,
      "size": 10
    }
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	600004	参数解析错误	参数解析错误。
400	600005	服务内部错误	服务内部错误。