跳到主要内容

创建 Cloud 角色 (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
连接端点

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com

📘说明

控制面接口速率限制为单用户单接口每秒最多 20 个请求。

shell
export BASE_URL="https://api.cloud.zilliz.com"
参数
Authorizationstringheader必填项

认证令牌，应为具备适当权限的 API Key。

示例值：Bearer {{TOKEN}}
请求体application/json
projectIdstring

项目级角色所属的项目 ID。组织级角色省略此字段。

roleNamestring必填项

角色作用域内唯一的显示名称。

descriptionstring

可选的角色描述。

policiesarray必填项

授予角色的策略语句。

[]policiesobject必填项

附加到自定义 Cloud 角色的策略语句。

resourceTypestring必填项

策略语句针对的二级资源。组织级类型：org_member、group、api_key、org_role、project_role、project、billing、authentication、org_control_ops、recovery。项目级类型：project_member、security、backup、observability、serving_cluster、on_demand_cluster、volume、storage_integration、model_provider_integration、kms_integration、datadog_integration、serving_cluster_data、on_demand_compute_data、volume_data。

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": "org_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

Returns a successful result or an error message.

成功响应。

codeinteger必填项

响应码。

示例值：0
dataobject必填项

Cloud ACL 角色。

roleIdstring必填项

角色 ID。

roleNamestring必填项

角色显示名称。

roleTypestring必填项

角色作用域。

roleKindstring必填项

角色是预定义角色还是自定义角色。

projectIdstring

项目级角色的项目 ID。对于组织级角色，此字段返回空字符串。

descriptionstring

角色描述。

policiesarray

附加到角色的策略语句。

[]policiesobject

附加到自定义 Cloud 角色的策略语句。

resourceTypestring必填项

策略语句针对的二级资源。组织级类型：org_member、group、api_key、org_role、project_role、project、billing、authentication、org_control_ops、recovery。项目级类型：project_member、security、backup、observability、serving_cluster、on_demand_cluster、volume、storage_integration、model_provider_integration、kms_integration、datadog_integration、serving_cluster_data、on_demand_compute_data、volume_data。

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": "org_member",
                "privileges": [
                    "view"
                ]
            },
            {
                "resourceType": "org_role",
                "privileges": [
                    "grant",
                    "manage"
                ]
            }
        ]
    }
}
Ctrl I