DescribeEpnInstanceAttribute - 查询边边通组网信息

调用DescribeEpnInstanceAttribute查询边边通信组网信息。

接口说明

内网模式下 instaces 为空,公网模式下 vswitch 为空。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
EPNInstanceIdstring

边边网络实例 ID。

epn-xxxx

返回参数

名称类型描述示例值
object
ConfVersionsarray<object>

边边网络配置信息。

ConfVersionsobject
ConfVersionstring

版本号。

2017-10-11
EnsRegionIdstring

节点 ID。

cn-chengdu-telecom
EPNInstanceIdstring

边边网络实例 ID。

epn-xxxx
EPNInstanceNamestring

边边网络实例名称。

epn-test
Instancesarray<object>

实例信息。

EPNInstanceobject
EnsRegionIdstring

节点 ID。

cn-chengdu-telecom-4
InstanceIdstring

实例 ID。

epn-xxx
InstanceNamestring

实例名称。

epn-test
Ispstring

运营商取值:

  • cmcc:移动。
  • unicom:联通。
  • telecom:电信。
cmcc
PrivateIpAddressstring

私网 IP。

192.168.1.12
PublicIpAddressstring

公网 IP。

20.3.XX.XX
Statusstring

实例状态如下所示:

  • Running:运行中。
  • Stopped:已停止。
  • Expired:已过期。
Running
NetworkingModelstring

组网模式,取值:

  • 智能加速(外网):SpeedUp。
  • 内网联通(内网模式):Connection。
  • 智能加速及内网联通(内网模式):SpeedUpAndConnection。
SpeedUp
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
VSwitchesarray<object>

交换机信息。

EPNInstanceobject
CidrBlockstring

Cidr 地址段。

10.0.0.1/24
EnsRegionIdstring

节点 ID。

cn-chengdu-telecom-4
VSwitchIdstring

交换机 ID。

vs-xxxx
VSwitchNamestring

交换机名称。

vs-test

示例

正常返回示例

JSON格式

{
  "ConfVersions": [
    {
      "ConfVersion": "2017-10-11",
      "EnsRegionId": "cn-chengdu-telecom"
    }
  ],
  "EPNInstanceId": "epn-xxxx",
  "EPNInstanceName": "epn-test",
  "Instances": [
    {
      "EnsRegionId": "cn-chengdu-telecom-4",
      "InstanceId": "epn-xxx",
      "InstanceName": "epn-test",
      "Isp": "cmcc",
      "PrivateIpAddress": "192.168.1.12",
      "PublicIpAddress": "20.3.XX.XX",
      "Status": "Running"
    }
  ],
  "NetworkingModel": "SpeedUp",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "VSwitches": [
    {
      "CidrBlock": "10.0.0.1/24",
      "EnsRegionId": "\t cn-chengdu-telecom-4",
      "VSwitchId": "vs-xxxx",
      "VSwitchName": "vs-test"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.接口调用出错。

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

变更历史

变更时间变更内容概要操作
2023-12-26OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情