DescribeTransitRouterRegions--中转路由器-火山引擎

文档中心

立即注册

导航

DescribeTransitRouterRegions

最近更新时间：2024.09.10 10:14:49首次发布时间：2023.09.12 10:21:33

调用 DescribeTransitRouterRegions 接口，查询当前账号支持的地理区域及地域信息。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTransitRouterRegions	要执行的操作，取值为DescribeTransitRouterRegions。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
GeographicRegionSetId	String	否	China	地理区域的ID。取值如下： China：中国大陆。
RegionIds.N	String	否	RegionIds.1=cn-beijing&RegionIds.2=cn-guangzhou	地域ID。您可以参考地域介绍获取地域ID。 N：表示地域ID的序号，取值范围为1～100。多个地域ID之间使用&分隔。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1 ～ 100，默认值为20。

返回参数

名称	类型	示例值	描述
PageSize	integer	20	当前分页的行数。
PageNumber	integer	1	当前页码。
TotalCount	Integer	2	符合条件的地域总数。
Regions	Array of Struct	-	符合条件的地域的详细信息。具体请参见下表“ Regions ”。

Regions

名称	类型	示例值	描述
GeographicRegionSetId	String	China	地理区域ID。 China：中国大陆。
RegionType	String	public	地理区域中地域的类型。
RegionId	String	cn-beijing	地理区域中地域的ID。
RegionName	String	华北2（北京）	地理区域中地域的名称。

请求示例

GET /?Action=DescribeTransitRouterRegions&Version=2020-04-01&GeographicRegionSetId=China HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeTransitRouterRegions",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Regions": [
            {
                "GeographicRegionSetId": "China",
                "RegionType": "public",
                "RegionId": "cn-beijing"
                "RegionName": "华北2（北京）"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	LimitExceeded.ResourceIds	You've reached the limit of 100 resource IDs that can be specified in this request.	已达到单次可查询的实例数量上限。