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

文档中心

立即注册

导航

DescribeTransitRouterGrantRules

最近更新时间：2024.07.09 08:42:33首次发布时间：2023.08.01 10:18:10

调用DescribeTransitRouterGrantRules接口，查询满足指定条件的实例共享。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeTransitRouterGrantRules	要执行的操作，取值为DescribeTransitRouterGrantRules。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
TransitRouterId	String	是	tr-7qthudw0ll6jmc****	中转路由器实例的ID。您可以调用DescribeTransitRouters接口获取中转路由器实例ID。
GrantAccountId	String	否	210001****	实例共享的账号ID。您可以调用DescribeVpcs接口获取待授权的账号ID。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数，取值范围为1 ~ 100，默认值为20。

返回参数

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

TransitRouterGrantRules

名称	类型	示例值	描述
GrantAccountId	String	210001****	实例共享的账号ID。
TransitRouterId	String	tr-3tehy13n2l4c6c0v844f	中转路由器实例的ID。
Status	String	Accepted	实例共享的状态。 Accepted：已接受。 Rejected：已拒绝。 Initial：待接受。
Description	String	This is a sample description.	实例共享的描述信息。
CreationTime	String	2021-04-09T08:36:47+08:00	实例共享的创建时间。
UpdateTime	String	2021-04-10T09:18:28+08:00	实例共享的更新时间。

请求示例

GET /?Action=DescribeTransitRouterGrantRules&Version=2020-04-01&TransitRouterId=tr-7qthudw0ll6jmc**** HTTP/1.1
Host: open.volcengineapi.com
Service: transitrouter
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeTransitRouterGrantRules",
        "Version": "2020-04-01",
        "Service": "transitrouter",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 2,
        "TransitRouters": [
            {
                "GrantAccountId": "210001****",
                "TransitRouterId": "tr-7qthudw0ll6jmc****",
                "Description": "grant rule 01",
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Status": "Accepted"
            },
            {
                "GrantAccountId": "210001****",
                "TransitRouterId": "tr-3tehy13n2l4c6c0v****",
                "Description": "This grant rule is used for test.",
                "CreationTime": "2021-04-09T08:36:47+08:00",
                "UpdateTime": "2021-04-10T09:18:28+08:00",
                "Status": "Accepted"
            }
        ]
    }
}

错误码

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

HttpCode	错误码	错误信息	描述
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。