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

Cloud Role の作成 (V2)

Creates a custom organization- or project-scoped Cloud ACL role.

Policy reference — allowed resourceType values and their combinations:

resourceType Privileges Requires resources Note
project_member view, create, modify, delete No
project_role view, create, modify, delete, grant No
project view, modify, delete No
security view, manage No
backup view, manage No
observability view, manage No
serving_cluster create, view, modify, delete Yes (except create) resources = cluster id, e.g. in01-xxx. Use * to cover all clusters including future ones.
on_demand_cluster create, view, modify, delete Yes (except create) resources = cluster id
volume create, view, modify, delete, usage Yes (except create) resources = volume id
storage_integration create, view, modify, delete, usage Yes (except create) resources = integration id
model_provider_integration create, view, modify, delete, usage Yes (except create) resources = integration id
kms_integration create, view, modify, delete, usage Yes (except create) resources = integration id (CMEK)
datadog_integration create, view, modify, delete, usage Yes (except create) resources = integration id
serving_cluster_data read, write, all Yes resources = cluster id
on_demand_compute_data read, write, all No
volume_data read, write, all Yes resources = volume id
POST/v2/roles
接続エンドポイント

https://api.cloud.zilliz.com

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

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

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

プロジェクトをスコープとするロールのプロジェクト ID。組織をスコープとするロールの場合は、このフィールドを省略します。

roleNamestring必要

そのスコープ内で一意のロール表示名。

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

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

bash
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/roles" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "roleName": "Org Manager",
    "description": "Can view members and manage org roles",
    "policies": [
        {
            "resourceType": "member",
            "privileges": [
                "view"
            ]
        },
        {
            "resourceType": "org_role",
            "privileges": [
                "grant",
                "manage"
            ]
        }
    ]
}'
bash
export TOKEN="YOUR_API_KEY"

curl --request POST \
--url "${BASE_URL}/v2/roles" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "projectId": "proj-xxxxxxxx",
    "roleName": "Data Reader",
    "description": "Can read serving clusters",
    "policies": [
        {
            "resourceType": "serving_cluster",
            "resources": [
                "*"
            ],
            "privileges": [
                "view"
            ]
        }
    ]
}'
レスポンス200 OK - application/json

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

成功したレスポンス。

codeinteger必要

レスポンスコード。

値の例： 0
dataobject必要

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": {
        "roleId": "r-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "roleName": "Org Manager",
        "roleType": "org",
        "roleKind": "custom",
        "description": "Can view members and manage org roles",
        "policies": [
            {
                "resourceType": "member",
                "privileges": [
                    "view"
                ]
            },
            {
                "resourceType": "org_role",
                "privileges": [
                    "grant",
                    "manage"
                ]
            }
        ]
    }
}
Ctrl I