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

ユーザーを更新 (V2)

この操作は、指定したユーザーのパスワードまたは説明を更新します。

POST/v2/vectordb/users/update_password
接続エンドポイント

https://${CLUSTER_ENDPOINT}

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

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

値の例: Bearer {{TOKEN}}
リクエスト・ボディ
userNamestring必要

対象ユーザーの名前です。値は文字で始まる必要があり、アンダースコア、英字、数字のみを含めることができます。

passwordstring<password>

ユーザーの現在のパスワードです。パスワードを変更する場合は、このフィールドを newPassword とあわせて指定してください。

newPasswordstring<password>

ユーザーの新しいパスワードです。パスワードを変更する場合は、このフィールドを password とあわせて指定してください。

descriptionstring

ユーザーの新しい説明です。値には空文字列を指定できます。

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/users/update_password" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
"newPassword": "P@ssw0rd!",
"userName": "myUser",
"password": "P@ssw0rd*"
}'
レスポンス

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

成功レスポンス

codeinteger

レスポンスコード。

値の例: 0
dataobject

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

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

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