You need to enable JavaScript to run this app.
导航
批式计算 Spark版
  • 文档首页
    • /
  • 批式计算 Spark版

ListProject

最近更新时间：2023.05.11 16:26:01

首次发布时间：2023.05.11 16:17:40

我的收藏

调用 ListProject 接口，查询符合条件的项目列表。

前提条件

查询项目列表时，只会返回您加入的项目，无法查询未加入的项目。
如何成为项目成员，请参见权限概述。

请求参数

参数

类型

是否必填

示例值

说明

SearchKey

string

否

doc-test

根据项目名称的关键词进行模糊搜索。

PageNum

int

否

1

页数。

PageSize

int

否

10

每页展示的项目数量。

返回参数

参数

类型

示例值

说明

Items

list

-

返回的项目列表详情，详情请参见GETApiV1ProjectListItemsItem数据结构。

Total

int

1

满足条件的项目总数。

Pages

int

1

总页数。

PageNum

int

0

当前页数。

PageSize

int

10

每页能展示的项目数量。

GETApiV1ProjectListItemsItem 数据结构

参数

类型

示例值

说明

ProjectId

string

w4***rd65

项目 ID。

ProjectName

string

doc-test-project

项目名称。

RegionId

string

cn-beijing

项目所属地域。

CreateDate

string

2023-03-17 17:23:40

项目的创建时间。

Description

string

文档测试项目！

项目的描述语句。

请求示例

POST https://open.volcengineapi.com?Action=ListProject&Version=2021-06-01
Content-Type: application/json
Region: cn-beijing
ServiceName: spark
{
    "SearchKey": "doc-test"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023041414150035F1360E3A603D2D8A2F",
        "Action": "ListProject",
        "Version": "2021-06-01",
        "Service": "spark",
        "Region": "cn-beijing"
    },
    "Result": {
        "Items": [
            {
                "ProjectId": "o5k2***9g5",
                "ProjectName": "doc-test-project",
                "RegionId": "cn-beijing",
                "OwnerName": "openstudio-test",
                "Description": "文档测试项目！",
                "CreateDate": "2023-04-14 14:13:17"
            }
        ],
        "Total": 1,
        "Pages": 1,
        "PageNum": 0,
        "PageSize": 10
    }
}