跳到主要内容

更新 Cloud 角色 (V2)

Partially updates a custom Cloud ACL role. Provided policies replace the complete policy set.

PUT/v2/roles/{roleId}
连接端点

该 API 的 Base URL 格式如下：

https://api.cloud.zilliz.com

📘说明

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

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

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

示例值：Bearer {{TOKEN}}
roleIdstringpath必填项

角色 ID。

示例值：r-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
请求体application/json
projectIdstring

项目级角色的项目边界声明。

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

保留供未来使用，请省略此字段。

Replace Policiesbash
export TOKEN="YOUR_API_KEY"
export roleId="r-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

curl --request PUT \
--url "${BASE_URL}/v2/roles/${roleId}" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Request-Timeout: 5" \
--header "Content-Type: application/json" \
-d '{
    "roleName": "Data Reader",
    "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": "Data Reader",
        "roleType": "project",
        "roleKind": "custom",
        "projectId": "proj-xxxxxxxx",
        "description": "Can read serving clusters",
        "policies": [
            {
                "resourceType": "serving_cluster",
                "resources": [
                    "*"
                ],
                "privileges": [
                    "view"
                ]
            }
        ]
    }
}
Ctrl I