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

Cloud ロールの一覧取得（V2）

Lists organization- or project-scoped Cloud ACL roles.

GET/v2/roles
接続エンドポイント

https://api.cloud.zilliz.com

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

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

値の例： Bearer {{TOKEN}}
projectIdstringquery

ロールをフィルタリングするために使用されるプロジェクト ID。

値の例： proj-xxxxxxxx
currentPageintegerquery

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

値の例： 1
pageSizeintegerquery

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

値の例： 10
bash
export TOKEN="YOUR_API_KEY"

curl --request GET \
--url "${BASE_URL}/v2/roles" \
--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
rolesarray必要

このページで返されたロール。

[]rolesobject必要

Cloud ACL ロール。

roleIdstring必要

ロール ID。

roleNamestring必要

ロールの表示名。

roleTypestring必要

ロールのスコープ。

roleKindstring必要

ロールが事前定義されているか、カスタムであるか。

projectIdstring

プロジェクトスコープのロールのプロジェクト ID。このフィールドは、組織スコープのロールには存在しません。

descriptionstring

ロールの説明。

policiesarray

ロールに添付されたポリシーステートメント。

[]policiesobject

カスタム Cloud ロールに添付されたポリシーステートメント。

resourceTypestring必要

ステートメントが対象とする第 2 レベルのリソース。例: serving_cluster、volume、project_member、project_role。

privilegesarray必要

そのリソースに対するアトミックな権限。例: ["view", "create"]。

[]privilegesstring
(近日追加予定)
resourcesarray

ステートメントがカバーするインスタンス: すべての場合は *、または明示的な ID (ロールのプロジェクトに対して検証されます)。serving_cluster、on_demand_cluster、volume、serving_cluster_data、volume_data、storage_integration、model_provider_integration、kms_integration、datadog_integration では、ステートメントの唯一の権限が create でない限り必須です。on_demand_compute_data を含む他のすべての場所では、これを省略してください。書き込み時に拒否され、返されることもありません。

[]resourcesstring
(近日追加予定)
scopeobject

将来の使用のために予約されています。このフィールドは省略してください。

失敗したレスポンス。

codeinteger必要

レスポンスコード。

messagestring必要

エラーメッセージ。

Successjson
{
    "code": 0,
    "data": {
        "count": 2,
        "currentPage": 1,
        "pageSize": 10,
        "roles": [
            {
                "roleId": "r-onpocppupmikjqmildbpbeouxsrwvy",
                "roleName": "Project Admin",
                "roleType": "project",
                "roleKind": "pre-defined",
                "projectId": "",
                "description": ""
            },
            {
                "roleId": "r-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "roleName": "Data Reader",
                "roleType": "project",
                "roleKind": "custom",
                "projectId": "proj-xxxxxxxx",
                "description": ""
            }
        ]
    }
}
Ctrl I