All Products
Search
Document Center

API Gateway:Service-linked roles of API Gateway

Last Updated:Feb 11, 2025

This topic describes the usage scenarios of the service-linked roles of the original API Gateway and how to delete the service-linked roles. This topic also provides answers to frequently asked questions about the service-linked roles to help you understand and use the roles.

Service-linked role for VPC

API Gateway provides the AliyunServiceRoleForApiGatewayConnectUserVpc Resource Access Management (RAM) role to create dedicated instances that are used to directly access services in a virtual private cloud (VPC) over an internal network. This role is suitable for scenarios where secure and efficient access to internal services is required. Specifically:

For more information, see AliyunServiceRoleForApiGatewayConnectUserVpc.

Service-linked role for EventBridge

API Gateway provides the AliyunServiceRoleForApigatewayPutEventsToEventBridge RAM role for you to interconnect API Gateway and EventBridge and upload events to your event bus in EventBridge. Specifically:

  • Scenarios to use the service-linked role

  • Introduction to the service-linked role

  • How to delete the service-linked role

For more information, see API Gateway-EventBridge service-linked role.

Service-linked role for Function Compute

The AliyunServiceRoleForApiGateway service-linked role is a RAM role that is used to grant API Gateway the access permissions on Function Compute. API Gateway accesses Function Compute by assuming the service-linked role. Specifically:

  • Scenarios to use the service-linked role

  • Introduction to the service-linked role

  • How to delete the service-linked role

For more information, see Service-linked role of API Gateway.

Service-linked role for monitoring

The AliyunServiceRoleForApiGatewayMonitoring service-linked role is a RAM role that is provided to help you apply the same alert settings to all APIs in an API group. Specifically:

  • Scenarios to use the service-linked role

  • Introduction to the service-linked role

  • How to delete the service-linked role

For more information, see AliyunServiceRoleForApiGatewayMonitoring service-linked role.

Service-linked role for microservices integration

AliyunServiceRoleForApiGatewayIntegrateWithMicroservices is a RAM role that is used by API Gateway to access your resources in Enterprise Distributed Application Service (EDAS) and Microservices Engine (MSE). This role ensures that API Gateway can efficiently and securely integrate and interact with your microservices architecture to support complex applications and fulfill complex management requirements. Specifically:

For more information, see Service-linked role for microservices integration - AliyunServiceRoleForApiGatewayIntegrateWithMicroservices.