Updated on 2022-08-12 GMT+08:00

Permissions Policies and Supported Actions

This chapter describes fine-grained permissions management for your DMS for Kafka instances. If your account does not require individual IAM users, you can skip this chapter.

By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.

You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.

Policy-based authorization is useful if you want to allow or deny the access to an API.

Your account has all the permissions required to call all APIs, but IAM users under your account must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query Kafka instances using an API, the user must have been granted permissions that allow the dms:instance:create action.

Supported Actions

DMS for Kafka provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:

  • Permission: a statement in a policy that allows or denies certain operations.
  • API: REST APIs that can be called by a user who has been granted specific permissions.
  • Action: Specific operations that are allowed or denied.
  • IAM project or enterprise projects: type of projects for which an action will take effect. Policies that contain actions for both IAM and enterprise projects can be used and take effect for both IAM and Enterprise Management. Policies that only contain actions for IAM projects can be used and only take effect for IAM.

DMS for Kafka supports the following actions that can be defined in custom policies. Permissions must be obtained before calling DMS APIs. For details on how to obtain permissions, visit the Identity and Access Management help center.

Table 1 DMS for Kafka actions

Permissions

APIs

Actions

IAM Project

Enterprise Project

Creating an instance

POST /v1.0/{project_id}/instances

dms:instance:create

Viewing instance details

GET /v1.0/{project_id}/instances/{instance_id}

dms:instance:get

Modifying an instance

PUT /v1.0/{project_id}/instances/{instance_id}

dms:instance:modify

Deleting an instance

DELETE /v1.0/{project_id}/instances/{instance_id}

dms:instance:delete

Modifying instance specifications

POST /v1.0/{project_id}/instances/{instance_id}/extend

dms:instance:scale

Querying all instances

GET /v1.0/{project_id}/instances

dms:instance:list

Restarting an instance

POST /v1.0/{project_id}/instances/action

dms:instance:modifyStatus

Modifying Kafka Manager or Kafka instance password

This operation is supported only by using the console and not by calling APIs.

dms:instance:modifyAuthInfo

Resetting Kafka Manager or Kafka instance password

This operation is supported only by using the console and not by calling APIs.

dms:instance:resetAuthInfo

Querying one or more background tasks that have not been deleted

This operation is supported only by using the console and not by calling APIs.

dms:instance:getBackgroundTask

Deleting a background task

This operation is supported only by using the console and not by calling APIs.

dms:instance:deleteBackgroundTask