CreateCustomerGateway - : 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 gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	CreateCustomerGateway	Operação a ser executada. Defina o valor como CreateCustomerGateway.
RegionId	String	Sim	cn-shanghai	ID da região do customer gateway. Chame a operação DescribeRegions para consultar a lista de regiões mais recente.
ClientToken	String	Não	02fb3da4-130e-11e9-8e44****	Token de cliente usado para garantir a idempotência da solicitação. Gere o valor com o cliente, mas garanta que seja exclusivo entre solicitações diferentes. O token aceita apenas caracteres ASCII e não pode exceder 64 caracteres. Nota Se este parâmetro não for definido, ClientToken assumirá o valor de RequestId. O valor de RequestId pode variar em cada solicitação de API.
IpAddress	String	Sim	101.12.XX.XX	Endereço IP público estático do dispositivo de gateway no data center.
Name	String	Não	nametest	Nome do customer gateway. Deve ter de 1 a 100 caracteres e não pode começar com `http://` ou `https://`.
Description	String	Não	desctest	Descrição do customer gateway. Deve ter de 1 a 100 caracteres e não pode começar com `http://` ou `https://`.
Asn	String	Não	65530	Número do sistema autônomo (ASN) do dispositivo de gateway no data center. Asn é um número de 4 bytes. Insira-o em dois segmentos, separando os primeiros 16 bits dos 16 bits seguintes por um ponto (.). Utilize o formato decimal para cada segmento. Por exemplo, ao inserir 123.456, o ASN será: 123 × 65536 + 456 = 8061384.
AuthKey	String	Não	AuthKey****	Chave de autenticação do protocolo de roteamento BGP do dispositivo de gateway no data center. Deve ter de 1 a 64 caracteres. Aceita apenas caracteres ASCII e não pode conter espaços nem pontos de interrogação (?).
Tags.N.Key	String	Não	TagKey	Chave da tag. Não pode ser uma string vazia. Pode ter até 64 caracteres e não deve conter `http://` ou `https://`. Não pode começar com `aliyun` ou `acs:`. Especifique até 20 chaves de tag por chamada.
Tags.N.Value	String	Não	TagValue	Valor da tag. Pode ser uma string vazia e não deve exceder 128 caracteres. Não pode começar com `aliyun` ou `acs:`, nem conter `http://` ou `https://`. Cada chave corresponde a um valor de tag. Especifique até 20 valores de tag por chamada.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	D32B3C26-6C6C-4988-93E9-D2A6444CE6AE	ID da solicitação.
IpAddress	String	101.12.XX.XX	Endereço IP público estático do dispositivo de gateway no data center.
Description	String	desctest	Descrição do customer gateway.
CustomerGatewayId	String	cgw-bp1jrawp82av6bws9****	ID do customer gateway.
CreateTime	Long	1493363486000	Timestamp de criação do customer gateway. Unidade: milissegundos. Valor UNIX que representa os milissegundos decorridos desde a época (epoch time) de 1º de janeiro de 1970, 00:00:00 UTC.
Name	String	nametest	Nome do customer gateway.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=CreateCustomerGateway
&RegionId=cn-shanghai
&ClientToken=02fb3da4-130e-11e9-8e44****
&IpAddress=101.12.XX.XX
&Name=nametest
&Description=desctest
&Asn=65530
&Tags=[{"Key":"Tagkey","Value":"Tagvalue"}]
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

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

<CreateCustomerGatewayResponse>
    <RequestId>D32B3C26-6C6C-4988-93E9-D2A6444CE6AE</RequestId>
    <IpAddress>101.12.XX.XX</IpAddress>
    <Description>desctest</Description>
    <CustomerGatewayId>cgw-bp1jrawp82av6bws9****</CustomerGatewayId>
    <CreateTime>1493363486000</CreateTime>
    <Name>nametest</Name>
</CreateCustomerGatewayResponse>

Formato JSON

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

{
  "RequestId" : "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
  "IpAddress" : "101.12.XX.XX",
  "Description" : "desctest",
  "CustomerGatewayId" : "cgw-bp1jrawp82av6bws9****",
  "CreateTime" : 1493363486000,
  "Name" : "nametest"
}

Códigos de erro

HttpCode	Código de erro	Mensagem de erro	Descrição
400	InvalidAuthkey.Malformed	The specified BGP authentication key (%s) is malformed.	Chave de autenticação BGP inválida.
400	InvalidIpAddress.AlreadyExist	Specified IpAddress is already exist.	O endereço IP especificado já existe. Não é permitido usar endereços IP duplicados na mesma região.
400	InvalidIpAddress.WrongFormat	Specified IpAddress is invalid.	Endereço IP especificado inválido.
400	InvalidName	The name is not valid	Formato do nome inválido.
400	InvalidDescription	The description is not valid	Descrição especificada em formato inválido.
400	Resource.QuotaFull	The quota of resource is full	Cota de recursos esgotada.
400	IllegalParam.Asn	The specified Asn is invalid.	Valor do ASN inválido.
400	OperationDenied.MissingAsn	The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified.	É obrigatório especificar um ASN ao definir a chave de autenticação BGP.
400	InvalidParameter.TagValue	The specified parameter TagValue is invalid.	Valor da tag especificado inválido.
400	SizeLimitExceeded.TagNum	The maximum number of tags is exceeded.	Número de tags excede o limite superior.
400	Forbidden.TagKey.Duplicated	The specified tag key already exists.	A chave da tag já existe.
400	InvalidParameter.TagKey	The specified parameter TagKey is invalid.	Chave da tag especificada inválida.
400	Duplicated.TagKey	The specified parameter TagKey is duplicated.	A chave da tag especificada já existe.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Sem autorização para executar esta operação no recurso especificado. Adquira as permissões necessárias e tente novamente.
403	Forbidden	User not authorized to operate on the specified resource.	Sem autorização para gerenciar o recurso especificado. Adquira as permissões necessárias e tente novamente.
409	OperationConflict	The operation against this instance is too frequent, please try again later.	Operações no gateway estão sendo executadas com alta frequência. Tente novamente mais tarde.

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.