功能介绍
根据对端网关ID,更新指定的对端网关。支持更新名称和更换证书,修改其他参数需重新创建对端网关。
URI
PUT /v5/{project_id}/customer-gateways/{customer_gateway_id}
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
project_id |
String |
是 |
项目ID,可以通过获取项目ID获取项目ID。 |
customer_gateway_id |
String |
是 |
对端网关ID |
请求消息
- 请求样例
PUT https://{Endpoint}/v5/{project_id}/customer-gateways/{customer_gateway_id} { "customer_gateway": { "name": "cgw-f846" "ca_certificate": { "content":"******" } } }
响应消息
- 响应参数
表5 响应Body参数列表 名称
类型
描述
customer_gateway
customer_gateway对象
request_id
String
请求id
表6 ResponseCustomerGateway 名称
类型
描述
id
String
- 功能说明:对端网关的ID
- 格式:36位UUID
name
String
- 功能说明:对端网关名称,不填时会自动生成。
- 取值范围:1-64个字符,包括数字、英文字母、中文(\u4e00 - \u9fa5)、_(下划线)、-(中划线)。
route_mode
String
- 功能说明:对端网关路由模式
- 取值范围:static,bgp。
bgp_asn
Long
对端网关的BGP自治域编号。仅当route_mode为bgp时返回。
ip
String
- 功能说明:对端网关 ip地址
- 格式:ipv4类型地址。例如:10.***.***.21。
created_at
String
创建时间
updated_at
String
最后一次更新时间
ca_certificate
对端网关CA证书信息。仅当对端网关绑定CA证书时返回。
表7 CaCertificate 名称
类型
描述
serial_number
String
证书序列号
signature_algorithm
String
签名算法
issuer
String
证书颁发者
subject
String
证书使用者
expire_time
String
证书过期时间
is_updatable
boolean
是否能更新证书内容
- 响应样例
{ "customer_gateway": { "id": "03c0aa3d-****-****-****-9d82473765d4", "name": "cgw-f846", "route_mode": "bgp", "bgp_asn": 65533, "ip": "10.***.***.21", "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.108+08:00", "updated_at": "2021-12-21T16:49:28.108+08:00" }, "request_id": "96718f4a-f57a-4e1f-8d05-7d5e903c8d90" }
状态码
请参见状态码