RAM authorization - DataWorks - Alibaba Cloud Documentation Center

Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. Using RAM helps you avoid sharing your Alibaba Cloud account keys with other users and allows you to grant users the least privilege access. RAM uses permission policies to define authorizations. This topic describes the general structure of a RAM policy, and the policy statement elements (Action, Resource, and Condition) defined by DataWorks for RAM permission policies. The RAM code (RamCode) for DataWorks is dataworks , and the supported authorization granularity is OPERATION .

General structure of a policy

Permission policies support JSON format with the following general structure:

{
  "Version": "1",
  "Statement": [
    {
      "Effect": "<Effect>",
      "Action": "<Action>",
      "Resource": "<Resource>",
      "Condition": {
        "<Condition_operator>": {
          "<Condition_key>": [
            "<Condition_value>"
          ]
        }
      }
    }
  ]
}

The following list describes the fields in the policy:

Version: Specifies the policy version number. It is fixed at 1.
Statement:
- Effect: Specifies the authorization result. Valid values: Allow and Deny.
- Action: Specifies one or more operations that are allowed or denied.
- Resource: Specifies the specific objects affected by the operations. You can use Alibaba Cloud Resource Names (ARNs) to describe specific resources.
- Condition: Specifies the conditions for the authorization to take effect. This field is optional.
  - Condition operator: Specifies the conditional operators. Different types of conditions support different conditional operators.
  - Condition_key: Specifies the condition keys.
  - Condition_value: Specifies the condition values.

Action

The following table lists the actions defined by DataWorks. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding ARN in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys that are applicable across all RAM-integrated services. For more information, see Common condition keys.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action	API	Access level	Resource type	Condition key	Dependent action
dataworks:*	ListDataQualityResults	list	All Resource ``	None	None
dataworks:CreateProject	CreateProject	create	All Resource ``	None	None
dataworks:GrantMemberProjectRoles	GrantMemberProjectRoles	update	All Resource ``	None	None
dataworks:GetProject	GetProject	get	All Resource ``	None	None
dataworks:*	CreateFunction	create	All Resource ``	None	None
dataworks:*	ListPipelineRuns	list	All Resource ``	None	None
dataworks:*	StopWorkflowInstances	update	All Resource ``	None	None
dataworks:*	ListWorkflowDefinitions	list	All Resource ``	None	None
dataworks:*	ListDataQualityEvaluationTaskInstances	list	All Resource ``	None	None
dataworks:TestDataSourceConnectivity	TestDataSourceConnectivity	get	All Resource ``	None	None
dataworks:CreateDataSource	CreateDataSource	get	All Resource ``	None	None
dataworks:*	CreatePipelineRun	create	All Resource ``	None	None
dataworks:DeleteProjectMember	DeleteProjectMember	delete	All Resource ``	None	None
dataworks:*	GetResource	get	All Resource ``	None	None
dataworks:*	ListTasks	get	Task `acs:dataworks:{#regionId}:{#accountId}:task/`	None	None
dataworks:GetRoute	GetRoute	get	All Resource ``	None	None
dataworks:CreateIdentifyCredential	CreateIdentifyCredential	create	All Resource ``	None	None
dataworks:*	RenameWorkflowDefinition	update	All Resource ``	None	None
dataworks:*	MoveResource	update	All Resource ``	None	None
dataworks:GetCatalog	GetCatalog	get	All Resource ``	None	None
dataworks:DeleteDataSource	DeleteDataSource	get	All Resource ``	None	None
dataworks:ListDataQualityScans	ListDataQualityScans	list	All Resource ``	None	None
dataworks:*	ExecPipelineRunStage	none	All Resource ``	None	None
dataworks:*	CreateWorkflowDefinition	create	All Resource ``	None	None
dataworks:*	DeleteWorkflowDefinition	delete	All Resource ``	None	None
dataworks:DeleteRoute	DeleteRoute	delete	All Resource ``	None	None
dataworks:AssociateProjectToResourceGroup	AssociateProjectToResourceGroup	update	All Resource ``	None	None
dataworks:GetDataQualityAlertRule	GetDataQualityAlertRule	get	All Resource ``	None	None
dataworks:GetTable	GetTable	get	All Resource ``	None	None
dataworks:GetDataSource	GetDataSource	get	All Resource ``	None	None
dataworks:ListNetworks	ListNetworks	list	All Resource ``	None	None
dataworks:UpdateDataSource	UpdateDataSource	get	All Resource ``	None	None
dataworks:*	ListDataQualityEvaluationTasks	list	All Resource ``	None	None
dataworks:*	ImportWorkflowDefinition	update	All Resource ``	None	None
dataworks:ListCertificates	ListCertificates	get	All Resource ``	None	None
dataworks:RerunWorkflowInstances	RerunWorkflowInstances	update	All Resource ``	None	None
dataworks:ExecuteAdhocWorkflowInstance	ExecuteAdhocWorkflowInstance	create	All Resource ``	None	None
dataworks:CreateRoute	CreateRoute	create	All Resource ``	None	None
dataworks:CreateWorkflowInstances	CreateWorkflowInstances	create	All Resource ``	None	None
dataworks:ListTaskOperationLogs	ListTaskOperationLogs	get	All Resource ``	None	None
dataworks:CreateNetwork	CreateNetwork	create	All Resource ``	None	None
dataworks:*	AbolishPipelineRun	update	All Resource ``	None	None
dataworks:DeleteDataset	DeleteDataset	delete	All Resource ``	None	None
dataworks:*	ListPipelineRunItems	list	All Resource ``	None	None
dataworks:ListLineages	ListLineages	list	All Resource ``	None	None
dataworks:*	GetNode	get	All Resource ``	None	None
dataworks:ListTables	ListTables	list	All Resource ``	None	None
dataworks:*	ListNodes	list	All Resource ``	None	None
dataworks:GetDatasetVersion	GetDatasetVersion	get	All Resource ``	None	None
dataworks:ListDataQualityAlertRules	ListDataQualityAlertRules	list	All Resource ``	None	None
dataworks:ListDatasets	ListDatasets	list	All Resource ``	None	None
dataworks:*	ListDeploymentPackageFiles	list	All Resource ``	None	None
dataworks:ListDatasetVersions	ListDatasetVersions	list	All Resource ``	None	None
dataworks:GetDataQualityScan	GetDataQualityScan	get	All Resource ``	None	None
dataworks:CreateDatasetVersion	CreateDatasetVersion	create	All Resource ``	None	None
dataworks:GetDataset	GetDataset	get	All Resource ``	None	None
dataworks:*	GetPipelineRun	get	All Resource ``	None	None
dataworks:ListResourceGroupAssociateProjects	ListResourceGroupAssociateProjects	get	*DwResourceGroup `acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}`	None	None
dataworks:GetColumn	GetColumn	get	All Resource ``	None	None
dataworks:GetCreateWorkflowInstancesResult	GetCreateWorkflowInstancesResult	get	All Resource ``	None	None
dataworks:ListPartitions	ListPartitions	list	All Resource ``	None	None
dataworks:GetComputeResource	GetComputeResource	get	All Resource ``	None	None
dataworks:CreateDataSourceSharedRule	CreateDataSourceSharedRule	get	All Resource ``	None	None
dataworks:ListProjectMembers	ListProjectMembers	list	All Resource ``	None	None
dataworks:ListDataQualityScanRuns	ListDataQualityScanRuns	list	All Resource ``	None	None
dataworks:ListProjects	ListProjects	list	All Resource ``	None	None
dataworks:ListColumns	ListColumns	list	All Resource ``	None	None
dataworks:GetDataQualityTemplate	GetDataQualityTemplate	get	All Resource ``	None	None
dataworks:DeleteNetwork	DeleteNetwork	delete	All Resource ``	None	None
dataworks:CreateResourceGroup	CreateResourceGroup	create	DwResourceGroup `acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/`	None	None
dataworks:UpdateRoute	UpdateRoute	update	All Resource ``	None	None
dataworks:GetLineageRelationship	GetLineageRelationship	get	All Resource ``	None	None
dataworks:*	RenameFunction	update	All Resource ``	None	None
dataworks:ListCatalogs	ListCatalogs	list	All Resource ``	None	None
dataworks:ListDatabases	ListDatabases	list	All Resource ``	None	None
dataworks:GetResourceGroup	GetResourceGroup	get	*DwResourceGroup `acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}`	None	None
dataworks:GetDataQualityScanRunLog	GetDataQualityScanRunLog	get	All Resource ``	None	None
dataworks:ListLineageRelationships	ListLineageRelationships	list	All Resource ``	None	None
dataworks:GetProjectRole	GetProjectRole	get	All Resource ``	None	None
dataworks:DeleteComponent	DeleteComponent	delete	All Resource ``	None	None
dataworks:DissociateProjectFromResourceGroup	DissociateProjectFromResourceGroup	update	All Resource ``	None	None
dataworks:ListDataSourceSharedRules	ListDataSourceSharedRules	get	All Resource ``	None	None
dataworks:*	RenameNode	update	All Resource ``	None	None
dataworks:*	RerunTaskInstances	update	All Resource ``	None	None
dataworks:ListDataSources	ListDataSources	get	All Resource ``	None	None
dataworks:AddEntityIntoMetaCollection	AddEntityIntoMetaCollection	none	All Resource ``	None	None
dataworks:ListCrawlerTypes	ListCrawlerTypes	list	All Resource ``	None	None
dataworks:CreateDataset	CreateDataset	create	All Resource ``	None	None
dataworks:DeleteProject	DeleteProject	delete	All Resource ``	None	None
dataworks:*	GetFunction	get	All Resource ``	None	None
dataworks:CreateProjectMember	CreateProjectMember	create	All Resource ``	None	None
dataworks:UpdateDataset	UpdateDataset	update	All Resource ``	None	None
dataworks:*	UpdateResource	update	All Resource ``	None	None
dataworks:*	ListFunctions	list	All Resource ``	None	None
dataworks:GetComponent	GetComponent	get	All Resource ``	None	None
dataworks:*	CreateResource	create	All Resource ``	None	None
dataworks:CreateComputeResource	CreateComputeResource	get	All Resource ``	None	None
dataworks:*	UpdateTask	update	All Resource ``	None	None
dataworks:*	ListNodeDependencies	list	All Resource ``	None	None
dataworks:*	UpdateWorkflowDefinition	update	All Resource ``	None	None
dataworks:UpdateDatasetVersion	UpdateDatasetVersion	update	All Resource ``	None	None
dataworks:ListResourceGroups	ListResourceGroups	list	DwResourceGroup `acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/`	None	None
dataworks:DeleteCertificate	DeleteCertificate	get	All Resource ``	None	None
dataworks:ListComponents	ListComponents	list	All Resource ``	None	None
dataworks:DeleteDatasetVersion	DeleteDatasetVersion	delete	All Resource ``	None	None
dataworks:UpdateComponent	UpdateComponent	update	All Resource ``	None	None
dataworks:UpdateProject	UpdateProject	update	All Resource ``	None	None
dataworks:*	GetWorkflowInstance	get	All Resource ``	None	None
dataworks:ListComputeResources	ListComputeResources	get	All Resource ``	None	None
dataworks:RevokeMemberProjectRoles	RevokeMemberProjectRoles	update	All Resource ``	None	None
dataworks:ListResourceGroupMetricData	ListResourceGroupMetricData	get	*DwResourceGroup `acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}`	None	None
dataworks:GetCertificate	GetCertificate	get	All Resource ``	None	None
dataworks:*	GetWorkflowDefinition	get	All Resource ``	None	None
dataworks:PreviewDatasetVersion	PreviewDatasetVersion	get	All Resource ``	None	None
dataworks:*	ListResources	list	All Resource ``	None	None
dataworks:ListDataQualityTemplates	ListDataQualityTemplates	list	All Resource ``	None	None
dataworks:ListTaskInstances	ListTaskInstances	get	TaskInstance `acs:dataworks:{#regionId}:{#accountId}:taskinstance/`	None	None
dataworks:GetJobStatus	GetJobStatus	get	All Resource ``	None	None
dataworks:DeleteResourceGroup	DeleteResourceGroup	delete	All Resource ``	None	None
dataworks:*	ListDataQualityRules	list	All Resource ``	None	None
dataworks:UpdateResourceGroup	UpdateResourceGroup	update	*DwResourceGroup `acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}`	None	None
dataworks:ListProjectRoles	ListProjectRoles	list	All Resource ``	None	None
dataworks:DeleteDataSourceSharedRule	DeleteDataSourceSharedRule	get	All Resource ``	None	None
dataworks:GetProjectMember	GetProjectMember	get	All Resource ``	None	None
dataworks:GetNetwork	GetNetwork	get	All Resource ``	None	None
dataworks:CloneDataSource	CloneDataSource	get	All Resource ``	None	None
dataworks:ListSchemas	ListSchemas	list	All Resource ``	None	None

Resource

The following table lists the resources defined by DataWorks. Specify them in the Resource element of RAM policy statements to grant permissions for specific operations. They are uniquely identified by ARNs. Format: acs:{#ramcode}:{#regionId}:{#accountId}:{#resourceType}:

acs: The initialism of Alibaba Cloud service, which indicates the public cloud of Alibaba Cloud.
{#ramcode}: The code used in RAM to indicate an Alibaba Cloud service.
{#regionId}: The region ID. If the resource covers all regions, set it to an asterisk (*).
{#accountId}: The ID of the Alibaba Cloud account. If the resource covers all Alibaba Cloud accounts, set it to an asterisk (*).
{#resourceType}: The service-defined resource identifier. It supports a hierarchical structure, which is similar to a file path. If the statement covers global resources, set it to an asterisk (*).

Resource type	ARN
Task	acs:dataworks:{#regionId}:{#accountId}:task/*
File	acs:dataworks:{#regionId}:{#accountId}:file/*
WorkflowInstance	acs:dataworks:{#regionId}:{#accountId}:workflowinstance/*
TaskInstance	acs:dataworks:{#regionId}:{#accountId}:taskinstance/*
Deployment	acs:dataworks:{#regionId}:{#accountId}:deployment/*
Route	acs:dataworks:{#regionId}:{#accountId}:route/*
DwResourceGroup	acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/* acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}
Network	acs:dataworks:{#regionId}:{#accountId}:network/*
Folder	acs:dataworks:{#regionId}:{#accountId}:folder/*
Business	acs:dataworks:{#regionId}:{#accountId}:business/*
UdfFile	acs:dataworks:{#regionId}:{#accountId}:udffile/*
Node	acs:dataworks:{#regionId}:{#accountId}:*
Workflow	acs:dataworks:{#regionId}:{#accountId}:workflow/*
ResourceFile	:dataworks:{#regionId}::resourcefile/*
FileVersion	acs:dataworks:{#regionId}:{#accountId}:fileversion/*

Condition

DataWorks does not define product-level condition keys. However, you can use Alibaba Cloud common condition keys for access control. For more information, see Common condition keys.

How to create custom RAM policies?

You can create custom policies and grant them to RAM users, RAM user groups, or RAM roles. For instructions, see: