ListNatIps - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
RegionId	String	Sim	eu-central-1	ID da região onde o gateway NAT está implantado. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
NatGatewayId	String	Sim	ngw-gw8v16wgvtq26vh59****	ID do gateway NAT.
NatIpCidr	String	Não	192.168.0.0/24	Bloco CIDR ao qual o endereço IP pertence.
DryRun	Boolean	Não	false	Especifica se apenas a pré-verificação da solicitação deve ser realizada. Valores válidos: true: verifica a solicitação de API sem consultar os endereços IP. O sistema valida os parâmetros obrigatórios, a sintaxe da solicitação e os limites. Se a pré-verificação falhar, o sistema retorna a mensagem de erro correspondente. Caso contrário, retorna o código de erro `DryRunOperation`. false (padrão): envia a solicitação. Se a pré-verificação for bem-sucedida, o sistema retorna um código de status HTTP 2xx e executa a operação.
ClientToken	String	Não	5A2CFF0E-5718-45B5-9D4D-70B3FF3898	Token de cliente usado para garantir a idempotência da solicitação. Gere o valor usando o cliente e garanta que seja único entre diferentes solicitações. O token pode conter apenas caracteres ASCII e não deve exceder 64 caracteres. Nota Se você não definir este parâmetro, o sistema usará automaticamente o RequestId como ClientToken. O RequestId pode variar para cada solicitação de API.
NatIpStatus	String	Não	Available	Status do endereço IP. Valores válidos: Available Deleting Creating
NextToken	String	Não	FFmyTO70tTpLG6I3FmYAXGKPd****f84eb48b699f0a4883	Token usado para a próxima consulta. Valores válidos: Ignore este parâmetro na primeira consulta ou quando não houver consultas subsequentes. Para enviar uma nova consulta, defina o valor como o NextToken retornado na última chamada.
MaxResults	String	Não	20	Número de entradas a serem retornadas por página. Valores válidos: de 1 a 100. Valor padrão: 20.
Action	String	Sim	ListNatIps	Operação a ser executada. Defina o valor como ListNatIps.
NatIpName.N	String	Não	test	Nome do endereço IP. Valores válidos de N: 1 a 20.
NatIpIds.N	String	Não	vpcnatcidr-gw8ov42ei6xh1jys2****	ID do endereço IP. Valores válidos de N: 1 a 20.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	Token usado para a próxima consulta. Valores válidos: A ausência do valor de NextToken indica que não há mais consultas a serem enviadas. Se o valor de NextToken for retornado, ele representa o token para a próxima consulta.
RequestId	String	7E78CEEA-BF8F-44D1-9DCD-D9141135B71E	ID da solicitação.
TotalCount	String	1	Número total de endereços IP retornados.
NatIps	Array of NatIp		Lista de endereços IP do gateway NAT.
IsDefault	Boolean	true	Indica se o endereço IP é o padrão do gateway NAT. Valores válidos: true: sim false: não
NatIp	String	192.168.0.126	Endereço IP.
NatIpCidr	String	192.168.0.0/24	Bloco CIDR ao qual o endereço IP pertence.
NatIpId	String	vpcnatip-gw8a863sut1zijxh0****	ID do endereço IP.
NatIpDescription	String	default	Descrição do endereço IP.
NatGatewayId	String	ngw-gw8v16wgvtq26vh59****	ID do gateway NAT da Virtual Private Cloud (VPC) ao qual o endereço IP está atribuído.
NatIpName	String	default	Nome do endereço IP.
NatIpStatus	String	Available	Status do endereço IP. Valores válidos: Available: disponível Deleted: excluído Deleting: excluindo Creating: criando Associated: especificado em uma entrada SNAT ou DNAT Associating: sendo especificado em uma entrada SNAT ou DNAT

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?RegionId=eu-central-1
&NatGatewayId=ngw-gw8v16wgvtq26vh59****
&NatIpCidr=192.168.0.0/24
&DryRun=false
&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF3898
&NatIpStatus=Available
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****f84eb48b699f0a4883
&MaxResults=20
&NatIpName=["test"]
&NatIpIds=["vpcnatcidr-gw8ov42ei6xh1jys2****"]
&Action=ListNatIps
&Common request parameters

Exemplos de respostas

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListNatIpsResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>7E78CEEA-BF8F-44D1-9DCD-D9141135B71E</RequestId>
    <TotalCount>1</TotalCount>
    <NatIps>
        <IsDefault>true</IsDefault>
        <NatIp>192.168.0.126</NatIp>
        <NatIpCidr>192.168.0.0/24</NatIpCidr>
        <NatIpId>vpcnatip-gw8a863sut1zijxh0****</NatIpId>
        <NatIpDescription>default</NatIpDescription>
        <NatGatewayId>ngw-gw8v16wgvtq26vh59****</NatGatewayId>
        <NatIpName>default</NatIpName>
        <NatIpStatus>Available</NatIpStatus>
    </NatIps>
</ListNatIpsResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "7E78CEEA-BF8F-44D1-9DCD-D9141135B71E",
  "TotalCount" : "1",
  "NatIps" : [ {
    "IsDefault" : true,
    "NatIp" : "192.168.0.126",
    "NatIpCidr" : "192.168.0.0/24",
    "NatIpId" : "vpcnatip-gw8a863sut1zijxh0****",
    "NatIpDescription" : "default",
    "NatGatewayId" : "ngw-gw8v16wgvtq26vh59****",
    "NatIpName" : "default",
    "NatIpStatus" : "Available"
  } ]
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
404	InvalidRegionId.NotFound	The specified RegionId does not exist in our records.	Mensagem de erro retornada porque o ID da região especificado não existe.

Para obter uma lista de códigos de erro, visite o API Error Center.