跳到主要内容
版本:3.9.x

权限策略的操作与资源

本参考文档列出了 API7 Gateway 权限策略中可能出现的所有操作和资源 ARN。编写策略时请以此为准:此处列出的每项操作均由控制面强制执行,每个资源 ARN 均采用策略引擎接受的确切格式。

权限分为三个命名空间:

命名空间用途
gateway:数据面配置,包括网关组、服务、路由、消费者、插件、证书和告警
iam:身份和组织,包括用户、角色、权限策略、许可证、审计日志、登录选项、SMTP 和联系人
portal:开发者门户,包括门户、API 产品、开发者、DCR 提供方和门户 Token

通配符表示为 *(资源路径中的字面通配符)或 <regex>(用尖括号括起来、在匹配时应用的正则表达式)。例如,arn:api7:gateway:gatewaygroup/<.*> 匹配所有网关组,而 arn:api7:gateway:gatewaygroup/* 用于尚无特定目标的创建语句。

gateway: 命名空间​

网关组​

操作资源
gateway:GetGatewayGrouparn:api7:gateway:gatewaygroup/%s
gateway:CreateGatewayGrouparn:api7:gateway:gatewaygroup/*
gateway:UpdateGatewayGrouparn:api7:gateway:gatewaygroup/%s
gateway:DeleteGatewayGrouparn:api7:gateway:gatewaygroup/%s
gateway:GetAdminKeyarn:api7:gateway:gatewaygroup/%s

网关实例​

操作资源
gateway:GetGatewayInstancearn:api7:gateway:gatewaygroup/%s
gateway:GetGatewayInstanceCorearn:api7:gateway:gatewaygroup/*
gateway:CreateGatewayInstancearn:api7:gateway:gatewaygroup/%s
gateway:DeleteGatewayInstancearn:api7:gateway:gatewaygroup/%s

消费者​

操作资源
gateway:GetConsumerarn:api7:gateway:gatewaygroup/%s/consumer/%s
gateway:CreateConsumerarn:api7:gateway:gatewaygroup/%s/consumer/*
gateway:UpdateConsumerarn:api7:gateway:gatewaygroup/%s/consumer/%s
gateway:DeleteConsumerarn:api7:gateway:gatewaygroup/%s/consumer/%s

消费者凭证​

操作资源
gateway:GetConsumerCredentialarn:api7:gateway:gatewaygroup/%s/consumer/%s
gateway:CreateConsumerCredentialarn:api7:gateway:gatewaygroup/%s/consumer/%s
gateway:UpdateConsumerCredentialarn:api7:gateway:gatewaygroup/%s/consumer/%s
gateway:DeleteConsumerCredentialarn:api7:gateway:gatewaygroup/%s/consumer/%s

SSL 证书​

操作资源
gateway:GetSSLCertificatearn:api7:gateway:gatewaygroup/%s
gateway:CreateSSLCertificatearn:api7:gateway:gatewaygroup/%s
gateway:UpdateSSLCertificatearn:api7:gateway:gatewaygroup/%s
gateway:DeleteSSLCertificatearn:api7:gateway:gatewaygroup/%s

证书​

操作资源
gateway:GetCertificatearn:api7:gateway:gatewaygroup/%s
gateway:CreateCertificatearn:api7:gateway:gatewaygroup/%s
gateway:UpdateCertificatearn:api7:gateway:gatewaygroup/%s
gateway:DeleteCertificatearn:api7:gateway:gatewaygroup/%s

CA 证书​

操作资源
gateway:GetCACertificatearn:api7:gateway:gatewaygroup/%s
gateway:CreateCACertificatearn:api7:gateway:gatewaygroup/%s
gateway:UpdateCACertificatearn:api7:gateway:gatewaygroup/%s
gateway:DeleteCACertificatearn:api7:gateway:gatewaygroup/%s

SNI​

操作资源
gateway:GetSNIarn:api7:gateway:gatewaygroup/%s
gateway:CreateSNIarn:api7:gateway:gatewaygroup/%s
gateway:UpdateSNIarn:api7:gateway:gatewaygroup/%s
gateway:DeleteSNIarn:api7:gateway:gatewaygroup/%s

全局插件规则​

操作资源
gateway:GetGlobalPluginRulearn:api7:gateway:gatewaygroup/%s
gateway:CreateGlobalPluginRulearn:api7:gateway:gatewaygroup/%s
gateway:UpdateGlobalPluginRulearn:api7:gateway:gatewaygroup/%s
gateway:DeleteGlobalPluginRulearn:api7:gateway:gatewaygroup/%s

插件元数据​

操作资源
gateway:GetPluginMetadataarn:api7:gateway:gatewaygroup/%s
gateway:UpdatePluginMetadataarn:api7:gateway:gatewaygroup/%s
gateway:DeletePluginMetadataarn:api7:gateway:gatewaygroup/%s

服务注册中心​

操作资源
gateway:GetServiceRegistryarn:api7:gateway:gatewaygroup/%s
gateway:ConnectServiceRegistryarn:api7:gateway:gatewaygroup/%s
gateway:UpdateServiceRegistryarn:api7:gateway:gatewaygroup/%s
gateway:DisconnectServiceRegistryarn:api7:gateway:gatewaygroup/%s

密钥提供方​

操作资源
gateway:GetSecretProviderarn:api7:gateway:gatewaygroup/%s/secret_provider/%s
gateway:PutSecretProviderarn:api7:gateway:gatewaygroup/%s/secret_provider/%s
gateway:DeleteSecretProviderarn:api7:gateway:gatewaygroup/%s/secret_provider/%s

Proto​

适用于 grpc-transcode 和 proto 插件所用的 gRPC 服务定义。

操作资源
gateway:GetProtoarn:api7:gateway:gatewaygroup/%s
gateway:CreateProtoarn:api7:gateway:gatewaygroup/%s
gateway:UpdateProtoarn:api7:gateway:gatewaygroup/%s
gateway:DeleteProtoarn:api7:gateway:gatewaygroup/%s

调试会话​

用于在线请求调试和链路捕获。

操作资源
gateway:GetDebugSessionarn:api7:gateway:gatewaygroup/%s
gateway:CreateDebugSessionarn:api7:gateway:gatewaygroup/%s
gateway:StopDebugSessionarn:api7:gateway:gatewaygroup/%s
gateway:DeleteDebugSessionarn:api7:gateway:gatewaygroup/%s
gateway:ExportDebugSessionarn:api7:gateway:gatewaygroup/%s

服务模板​

服务模板定义可复用的服务配置,包括路由和流路由。关于服务模板 ID 与已发布服务 ID 的区别,以及如何在权限策略中使用两者,请参阅服务管理员示例。

操作资源
gateway:GetServiceTemplatearn:api7:gateway:servicetemplate/%s
gateway:CreateServiceTemplatearn:api7:gateway:servicetemplate/*
gateway:UpdateServiceTemplatearn:api7:gateway:servicetemplate/%s
gateway:DeleteServiceTemplatearn:api7:gateway:servicetemplate/%s

已发布服务​

已发布服务是部署到特定网关组的服务模板。相同的四项操作也涵盖该服务的路由和流路由。

操作资源
gateway:GetPublishedServicearn:api7:gateway:gatewaygroup/%s/publishedservice/%s
gateway:CreatePublishedServicearn:api7:gateway:gatewaygroup/%s/publishedservice/*
gateway:UpdatePublishedServicearn:api7:gateway:gatewaygroup/%s/publishedservice/%s
gateway:DeletePublishedServicearn:api7:gateway:gatewaygroup/%s/publishedservice/%s
gateway:PublishServicesarn:api7:gateway:gatewaygroup/%s/publishedservice/*

部署设置​

系统范围内的网关部署设置。

操作资源
gateway:UpdateDeploymentSettingarn:api7:gateway:gatewaysetting/*

自定义插件​

操作资源
gateway:CreateCustomPluginarn:api7:gateway:gatewaysetting/*
gateway:UpdateCustomPluginarn:api7:gateway:gatewaysetting/*
gateway:DeleteCustomPluginarn:api7:gateway:gatewaysetting/*

告警策略​

操作资源
gateway:GetAlertPolicyarn:api7:gateway:alert/%s
gateway:CreateAlertPolicyarn:api7:gateway:alert/*
gateway:UpdateAlertPolicyarn:api7:gateway:alert/%s
gateway:DeleteAlertPolicyarn:api7:gateway:alert/%s

Webhook 模板​

告警联系人使用的可复用 Webhook 载荷模板。

操作资源
gateway:GetWebhookTemplatearn:api7:gateway:gatewaysetting/*
gateway:CreateWebhookTemplatearn:api7:gateway:gatewaysetting/*
gateway:UpdateWebhookTemplatearn:api7:gateway:gatewaysetting/*
gateway:DeleteWebhookTemplatearn:api7:gateway:gatewaysetting/*

iam: 命名空间​

用户​

操作资源
iam:GetUserarn:api7:iam:user/%s
iam:InviteUserarn:api7:iam:user/*
iam:UpdateUserarn:api7:iam:user/%s
iam:DeleteUserarn:api7:iam:user/%s
iam:UpdateUserRolearn:api7:iam:user/%s
iam:ResetPasswordarn:api7:iam:user/%s
iam:UpdateUserBoundaryarn:api7:iam:user/%s

角色​

操作资源
iam:GetRolearn:api7:iam:role/%s
iam:CreateRolearn:api7:iam:role/*
iam:UpdateRolearn:api7:iam:role/%s
iam:DeleteRolearn:api7:iam:role/%s

权限策略​

操作资源
iam:GetPermissionPolicyarn:api7:iam:permissionpolicy/%s
iam:CreatePermissionPolicyarn:api7:iam:permissionpolicy/*
iam:UpdatePermissionPolicyarn:api7:iam:permissionpolicy/%s
iam:DeletePermissionPolicyarn:api7:iam:permissionpolicy/%s

许可证​

操作资源
iam:UpdateLicensearn:api7:iam:organization/*

审计日志​

操作资源
iam:GetAuditarn:api7:iam:organization/*
iam:ExportAuditsarn:api7:iam:organization/*

登录选项​

登录选项用于配置 Dashboard 的认证方式(OIDC、SAML、LDAP、CAS)。

操作资源
iam:GetLoginOptionarn:api7:iam:organization/*
iam:CreateLoginOptionarn:api7:iam:organization/*
iam:UpdateLoginOptionarn:api7:iam:organization/*
iam:DeleteLoginOptionarn:api7:iam:organization/*

SCIM 预配​

操作资源
iam:GetSCIMProvisioningarn:api7:iam:organization/*
iam:UpdateSCIMProvisioningarn:api7:iam:organization/*

SMTP 服务器​

用于发送电子邮件通知和用户邀请。

操作资源
iam:GetSMTPServerarn:api7:iam:organization/*
iam:UpdateSMTPServerarn:api7:iam:organization/*

联系人​

联系人是告警策略引用的告警通知目标(电子邮件、Webhook 等)。

操作资源
iam:GetContactPointarn:api7:iam:contactpoint/%s
iam:CreateContactPointarn:api7:iam:contactpoint/*
iam:UpdateContactPointarn:api7:iam:contactpoint/%s
iam:DeleteContactPointarn:api7:iam:contactpoint/%s

portal: 命名空间​

门户​

操作资源
portal:GetPortalarn:api7:portal:portal/%s
portal:CreatePortalarn:api7:portal:portal/*
portal:UpdatePortalarn:api7:portal:portal/%s
portal:DeletePortalarn:api7:portal:portal/%s

门户 Token​

操作资源
portal:GetPortalTokenarn:api7:portal:portal/%s/token/*
portal:CreatePortalTokenarn:api7:portal:portal/%s/token/*
portal:UpdatePortalTokenarn:api7:portal:portal/%s/token/*
portal:DeletePortalTokenarn:api7:portal:portal/%s/token/*

API 产品​

操作资源
portal:GetAPIProductarn:api7:portal:portal/%s/apiproduct/%s
portal:CreateAPIProductarn:api7:portal:portal/%s/apiproduct/*
portal:UpdateAPIProductarn:api7:portal:portal/%s/apiproduct/%s
portal:DeleteAPIProductarn:api7:portal:portal/%s/apiproduct/%s

开发者​

操作资源
portal:GetDeveloperarn:api7:portal:portal/%s/developer/%s
portal:InviteDeveloperarn:api7:portal:portal/%s/developer/*
portal:DeleteDeveloperarn:api7:portal:portal/%s/developer/%s

DCR 提供方​

开发者门户使用的动态客户端注册提供方。

操作资源
portal:GetDCRProviderarn:api7:portal:dcrprovider/*
portal:CreateDCRProviderarn:api7:portal:dcrprovider/*
portal:UpdateDCRProviderarn:api7:portal:dcrprovider/*
portal:DeleteDCRProviderarn:api7:portal:dcrprovider/*

开发者登录选项​

配置开发者可用于登录开发者门户的认证方式。

操作资源
portal:GetDeveloperLoginOptionarn:api7:portal:portal/%s/loginsetting/*
portal:CreateDeveloperLoginOptionarn:api7:portal:portal/%s/loginsetting/*
portal:UpdateDeveloperLoginOptionarn:api7:portal:portal/%s/loginsetting/*
portal:DeleteDeveloperLoginOptionarn:api7:portal:portal/%s/loginsetting/*

开发者 SCIM 预配​

操作资源
portal:GetDeveloperSCIMProvisioningarn:api7:portal:portal/%s/loginsetting/*
portal:UpdateDeveloperSCIMProvisioningarn:api7:portal:portal/%s/loginsetting/*

开发者门户公开访问​

控制开发者门户是否可在无需登录的情况下公开访问。

操作资源
portal:GetDeveloperPortalPublicAccessarn:api7:portal:portal/%s/loginsetting/*
portal:UpdateDeveloperPortalPublicAccessarn:api7:portal:portal/%s/loginsetting/*

审批​

审批待处理的 API 产品订阅或新开发者注册。

操作资源
portal:ApproveAPIProductSubscriptionarn:api7:portal:portal/%s/apiproduct/%s
portal:ApproveDeveloperSignUparn:api7:portal:portal/%s/developer/*

后续步骤​