All Products
Search
Document Center

Application Real-Time Monitoring Service:RAM authorization

Last Updated:Nov 05, 2024
Resource Access Management (RAM) is a service provided by Alibaba Cloud to manage user identities and resource access permissions. You can use RAM to prevent RAM users from sharing the AccessKey pairs of your Alibaba Cloud account. You can also use RAM to grant minimum permissions to RAM users. RAM uses policies to define permissions.
This topic describes the elements, such as Action, Resource, and Condition, which are defined by ARMS. You can use the elements to create policies in RAM. The code (RamCode) in RAM that is used to indicate ARMS is arms,xtrace. You can grant permissions on ARMS at the RESOURCE.

General structure of a policy

Policies can be stored as JSON files. The following code provides an example on the general structure of a policy:
{
  "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:
  • Effect: specifies the authorization effect. Valid values: Allow, Deny.
  • Action: specifies one or more API operations that are allowed or denied. For more information, see the Action section of this topic.
  • Resource: specifies one or more resources to which the policy applies. You can use an Alibaba Cloud Resource Name (ARN) to specify a resource. For more information, see the Resource section of this topic.
  • Condition: specifies one or more conditions that are required for the policy to take effect. This is an optional field. For more information, see the Condition section of this topic.
    • Condition_operator: specifies the conditional operators. Different types of conditions support different conditional operators. For more information, see Policy elements.
    • Condition_key: specifies the condition keys.
    • Condition_value: specifies the condition values.

Action

ARMS defines the values that you can use in the Action element of a policy statement. The following table describes the values.
  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • API operation: the API operation that you can call to perform the operation.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition key: the condition keys that are defined by the Alibaba Cloud service. The Condition key column does not list the common condition keys that are defined by Alibaba Cloud. For more information about the common condition keys, see Generic Condition Keyword.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
ActionsAPI operationAccess levelResource typeCondition keyAssociated operation
arms:GetAppApiPageInfoGetAppApiByPagenone
All Resources
*
NoneNone
arms:GetAgentDownloadUrlGetAgentDownloadUrlnone
All Resources
*
NoneNone
arms:CheckCommercialStatusCheckCommercialStatusnone
All Resources
*
NoneNone
arms:ConfigAppConfigAppnone
All Resources
*
NoneNone
arms:SearchTraceAppByPageSearchTraceAppByPagenone
TraceApp
acs:arms:{#regionId}:{#accountId}:traceapp/*
NoneNone
arms:SearchTracesByPageSearchTracesByPagenone
All Resources
*
NoneNone
arms:DescribeTraceLicenseKeyDescribeTraceLicenseKeynone
All Resources
*
NoneNone
arms:SearchTracesSearchTracesnone
All Resources
*
NoneNone
arms:OpenArmsDefaultSLROpenArmsDefaultSLRnone
All Resources
*
NoneNone
arms:GetTraceAppConfigGetTraceAppConfigget
TraceApp
acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}
NoneNone
arms:ListTraceAppsListTraceAppsnone
All Resources
*
NoneNone
arms:GetTraceAppGetTraceAppnone
TraceApp
acs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}
NoneNone
arms:GetAlertListInsightsEventsnone
All Resources
*
NoneNone
arms:OpenXtraceDefaultSLROpenXtraceDefaultSLRnone
All Resources
*
NoneNone
arms:DoInsightsActionDoInsightsActionget
All Resources
*
NoneNone
arms:UntagResourcesUntagResourcesupdate
All Resources
*
NoneNone
arms:QueryMetricByPageQueryMetricByPageget
All Resources
*
NoneNone
arms:QueryTopologyQueryAppTopologyget
All Resources
*
NoneNone
arms:GetAgentDownloadUrlGetAgentDownloadUrlV2none
All Resources
*
NoneNone
arms:GetCommercialStatusGetCommercialStatusnone
All Resources
*
NoneNone
arms:SaveTraceAppConfigSaveTraceAppConfignone
TraceApp
acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}
NoneNone
arms:OpenArmsServiceOpenArmsServiceSecondVersionnone
All Resources
*
NoneNone
arms:DeleteAppListDeleteAppListnone
TraceApp
acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}
NoneNone
arms:ChangeResourceGroupChangeResourceGroupupdate
Prometheus
acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
RetcodeApp
acs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}
TraceApp
acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}
Environment
acs:arms:{#regionId}:{#accountId}:environment/{#EnvironmentId}
GrafanaWorkspace
acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}
XTraceApp
acs:arms:{#regionId}:{#accountId}:xtraceapp/{#Pid}
NoneNone
arms:GetAppJVMConfigGetAppJVMConfignone
All Resources
*
NoneNone
arms:QueryAppMetadataQueryAppMetadataget
All Resources
*
NoneNone
arms:DeleteTraceAppDeleteTraceAppnone
TraceApp
acs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}
NoneNone
arms:GetMultipleTraceGetMultipleTracenone
All Resources
*
NoneNone
arms:QueryReleaseMetricQueryReleaseMetricnone
All Resources
*
NoneNone
arms:GetTraceGetTracenone
All Resources
*
NoneNone
arms:SearchTraceAppByNameSearchTraceAppByNameget
TraceApp
acs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}
NoneNone
arms:TagResourcesTagResourcesupdate
Prometheus
acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
RetcodeApp
acs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}
TraceApp
acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}
Environment
acs:arms:{#regionId}:{#accountId}:environment/{#EnvironmentId}
GrafanaWorkspace
acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}
NoneNone
arms:QueryCommercialUsageQueryCommercialUsageget
All Resources
*
NoneNone
arms:GetStackGetStacknone
All Resources
*
NoneNone

Resource

ARMS defines the values that you can use in the Resource. You can attach the policy to a RAM user or a RAM role so that the RAM user or the RAM role can perform a specific operation on a specific resource. The ARN is the unique identifier of the resource on Alibaba Cloud. Take note of the following items:
  • {#}indicates a variable. {#} must be replaced with an actual value. For example, {#ramcode} must be replaced with the actual code of an Alibaba Cloud service in RAM.
  • An asterisk (*) is used as a wildcard. Examples:
    • {#resourceType} is set to *, all resources are specified.
    • {#regionId} is set to *, all regions are specified.
    • {#accountId} is set to *, all Alibaba Cloud accounts are specified.
Resource typeARN
Prometheusacs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}
Environmentacs:arms:{#regionId}:{#accountId}:environment/{#environmentId}
Prometheusacs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
XTraceAppacs:arms:{#regionId}:{#accountId}:xtraceapp/*
TraceAppacs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}
Prometheusacs:arms:{#regionId}:{#accountId}:prometheus/*
AlertRuleacs:arms:{#regionId}:{#AccountId}:alertrule/{#AlertRuled}
GrafanaWorkspaceacs:arms:{#regionId}:{#accountId}:grafanaworkspace/*
Prometheusacs:arms:{#regionId}:{#accountId}:Prometheus/{#ClusterId}
Environmentacs:arms:{#regionId}:{#accountId}:environment/*
GrafanaWorkspaceacs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}
XTraceAppacs:arms:{#regionId}:{#accountId}:xtraceapp/{#Pid}
Prometheusacs:arms:{#regionId}:{#accountId}:Prometheus/*
RetcodeAppacs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}
Prometheusacs:arms:{#regionId}:{#accountId}:prometheus/{#prometheusId}
TraceAppacs:arms:{#regionId}:{#accountId}:traceapp/*
PrometheusAlertRuleacs:arms:{#regionId}:{#accountId}:prometheusalertrule/{#ClusterId}/{#PrometheusAlertRuleId}
PrometheusAlertRuleacs:arms:${Region}:${AccountId}:prometheus/${ClusterId}/prometheusalertrule/*
RetcodeAppacs:arms:{#regionId}:{#accountId}:retcodeapp/*
PrometheusAlertRuleacs:arms:${Region}:${AccountId}:prometheus/${ClusterId}/prometheusalertrule/${PrometheusAlertRuleId}
PrometheusMonitoringacs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}/monitoring/{#type}/*
SyntheticTaskacs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}
AlertRuleacs:arms:{#regionId}:{#AccountId}:AlertRule/*
SyntheticTaskacs:arms:{#regionId}:{#accountId}:*
AgentInfoacs:arms:{#regionId}:{#accountId}:
TraceAppacs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}
IntegrationExporteracs:arms:${Region}:${AccountId}:prometheus/${ClusterId}/integrationexporter/*
RetcodeAppacs:arms:{#regionId}:{#AccountId}:retcodeapp/{#Pid}
Prometheusacs:arms:{#regionId}:{#AccountId}:prometheus/{#ClusterId}
GrafanaWorkspaceacs:arms:{#regionId}:{#AccountId}:grafanaworkspace/{#GrafanaWorkspaceId}
SyntheticTaskacs:arms:{#regionId}:{#AccountId}:synthetictask/{#TaskId}
GrafanaWorkspaceacs:arms:{#regionId}:{#AccountId}:grafanaworkspace/*
IntegrationExporteracs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}
SyntheticTaskacs:arms:{#regionId}:{#accountId}:synthetictask/*
Rumacs:arms:{#regionId}:{#accountId}:rum/*
PrometheusMonitoringacs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}/monitoring/{#type}/{#monitoringName}/*
Environmentacs:arms:{#regionId}:{#accountId}:environment/{#EnvironmentId}
RetcodeAppacs:arms:{#regionId}:{#accountId}:retcodeapp/{#RetcodeAppId}
Prometheusacs:arms:{#regionId}:{#accountId}:Prometheus/#{ClusterId}
IntegrationExporteracs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
PrometheusMonitoringacs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}/monitoring/{#type}/{#monitoringName}
AlertRuleacs:arms:{#regionId}:{#accountId}:AlertRule/{#AlertRuled}
PrometheusMonitoringacs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}/monitoring/*
PrometheusMonitoringacs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
PrometheusAlertRuleacs:arms:{#regionId}:${AccountId}:prometheus/${ClusterId}/prometheusalertrule/*

Condition

ARMS does not define service-specific condition keys. For more information about common condition keys that are defined by Alibaba Cloud, see Generic Condition Keyword.

What to do next

You can create a custom policy and attach the policy to a RAM user, RAM user group, or RAM role. For more information, see the following topics: