メインコンテンツまでスキップ

プロジェクトの更新 (V2)

This operation updates the name and description of a specified project.

PATCH/v2/projects/{projectId}
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

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

値の例： Bearer {{TOKEN}}
OrgIdstringheader必要

プロジェクトの organization ID。

値の例： org-xxxxxxxxxxxxxxxxxxx
projectIdstringpath必要

更新するプロジェクトの ID。

値の例： proj-xxxxxxxxxxxxxxxxxxx
リクエスト・ボディapplication/json
projectNamestring

プロジェクトの新しい名前。値を空文字列にすることはできません

descriptionstring

プロジェクトの新しい説明。値は空文字列にできます。

bash
export TOKEN="YOUR_API_KEY"
export projectId="proj-xxxxxxxxxxxxxxxxxxx"

curl --request PATCH \
--url "${BASE_URL}/v2/projects/${projectId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "OrgId: org-xxxxxxxxxxxxxxxxxxx" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "projectName": "New Project Name",
    "description": "This is a new description of the project."
}'
bash
export TOKEN="YOUR_API_KEY"
export projectId="proj-xxxxxxxxxxxxxxxxxxx"

curl --request PATCH \
--url "${BASE_URL}/v2/projects/${projectId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "OrgId: org-xxxxxxxxxxxxxxxxxxx" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "projectName": "New Project Name"
}'
bash
export TOKEN="YOUR_API_KEY"
export projectId="proj-xxxxxxxxxxxxxxxxxxx"

curl --request PATCH \
--url "${BASE_URL}/v2/projects/${projectId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "OrgId: org-xxxxxxxxxxxxxxxxxxx" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "description": "This is a new description of the project."
}'
レスポンス200 OK - application/json

なし

成功レスポンス

codeinteger

レスポンスコード。

値の例： 0
datastring

プロジェクトが正常に更新されたことを示す文字列 'ok'。

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": "ok"
}
Ctrl I