Queries the switch status of an Internet NAT gateway.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates a sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes GetNatGatewayConvertStatus

The operation that you want to perform. Set the value to GetNatGatewayConvertStatus.

NatGatewayId String Yes ngw-bp1b0lic8uz4r6vf2****

The ID of the Internet NAT gateway to be queried.

RegionId String Yes cn-qingdao

The ID of the region to which the NAT gateway belongs.

Response parameters

Parameter Type Example Description
ConvertSteps Array of ConvertStep

The status during the switch.

StepName String init

Valid values:

  • init: initializing
  • check: checking configurations
  • configure: pushing configurations
  • activate: switching
  • conf_delete: deleting configurations
  • rollback: rolling back
  • end_success: switched
  • end_fail: failed
StepStartTime String 2020-08-26T08:27:19Z

The time when the switch started.

StepStatus String successful

The switch status. Valid values:

  • processing: switching
  • successful: switched
  • failed: failed
DstNatType String Enhanced

The type of the NAT gateway. Set the value to Enhanced, which specifies an enhanced Internet NAT gateway.

NatGatewayId String ngw-bp1b0lic8uz4r6vf2****

The ID of the Internet NAT gateway.

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The ID of the request.

Examples

Sample requests

http(s)://vpc.aliyuncs.com/?Action=GetNatGatewayConvertStatus
&NatGatewayId=ngw-bp1b0lic8uz4r6vf2****
&RegionId=cn-qingdao
&<Common request parameters>

Sample success responses

XML format

<GetNatGatewayConvertStatusResponse>
  <RequestId>566678F2-BF11-4701-9569-D888191DAF5F</RequestId>
  <DstNatType>Enhanced</DstNatType>
  <ConvertSteps>
        <StepName>init</StepName>
        <StepStatus>successful</StepStatus>
        <StepStartTime>2020-08-26T08:27:19Z</StepStartTime>
  </ConvertSteps>
  <ConvertSteps>
        <StepName>check</StepName>
        <StepStatus>successful</StepStatus>
        <StepStartTime>2020-08-26T08:27:19Z</StepStartTime>
  </ConvertSteps>
  <ConvertSteps>
        <StepName>configure</StepName>
        <StepStatus>successful</StepStatus>
        <StepStartTime>2020-08-26T08:27:19Z</StepStartTime>
  </ConvertSteps>
  <ConvertSteps>
        <StepName>activate</StepName>
        <StepStatus>successful</StepStatus>
        <StepStartTime>2020-08-26T08:27:54Z</StepStartTime>
  </ConvertSteps>
  <ConvertSteps>
        <StepName>conf_delete</StepName>
        <StepStatus>successful</StepStatus>
        <StepStartTime>2020-08-26T08:27:58Z</StepStartTime>
  </ConvertSteps>
  <ConvertSteps>
        <StepName>end_success</StepName>
        <StepStatus>successful</StepStatus>
        <StepStartTime>2020-08-26T08:28:00Z</StepStartTime>
  </ConvertSteps>
  <NatGatewayId>ngw-p0w4fb0mospbkaw9n****</NatGatewayId>
</GetNatGatewayConvertStatusResponse>

JSON format

{
  "RequestId": "566678F2-BF11-4701-9569-D888191DAF5F",
  "DstNatType": "Enhanced",
  "ConvertSteps": [
    {
      "StepName": "init",
      "StepStatus": "successful",
      "StepStartTime": "2020-08-26T08:27:19Z"
    },
    {
      "StepName": "check",
      "StepStatus": "successful",
      "StepStartTime": "2020-08-26T08:27:19Z"
    },
    {
      "StepName": "configure",
      "StepStatus": "successful",
      "StepStartTime": "2020-08-26T08:27:19Z"
    },
    {
      "StepName": "activate",
      "StepStatus": "successful",
      "StepStartTime": "2020-08-26T08:27:54Z"
    },
    {
      "StepName": "conf_delete",
      "StepStatus": "successful",
      "StepStartTime": "2020-08-26T08:27:58Z"
    },
    {
      "StepName": "end_success",
      "StepStatus": "successful",
      "StepStartTime": "2020-08-26T08:28:00Z"
    }
  ],
  "NatGatewayId": "ngw-p0w4fb0mospbkaw9n****",
}

Error codes

HttpCode Error code Error message Description
404 InvalidRegionId.NotFound The specified RegionId does not exist in our records. The error message returned because the specified region ID does not exist.

For a list of error codes, visit the API Error Center.