You need to enable JavaScript to run this app.
导航
专线连接
  • 文档首页
    • /
  • 专线连接

DescribeDirectConnectGatewayAttributes

最近更新时间：2024.04.18 19:01:51

首次发布时间：2022.03.25 07:38:20

我的收藏

调用DescribeDirectConnectGatewayAttributes查询指定专线网关的详细信息。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是DescribeDirectConnectGatewayAttributes要执行的操作，取值为DescribeDirectConnectGatewayAttributes。
VersionString是2020-04-01API版本信息。
DirectConnectGatewayIdString是dcg-7qthudw0ll6jmc****要查询的专线网关的ID。您可调用DescribeDirectConnectGateways查询专线网关的ID。

返回数据

名称类型
示例值
描述
RequestIdString2021111616110801021214619****请求ID。
AccountIdString21000*****专线网关所属账号的ID。
DirectConnectGatewayIdStringdcg-7qthudw0ll6jmc****专线网关的ID。
DirectConnectGatewayNameStringtest专线网关的名称。
DescriptionStringThis is a sample description专线网关的描述。
CreationTimeString2021-04-09T08:36:47+08:00创建专线网关的时间。
UpdateTimeString2021-04-10T09:18:28+08:00更新专线网关的时间。

Status

String

Available

专线网关的状态。

  • Creating：创建中
  • Deleting：删除中
  • Pending：配置中
  • Available：可用

BusinessStatus

String

FinancialLocked

专线网关是否被锁定。

  • Normal：正常。
  • FinancialLocked：被锁定。

LockReason

String

Financial

专线网关被锁定的原因。

  • unlock ：解锁。
  • financial： 因欠费被锁定。
  • security： 因安全被锁定。
OverdueTimeString2021-04-29 01:37:38资源冻结时间。仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
DeletedTimeString2021-04-30 01:37:38预期资源强制回收时间。 仅当资源因为欠费冻结，此参数才会有返回值，否则均返回空值。
AssociateCensArray of struct-关联的CEN信息，具体请见下表“AssociateCen”。
TagsArray of struct-专线网关已添加的全部标签信息。具体请参见下表“Tag”。

EnableIpv6

Boolean

false

是否支持IPv6。

  • true：支持
  • false：不支持

AssociateCen

名称
类型
示例值
描述
CenIdStringcen-23987fdc****CEN的ID。
CenOwnerIdString122***023CEN的用户ID。

CenStatus

String

Attached

实例在CEN中的状态。

  • Attaching：加载中
  • Attached：已加载

Tag

名称
类型
示例值
描述
KeyStringkey1标签键。
ValueStringvalue1标签值。

请求示例

GET /?Action=DescribeDirectConnectGatewayAttributes&Version=2020-04-01&DirectConnectGatewayId=dcg-7qthudw0ll6jmc**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021111616110801021214619****",
        "Action": "DescribeDirectConnectGatewayAttributes",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021111616110801021214619****",
        "AccountId":"210000****",
        "DirectConnectGatewayId": "dcg-7qthudw0ll6jmc****",
        "DirectConnectGatewayName": "test",
        "Description": "test",
        "AssociateCens":[ 
             { 
              "CenId": "cen-23af298****", 
              "CenOwnerId": "1223****", 
              "CenStatus": "Attached"
             } 
        ],
        "CreationTime": "2021-12-15T17:05:42+08:00",
        "UpdateTime": "2021-12-17T11:50:30+08:00",
        "Status": "Available",
        "EnableIpv6":"false",
        "BusinessStatus":"Normal",
				"LockReason":"unlock",
				"OverdueTime":"",
				"DeletedTime":"",
				"Tags":[ 
				   { 
				    "Key":"k1", 
				    "Value":"v1" 
				   }, 
				   { 
				    "Key":"k2", 
				    "Value":"" 
				   } 
			  ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode
错误码
错误信息
描述
404InvalidDirectConnectGateway.NotFoundThe specified direct connect gateway does not exist.指定的专线网关不存在。