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

ロールを変更 (V2)

この操作は、指定したロールの説明を更新します。

POST/v2/vectordb/roles/alter
接続エンドポイント

https://${CLUSTER_ENDPOINT}

📘ノート
  • ${CLUSTER_ENDPOINT} を、あなたのZilliz Cloudクラスターのエンドポイントに置き換える必要があります。
  • エンドポイントを取得するには、Describe Cluster V2 APIを使用してレスポンスから値を抽出してください。
shell
export CLUSTER_ENDPOINT=""
パラメータ
Authorizationstringheader必要

認証トークンには、適切な権限を持つ API key または username:password のようにコロンで結合した username と password のペアを指定する必要があります。

値の例： Bearer {{TOKEN}}
リクエスト・ボディapplication/json
roleNamestring必要

ロールの名前。

descriptionstring

ロールの説明。

dbNamestring

データベース名。指定しない場合は、デフォルトのデータベースが使用されます。

Examplebash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/alter" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "roleName": "my_role",
    "description": "Grants read-only access to analytics collections."
}'
レスポンス200 OK - application/json

空のオブジェクトまたはエラーメッセージを返します。

成功レスポンス

codeinteger

レスポンスコード。

値の例： 0
dataobject

空のオブジェクトであるレスポンスペイロード。

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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