文档

授权信息

更新时间:
访问控制(RAM)是阿里云提供的管理用户身份与资源访问权限的服务。使用RAM可以让您避免与其他用户共享阿里云账号密钥,并可按需为用户授予最小权限。RAM中使用权限策略描述授权的具体内容。
本文为您介绍API 网关(ApiGateway)为RAM权限策略定义的操作(Action)、资源(Resource)和条件(Condition)。API 网关(ApiGateway)的RAM代码(RamCode)为cloudapi,apigateway,支持的授权粒度为RESOURCE

权限策略通用结构

权限策略支持JSON格式,其通用结构如下:
{
  "Version": "1",
  "Statement": [
    {
      "Effect": "<Effect>",
      "Action": "<Action>",
      "Resource": "<Resource>",
      "Condition": {
        "<Condition_operator>": {
          "<Condition_key>": [
            "<Condition_value>"
          ]
        }
      }
    }
  ]
}
各字段含义如下:
  • Effect:权限策略效果。取值:Allow(允许)、Deny(拒绝)。
  • Action:授予允许或拒绝权限的具体操作。具体信息,请参见操作(Action)
  • Resource:受操作影响的具体对象,您可以使用资源ARN来描述指定资源。具体信息,请参见资源(Resource)
  • Condition:指授权生效的条件。可选字段。具体信息,请参见条件(Condition)
    • Condition_operator:条件运算符,不同类型的条件对应不同的条件运算符。具体信息,请参见权限策略基本元素
    • Condition_key:条件关键字。
    • Condition_value:条件关键字对应的值。

操作(Action)

下表是API 网关(ApiGateway)定义的操作,这些操作可以在RAM权限策略语句的Action元素中使用,用来授予执行该操作的权限。下面对表中的具体项提供说明:
  • 操作:是指具体的权限点。
  • API:是指操作对应的API接口。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。该列不体现适用于任何操作的通用条件关键字
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作API访问级别资源类型条件关键字关联操作
apigateway:AbolishApiAbolishApi
全部资源
*
apigateway:AddAccessControlListEntryAddAccessControlListEntryWrite
全部资源
*
apigateway:AddIpControlPolicyItemAddIpControlPolicyItemWrite
全部资源
*
apigateway:AddTrafficSpecialControlAddTrafficSpecialControlWrite
全部资源
*
apigateway:AttachPluginAttachPluginWrite
全部资源
*
apigateway:BatchAbolishApisBatchAbolishApisWrite
全部资源
*
apigateway:BatchDeployApisBatchDeployApisWrite
全部资源
*
apigateway:CreateAccessControlListCreateAccessControlListWrite
全部资源
*
apigateway:CreateApiCreateApiWrite
全部资源
*
apigateway:CreateApiGroupCreateApiGroupWrite
全部资源
*
apigateway:CreateApiStageVariableCreateApiStageVariableWrite
全部资源
*
apigateway:CreateAppCreateAppWrite
全部资源
*
apigateway:CreateBackendCreateBackendWrite
全部资源
*
apigateway:CreateBackendModelCreateBackendModelWrite
全部资源
*
apigateway:CreateDatasetCreateDatasetWrite
全部资源
*
apigateway:CreateDatasetItemCreateDatasetItemWrite
全部资源
*
apigateway:CreateInstanceCreateInstanceWrite
全部资源
*
apigateway:CreateIpControlCreateIpControlWrite
全部资源
*
apigateway:CreateLogConfigCreateLogConfigWrite
全部资源
*
apigateway:CreateModelCreateModelWrite
全部资源
*
apigateway:CreateMonitorGroupCreateMonitorGroupWrite
全部资源
*
apigateway:CreatePluginCreatePluginWrite
全部资源
*
apigateway:CreateSignatureCreateSignatureWrite
全部资源
*
apigateway:CreateTrafficControlCreateTrafficControlWrite
全部资源
*
apigateway:DeleteAccessControlListDeleteAccessControlListWrite
全部资源
*
apigateway:DeleteApiDeleteApiWrite
全部资源
*
apigateway:DeleteApiGroupDeleteApiGroupWrite
全部资源
*
apigateway:DeleteApiStageVariableDeleteApiStageVariableWrite
全部资源
*
apigateway:DeleteAppDeleteAppWrite
全部资源
*
apigateway:DeleteBackendDeleteBackendWrite
全部资源
*
apigateway:DeleteBackendModelDeleteBackendModelWrite
全部资源
*
apigateway:DeleteDatasetDeleteDatasetWrite
全部资源
*
apigateway:DeleteDatasetItemDeleteDatasetItemWrite
全部资源
*
apigateway:DeleteDomainDeleteDomainWrite
全部资源
*
apigateway:DeleteDomainCertificateDeleteDomainCertificateWrite
全部资源
*
apigateway:DeleteInstanceDeleteInstanceWrite
全部资源
*
apigateway:DeleteIpControlDeleteIpControlWrite
全部资源
*
apigateway:DeleteLogConfigDeleteLogConfigWrite
全部资源
*
apigateway:DeleteModelDeleteModelWrite
全部资源
*
apigateway:DeleteMonitorGroupDeleteMonitorGroupWrite
全部资源
*
apigateway:DeletePluginDeletePluginWrite
全部资源
*
apigateway:DeleteSignatureDeleteSignatureWrite
全部资源
*
apigateway:DeleteTrafficControlDeleteTrafficControlWrite
全部资源
*
apigateway:DeployApiDeployApiWrite
全部资源
*
apigateway:DescribeAbolishApiTaskDescribeAbolishApiTaskRead
全部资源
*
apigateway:DescribeAccessControlListAttributeDescribeAccessControlListAttributeRead
全部资源
*
apigateway:DescribeAccessControlListsDescribeAccessControlListsRead
全部资源
*
apigateway:DescribeApiDescribeApiRead
全部资源
*
apigateway:DescribeApiDocDescribeApiDocRead
全部资源
*
apigateway:DescribeApiGroupDescribeApiGroupRead
全部资源
*
apigateway:DescribeApiGroupVpcWhitelistDescribeApiGroupVpcWhitelistRead
全部资源
*
apigateway:DescribeApiGroupsDescribeApiGroupsRead
全部资源
*
apigateway:DescribeApiHistoriesDescribeApiHistoriesRead
全部资源
*
apigateway:DescribeApiHistoryDescribeApiHistoryRead
全部资源
*
apigateway:DescribeApiLatencyDataDescribeApiLatencyDataRead
全部资源
*
apigateway:DescribeApiMarketAttributesDescribeApiMarketAttributesRead
全部资源
*
apigateway:DescribeApiProductsByAppDescribeApiProductsByAppRead
全部资源
*
apigateway:DescribeApiQpsDataDescribeApiQpsDataRead
全部资源
*
apigateway:DescribeApiSignaturesDescribeApiSignaturesRead
全部资源
*
apigateway:DescribeApiTrafficControlsDescribeApiTrafficControlsRead
全部资源
*
apigateway:DescribeApiTrafficDataDescribeApiTrafficDataRead
全部资源
*
apigateway:DescribeApisDescribeApisRead
全部资源
*
apigateway:DescribeApisByAppDescribeApisByAppRead
全部资源
*
apigateway:DescribeApisByBackendDescribeApisByBackendRead
全部资源
*
apigateway:DescribeApisBySignatureDescribeApisBySignatureRead
全部资源
*
apigateway:DescribeApisByVpcAccessDescribeApisByVpcAccessList
全部资源
*
apigateway:DescribeApisWithStageNameIntegratedByAppDescribeApisWithStageNameIntegratedByAppRead
全部资源
*
apigateway:DescribeAppDescribeAppRead
全部资源
*
apigateway:DescribeAppAttributesDescribeAppAttributesRead
全部资源
*
apigateway:DescribeAppSecurityDescribeAppSecurityRead
全部资源
*
apigateway:DescribeAppsDescribeAppsRead
全部资源
*
apigateway:DescribeAppsByApiProductDescribeAppsByApiProductRead
全部资源
*
apigateway:DescribeAuthorizedApisDescribeAuthorizedApisRead
全部资源
*
apigateway:DescribeAuthorizedAppsDescribeAuthorizedAppsRead
全部资源
*
apigateway:DescribeBackendInfoDescribeBackendInfoRead
全部资源
*
apigateway:DescribeBackendListDescribeBackendListRead
全部资源
*
apigateway:DescribeDatasetInfoDescribeDatasetInfoRead
全部资源
*
apigateway:DescribeDatasetItemInfoDescribeDatasetItemInfoRead
全部资源
*
apigateway:DescribeDatasetItemListDescribeDatasetItemListRead
全部资源
*
apigateway:DescribeDatasetListDescribeDatasetListRead
全部资源
*
apigateway:DescribeDeployApiTaskDescribeDeployApiTaskRead
全部资源
*
apigateway:DescribeDeployedApiDescribeDeployedApiRead
全部资源
*
apigateway:DescribeDeployedApisDescribeDeployedApisRead
全部资源
*
apigateway:DescribeDomainDescribeDomainRead
全部资源
*
apigateway:DescribeGroupLatencyDescribeGroupLatencyRead
全部资源
*
apigateway:DescribeGroupQpsDescribeGroupQpsRead
全部资源
*
apigateway:DescribeGroupTrafficDescribeGroupTraffic
全部资源
*
apigateway:DescribeHistoryApisDescribeHistoryApisRead
全部资源
*
apigateway:DescribeImportOASTaskDescribeImportOASTaskRead
全部资源
*
apigateway:DescribeInstanceClusterInfoDescribeInstanceClusterInfoRead
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/*
apigateway:DescribeInstanceClusterListDescribeInstanceClusterListList
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/*
apigateway:DescribeInstanceDropConnectionsDescribeInstanceDropConnectionsRead
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
apigateway:DescribeInstanceDropPacketDescribeInstanceDropPacketRead
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
apigateway:DescribeInstanceHttpCodeDescribeInstanceHttpCodeRead
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
apigateway:DescribeInstanceLatencyDescribeInstanceLatencyRead
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
apigateway:DescribeInstanceNewConnectionsDescribeInstanceNewConnectionsRead
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
apigateway:DescribeInstancePacketsDescribeInstancePacketsRead
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
apigateway:DescribeInstanceQpsDescribeInstanceQpsRead
全部资源
*
apigateway:DescribeInstanceSlbConnectDescribeInstanceSlbConnectRead
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
apigateway:DescribeInstanceTrafficDescribeInstanceTrafficRead
全部资源
*
apigateway:DescribeInstancesDescribeInstancesRead
全部资源
*
apigateway:DescribeIpControlPolicyItemsDescribeIpControlPolicyItemsRead
全部资源
*
apigateway:DescribeIpControlsDescribeIpControlsRead
全部资源
*
apigateway:DescribeLogConfigDescribeLogConfigRead
全部资源
*
apigateway:DescribeMarketRemainsQuotaDescribeMarketRemainsQuotaRead
全部资源
*
apigateway:DescribeModelsDescribeModelsRead
全部资源
*
apigateway:DescribePluginApisDescribePluginApisRead
Plugin
acs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}
apigateway:DescribePluginSchemasDescribePluginSchemasRead
全部资源
*
apigateway:DescribePluginTemplatesDescribePluginTemplatesRead
全部资源
*
apigateway:DescribePluginsDescribePluginsRead
全部资源
*
apigateway:DescribePluginsByApiDescribePluginsByApiRead
全部资源
*
apigateway:DescribePurchasedApiGroupDescribePurchasedApiGroupRead
全部资源
*
apigateway:DescribePurchasedApiGroupsDescribePurchasedApiGroupsRead
全部资源
*
apigateway:DescribePurchasedApisDescribePurchasedApisRead
全部资源
*
apigateway:DescribeSignaturesDescribeSignaturesRead
全部资源
*
apigateway:DescribeSummaryDataDescribeSummaryDataRead
全部资源
*
apigateway:DescribeSystemParametersDescribeSystemParametersRead
全部资源
*
apigateway:DescribeTrafficControlsDescribeTrafficControlsRead
全部资源
*
apigateway:DescribeUpdateBackendTaskDescribeUpdateBackendTaskRead
全部资源
*
apigateway:DescribeUpdateVpcInfoTaskDescribeUpdateVpcInfoTaskRead
全部资源
*
apigateway:DescribeVpcAccessesDescribeVpcAccessesRead
全部资源
*
apigateway:DetachPluginDetachPluginWrite
全部资源
*
apigateway:DisableInstanceAccessControlDisableInstanceAccessControlWrite
全部资源
*
apigateway:DryRunSwaggerDryRunSwaggerWrite
全部资源
*
apigateway:EnableInstanceAccessControlEnableInstanceAccessControlWrite
全部资源
*
apigateway:ImportOASImportOASWrite
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}
apigateway:ImportSwaggerImportSwaggerWrite
全部资源
*
apigateway:ListTagResourcesListTagResourcesRead
全部资源
*
apigateway:ModifyApiModifyApiWrite
全部资源
*
apigateway:ModifyApiConfigurationModifyApiConfigurationWrite
全部资源
*
apigateway:ModifyApiGroupModifyApiGroupWrite
全部资源
*
apigateway:ModifyApiGroupInstanceModifyApiGroupInstance
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}
apigateway:ModifyApiGroupNetworkPolicyModifyApiGroupNetworkPolicy
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}
apigateway:ModifyApiGroupVpcWhitelistModifyApiGroupVpcWhitelistWrite
全部资源
*
apigateway:ModifyAppModifyAppWrite
全部资源
*
apigateway:ModifyBackendModifyBackendWrite
全部资源
*
apigateway:ModifyBackendModelModifyBackendModelWrite
全部资源
*
apigateway:ModifyDatasetModifyDatasetWrite
全部资源
*
apigateway:ModifyDatasetItemModifyDatasetItemWrite
全部资源
*
apigateway:ModifyInstanceAttributeModifyInstanceAttribute
Instance
acs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
apigateway:ModifyInstanceSpecModifyInstanceSpecWrite
全部资源
*
apigateway:ModifyIntranetDomainPolicyModifyIntranetDomainPolicy
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}
apigateway:ModifyIpControlPolicyItemModifyIpControlPolicyItemWrite
全部资源
*
apigateway:ModifyLogConfigModifyLogConfigWrite
全部资源
*
apigateway:ModifyModelModifyModelWrite
全部资源
*
apigateway:ModifyPluginModifyPluginWrite
全部资源
*
apigateway:ModifyTrafficControlModifyTrafficControlWrite
全部资源
*
apigateway:ModifyVpcAccessAndUpdateApisModifyVpcAccessAndUpdateApisWrite
全部资源
*
apigateway:OpenApiGatewayServiceOpenApiGatewayService
全部资源
*
apigateway:QueryRequestLogsQueryRequestLogsRead
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/*
apigateway:ReactivateDomainReactivateDomainWrite
全部资源
*
apigateway:RemoveAccessControlListEntryRemoveAccessControlListEntryWrite
全部资源
*
apigateway:RemoveApiProductsAuthoritiesRemoveApiProductsAuthoritiesWrite
全部资源
*
apigateway:RemoveApisAuthoritiesRemoveApisAuthoritiesWrite
全部资源
*
apigateway:RemoveAppsAuthoritiesRemoveAppsAuthoritiesWrite
全部资源
*
apigateway:RemoveIpControlPolicyItemRemoveIpControlPolicyItemWrite
全部资源
*
apigateway:RemoveVpcAccessRemoveVpcAccessWrite
全部资源
*
apigateway:RemoveVpcAccessAndAbolishApisRemoveVpcAccessAndAbolishApisWrite
全部资源
*
apigateway:ResetAppCodeResetAppCodeWrite
全部资源
*
apigateway:ResetAppSecretResetAppSecretWrite
全部资源
*
apigateway:SdkGenerateByAppSdkGenerateByAppWrite
全部资源
*
apigateway:SdkGenerateByAppForRegionSdkGenerateByAppForRegionRead
App
acs:apigateway:{#regionId}:{#accountId}:app/{#AppId}
apigateway:SdkGenerateByGroupSdkGenerateByGroupWrite
全部资源
*
apigateway:SetApiProductsAuthoritiesSetApiProductsAuthoritiesWrite
全部资源
*
apigateway:SetApisAuthoritiesSetApisAuthoritiesWrite
全部资源
*
apigateway:SetAppsAuthToApiProductSetAppsAuthToApiProductWrite
全部资源
*
apigateway:SetAppsAuthoritiesSetAppsAuthoritiesWrite
全部资源
*
apigateway:SetDomainSetDomainWrite
全部资源
*
apigateway:SetDomainCertificateSetDomainCertificateWrite
全部资源
*
apigateway:SetDomainWebSocketStatusSetDomainWebSocketStatusWrite
全部资源
*
apigateway:SetSignatureApisSetSignatureApisWrite
全部资源
*
apigateway:SetTrafficControlApisSetTrafficControlApisWrite
全部资源
*
apigateway:SetVpcAccessSetVpcAccessWrite
全部资源
*
apigateway:SetWildcardDomainPatternsSetWildcardDomainPatternsWrite
全部资源
*
apigateway:SwitchApiSwitchApiWrite
全部资源
*
apigateway:TagResourcesTagResourcesWrite
全部资源
*
apigateway:UntagResourcesUntagResourcesWrite
全部资源
*
apigateway:ValidateVpcConnectivityValidateVpcConnectivityRead
全部资源
*

资源(Resource)

下表是API 网关(ApiGateway)定义的资源,这些资源可以在RAM权限策略语句的Resource元素中使用,用来授予对该资源执行具体操作的权限。 其中,资源ARN是资源在阿里云上的唯一标识。具体说明如下:
  • {#}为变量标识,需要您替换为实际值。例如:{#ramcode}需要您替换为实际的云服务RAM代码。
  • *表示全部。例如:
    • {#resourceType}*时:表示全部资源。
    • {#regionId}*时:表示全部地域。
    • {#accountId}*时:表示全部阿里云账号。
资源类型资源ARN
ApiGroupacs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}
Instanceacs:apigateway:{#regionId}:{#accountId}:instance/{#InstanceId}
Appacs:apigateway:{#regionId}:{#accountId}:app/{#AppId}
Backendacs:{#ramcode}:{#regionId}:{#accountId}:backend/{#BackendId}
IpControlacs:{#ramcode}:{#regionId}:{#accountId}:ipcontrol/{#IpControlId}
AccessControlListacs:apigateway:{#regionId}:{#accountId}:accesscontrollist/{#AclId}
Vpcacs:{#ramcode}:{#regionId}:{#accountId}:vpc/{#VpcId}
LogConfigacs:{#ramcode}:{#regionId}:{#accountId}:logconfig/{#LogType}
Pluginacs:apigateway:{#regionId}:{#accountId}:plugin/{#PluginId}
Datasetacs:{#ramcode}:{#regionId}:{#accountId}:dataset/{#DatasetId}
TrafficControlacs:{#ramcode}:{#regionId}:{#accountId}:trafficcontrol/{#TrafficControlId}
Signatureacs:{#ramcode}:{#regionId}:{#accountId}:signature/{#SignatureId}

条件(Condition)

API 网关(ApiGateway)未定义产品级别的条件关键字。如需查看适用于所有云产品的通用条件关键字,请参见通用条件关键字

相关操作

您可以创建自定义权限策略,并将权限策略授予RAM用户、RAM用户组或RAM角色。具体操作如下:
  • 本页导读 (1)