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

Cloud ロールのプリンシパルの一覧表示 (V2)

Cloud ACL ロールに直接バインドされたユーザー、グループ、API key を一覧表示します。

GET/v2/roles/{roleId}/principals
接続エンドポイント

https://api.cloud.zilliz.com

shell
export BASE_URL="https://api.cloud.zilliz.com"
パラメータ
Authorizationstringheader必要

認証トークンには、適切な権限を持つ API key を使用する必要があります。

値の例： Bearer {{TOKEN}}
roleIdstringpath必要

ロール ID。

値の例： r-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
projectIdstringquery

定義済みプロジェクトロールのプロジェクト境界。

値の例： proj-xxxxxxxx
currentPageintegerquery

返すページ番号。最初のページは 1 です。

値の例： 1
pageSizeintegerquery

1 ページあたりに返す項目数。

値の例： 10
bash
export TOKEN="YOUR_API_KEY"
export roleId="r-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

curl --request GET \
--url "${BASE_URL}/v2/roles/${roleId}/principals" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json"
レスポンス200 OK - application/json

成功した結果またはエラーメッセージを返します。

成功レスポンス。

codeinteger必要

レスポンスコード。

値の例： 0
dataobject必要
countinteger必要

一致する項目の総数。

currentPageinteger必要

現在のページ番号。

値の範囲： ≥ 1
pageSizeinteger必要

要求されたページサイズ。

値の範囲： ≥ 1
principalsarray必要

このページで返されるプリンシパル。

[]principalsobject必要
principalTypestring必要

プリンシパルのタイプ。

principalIdstring必要

プリンシパル識別子。user タイプの場合はユーザー ID(usr-xxxxxxxxxxxxxxxxxxxxxx など)、apikey タイプの場合は API key ID(64 文字の 16 進文字列)、group タイプの場合はグループ ID です。

principalNamestring必要

プリンシパルの表示名。

assignedBystring必要

割り当てたユーザーの表示名、または system などの非ユーザーの生の値。

assignedAtstring<date-time>必要

UTC ISO 8601 形式の割り当て時刻。

失敗レスポンス。

codeinteger必要

レスポンスコード。

messagestring必要

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "count": 3,
        "currentPage": 1,
        "pageSize": 10,
        "principals": [
            {
                "principalType": "user",
                "email": "alice@example.com",
                "principalName": "Alice Wang",
                "assignedBy": "Bob Li",
                "assignedAt": "2026-06-21T00:00:00Z"
            },
            {
                "principalType": "group",
                "groupId": "g-xxxxxxxxxxxxxx",
                "principalName": "engineering",
                "assignedBy": "Bob Li",
                "assignedAt": "2026-06-21T00:00:00Z"
            },
            {
                "principalType": "apikey",
                "apiKeyId": "key-xxxxxxxxxxxxxx",
                "principalName": "Alice's key",
                "assignedBy": "system",
                "assignedAt": "2026-06-21T00:00:00Z"
            }
        ]
    }
}
Ctrl I