本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
AwsApiGatewayV2Stage
AwsApiGatewayV2Stage
包含有关 Amazon API Gateway 的版本 2 阶段的信息。
示例
"AwsApiGatewayV2Stage": { "CreatedDate": "2020-04-08T00:36:05Z", "Description" : "ApiGatewayV2", "DefaultRouteSettings": { "DetailedMetricsEnabled": false, "LoggingLevel": "INFO", "DataTraceEnabled": true, "ThrottlingBurstLimit": 100, "ThrottlingRateLimit": 50 }, "DeploymentId": "x1zwyv", "LastUpdatedDate": "2020-04-08T00:36:13Z", "RouteSettings": { "DetailedMetricsEnabled": false, "LoggingLevel": "INFO", "DataTraceEnabled": true, "ThrottlingBurstLimit": 100, "ThrottlingRateLimit": 50 }, "StageName": "prod", "StageVariables": [ "function": "my-prod-function" ], "AccessLogSettings": { "Format": "{\"requestId\": \"$context.requestId\", \"extendedRequestId\": \"$context.extendedRequestId\", \"ownerAccountId\": \"$context.accountId\", \"requestAccountId\": \"$context.identity.accountId\", \"callerPrincipal\": \"$context.identity.caller\", \"httpMethod\": \"$context.httpMethod\", \"resourcePath\": \"$context.resourcePath\", \"status\": \"$context.status\", \"requestTime\": \"$context.requestTime\", \"responseLatencyMs\": \"$context.responseLatency\", \"errorMessage\": \"$context.error.message\", \"errorResponseType\": \"$context.error.responseType\", \"apiId\": \"$context.apiId\", \"awsEndpointRequestId\": \"$context.awsEndpointRequestId\", \"domainName\": \"$context.domainName\", \"stage\": \"$context.stage\", \"xrayTraceId\": \"$context.xrayTraceId\", \"sourceIp\": \"$context.identity.sourceIp\", \"user\": \"$context.identity.user\", \"userAgent\": \"$context.identity.userAgent\", \"userArn\": \"$context.identity.userArn\", \"integrationLatency\": \"$context.integrationLatency\", \"integrationStatus\": \"$context.integrationStatus\", \"authorizerIntegrationLatency\": \"$context.authorizer.integrationLatency\" }", "DestinationArn": "arn:aws:logs:us-west-2:111122223333:log-group:SecurityHubAPIAccessLog/Prod" }, "AutoDeploy": false, "LastDeploymentStatusMessage": "Message", "ApiGatewayManaged": true, }
AwsApiGatewayV2Stage 属性
AwsApiGatewayV2Stage
可能具有以下属性。
- AccessLogSettings
-
可选
有关用于日志记录阶段访问的设置的信息。
类型:对象
ApiGatewayManaged
-
可选
指示阶段是否由 API Gateway 管理。
类型:Boolean
AutoDeploy
-
可选
指示对 API 的更新是否自动触发新的部署。
类型:Boolean
ClientCertificateId
-
可选
阶段的客户端证书的标识符。仅 WebSocket API 调用支持。
类型:字符串
CreatedDate
-
可选
指示舞台的创建时间。
类型:字符串
格式:使用
date-time
在中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式. 值不能包含空格。 示例
"CreatedDate": "2017-03-22T13:22:13.933Z"
- DefaultRouteSettings
-
可选
阶段的默认路由设置。
类型:对象
DeploymentId
-
可选
该阶段关联到的部署的标识符。
类型:字符串
Description
-
可选
阶段的描述。
类型:字符串
LastDeploymentStatusMessage
-
可选
阶段的上次部署状态。仅当阶段启用了自动部署时才支持。
类型:字符串
LastUpdatedDate
-
可选
指示舞台最近更新时间。
类型:字符串
格式:使用
date-time
在中指定的格式RFC 3339 第 5.6 节,互联网日期/时间格式. 值不能包含空格。 示例
"LastUpdatedDate": "2017-03-22T13:22:13.933Z"
- RouteSettings
-
可选
阶段的路由设置。
类型:对象
StageName
-
可选
阶段的名称。
类型:字符串
StageVariables
-
可选
一个定义阶段变量的映射。
变量名称可以包含以下字符:A-Z、a-z、0-9 和 _(下划线)。
类型:字符串映射
有效值:
-
大写字母和小写字母
-
数字
-
特殊字符。_ ~:/? # & =、-(连字符)
-
AccessLogSettings
这些区域有:AccessLogSettings
对象包含有关用于记录舞台访问权限的设置的信息。
AccessLogSettings
可能具有以下属性。
DestinationArn
-
可选
接收访问日志的 CloudWatch Logs 日志组的 ARN。
类型:字符串
Format
-
可选
数据访问日志的单行格式,由选定项指定
$context
变量。格式必须至少包括$context.requestId
。类型:字符串
DefaultRouteSettings 和 RouteSettings
这些区域有:DefaultRouteSettings
对象包含阶段的默认路由设置。
这些区域有:RouteSettings
对象包含阶段的路由设置。
这些对象可能具有以下属性。
DataTraceEnabled
-
可选
指示是否启用数据跟踪日志记录。数据跟踪记录会影响推送到 CloudWatch Logs 的日志条目。仅 WebSocket API 调用支持。
类型:Boolean
DetailedMetricsEnabled
-
可选
指示是否启用详细指标。
类型:Boolean
LoggingLevel
-
可选
日志记录的级别。日志记录级别会影响推送到 CloudWatch Logs 的日志条目。仅 WebSocket API 调用支持。
如果日志记录级别
ERROR
,那么日志只包含错误级别的条目。如果日志记录级别
INFO
,那么日志包括两者ERROR
事件和额外的信息性事件。类型:字符串
有效值:
OFF
|ERROR
|INFO
ThrottlingBurstLimit
-
可选
限制突增限制。
类型:Number
ThrottlingRateLimit
-
可选
限制速率限制。
类型:Number