DescribeCustomerGateway - 查詢已建立的使用者網關 - VPN Gateway

查詢已建立的使用者網關的詳細資料。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	使用者網關所屬的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-shanghai
CustomerGatewayId	string	是	使用者網關的執行個體 ID。	cgw-bp1pvpl9r9adju6l5****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
Asn	integer	本機資料中心網關裝置的自治系統號。	65535
RequestId	string	請求 ID。	A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2
IpAddress	string	本機資料中心網關裝置的 IP 位址。	139.32.XX.XX
Description	string	使用者網關的描述資訊。	desctest
CustomerGatewayId	string	使用者網關的執行個體 ID。	cgw-bp1pvpl9r9adju6l5****
CreateTime	integer	建立使用者網關的時間戳記。單位：毫秒。時間戳記的格式採用 Unix 時間戳記，表示從格林威治時間 1970 年 01 月 01 日 00 時 00 分 00 秒至建立使用者網關時的總時間長度。	1492747187000
Name	string	使用者網關的名稱。	nametest
AuthKey	string	本機資料中心網關裝置 BGP 路由協議的認證密鑰。	AuthKey****
Tags	object
Tag	array<object>	使用者網關綁定的標籤列表。
	object	標籤資訊。
Key	string	標籤鍵。	TagKey
Value	string	標籤值。	TagValue
ResourceGroupId	string	使用者網關所屬的資源群組 ID。您可以調用 ListResourceGroups 介面查詢資源群組資訊。	rg-acfmzs372yg****

樣本

正常返回樣本

JSON格式

{
  "Asn": 65535,
  "RequestId": "A0457BC9-6C0F-4437-AB9D-FB2EABC1D6A2",
  "IpAddress": "139.32.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
  "CreateTime": 1492747187000,
  "Name": "nametest",
  "AuthKey": "AuthKey****",
  "Tags": {
    "Tag": [
      {
        "Key": "TagKey",
        "Value": "TagValue"
      }
    ]
  },
  "ResourceGroupId": "rg-acfmzs372yg****"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbidden.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.	您沒有許可權操作指定資源，請申請許可權後再操作。
404	InvalidCustomerGatewayInstanceId.NotFound	The specified customer gateway instance id does not exist.	指定的使用者網關執行個體不存在，請您檢查使用者網關執行個體ID是否正確。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。