プロジェクトを一覧表示 (V1)

ノート

既存のプロジェクトを一覧表示します。

GET/v1/projects

接続エンドポイント

https://controller.api.${CLOUD_REGION}.zillizcloud.com

📘ノート

• ${CLOUD_REGION} を、デプロイに適したリージョンに置き換える必要があります。
• クラウドリージョンIDを取得するには、Zilliz Cloudコンソールまたはクラウドリージョンの一覧を参照してください。

shell

export CLOUD_REGION="gcp-us-west1"
export BASE_URL="https://controller.api.${CLOUD_REGION}.zillizcloud.com"

パラメータ

Authorizationstringheader必要

認証トークンには、適切な権限を持つ API key を使用する必要があります。

値の例： Bearer {{TOKEN}}

bash

export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v1/projects" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"

レスポンス200 OK - application/json

プロジェクトの一覧を返します。

Success

プロジェクトの一覧を返します。

codeinteger

レスポンスコード。

dataarray

プロジェクトの一覧であるレスポンスペイロード。

[]dataobject

プロジェクト。

createTimeMillistring

Unix epoch からの経過時間をミリ秒で表した、プロジェクトの作成時刻を示す数値です。

instanceCountinteger

プロジェクト内に作成されたクラスターの数です。

projectIdstring

プロジェクトの ID。

projectNamestring

プロジェクト名。

Failure

エラーメッセージを返します。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson

{
    "code": 200,
    "data": [
        {
            "createTimeMilli": 1685006864000,
            "instanceCount": 0,
            "projectId": "proj-xxxxxxxxxxxxxxxxxxxxxx",
            "projectName": "Default Project"
        }
    ]
}