# API Gateway Amazon 资源名称 (ARN) 参考
<a name="arn-format-reference"></a>

下表列出 API Gateway 资源的 Amazon 资源名称 (ARN)。要了解有关在 Amazon Identity and Access Management 策略中使用 ARN 的更多信息，请参阅[Amazon API Gateway 如何与 IAM 配合使用](security_iam_service-with-iam.md)和[使用 IAM 权限控制对 REST API 的访问](permissions.md)。

## HTTP API 和 WebSocket API 资源
<a name="apigateway-v2-arns"></a>


| 资源 | ARN | 
| --- | --- | 
|  AccessLogSettings  |  `arn:partition:apigateway:region::/apis/api-id/stages/stage-name/accesslogsettings`  | 
|  API  |  `arn:partition:apigateway:region::/apis/api-id`  | 
|  Api  |  `arn:partition:apigateway:region::/apis`  | 
|  授权方  |  `arn:partition:apigateway:region::/apis/api-id/authorizers/id`  | 
|  授权方  |  `arn:partition:apigateway:region::/apis/api-id/authorizers`  | 
|  Cors  |  `arn:partition:apigateway:region::/apis/api-id/cors`  | 
|  部署  |  `arn:partition:apigateway:region::/apis/api-id/deployments/id`  | 
|  部署  |  `arn:partition:apigateway:region::/apis/api-id/deployments`  | 
|  ExportedAPI  |  `arn:partition:apigateway:region::/apis/api-id/exports/specification`  | 
|  集成  |  `arn:partition:apigateway:region::/apis/api-id/integrations/integration-id`  | 
|  集成  |  `arn:partition:apigateway:region::/apis/api-id/integrations`  | 
|  IntegrationResponse  |  `arn:partition:apigateway:region::/apis/api-id/integrationresponses/integration-response`  | 
|  IntegrationResponses  |  `arn:partition:apigateway:region::/apis/api-id/integrationresponses`  | 
|  模型  |  `arn:partition:apigateway:region::/apis/api-id/models/id`  | 
|  模型  |  `arn:partition:apigateway:region::/apis/api-id/models`  | 
|  ModelTemplate  |  `arn:partition:apigateway:region::/apis/api-id/models/id/template`  | 
|  路线  |  `arn:partition:apigateway:region::/apis/api-id/routes/id`  | 
|  路线  |  `arn:partition:apigateway:region::/apis/api-id/routes`  | 
|  RouteRequestParameter  |  `arn:partition:apigateway:region::/apis/api-id/routes/id/requestparameters/key`  | 
|  RouteResponse  |  `arn:partition:apigateway:region::/apis/api-id/routes/id/routeresponses/id`  | 
|  RouteResponses  |  `arn:partition:apigateway:region::/apis/api-id/routes/id/routeresponses`  | 
|  RouteSettings  |  `arn:partition:apigateway:region::/apis/api-id/stages/stage-name/routesettings/route-key`  | 
|  暂存区  |  `arn:partition:apigateway:region::/apis/api-id/stages/stage-name`  | 
|  阶段  |  `arn:partition:apigateway:region::/apis/api-id/stages`  | 
|  VpcLink  |  `arn:partition:apigateway:region::/vpclinks/vpclink-id`  | 
|  VpcLinks  |  `arn:partition:apigateway:region::/vpclinks`  | 

## Rest API 资源 ID
<a name="apigateway-v1-arns"></a>


| 资源 | ARN | 
| --- | --- | 
|  账户  |  `arn:partition:apigateway:region::/account`  | 
|  ApiKey  |  `arn:partition:apigateway:region::/apikeys/id`  | 
|  ApiKeys  |  `arn:partition:apigateway:region::/apikeys`  | 
|  授权方  |  `arn:partition:apigateway:region::/restapis/api-id/authorizers/id`  | 
|  授权方  |  `arn:partition:apigateway:region::/restapis/api-id/authorizers`  | 
|  ClientCertificate  |  `arn:partition:apigateway:region::/clientcertificates/id`  | 
|  ClientCertificates  |  `arn:partition:apigateway:region::/clientcertificates`  | 
|  部署  |  `arn:partition:apigateway:region::/restapis/api-id/deployments/id`  | 
|  部署  |  `arn:partition:apigateway:region::/restapis/api-id/deployments`  | 
|  DocumentationPart  |  `arn:partition:apigateway:region::/restapis/api-id/documentation/parts/id`  | 
|  DocumentationParts  |  `arn:partition:apigateway:region::/restapis/api-id/documentation/parts`  | 
|  DocumentationVersion  |  `arn:partition:apigateway:region::/restapis/api-id/documentation/versions/version`  | 
|  DocumentationVersions  |  `arn:partition:apigateway:region::/restapis/api-id/documentation/versions`  | 
|  GatewayResponse  |  `arn:partition:apigateway:region::/restapis/api-id/gatewayresponses/response-type`  | 
|  GatewayResponses  |  `arn:partition:apigateway:region::/restapis/api-id/gatewayresponses`  | 
|  集成  |  `arn:partition:apigateway:region::/restapis/api-id/resources/resource-id/methods/http-method/integration`  | 
|  IntegrationResponse  |  `arn:partition:apigateway:region::/restapis/api-id/resources/resource-id/methods/http-method/integration/responses/status-code`  | 
|  方法  |  `arn:partition:apigateway:region::/restapis/api-id/resources/resource-id/methods/http-method`  | 
|  MethodResponse  |  `arn:partition:apigateway:region::/restapis/api-id/resources/resource-id/methods/http-method/responses/status-code`  | 
|  模型  |  `arn:partition:apigateway:region::/restapis/api-id/models/model-name`  | 
|  模型  |  `arn:partition:apigateway:region::/restapis/api-id/models`  | 
|  RequestValidator  |  `arn:partition:apigateway:region::/restapis/api-id/requestvalidators/id`  | 
|  RequestValidators  |  `arn:partition:apigateway:region::/restapis/api-id/requestvalidators`  | 
|  资源  |  `arn:partition:apigateway:region::/restapis/api-id/resources/id`  | 
|  资源  |  `arn:partition:apigateway:region::/restapis/api-id/resources`  | 
|  RestApi  |  `arn:partition:apigateway:region::/restapis/api-id`  | 
|  RestApis  |  `arn:partition:apigateway:region::/restapis`  | 
|  暂存区  |  `arn:partition:apigateway:region::/restapis/api-id/stages/stage-name`  | 
|  阶段  |  `arn:partition:apigateway:region::/restapis/api-id/stages`  | 
|  标签  |  `arn:partition:apigateway:region::/tags/url-encoded-resource-arn`  | 
|  模板  |  `arn:partition:apigateway:region::/restapis/models/model-name/template`  | 
|  UsagePlan  |  `arn:partition:apigateway:region::/usageplans/usageplan-id`  | 
|  UsagePlans  |  `arn:partition:apigateway:region::/usageplans`  | 
|  UsagePlanKey  |  `arn:partition:apigateway:region::/usageplans/usageplan-id/keys/id`  | 
|  UsagePlanKeys  |  `arn:partition:apigateway:region::/usageplans/usageplan-id/keys`  | 
|  VpcLink  |  `arn:partition:apigateway:region::/vpclinks/vpclink-id`  | 
|  VpcLinks  |  `arn:partition:apigateway:region::/vpclinks`  | 

## 域名资源
<a name="apigateway-domain-name-arns"></a>


| 资源 | ARN | 
| --- | --- | 
|  ApiMapping  |  `arn:partition:apigateway:region::/domainnames/domain-name/apimappings/id`  | 
|  ApiMappings  |  `arn:partition:apigateway:region::/domainnames/domain-name/apimappings`  | 
|  BasePathMapping  |  `arn:partition:apigateway:region::/domainnames/domain-name/basepathmappings/basepath`  | 
|  BasePathMappings  |  `arn:partition:apigateway:region::/domainnames/domain-name/basepathmappings`  | 
|  DomainName  |  `arn:partition:apigateway:region::/domainnames/domain-name`  | 
|  DomainNameAccessAssociation  |  `arn:partition:apigateway:region:account-id:/domainnameaccessassociations/domainname/domain-name/vpcesource/vpce-source-id` | 
|  DomainNameAccessAssociations  |  `arn:partition:apigateway:region:account-id:/domainnameaccessassociations`  | 
|  DomainNames  |  `arn:partition:apigateway:region::/domainnames`  | 
|  RoutingRule  |  `arn:partition:apigateway:region:account-id:/domainnames/domain-name/routingrules/routing-rule-id`  | 

## `execute-api`（HTTP API、WebSocket API 和 REST API）
<a name="apigateway-execute-api-arns"></a>


| 资源 | ARN | 
| --- | --- | 
|  WebSocket API 端点  |  `arn:partition:execute-api:region:account-id:api-id/stage/route-key`  | 
|  HTTP API 和 REST API 端点 \$1  |  `arn:partition:execute-api:region:account-id:api-id/stage/http-method/resource-path`  | 
|  Lambda 授权方 \$1\$1  |  `arn:partition:execute-api:region:account-id:api-id/authorizers/authorizer-id`  | 

\$1 HTTP API 的 `$default` 路由端点的 ARN 是 `arn:partition:execute-api:region:account-id:api-id/*/$default`。

\$1\$1 此 ARN 仅在[资源策略](https://docs.amazonaws.cn/lambda/latest/dg/access-control-resource-based.html)中为 Lambda 授权方函数设置 `SourceArn` 条件时适用。有关示例，请参阅 [创建 Lambda 授权方](http-api-lambda-authorizer.md#http-api-lambda-authorizer.example-create)。