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

ロールの説明 (V2)

この操作は、指定されたロールの詳細を説明します。

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

https://${CLUSTER_ENDPOINT}

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

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

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

ロールの名前。

dbNamestring

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

Examplebash
export TOKEN="db_admin:xxxxxxxxxxxxx"

curl --request POST \
--url "${CLUSTER_ENDPOINT}/v2/vectordb/roles/describe" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "roleName": "db_admin"
}'
レスポンス200 OK - application/json

ロールの詳細な説明を含むオブジェクト。

成功レスポンス。

codeinteger

レスポンスコード。

値の例： 0
dataarray

レスポンスペイロードは、権限アイテムのリストです。

[]dataobject

権限アイテム。

object_typestring

権限が属するオブジェクトのタイプ。

privilegestring

ロールに付与された権限。

object_namestring

ロールに指定された権限が付与されているオブジェクトの名前。

grantorstring

特定のロールをユーザーに付与したユーザーの名前。

descriptionstring

ロールの説明。

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": [
        {
            "dbName": "*",
            "grantor": "db_admin",
            "objectName": "*",
            "objectType": "Collection",
            "privilege": "IndexDetail"
        },
        {
            "dbName": "*",
            "grantor": "db_admin",
            "objectName": "*",
            "objectType": "Global",
            "privilege": "DescribeCollection"
        },
        {
            "dbName": "*",
            "grantor": "db_admin",
            "objectName": "*",
            "objectType": "Global",
            "privilege": "ShowCollections"
        }
    ],
    "description": "Grants read-only access to analytics collections."
}
Ctrl I