文档中心

DescribeTransitRouters

最近更新时间：2024.03.26 10:26:48

首次发布时间：2023.03.07 09:56:37

调用DescribeTransitRouters接口，查询满足指定条件的中转路由器实例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTransitRouters	要执行的操作，取值为DescribeTransitRouters。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TransitRouterIds.N	String	否	TransitRouterIds.1=tr-7qthudw0ll6jmc**&TransitRouterIds.2=tr-3tehy13n2l4c6c0v**	中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。参数 - N：表示中转路由器实例的序号，取值范围为1～100，单次最多可查询100个。多个中转路由器实例ID之间使用“&”分隔。
TransitRouterName	String	否	transitrouter-01	中转路由器实例的名称。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。
ProjectName	String	否	default	中转路由器实例所属项目的名称。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2	中转路由器实例标签的标签键。参数 - N：表示标签键的序号，单次调用数量上限10个。多个标签键之间使用&分隔。指定多个标签键时，表示查询同时包含所有指定标签键的中转路由器实例。
TagFilters.N.Values.M	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3	中转路由器实例标签的标签值。参数 - M：表示标签值的序号，单次调用每个标签键最多可指定3个标签值。未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的中转路由器实例。该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的中转路由器实例。同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联中转路由器实例的集合。说明如果传入该参数，则必须先传入`TagFilters.N.Key`。

返回参数

名称	类型	示例值	描述
RequestId	String	0ED8D006-F706-4D23-88ED-E11ED28D****	请求ID。
PageSize	Integer	20	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	2	符合条件的中转路由器实例总数。
TransitRouters	Array of Struct	-	符合条件的中转路由器实例的详细信息。具体请参见下表“ TransitRouters ”。

TransitRouters

名称	类型	示例值	描述
AccountId	String	200000****	中转路由器实例所属的账号ID。
BusinessStatus	String	Normal	中转路由器实例的业务状态。取值如下： Normal：正常。 FinancialLocked：已冻结。
CreationTime	String	2021-04-09T08:36:47+08:00	中转路由器实例的创建时间。
DeletedTime	String	2021-05-22 00:00:00	中转路由器实例的删除时间。
Description	String	This transit router is used for test.	中转路由器实例的描述信息。
OverdueTime	String	2021-05-07 23:23:23	中转路由器实例的欠费关停时间。
Status	String	Available	中转路由器实例的状态。 Creating: 创建中。 Deleting: 删除中。 Pending：配置中。 Available：可用。
TransitRouterName	String	transitrouter-01	中转路由器实例的名称。
TransitRouterId	String	tr-3tehy13n2l4c6c0v****	中转路由器实例的ID。
UpdateTime	String	2021-04-10T09:18:28+08:00	中转路由器实例的最近操作时间。
GrantStatus	String	Initial	共享规则的状态。 Accepted：已接受。 Initial：待接受。
Asn	Integer	64512	中转路由器的ASN号。
ProjectName	String	default	中转路由器实例所属项目的名称。
Tags	Array of Struct	-	中转路由器实例的标签信息。具体请参见下表“Tags”。

名称	类型	示例值	描述
Key	String	k1	中转路由器实例标签的标签键。
Value	String	v1	中转路由器实例标签的标签值。

请求示例

GET /?Action=DescribeTransitRouters&Version=2020-04-01&TransitRouterIds.1=tr-7qthudw0ll6jmc****&TransitRouterIds.2=tr-3tehy13n2l4c6c0v**** HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeTransitRouters",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "TransitRouters": [
            {
                "TransitRouterId": "tr-7qthudw0ll6jmc****",
                "TransitRouterName": "transitrouter-01",
                "Description": "This transit router is used for test.",
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Status": "Available",
                "AccountId": "200005****",
                "BusinessStatus": "Normal",
                "OverdueTime": "2021-05-07 23:23:23",
                "DeletedTime": "",
                "GrantStatus": "Initial",
                "Asn": "64512",
                "ProjectName": "default",
                "Tags": [
                  {
                    "Key": "k1",
                    "Value": "v1"
                  }
               ]
            },
            {
                "TransitRouterId": "tr-3tehy13n2l4c6c0v****",
                "TransitRouterName": "transitrouter-02",
                "Description": "This transit router is used for test.",
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Status": "Available",
                "AccountId": "200000****",
                "BusinessStatus": "Normal",
                "OverdueTime": "2021-05-07 23:23:23",
                "DeletedTime": "",
                "GrantStatus": "Initial",
                "Asn": "64513",
                "ProjectName": "default",
                "Tags": [
                  {
                    "Key": "k1",
                    "Value": "v1"
                  }
               ]
            }
        ]
    }
}

错误码

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

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.	该请求传入了非法或不支持的参数。资源查询数目最大限制100。
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	LmitExceeded.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.	已达到单次可指定过滤标签值数量的上限。

请求参数

返回参数

TransitRouters