文档

DescribeEpnInstances - 查询边边网络实例

更新时间:

调用DescribeEpnInstances查询边边网络实例。

调试

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

授权信息

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

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

请求参数

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

版本号。

2017-11-10
EPNInstanceNamestring

边边网络实例名称。

testEPNInstanceName
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

10

返回参数

名称类型描述示例值
object
EPNInstancesobject []

边边网络实例。

CreationTimestring

创建时间,UTC 时间格式。

2019-11-01T06:08:46Z
EPNInstanceIdstring

边边网络实例 ID。

epn****
EPNInstanceNamestring

边边通信实例名称。

ens_test_epn
EPNInstanceTypestring

边边通信:EdgeToEdge。

EdgeToEdge
EndTimestring

结束时间,UTC 时间格式。

2019-11-01T06:08:46Z
InternetMaxBandwidthOutinteger

上行限速带宽,单位 Mbps。

40
ModifyTimestring

修改时间,UTC 时间格式。

2019-11-01T06:08:46Z
NetworkingModelstring

组网模式,取值:

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

开始时间,UTC 时间格式。

2019-11-01T06:08:46Z
Statusstring

运行状态:

  • Running:运行中。
  • Excuting:执行中。
  • Stopped:已停止。
Running
PageNumberinteger

列表的页码。

1
PageSizeinteger

分页查询时每页的行数。

40
RequestIdstring

请求 ID。

A1707FC0-430C-423A-B624-284046B20399
TotalCountinteger

总页数。

1

示例

正常返回示例

JSON格式

{
  "EPNInstances": {
    "EPNInstance": [
      {
        "CreationTime": "2019-11-01T06:08:46Z",
        "EPNInstanceId": "epn****",
        "EPNInstanceName": "ens_test_epn",
        "EPNInstanceType": "EdgeToEdge",
        "EndTime": "2019-11-01T06:08:46Z",
        "InternetMaxBandwidthOut": 40,
        "ModifyTime": "2019-11-01T06:08:46Z",
        "NetworkingModel": "SpeedUp",
        "StartTime": "2019-11-01T06:08:46Z",
        "Status": "Running"
      }
    ]
  },
  "PageNumber": 1,
  "PageSize": 40,
  "RequestId": "A1707FC0-430C-423A-B624-284046B20399",
  "TotalCount": 1
}

错误码

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 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    错误码 400 变更
  • 本页导读 (1)
文档反馈