Tüm Ürünler
Search
Belge Merkezi

:DescribeCustomerGateways

Son Güncelleme:Oct 02, 2026

Müşteri ağ geçitleri hakkında bilgi sorgular.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeCustomerGateways

list

CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/*

CustomerGateway

acs:vpc:{#regionId}:{#accountId}:customergateway/{#CustomerGatewayId}

None None

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

Müşteri ağ geçidinin bölge kimliği.

Bölge kimliklerini sorgulamak için DescribeRegions API'sini çağırabilirsiniz.

cn-shanghai

CustomerGatewayId

string

No

Müşteri ağ geçidinin örnek kimliği.

Not

Bir müşteri ağ geçidinin örnek kimliğini belirtmezseniz, sistem varsayılan olarak mevcut bölgedeki tüm müşteri ağ geçitleri hakkındaki bilgileri sorgular.

cgw-bp1pvpl9r9adju6l5****

PageNumber

integer

No

Listenin sayfa numarası. Varsayılan değer: 1.

1

PageSize

integer

No

Sayfalanmış sorguda sayfa başına giriş sayısı. Maksimum değer: 50. Varsayılan değer: 10.

10

Tag

array<object>

No

Müşteri ağ geçidine bağlı etiketlerin listesi.

object

No

Etiket bilgileri.

Key

string

No

Etiket anahtarı. Bu parametreyi belirtirseniz, değer boş bir dize olamaz.

Etiket anahtarı en fazla 64 karakter uzunluğunda olabilir ve aliyun veya acs: ile başlayamaz. http:// veya https:// içeremez.

Tek seferde en fazla 20 etiket anahtarı belirtebilirsiniz.

TagKey

Value

string

No

Etiket değeri.

Etiket değeri en fazla 128 karakter uzunluğunda olabilir ve boş bir dize olabilir. aliyun veya acs: ile başlayamaz ve http:// veya https:// içeremez.

Her etiket anahtarı bir etiket değerine karşılık gelir. Tek seferde en fazla 20 etiket değeri belirtebilirsiniz.

TagValue

ResourceGroupId

string

No

Müşteri ağ geçidinin ait olduğu kaynak grubunun kimliği.

Kaynak grubu kimliklerini sorgulamak için ListResourceGroups API'sini çağırabilirsiniz.

rg-acfmzs372yg****

Response elements

Element

Type

Description

Example

object

Yanıt parametreleri.

PageSize

integer

Sayfalama sorgusunda sayfa başına giriş sayısı.

10

RequestId

string

İstek kimliği.

E82612A9-CB90-4D7E-B394-1DB7F6509B29

PageNumber

integer

Listenin sayfa numarası.

1

TotalCount

integer

Listedeki toplam giriş sayısı.

1

CustomerGateways

object

CustomerGateway

array<object>

Müşteri ağ geçidi bilgilerinin listesi.

array<object>

Müşteri ağ geçidi hakkındaki bilgiler.

IpAddress

string

Şirket içi veri merkezindeki ağ geçidi cihazının IP adresi.

139.32.XX.XX

Asn

integer

Şirket içi veri merkezindeki ağ geçidi cihazının otonom sistem numarası.

65530

Description

string

Müşteri ağ geçidinin açıklaması.

desctest

CustomerGatewayId

string

Müşteri ağ geçidinin örnek kimliği.

cgw-bp1pvpl9r9adju6l5****

CreateTime

integer

Müşteri ağ geçidinin oluşturulduğu zaman damgası. Birim: milisaniye.

Zaman damgası Unix biçimindedir ve 1 Ocak 1970 00:00:00 UTC'den müşteri ağ geçidinin oluşturulduğu zamana kadar geçen toplam milisaniye sayısını temsil eder.

1492747187000

Name

string

Müşteri ağ geçidinin adı.

nametest

AuthKey

string

Şirket içi veri merkezindeki ağ geçidi cihazı için BGP yönlendirme protokolünün kimlik doğrulama anahtarı.

AuthKey****

Tags

object

Tag

array<object>

Müşteri ağ geçidine bağlı etiketlerin listesi.

object

Etiket bilgileri.

Key

string

Etiket anahtarı.

TagKey

Value

string

Etiket değeri.

TagValue

ResourceGroupId

string

Müşteri ağ geçidinin ait olduğu kaynak grubunun kimliği.

Kaynak grubu bilgilerini sorgulamak için ListResourceGroups API'sini çağırabilirsiniz.

rg-acfmzs372yg****

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "E82612A9-CB90-4D7E-B394-1DB7F6509B29",
  "PageNumber": 1,
  "TotalCount": 1,
  "CustomerGateways": {
    "CustomerGateway": [
      {
        "IpAddress": "139.32.XX.XX",
        "Asn": 65530,
        "Description": "desctest",
        "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
        "CreateTime": 1492747187000,
        "Name": "nametest",
        "AuthKey": "AuthKey****",
        "Tags": {
          "Tag": [
            {
              "Key": "TagKey",
              "Value": "TagValue"
            }
          ]
        },
        "ResourceGroupId": "rg-acfmzs372yg****"
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400 Forbidden.TagKey.Duplicated The specified tag key already exists. The tag resources are duplicate.
400 SizeLimitExceeded.TagNum The maximum number of tags is exceeded. The number of tags has reached the upper limit.
400 InvalidParameter.TagValue The specified parameter TagValue is invalid. The error message returned because the specified tag value is invalid.
400 InvalidParameter.TagKey The specified parameter TagKey is invalid. The error message returned because the specified tag key is invalid.
400 Duplicated.TagKey The specified parameter TagKey is duplicated. The error message returned because the specified tag key already exists.
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user.
403 Forbidden User not authorized to operate on the specified resource. You do not have the permissions to manage the specified resource. Apply for the permissions and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.