EnableNatGatewayEcsMetric - NAT Gateway - Alibaba Cloud Documentation Center

Enables Elastic Compute Service (ECS) traffic monitoring.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:EnableNatGatewayEcsMetric	create	NatGateway acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the NAT gateway. You can call the DescribeRegions operation to query the most recent region list.	cn-chengdu
DryRun	boolean	No	Specifies whether to perform only a dry run, without performing the actual request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	false
NatGatewayId	string	Yes	The ID of the NAT gateway for which you want to enable ECS traffic monitoring.	ngw-2vc53wynunp35lw1y****
RegionId	string	Yes	The region ID of the NAT gateway. You can call the DescribeRegions operation to query the most recent region list.	cn-chengdu

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0

Examples

Sample success responses

JSONformat

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0"
}

Error codes

HTTP status code	Error code	Error message
400	MissingParam.NatGatewayId	The parameter NatGatewayId is mandatory.
400	OperationFailed.RegionNotSupport	Operation failed because region not support.
400	OperationFailed.NoPermission	Operation failed because user does not have permissions.
400	OperationFailed.NatGatewayNotExist	Operation failed because NatGateway not exist.
400	OperationFailed.NatTypeInvalid	Operation failed because only the enhanced NAT gateway supports this operation.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-10-18	API Description Update. The API operation is deprecated. The Error code has changed	View Change Details
2023-03-01	The Error code has changed	View Change Details