Describe User (V2)

この操作は、特定のユーザーの詳細情報を説明します。

POST/v2/vectordb/users/describe

接続エンドポイント

https://${CLUSTER_ENDPOINT}

📘ノート

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

shell

export CLUSTER_ENDPOINT=""

パラメータ

Authorizationstringheader必要

認証トークンは、適切な権限を持つAPIキー、またはコロンで連結されたユーザー名とパスワードのペア（例: username:password）である必要があります。

値の例： Bearer {{TOKEN}}

リクエスト・ボディapplication/json

userNamestring必要

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

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/users/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "userName": "my_user"
}'

レスポンス200 OK - application/json

指定されたユーザーに割り当てられたロールの名前を返します。

Success

成功レスポンス。

codeinteger

レスポンスコード。

値の例： 0

dataarray

レスポンスペイロード。ユーザーに割り当て済みのロールのリストです。

[]datastring

指定されたユーザーに割り当てられたロールの名前。

descriptionstring

ユーザーの説明。

Failure

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": [
        "db_admin"
    ],
    "description": "Read-only analyst account."
}