# 更新对端网关 - UpdateCustomerGateway #### 功能介绍 根据对端网关ID，更新指定的对端网关。支持更新名称和更换证书，修改其他参数需重新创建对端网关。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-vpn/vpn_api_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-vpn/vpn_api_0044.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | vpn:customerGateways:update | write | customerGateways | [g:ResourceTag/\](https://support.huaweicloud.com/usermanual-iam5/iam_01_0934.html#section2) | - | - | #### URI PUT /v5/{project_id}/customer-gateways/{customer_gateway_id} 表1参数说明 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | project_id | String | 是 | 项目ID，可以通过[获取项目ID](https://support.huaweicloud.com/api-vpn/vpn_api_0051.html)获取项目ID。 | | customer_gateway_id | String | 是 | 对端网关ID。 | #### 请求消息 - 请求参数 表2请求参数 | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | customer_gateway | [UpdateCgwRequestBodyContent] object | 是 | customer_gateway对象。 | 表3UpdateCgwRequestBodyContent | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | name | String | 否 | - 功能说明：网关名称。 - 取值范围：1-64个字符，支持数字、英文字母、中文（\\u4e00 - \\u9fa5）、_（下划线）、-（中划线）、.（点）。 | | ca_certificate | [CaCertificateRequest] object | 否 | - 功能说明：对端网关CA证书。 | 表4CaCertificateRequest | 名称 | 类型 | 是否必选 | 描述 | |:---|:---|:---|:---| | id | String | 否 | - 功能说明：证书ID。 - 格式：36位UUID。 | | content | String | 否 | - 功能说明：对端网关CA证书内容。 - 取值范围：1-8192个字符。 | - 请求样例 ``` PUT https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id} { "customer_gateway": { "name": "cgw-f846", "ca_certificate": { "content":"******" } } } ``` #### 响应消息 - 响应参数 返回状态码为 200: 更新成功。 表5响应Body参数列表 | 名称 | 类型 | 描述 | |:---|:---|:---| | customer_gateway | [ResponseCustomerGateway] object | customer_gateway对象。 | | request_id | String | 请求id。 | 表6ResponseCustomerGateway | 名称 | 类型 | 描述 | |:---|:---|:---| | id | String | - 功能说明：对端网关的ID。 - 格式：36位UUID。 | | name | String | - 功能说明：对端网关名称。 - 取值范围：1-64个字符，包括数字、英文字母、中文(\\u4e00 - \\u9fa5)、_(下划线)、-(中划线)。 | | id_type | String | - 功能说明：对端网关标识类型。 - 取值范围： - ip：对端网关标识类型为ip。 | | id_value | String | 对端网关标识值。 | | bgp_asn | Long | 对端网关的BGP自治域编号。仅当id_type为ip时返回。 | | created_at | String | - 创建时间。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ。* | | updated_at | String | - 最后一次更新时间。 - UTC时间格式：*yyyy-MM-ddTHH:mm:ss.SSSZ。* | | ca_certificate | [CaCertificate] object | 对端网关CA证书信息。仅当对端网关绑定CA证书时返回。 | | tags | Array of [VpnResourceTag] objects | 标签列表。 | 表7CaCertificate | 名称 | 类型 | 描述 | |:---|:---|:---| | id | String | 证书ID。 | | serial_number | String | 证书序列号。 | | signature_algorithm | String | 签名算法。 | | issuer | String | 证书颁发者。 | | subject | String | 证书使用者。 | | expire_time | String | 证书过期时间。 | | is_updatable | boolean | 是否能更新证书内容。 | 表8VpnResourceTag | 名称 | 类型 | 描述 | |:---|:---|:---| | key | String | - 功能说明：标签的键。 - 取值范围：1-128个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 | | value | String | - 功能说明：标签的值。 - 取值范围：0-255个字符，支持数字、英文字母、中文、西班牙语、葡语、空格，以及以下字符：_.:=+-@。 | - 响应样例 ``` { "customer_gateway": { "id": "03c0aa3d-demo-a8df-va86-9d82473765d4", "name": "cgw-f846", "id_type": "ip", "id_value": "10.***.***.21", "bgp_asn": 65533, "ca_certificate": { "serial_number": "14257156674311863338", "signature_algorithm": "SM3WITHSM2", "issuer": "C=CN,O=a0002,CN=XXX", "subject": "C=CN,O=a0002,CN=XXX", "expire_time": "2024-05-22T07:34:22Z", "is_updatable": true }, "created_at": "2021-12-21T16:49:28.108Z", "updated_at": "2021-12-21T16:49:28.108Z" }, "request_id": "96718f4a-f57a-4e1f-8d05-7d5e903c8d90" } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-vpn/vpn_api_0052.html)。