API Gateway uses several service-linked roles for different integration scenarios. This topic covers each role, how to delete it, and related FAQs.
Service-linked role for connecting to a user VPC
This Resource Access Management (RAM) role allows API Gateway to create dedicated instances that directly access services in your VPC over an internal network. This section covers:
-
Scenarios for the service-linked role for connecting to a user VPC.
-
An introduction to AliyunServiceRoleForApiGatewayConnectUserVpc.
-
How to delete the service-linked role for connecting to a user VPC.
-
FAQ: Why can't my RAM user automatically create an API Gateway service-linked role?
For more information, see Service-linked role for connecting to a user VPC.
Service-linked role for EventBridge
This RAM role allows API Gateway to access your EventBridge service and publish events to your event bus. This section covers:
-
Scenarios for the service-linked role for EventBridge.
-
An introduction to AliyunServiceRoleForApigatewayPutEventsToEventBridge.
-
How to delete the service-linked role for EventBridge.
For more information, see Service-linked role for EventBridge.
ApiGateway service-linked role
When you use Function Compute as the API backend, this RAM role grants API Gateway access to your Function Compute service. This section covers:
-
Scenarios for the API Gateway service-linked role.
-
An introduction to AliyunServiceRoleForApiGateway.
-
How to delete the API Gateway service-linked role.
For more information, see API Gateway service-linked role.
Service-linked role for monitoring
This RAM role lets you apply the same alert configurations to all APIs in a group. This section covers:
-
Scenarios for the service-linked role for monitoring.
-
An introduction to AliyunServiceRoleForApiGatewayMonitoring.
-
How to delete the service-linked role for monitoring.
For more information, see Service-linked role for monitoring.
Service-linked role for microservice integration
This RAM role grants API Gateway access to your resources in Enterprise Distributed Application Service (EDAS) and Microservices Engine (MSE), enabling secure integration with your microservices.
-
Scenarios for the service-linked role for microservice integration.
-
An introduction to AliyunServiceRoleForApiGatewayIntegrateWithMicroservices.
-
How to delete the service-linked role for microservice integration.
-
FAQ: Why can't my RAM user automatically create an API Gateway service-linked role?
For more information, see Service-linked role for microservice integration.