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

Cloud ロールの更新 (V2)

カスタム Cloud ACL ロールを部分的に更新します。指定されたポリシーがポリシーセット全体を置き換えます。

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

https://api.cloud.zilliz.com

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必要

ステートメントが対象とする第 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

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

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

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

成功レスポンス。

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": "Data Reader",
        "roleType": "project",
        "roleKind": "custom",
        "projectId": "proj-xxxxxxxx",
        "description": "Can read serving clusters",
        "policies": [
            {
                "resourceType": "serving_cluster",
                "resources": [
                    "*"
                ],
                "privileges": [
                    "view"
                ]
            }
        ]
    }
}
Ctrl I