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

ボリュームの更新 (V2)

Update the description of a volume.

PATCH/v2/volumes/{VOLUME_NAME}
接続エンドポイント

https://api.cloud.zilliz.com

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

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

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

ボリュームの organization ID。

値の例： org-xxxxxxxxxxxxxxxxxxx
VOLUME_NAMEstringpath必要

更新するボリュームの名前。

値の例： my_volume
リクエスト・ボディapplication/json
descriptionstring必要

ボリュームの新しい説明。値には空文字列を指定できます。

Descriptionbash
export TOKEN="YOUR_API_KEY"
export VOLUME_NAME="my_volume"

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

指定されたボリュームの詳細を返します。

codeinteger

レスポンスコード。

dataobject

ボリュームの詳細を含むレスポンスペイロード。

volumeNamestring

ボリュームの名前。

typestring

ボリュームのカテゴリ。

regionIdstring

ボリュームが配置されているリージョンの ID。

storageIntegrationIdstring

storage integration ID。external volume の場合にのみ返されます。

pathstring

ボリューム内のパスプレフィックス。external volume の場合にのみ返されます。

statusstring

ボリュームの現在のステータス。

createTimestring

ISO 8601 形式のボリューム作成時刻。

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Ctrl I