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

中转路由器

复制全文
下载 pdf
全域网络
DescribeGlobalNetworks-查询全域网络实例列表
复制全文
下载 pdf
DescribeGlobalNetworks-查询全域网络实例列表
调用DescribeGlobalNetworks接口,查询全域网络实例。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值:DescribeGlobalNetworks​
接口名称。当前 API 的名称为 DescribeGlobalNetworks。​
​
Version String 必选 示例值:2026-06-01​
接口版本。当前 API 的版本为 2026-06-01。​
​
GlobalNetworkIds.N String 可选 示例值:gn-3hxn9ush899xmr2jxo0***​
全域网络实例的ID。​
  • N:表示全域网络实例的序号,取值范围为1~100。​
  • 多个实例ID之间使用“&”分隔。​
​
GlobalNetworkName String 可选 示例值:GlobalNetwork01​
全域网络实例的名称。​
​
ProjectName String 可选 示例值:default​
全域网络实例所属项目的名称。​
​
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。​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
GlobalNetworks Object[] 示例值:-​
符合条件的全域网络实例的详细信息。​
Tags Object[] 示例值:-​
全域网络实例的标签信息。​
Key String 示例值:k1​
标签的标签键。​
​
Value String 示例值:v1​
标签的标签值。​
​
​
Status String 示例值:Available​
全域网络实例的状态。​
  • Creating: 创建中。​
  • Deleting: 删除中。​
  • Pending:配置中。​
  • Available:可用。​
​
AccountId String 示例值:21****6666​
全域网络实例所属的账号ID。​
​
UpdateTime String 示例值:2026-06-01T00:00:00Z​
全域网络实例最近的操作时间。​
​
Description String 示例值:global-network-1 description​
全域网络的描述信息。​
​
ProjectName String 示例值:default​
全域网络实例所属的项目名称。​
​
CreationTime String 示例值:2026-06-01T00:00:00Z​
全域网络实例创建的时间。​
​
CoreNetworkId String 示例值:cn-3hxn9ush899xmr2jxo0p***​
全域网络实例包含的核心网的ID。​
​
GlobalNetworkId String 示例值:gn-3hxn9ush899xmr2jxo0p***​
全域网络实例的ID。​
​
GlobalNetworkName String 示例值:GlobalNetwork01​
全域网络实例的名称。​
​
​
PageNumber Integer 示例值:1​
当前分页的行数。​
​
PageSize Integer 示例值:20​
当前页码。​
​
TotalCount Integer 示例值:33​
符合条件的全域网络实例总数。​
​
​
请求示例​
​
GET /?Action=DescribeGlobalNetworks&Version=2026-06-01&GlobalNetworkIds.1=gn-3hxn9ush899xmr2jxo0***&GlobalNetworkName=GlobalNetwork01&ProjectName=default&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": "DescribeGlobalNetworks",​
"Version": "2026-06-01",​
"Service": "transitrouter",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"GlobalNetworks": [​
{​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
}​
],​
"Status": "Available",​
"AccountId": "21****6666",​
"UpdateTime": "2026-06-01T00:00:00Z",​
"Description": "global-network-1 description",​
"ProjectName": "default",​
"CreationTime": "2026-06-01T00:00:00Z",​
"CoreNetworkId": "cn-3hxn9ush899xmr2jxo0p3xxk",​
"GlobalNetworkId": "gn-3hxn9ush899xmr2jxo0p3xxk",​
"GlobalNetworkName": "global-network-1"​
}​
],​
"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.GlobalNetworkId​
You've reached the limit on the number of global network 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
这个页面对您有帮助吗?
有用
有用
无用
无用