Help Center/ Direct Connect/ API Reference/ API/ Connect Gateways/ Updating a Connect Gateway
Updated on 2026-11-11 GMT+08:00

Updating a Connect Gateway

Function

This API is used to update a connect gateway.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    dcaas:connectGateway:update

    Write

    connectGateway *

    -

    -

    -

URI

PUT /v3/{project_id}/dcaas/connect-gateways/{connect_gateway_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

connect_gateway_id

Yes

String

Definition

Specifies the connect gateway ID.

Constraints

N/A

Range

The value is in UUID format and is connected by hyphens (-).

Default Value

N/A

project_id

Yes

String

Definition

Specifies the project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. After the request is processed, the value of X-Subject-Token in the header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

connect_gateway

No

UpdateConnectGateway object

Definition

Request body for modifying a connect gateway.

Constraints

N/A

Table 4 UpdateConnectGateway

Parameter

Mandatory

Type

Description

name

No

String

Definition

Specifies the connect gateway name.

Constraints

N/A

Range

The value can contain a maximum of 64 characters, including letters (a–z or A–Z), digits (0-9), hyphens (-), underscores (_), and periods (.).

Default Value

N/A

description

No

String

Definition

Specifies the description.

Constraints

N/A

Range

The value can contain a maximum of 255 characters. Angle brackets (< and >) are not allowed.

Default Value

N/A

address_family

No

String

Definition

Specifies the address family.

Constraints

N/A

Range

  • ipv4

  • dual

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Definition

Specifies the request ID.

Range

N/A

connect_gateway

ConnectGatewayResponse object

Definition

Specifies the connect gateway details.

Table 6 ConnectGatewayResponse

Parameter

Type

Description

id

String

Definition

Specifies the unique ID of the connect gateway.

Range

N/A

tenant_id

String

Definition

Specifies the project ID.

Range

N/A

name

String

Definition

Specifies the connect gateway name.

Range

N/A

description

String

Definition

Specifies the description.

Range

N/A

address_family

String

Definition

Specifies the address family.

  • ipv4: Only IPv4 is supported.

  • dual: IPv4 and IPv6 are supported.

Range

  • ipv4: Only IPv4 is supported.

  • dual: IPv4 and IPv6 are supported.

status

String

Definition

Specifies the connect gateway status.

  • DOWN: The connect gateway is not in use or the associated device goes down.

  • ACTIVE: The connect gateway is normal.

  • ERROR: The connect gateway is abnormal.

Range

N/A

access_site

String

Definition

Specifies the access site of the connect gateway.

Range

N/A

bgp_asn

Long

Definition

Specifies the BGP ASN.

Range

N/A

current_geip_count

Integer

Definition

Specifies the number of global EIPs bound.

Range

N/A

created_time

String

Definition

Specifies the creation time.

updated_time

String

Definition

Specifies the update time.

gcb_id

String

Definition

Specifies the global connection bandwidth ID.

Range

N/A

gateway_site

String

Definition

Specifies the gateway location.

Range

N/A

Example Requests

Updating a connect gateway

PUT https://{dc_endpoint}/v3/b197c48159d44a66b32c538c3f8da89a/dcaas/connect-gateways/934aa302-5f1a-44c8-855b-20f715e2dbf3

{
  "connect_gateway" : {
    "description" : "Global EIP testing"
  }
}

Example Responses

Status code: 200

Connect gateway that has been updated

{
  "request_id" : "ecf6442668da7d4adf0dfaf4bded8840",
  "connect_gateway" : {
    "name" : "cgw-test",
    "id" : "934aa302-5f1a-44c8-855b-20f715e2dbf3",
    "description" : "Global EIP testing",
    "created_time" : "2024-12-12T06:12:15Z",
    "updated_time" : null,
    "tenant_id" : "b197c48159d44a66b32c538c3f8da89a",
    "status" : "DOWN",
    "bgp_asn" : 139144,
    "address_family" : "dual",
    "access_site" : null,
    "current_geip_count" : 0,
    "gcb_id" : null,
    "gateway_site" : null
  }
}

SDK Sample Code

The SDK sample code is as follows.

Updating a connect gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;


public class UpdateConnectGatewaySolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateConnectGatewayRequest request = new UpdateConnectGatewayRequest();
        request.withConnectGatewayId("{connect_gateway_id}");
        UpdateConnectGatewayRequestBody body = new UpdateConnectGatewayRequestBody();
        UpdateConnectGateway connectGatewaybody = new UpdateConnectGateway();
        connectGatewaybody.withDescription("Global EIP testing");
        body.withConnectGateway(connectGatewaybody);
        request.withBody(body);
        try {
            UpdateConnectGatewayResponse response = client.updateConnectGateway(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Updating a connect gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.v3 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DcClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DcRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = UpdateConnectGatewayRequest()
        request.connect_gateway_id = "{connect_gateway_id}"
        connectGatewaybody = UpdateConnectGateway(
            description="Global EIP testing"
        )
        request.body = UpdateConnectGatewayRequestBody(
            connect_gateway=connectGatewaybody
        )
        response = client.update_connect_gateway(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Updating a connect gateway

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dc.DcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dc.NewDcClient(hcClient)

    request := &model.UpdateConnectGatewayRequest{}
	request.ConnectGatewayId = "{connect_gateway_id}"
	descriptionConnectGateway:= "Global EIP testing"
	connectGatewaybody := &model.UpdateConnectGateway{
		Description: &descriptionConnectGateway,
	}
	request.Body = &model.UpdateConnectGatewayRequestBody{
		ConnectGateway: connectGatewaybody,
	}
	response, err := client.UpdateConnectGateway(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.