Help Center> Cloud Data Migration> API Reference> Permissions Policies and Supported Actions
Updated on 2024-01-16 GMT+08:00
View PDF

Permissions Policies and Supported Actions

This chapter describes fine-grained permissions management for your CDM. If your cloud account does not need individual IAM users, then you may skip over this chapter.

By default, new IAM users do not have any permissions assigned. You need to add a user to one or more groups, and assign permissions policies or roles to these groups. The user then inherits permissions from the groups it is a member of. This process is called authorization. After authorization, the user 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.

An account has all the permissions required to call all APIs, but IAM users 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 queries the cluster list using an API, the user must have been granted permissions that allow the cdm:cluster:list action.

Supported Actions

CDM 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.
  • APIs: REST APIs that can be called in a custom policy.
  • Actions: added to a custom policy to control permissions for specific operations.
  • IAM or enterprise projects: Type of projects for which an action will take effect. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM.

    The check mark (√) indicates that an action takes effect. The cross mark (x) indicates that an action does not take effect.

CDM supports the actions listed in Table 1 that can be defined in custom policies. All actions listed in the following table support both Project and Enterprise Project.
Table 1 Actions

Permission

API

Action

IAM Project

Enterprise Project

Creating a cluster

POST /v1.1/{project_id}/clusters

cdm:cluster:create

√

×

Querying the cluster list

GET /v1.1/{project_id}/clusters

cdm:cluster:list

√

×

Querying cluster details

GET /v1.1/{project_id}/clusters/{cluster_id}

cdm:cluster:get

√

×

Restarting a cluster

POST /v1.1/{project_id}/clusters/{cluster_id}/action

cdm:cluster:operate

√

×

Modifying cluster configuration

POST /v1.1/{project_id}/cluster/modify/{cluster_id}

cdm:cluster:modify

√

×

Deleting a cluster

DELETE /v1.1/{project_id}/clusters/{cluster_id}

cdm:cluster:delete

√

×

Creating a link

POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/link

cdm:link:operate

√

×

Querying a link

GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{linkName}

cdm:cluster:get

√

×

Modifying a link

PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{link_name}

cdm:link:operate

√

×

Deleting a link

DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/link/{linkName}

cdm:link:operate

√

×

Creating a job in a specified cluster

POST /v1.1/{project_id}/clusters/{cluster_id}/cdm/job

cdm:job:operate

√

×

Querying a job

GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{jobName}

cdm:cluster:get

√

×

Modifying a job

PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{jobName}

cdm:job:operate

√

×

Starting a job

PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{jobName}/start

cdm:job:operate

√

×

Stopping a job

PUT /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{jobName}/stop

cdm:job:operate

√

×

Querying job status

GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{jobName}/status

cdm:cluster:get

√

×

Querying job execution history

GET /v1.1/{project_id}/clusters/{cluster_id}/cdm/submissions

cdm:cluster:get

√

×

Deleting a job

DELETE /v1.1/{project_id}/clusters/{cluster_id}/cdm/job/{jobName}

cdm:job:operate

√

×