Volume の詳細表示（V2）

Describes a volume in detail.

GET/v2/volumes/{VOLUME_NAME}

接続エンドポイント

https://api.cloud.zilliz.com

shell

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

パラメータ

Authorizationstringheader必要

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

値の例： Bearer {{TOKEN}}

VOLUME_NAMEstringpath必要

詳細を取得する Volume の名前。

値の例： my_volume

bash

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

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

レスポンス200 OK - application/json

指定した Volume の詳細を返します。

Success

codeinteger

レスポンスコード。

dataobject

Volume の詳細を含むレスポンスペイロード。

volumeNamestring

Volume の名前。

descriptionstring

Volume の説明。

typestring

Volume のカテゴリ。

regionIdstring

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

storageIntegrationIdstring

ストレージ統合 ID。external volume の場合にのみ返されます。

pathstring

Volume 内のパスプレフィックス。external volume の場合にのみ返されます。

statusstring

Volume の現在のステータス。

createTimestring

ISO 8601 形式の Volume の作成時刻。

Failure

失敗時のレスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。