DescribeRouterInterfaceAttribute - 查看路由器接口配置 - 专有网络 VPC

调用DescribeRouterInterfaceAttribute查看路由器接口配置。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeRouterInterfaceAttribute	get	*RouterInterface `acs:vpc:{#regionId}:{#accountId}:routerinterface/{#RouterInterfaceId}`	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	路由器接口所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-qingdao
InstanceId	string	是	要查询的路由器接口 ID。	ri-m5egfc10sednwk2yt****

返回参数

名称	类型	描述	示例值
	object	返回信息。
ReservationActiveTime	string	续费生效时间。	2022-06-11T16:00:00Z
HealthCheckTargetIp	string	健康检查目标 IP。	2.2.XX.XX
Status	string	路由器接口的状态。取值： Idle：未连接 AcceptingConnecting：接受连接中 Connecting：连接中 Activating：激活中 Active：已激活 Modifying：修改中 Deactivating：冻结中 Inactive：已冻结 Deleting：删除中	Active
CreationTime	string	路由器接口创建的时间。	2022-04-14T08:57:24Z
ReservationOrderType	string	续费订单类型。取值：RENEW，表示续费订单。	RENEW
OppositeInterfaceId	string	对端路由器接口 ID。	ri-bp1xkrzttximaoxbl****
Spec	string	路由器接口的规格。取值： Mini.2：2 Mbps Mini.5：5 Mbps Small.1：10 Mbps Small.2：20 Mbps Small.5：50 Mbps Middle.1：100 Mbps Middle.2：200 Mbps Middle.5：500 Mbps Large.1：1000 Mbps Large.2：2000 Mbps Large.5：5000 Mbps Xlarge.1：10000 Mbps	Mini.2
ChargeType	string	付费方式。取值： AfterPay：后付费 PrePaid：预付费	AfterPay
RouterInterfaceId	string	路由器接口的 ID。	ri-m5egfc10sednwk2yt****
Message	string	返回信息。	successful
HcThreshold	integer	健康检查阈值。表示指定健康检查时发送探测报文的个数。单位：个。	8
OppositeRouterType	string	连接对端的路由器接口所属的路由器类型。取值： VRouter：VPC 路由器 VBR：边界路由器	VRouter
GmtModified	string	路由器接口修改的时间点。	2022-04-28T10:02:12Z
VpcInstanceId	string	路由器接口所属的专有网络 ID。	vpc-bp1b49rqrybk45nio****
OppositeInterfaceOwnerId	string	对端路由器接口的账号 ID。	1321932713****
OppositeVpcInstanceId	string	对端的 VPC ID。	vpc-bp1b49rqrybk45nio****
ReservationInternetChargeType	string	续费付费类型。取值：PayByBandwidth，表示按使用带宽付费。	PayByBandwidth
CrossBorder	boolean	是否是跨境连接。取值： false：不是 true：是	false
RequestId	string	请求 ID。	01818199-04F6-47F4-9ADF-7CC824CF57A4
Bandwidth	integer	路由器接口带宽。单位：Mbps。	2
Description	string	路由器接口描述。	对端接口
HcRate	integer	健康检查速率。单位：秒。表示指定健康检查时发送连续探测报文的时间间隔。	2
ReservationBandwidth	string	续费带宽。单位：Mbps。	100
Code	string	HTTP 返回码。	200
Name	string	路由器接口名称。	路由器接口1
OppositeRouterId	string	连接对端的路由器接口所属的路由器 ID。	vrt-bp11xvy6lb9photuu****
OppositeInterfaceSpec	string	连接对端路由器接口的规格。取值： Mini.2：2 Mbps Mini.5：5 Mbps Small.1：10 Mbps Small.2：20 Mbps Small.5：50 Mbps Middle.1：100 Mbps Middle.2：200 Mbps Middle.5：500 Mbps Large.1：1000 Mbps Large.2：2000 Mbps Large.5：5000 Mbps Xlarge.1：10000 Mbps Negative：不涉及规格	Negative
RouterId	string	路由器接口所属的路由器 ID。	vbr-m5ex0xf63xk8s5bob****
Success	boolean	是否调用成功。	true
OppositeInterfaceBusinessStatus	string	连接对端的路由器接口的业务状态。取值： Normal：正常 FinancialLocked：欠费锁定 SecurityLocked：安全风控锁定	Normal
ConnectedTime	string	连接建立的时间。	2022-04-14T08:58:04Z
HealthCheckSourceIp	string	健康检查源 IP。	1.1.XX.XX
OppositeInterfaceStatus	string	连接对端的路由器接口的状态。取值： Idle：未连接 AcceptingConnecting：接受连接中 Connecting：连接中 Activating：激活中 Active：已激活 Modifying：修改中 Deactivating：冻结中 Inactive：已冻结 Deleting：删除中 Deleted：已删除	Active
EndTime	string	获取数据的结束时间点。	2999-09-08T16:00:00Z
OppositeRegionId	string	连接对端路由器接口的地域 ID。	cn-hangzhou
OppositeAccessPointId	string	对端接入点 ID。	ap-cn-qingdao-ls-B
BusinessStatus	string	路由器接口状态。取值： Normal：正常 FinancialLocked：欠费锁定 SecurityLocked：安全风控锁定	Normal
HealthCheckStatus	string	健康检查状态。取值： Abnormal：状态异常 Normal：正常 NoRedundantRoute：未配置冗余路由 NoHealthCheckConfig：未配置健康检查	normal
OppositeBandwidth	integer	对端带宽。单位：Mbps。	0
RouterType	string	路由表所在路由器的类型。取值： VRouter：VPC 路由器 VBR：边界路由器	VRouter
Role	string	对等连接中的角色。	InitiatingSide
HasReservationData	string	是否有续费数据。取值： false：没有 true：有	false
AccessPointId	string	接入点 ID。	ap-cn-qingdao-ls-A
ResourceGroupId	string	资源组 ID。关于资源组的更多信息，请参见什么是资源组。	rg-acfmxazb4ph6aiy****
Tags	array<object>	资源的标签。
Tags	object	标签。
Key	string	资源的标签键。至少输入 1 个标签键，最多支持输入 20 个标签键。一旦传入该值，则不允许为空字符串。一个标签键最多支持 64 个字符，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	资源的标签值。最多支持输入 20 个标签值。一旦传入该值，可以为空字符串。最多支持 128 个字符，可包含数字、半角句号（.）、下划线（_）和短划线（-），不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua
FastLinkMode	string	是否为使用快速连接模式创建的 VBR 上联路由器接口，快速连接模式可实现 VBR 和 VPC 两端路由器接口创建完毕后自动完成连接。取值： true：是。 false（默认值）：否。说明该参数只在 RouterType 取值为 VBR，OppositeRouterType 参数取值为 VRouter 时生效。当 FastLinkMode 参数取值为 true 时，Role 参数必须取值为 InitiatingSide，AccessPointId、OppositeRouterType、OpppsiteRouterId 和 OppositeInterfaceOwnerId 参数为必选。	false

示例

正常返回示例

JSON格式

{
  "ReservationActiveTime": "2022-06-11T16:00:00Z",
  "HealthCheckTargetIp": "2.2.XX.XX",
  "Status": "Active",
  "CreationTime": "2022-04-14T08:57:24Z",
  "ReservationOrderType": "RENEW",
  "OppositeInterfaceId": "ri-bp1xkrzttximaoxbl****",
  "Spec": "Mini.2",
  "ChargeType": "AfterPay",
  "RouterInterfaceId": "ri-m5egfc10sednwk2yt****",
  "Message": "successful",
  "HcThreshold": 8,
  "OppositeRouterType": "VRouter",
  "GmtModified": "2022-04-28T10:02:12Z",
  "VpcInstanceId": "vpc-bp1b49rqrybk45nio****",
  "OppositeInterfaceOwnerId": "1321932713****",
  "OppositeVpcInstanceId": "vpc-bp1b49rqrybk45nio****",
  "ReservationInternetChargeType": "PayByBandwidth",
  "CrossBorder": false,
  "RequestId": "01818199-04F6-47F4-9ADF-7CC824CF57A4",
  "Bandwidth": 2,
  "Description": "对端接口",
  "HcRate": 2,
  "ReservationBandwidth": "100",
  "Code": "200",
  "Name": "路由器接口1",
  "OppositeRouterId": "vrt-bp11xvy6lb9photuu****",
  "OppositeInterfaceSpec": "Negative",
  "RouterId": "vbr-m5ex0xf63xk8s5bob****",
  "Success": true,
  "OppositeInterfaceBusinessStatus": "Normal",
  "ConnectedTime": "2022-04-14T08:58:04Z",
  "HealthCheckSourceIp": "1.1.XX.XX",
  "OppositeInterfaceStatus": "Active",
  "EndTime": "2999-09-08T16:00:00Z",
  "OppositeRegionId": "cn-hangzhou",
  "OppositeAccessPointId": "ap-cn-qingdao-ls-B",
  "BusinessStatus": "Normal",
  "HealthCheckStatus": "normal",
  "OppositeBandwidth": 0,
  "RouterType": "VRouter",
  "Role": "InitiatingSide",
  "HasReservationData": "false",
  "AccessPointId": "ap-cn-qingdao-ls-A",
  "ResourceGroupId": "rg-acfmxazb4ph6aiy****",
  "Tags": {
    "Tags": [
      {
        "Key": "FinanceDept",
        "Value": "FinanceJoshua"
      }
    ]
  },
  "FastLinkMode": "false"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParam.NotNull	The parameter must not be null.	参数不能为空。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-09-11	OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更	查看变更详情
2023-07-24	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-07-20	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-09-14	OpenAPI 错误码发生变更	查看变更详情
2022-09-14	OpenAPI 错误码发生变更	查看变更详情