ModifyVpnGatewayAttribute - - Centro de documentación de Alibaba Cloud

Modifica el nombre y la descripción de una puerta de enlace VPN.

Notas de uso

ModifyVpnGatewayAttribute es una operación asíncrona. Tras enviar la solicitud, el sistema devuelve un ID de solicitud y ejecuta la tarea en segundo plano. Para consultar el estado de la tarea, llame a DescribeVpnGateway.
- Si la puerta de enlace VPN se encuentra en estado updating, significa que está en proceso de modificación.
- Si la puerta de enlace VPN se encuentra en estado active, la modificación se completó correctamente.
No llame repetidamente a ModifyVpnGatewayAttribute para modificar una misma puerta de enlace VPN dentro del periodo de tiempo especificado.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para mayor comodidad, le recomendamos ejecutar esta operación directamente en OpenAPI Explorer. Esta herramienta genera dinámicamente código de ejemplo de la operación para distintos SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ModifyVpnGatewayAttribute	La operación que desea realizar. Establezca el valor en ModifyVpnGatewayAttribute.
RegionId	String	Sí	ap-southeast-2	ID de la región donde se creó la puerta de enlace VPN. Llame a la operación DescribeRegions para obtener la lista más reciente de regiones.
ClientToken	String	No	123e4567-e89b-12d3-a456-4266****	Token de cliente utilizado para garantizar la idempotencia de la solicitud. Genere este token desde el cliente y asegúrese de que sea único para cada solicitud distinta. El token de cliente solo admite caracteres ASCII. Nota Si no especifica este parámetro, el sistema utiliza automáticamente el ID de la solicitud como token de cliente. Tenga en cuenta que el ID de solicitud puede variar entre llamadas.
VpnGatewayId	String	Sí	vpn-bp1q8bgx4xnkm2ogj****	ID de la puerta de enlace VPN.
Name	String	No	myvpn	Nuevo nombre para la puerta de enlace VPN. El nombre debe tener entre 2 y 100 caracteres de longitud y no puede comenzar con `http://` ni con `https://`. Debe iniciar con una letra y puede contener letras, dígitos, guiones bajos (_), guiones (-) y puntos (.). No se admiten otros caracteres.
Description	String	No	test	Nueva descripción para la puerta de enlace VPN. La descripción debe tener entre 1 y 100 caracteres de longitud y no puede comenzar con `http://` ni con `https://`.
AutoPropagate	Boolean	No	true	Indica si se deben anunciar automáticamente las rutas BGP hacia la nube privada virtual (VPC). Valores válidos: true false

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
VpcId	String	vpc-bp1ub1yt9cvakoel****	ID de la VPC a la que pertenece la puerta de enlace VPN.
Status	String	active	Estado actual de la puerta de enlace VPN. init provisioning active updating deleting
InternetIp	String	116.62.XX.XX	Si la puerta de enlace VPN admite conexiones IPsec-VPN en modo de túnel único, esta dirección corresponde a la IP de la puerta de enlace y sirve para establecer conexiones IPsec-VPN o SSL-VPN. Si la puerta de enlace VPN admite conexiones IPsec-VPN en modo de doble túnel, esta dirección representa la primera IP asignada para crear una conexión IPsec-VPN. Dicha dirección no es válida para conexiones SSL-VPN. En el modo de doble túnel, el sistema asigna dos direcciones IP a la puerta de enlace VPN para establecer dos túneles cifrados.
Spec	String	5M	Ancho de banda máximo de la puerta de enlace VPN. Unidad: Mbit/s.
CreateTime	Long	1492753580000	Hora de creación de la puerta de enlace VPN. Unidad: milisegundos. Este valor es una marca de tiempo UNIX que indica los milisegundos transcurridos desde el 1 de enero de 1970 a las 00:00:00 UTC.
AutoPropagate	Boolean	true	Indica si las rutas BGP se anuncian automáticamente hacia la VPC. Valores válidos: true false
VpnGatewayId	String	vpn-bp1q8bgx4xnkm2ogj****	ID de la puerta de enlace VPN.
IntranetIp	String	172.27.30.24	Dirección IP interna de la puerta de enlace VPN. Este parámetro solo se devuelve cuando la puerta de enlace VPN es privada y opera exclusivamente en modo de túnel único.
EndTime	Long	1495382400000	Fecha de vencimiento de la puerta de enlace VPN. Unidad: milisegundos. Se trata de una marca de tiempo UNIX que refleja los milisegundos transcurridos desde el 1 de enero de 1970 a las 00:00:00 UTC.
VSwitchId	String	vsw-bp1y9ovl1cu9ou4tv****	ID del vSwitch asociado a la puerta de enlace VPN.
RequestId	String	54B48E3D-DF70-471B-AA93-08E683A1B457	ID de la solicitud.
Description	String	test	Descripción configurada para la puerta de enlace VPN.
EnableBgp	Boolean	true	Indica si el protocolo BGP está habilitado en la puerta de enlace VPN. Valores válidos: true false
BusinessStatus	String	Normal	Estado de pago de la puerta de enlace VPN. Valores válidos: Normal FinancialLocked
Name	String	test	Nombre asignado a la puerta de enlace VPN.
DisasterRecoveryInternetIp	String	116.11.XX.XX	Segunda dirección IP asignada por el sistema para establecer una conexión IPsec-VPN. Este parámetro únicamente se devuelve si la puerta de enlace VPN es compatible con el modo de doble túnel.
DisasterRecoveryVSwitchId	String	vsw-p0w95ql6tmr2ludkt****	ID del segundo vSwitch vinculado a la puerta de enlace VPN. Solo se incluye en la respuesta cuando la puerta de enlace VPN admite el modo de doble túnel.
SslVpnInternetIp	String	116.33.XX.XX	Dirección IP correspondiente a la conexión SSL-VPN. Este campo aparece exclusivamente cuando la puerta de enlace VPN es pública, funciona en modo de túnel único y tiene habilitada la función SSL-VPN.

Ejemplos

Solicitudes de ejemplo

http(s)://[Endpoint]/?Action=ModifyVpnGatewayAttribute
&RegionId=ap-southeast-2
&ClientToken=123e4567-e89b-12d3-a456-4266****
&VpnGatewayId=vpn-bp1q8bgx4xnkm2ogj****
&Name=myvpn
&Description=test
&AutoPropagate=true
&Common request parameters

Respuestas exitosas de ejemplo

Formato XML

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

<ModifyVpnGatewayAttributeResponse>
    <VpcId>vpc-bp1ub1yt9cvakoel****</VpcId>
    <Status>active</Status>
    <InternetIp>116.62.XX.XX</InternetIp>
    <Spec>5M</Spec>
    <CreateTime>1492753580000</CreateTime>
    <AutoPropagate>true</AutoPropagate>
    <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
    <EndTime>1495382400000</EndTime>
    <VSwitchId>vsw-bp1y9ovl1cu9ou4tv****</VSwitchId>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B457</RequestId>
    <Description>test</Description>
    <EnableBgp>true</EnableBgp>
    <BusinessStatus>Normal</BusinessStatus>
    <DisasterRecoveryVSwitchId>vsw-p0w95ql6tmr2ludkt****</DisasterRecoveryVSwitchId>
    <DisasterRecoveryInternetIp>116.11.XX.XX</DisasterRecoveryInternetIp>
    <SslVpnInternetIp>116.33.XX.XX</SslVpnInternetIp>
    <Name>test</Name>
</ModifyVpnGatewayAttributeResponse>

Formato JSON

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

{
  "VpcId" : "vpc-bp1ub1yt9cvakoel****",
  "Status" : "active",
  "InternetIp" : "116.62.XX.XX",
  "Spec" : "5M",
  "CreateTime" : 1492753580000,
  "AutoPropagate" : true,
  "VpnGatewayId" : "vpn-bp1q8bgx4xnkm2ogj****",
  "EndTime" : 1495382400000,
  "VSwitchId" : "vsw-bp1y9ovl1cu9ou4tv****",
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B457",
  "Description" : "test",
  "EnableBgp" : true,
  "BusinessStatus" : "Normal",
  "DisasterRecoveryVSwitchId" : "vsw-p0w95ql6tmr2ludkt****",
  "DisasterRecoveryInternetIp" : "116.11.XX.XX",
  "SslVpnInternetIp" : "116.33.XX.XX",
  "Name" : "test"
}

Códigos de error

HttpCode	Código de error	Mensaje de error	Descripción
400	InvalidName	The name is not valid	El formato del nombre proporcionado no es válido.
400	InvalidDescription	The description is not valid	El formato de la descripción proporcionada no es válido.
400	OperationUnsupported.EnableBgp	Current version of the VPN does not support enable BGP.	La versión actual de la puerta de enlace VPN no es compatible con BGP.
400	OperationFailed.VpnConnectionExist	Auto propagate cannot be closed when VPN connections with BGP enabled exist.	No es posible desactivar el anuncio automático de rutas mientras exista una conexión VPN con BGP habilitado.
400	InvalidVpnGatewayInstanceId.NotFound	The specified vpn gateway instance id does not exist.	La puerta de enlace VPN especificada no existe. Compruebe si el identificador es correcto.
400	VpnGateway.Configuring	The specified service is configuring.	No se permite realizar esta operación mientras el servicio se encuentra en configuración. Inténtelo nuevamente más tarde.
400	OperationFailed.CenLevelNotSupport	When the VPC to which the VPN gateway belongs is attached to a FULL-mode CEN, the VPN gateway cannot enable BGP.	No se puede habilitar BGP en la puerta de enlace VPN si la VPC asociada está vinculada a una instancia de Cloud Enterprise Network (CEN) con el modo FULL activado.
403	Forbidden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.	Su cuenta carece de permisos para operar sobre este recurso debido a que fue creada por otro usuario. Obtenga los permisos necesarios e inténtelo de nuevo.
403	Forbidden	User not authorized to operate on the specified resource.	No cuenta con autorización para realizar operaciones en el recurso indicado. Solicite los permisos correspondientes y vuelva a intentar la acción.

Para obtener una lista completa de códigos de error, consulte Códigos de error del servicio.