You need to enable JavaScript to run this app.
导航
云企业网
  • 文档首页
    • /
  • 云企业网

DescribeCenAttachedInstances

最近更新时间：2024.04.22 17:41:14

首次发布时间：2022.01.07 11:44:37

我的收藏

调用 DescribeCenAttachedInstances 接口，查询符合要求的网络实例的详细信息。

调试

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

请求参数

参数名称
类型
是否必选
示例值
描述
ActionString是DescribeCenAttachedInstances要执行的操作，取值为DescribeCenAttachedInstances。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
CenIdString否cen-7qthudw0ll6jmc****CEN的ID。您可以调用DescribeCens接口获取云企业网实例ID。

InstanceId

String

否

vpc-2fexiqjlgjif45oxruvso****

网络实例的ID。

InstanceType

String

否

VPC

网络实例的类型，取值如下：

  • VPC：私有网络
  • DCGW：专线网关
InstanceRegionIdString否cn-beijing网络实例所属Region。
PageNumberInteger否1列表的页码。默认值为1。
PageSizeInteger否20分页查询时每页的行数。取值范围为1～100，默认值为20。

返回参数

参数名称
类型
示例值
描述
RequestIdString202111161611080102121461940900****请求ID。
TotalCountInteger10满足指定条件的网络实例总数。
PageNumberInteger1当前页码。
PageSizeInteger20当前分页的行数。
AttachedInstancesArray of Struct-网络实例的详细信息。具体请参见“ AttachedInstance结构 ”。

AttachedInstance结构

参数名称
类型
示例值
描述
CenIdStringcen-7qthudw0ll6jmc****云企业网实例的ID。
InstanceIdStringvpc-2fexiqjlgjif45oxruvso****网络实例的ID。
InstanceOwnerIdString210000****网络实例所属账号的ID。
InstanceTypeStringVPC网络实例的类型。
InstanceRegionIdStringcn-beijing网络实例所在的地域。

Status

String

Available

网络实例的加载状态。

  • Attaching：加载中
  • Available：可用
CreationTimeString2021-01-28T14:55:11+08:00网络实例的创建时间。

请求示例

GET /?Action=DescribeCenAttachedInstances&Version=2020-04-01&CenId=cen-7qthudw0ll6jmc****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
Service: cen
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021122212230001022513314307DBC68C",
        "Action": "DescribeCenAttachedInstances",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result":{
        "AttachedInstances": [
          {
            "CenId": "cen-7qthudw0ll6jmc****",
            "InstanceId": "vpc-2fexiqjlgjif45oxruvso****",
            "InstanceRegionId": "cn-beijing",
            "InstanceOwnerId": "210000****",
            "InstanceType": "VPC",
            "Status": "Available",
            "CreationTime": "2021-01-28T14:55:11+08:00"
          }
        ],
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1
		}
}

错误码

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

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