DescribeCenAttachedInstances--云企业网-火山引擎

文档中心

立即注册

导航

DescribeCenAttachedInstances

最近更新时间：2024.10.18 15:45:55首次发布时间：2022.01.07 11:44:37

调用 DescribeCenAttachedInstances 接口，查询满足指定条件的网络实例。

调试

API Explorer

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

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCenAttachedInstances	要执行的操作，取值为DescribeCenAttachedInstances。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
CenId	String	否	cen-7qthudw0ll6jmc****	CEN的ID。您可以调用DescribeCens接口，查询云企业网实例ID。
InstanceRegionId	String	否	cn-beijing	网络实例所属Region。
InstanceType	String	否	VPC	网络实例的类型，取值如下： VPC：私有网络 DCGW：专线网关
InstanceId	String	否	vpc-2fexiqjlgjif45oxruvso****	网络实例的ID。您可以调用DescribeVpcs接口，查询“VPC”类型网络实例的ID。您可以调用DescribeDirectConnectGateways接口，查询“DCGW”类型网络实例的ID。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	20	分页查询时每页的行数。取值范围为1～100，默认值为20。

返回参数

参数名称	类型	示例值	描述
TotalCount	Integer	10	满足指定条件的网络实例总数。
PageNumber	Integer	1	当前页码。
PageSize	Integer	20	当前分页的行数。
AttachedInstances	Array of Struct	-	网络实例的详细信息。具体请参见“ AttachedInstance结构 ”。

AttachedInstance结构

参数名称	类型	示例值	描述
CenId	String	cen-7qthudw0ll6jmc****	云企业网实例的ID。
InstanceId	String	vpc-2fexiqjlgjif45oxruvso****	网络实例的ID。
InstanceOwnerId	String	210000****	网络实例所属账号的ID。
InstanceType	String	VPC	网络实例的类型。
InstanceRegionId	String	cn-beijing	网络实例所在的地域。
Status	String	Available	网络实例的加载状态。 Attaching：加载中 Available：可用
CreationTime	String	2021-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": "2021122212230001022513314307DB****",
        "Action": "DescribeCenAttachedInstances",
        "Version": "2020-04-01",
        "Service": "cen",
        "Region": "cn-beijing"
    },
    "Result":{
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 20,
        "AttachedInstances": [
          {
            "CenId": "cen-7qthudw0ll6jmc****",
            "InstanceId": "vpc-2fexiqjlgjif45oxruvso****",
            "InstanceRegionId": "ap-southeast-1",
            "InstanceOwnerId": "210000****",
            "InstanceType": "VPC",
            "Status": "Available",
            "CreationTime": "2021-01-28T14:55:11+08:00"
          }
        ]
		}
}

错误码

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

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