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

List Roles (V2)

この操作は、既存のすべてのロールの情報を一覧表示します。

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

https://${CLUSTER_ENDPOINT}

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

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

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

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

bash
export TOKEN="db_admin:xxxxxxxxxxxxx"

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

RoleItem オブジェクトのリストを含む RoleInfo オブジェクト。

codeinteger

レスポンスコード。

値の例： 0
dataarray

レスポンスペイロード。アイテムオブジェクトのリストです。

[]datastring

アイテムオブジェクトのリスト。

失敗レスポンス。

codeinteger

レスポンスコード。

messagestring

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": [
        "db_admin",
        "db_ro",
        "db_rw"
    ]
}
Ctrl I