You need to enable JavaScript to run this app.
文档中心
中转路由器

中转路由器

复制全文
下载 pdf
核心网
DescribeCoreNetworkAttachments-查询核心网中的网络实例连接列表
复制全文
下载 pdf
DescribeCoreNetworkAttachments-查询核心网中的网络实例连接列表
调用DescribeCoreNetworkAttachments接口,查询核心网中已创建的网络实例连接。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeCoreNetworkAttachments​
接口名称。当前 API 的名称为 DescribeCoreNetworkAttachments。​
​
Version String 必选 示例值:2026-06-01​
接口版本。当前 API 的版本为 2026-06-01。​
​
CoreNetworkAttachmentIds.N String 可选 示例值:cn-attach-3hxn9ush899xmr2jxo0p***​
网络实例连接的ID。​
  • N:表示网络实例连接的序号,取值范围为1~100。​
  • 多个网络实例连接ID之间使用“&”分隔。​
​
CoreNetworkId String 可选 示例值:cn-3hxn9ush899xmr2jxo0p***​
核心网实例的ID。​
您可以调用DescribeCoreNetworks接口获取核心网实例ID。​
​
CoreNetworkAttachmentName String 可选 示例值:core-network-test​
网络实例连接的名称。​
​
RegionId String 可选 示例值:cn-guangzhou​
网络实例连接所在的地域名称。​
您可以参考地域介绍获取地域ID。​
​
ResourceType String 可选 示例值:VPC​
网络实例连接的类型,取值如下:​
  • VPC:私有网络类型。​
  • VPN:VPN连接类型。​
  • DirectConnectGateway:专线网关类型。​
  • TransitRouterRouteTable:TR路由表。​
​
ResourceId String 可选 示例值:vpc-12345adag141e***​
网络实例的ID。​
​
TagFilters.N.Key String 可选 示例值:k1​
网络实例连接的标签键。​
  • N:表示标签键的序号,取值范围1~50。多个标签键之间使用&分隔。​
  • 指定多个标签键时,表示查询同时包含所有指定标签键的全域网络实例。​
​
TagFilters.N.Values.N String 可选 示例值:v1​
网络实例连接标签的标签值。​
  • 第一个N:表示标签键的序号,取值范围1~50。​
  • 第二个N:表示标签值的序号,取值范围1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的资源。​
  • 多个标签值之间使用&分隔。​
  • 如果传入该参数,则必须先传入TagFilters.N.Key。​
  • 该参数传入空值时,表示查询指定标签键下标签值为空的资源。​
​
PageNumber Integer 可选 示例值:1​
列表的页码,默认值为1。​
​
PageSize Integer 可选 示例值:20​
分页查询时每页的行数,取值范围为1 ~ 100,默认值为20。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
CoreNetworkAttachments Object[] 示例值:-​
符合条件的网络实例连接详情。​
Tags Object[] 示例值:-​
网络实例连接的标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
Status String 示例值:Available​
网络实例连接的状态。​
  • Creating: 创建中。​
  • Deleting: 删除中。​
  • Pending:配置中。​
  • Available:可用。​
​
RegionId String 示例值:cn-beijing​
网络实例连接的地域。​
​
AccountId String 示例值:210000****​
网络实例连接所属的账号ID。​
​
ResourceId String 示例值:vpc-3tex2x1cwd4c6c0v****​
网络实例连接关联的资源ID。​
​
UpdateTime String 示例值:2024-01-01T00:00:00+08:00​
网络实例连接最近的操作时间。​
​
Description String 示例值:Attachment for production workload​
网络实例连接的描述。​
​
Ipv6Enabled Boolean 示例值:false​
VPC类型网路实例连接是否开启IPv6功能。​
  • true:开启。​
  • false:关闭。​
仅ResourceType传入VPC时有返回值。​
​
SegmentName String 示例值:prod​
网络实例连接所在的网络平面名称。​
​
CreationTime String 示例值:2024-01-01T00:00:00+08:00​
网络实例连接创建的时间。​
​
ResourceType String 示例值:VPC​
网络实例连接的类型。​
  • VPC:私有网络类型。​
  • VPN:VPN连接类型。​
  • DirectConnectGateway:专线网关类型。​
  • TransitRouterRouteTable:TR路由表。​
​
CoreNetworkId String 示例值:cn-3tex2x1cwd4c6****​
核心网实例的ID。​
​
PolicyRuleNumber Integer 示例值:100​
核心网连接策略的数量。​
​
AttachmentPolicyLabels Object[] 示例值:-​
网络实例连接的连接策略标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
AutoPublishRouteEnabled Boolean 示例值:false​
VPC类型网路实例连接是否开启路由同步功能。​
  • true:开启。​
  • false:关闭。​
仅ResourceType传入VPC时有返回值。​
​
CoreNetworkAttachmentId String 示例值:cn-attach-3tex2x1cwd4c6c0v****​
核心网的网络实例连接ID。​
​
NetworkFunctionGroupName String 示例值:fw​
网络服务组的ID。​
​
CoreNetworkAttachmentName String 示例值:prod-web-attach-01​
核心网的网络实例连接名称。​
​
​
PageNumber Integer 示例值:1​
当前分页的行数。​
​
PageSize Integer 示例值:20​
当前页码。​
​
TotalCount Integer 示例值:33​
符合条件的网络实例连接总数。​
​
​
请求示例​
​
GET /?Action=DescribeCoreNetworkAttachments&Version=2026-06-01&CoreNetworkAttachmentIds.1=cn-attach-3hxn9ush899xmr2jxo0p***&CoreNetworkId=cn-3hxn9ush899xmr2jxo0p***&CoreNetworkAttachmentName=core-network-test&RegionId=cn-guangzhou&ResourceType=VPC&ResourceId=vpc-12345adag141e***&TagFilters.1.Key=k1&TagFilters.1.Values.1=v1&PageNumber=1&PageSize=20 HTTP/1.1​
Host: transitrouter.cn-guangzhou.volcengineapi.com​
X-Date: 20251029T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250804/cn-guangzhou/transitrouter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeCoreNetworkAttachments",​
"Version": "2026-06-01",​
"Service": "transitrouter",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"CoreNetworkAttachments": [​
{​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Status": "Available",​
"RegionId": "cn-beijing",​
"AccountId": "210000****",​
"ResourceId": "vpc-3tex2x1cwd4c6c0v****",​
"UpdateTime": "2024-01-01T00:00:00+08:00",​
"Description": "Attachment for production workload",​
"Ipv6Enabled": false,​
"SegmentName": "prod",​
"CreationTime": "2024-01-01T00:00:00+08:00",​
"ResourceType": "VPC",​
"CoreNetworkId": "cn-3tex2x1cwd4c6****",​
"PolicyRuleNumber": 100,​
"AttachmentPolicyLabels": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"AutoPublishRouteEnabled": false,​
"CoreNetworkAttachmentId": "cn-attach-3tex2x1cwd4c6c0v****",​
"NetworkFunctionGroupName": "fw",​
"CoreNetworkAttachmentName": "prod-web-attach-01"​
}​
],​
"PageNumber": 1,​
"PageSize": 20,​
"TotalCount": 33​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
InvalidPage.Malformed​
The specified page is malformed.​
指定的分页参数不合法。​
400​
InvalidTagFilter.Disorder​
The specified index order of tag filter is malformed.​
指定标签过滤项的索引顺序参数格式不合法。​
400​
InvalidTagFilterKey.Malformed​
The specified parameter tag filter key is invalid.​
过滤标签键不合法。​
400​
InvalidTagFilterValue.Malformed​
The specified parameter tag filter value is invalid.​
过滤标签值不合法。​
400​
LimitExceeded.CoreNetworkAttachmentId​
You've reached the limit on the number of Core Network attachment IDs that you can describe.​
已达到可查询的网络实例连接ID数量上限。​
400​
LimitExceeded.TagFilterKey​
You've reached the limit on the number of tag keys that you can filter.​
已达到单次可指定过滤标签键数量的上限。​
400​
LimitExceeded.TagFilterValue​
You've reached the limit on the number of tag values that you can filter.​
已达到单次可指定过滤标签值数量的上限。​
​
最近更新时间:2026.06.18 14:27:20
这个页面对您有帮助吗?
有用
有用
无用
无用