查看 Stage 列表

内测版

This operation lists all stages in the specified project. You need to be

GET

/v2/stages

Base URL

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com.cn

📘说明

控制面接口速率限制为单用户单接口每秒最多 20 个请求。

如果您在使用该接口过程中遇到任何问题，欢迎您联系 Zilliz Cloud 技术支持。

export BASE_URL="https://api.cloud.zilliz.com.cn"

参数

Authorizationstringheaderrequired

认证令牌，应为具备适当权限的 API 密钥或用冒号分隔的用户名和密码，如 username:password。

示例值：Bearer {{TOKEN}}

projectIdstringqueryrequired

当前操作的目标项目。

示例值：proj-xxxxxxxxxxxxxxxxx

pageSizeintegerquery

每次返回的记录数。

示例值：10

currentPageintegerquery

当前页码。

示例值：1

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/stages?projectId=proj-xxxxxxxxxxxxxxxxx" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json"

响应200 - application/json

SUCCESS

返回 Stage 列表。

codeinteger

响应码。

dataobject

countinteger

Stage 总数。

currentPageinteger

当前页码。

pageSizeinteger

每页记录数。

stagesarray

Stage 列表。

[]stagesobject

stageNamestring

Stage 名称。

FAILURE

返回错误消息。

codeinteger

响应码。

messagestring

错误描述。

SUCCESS

{
    "code": 200,
    "data": {
        "count": 3,
        "currentPage": 1,
        "pageSize": 10,
        "stages": [
            {
                "stageName": "my_stage_1"
            },
            {
                "stageName": "my_stage_2"
            },
            {
                "stageName": "my_stage_3"
            }
        ]
    }
}