CreatePrivateConnect

1. 接口描述

调用本接口用于创建二层网络专线。

准备工作

查询机型规格：调用 DescribeZoneInstanceConfigInfos 可以查询到规格信息。
查询镜像：调用DescribeImages可以查询到镜像信息。

注意事项

实例创建成功后将自动开机启动，实例状态变为RUNNING(运行中)。
预付费实例的购买会预先扣除本次实例购买所需金额，如果余额不足，请求将会失败。后付费实例购买时需要确保账户账号状态正常。
调用本接口创建实例，支持代金券自动抵扣，详情请参考代金券选用规则。
本接口为异步接口，当创建实例请求下发成功后会返回一个实例ID列表，此时创建实例操作并未立即完成。在此期间实例的状态将会处于PENDING或DEPLOYING，实例创建结果可以通过调用DescribeInstances 接口查询，如果实例状态(instanceStatus)由CREATING(创建中)或PENDING(等待创建）变为RUNNING(运行中)，则代表实例创建成功，如果未查询到任何实例，则代表创建失败，创建过程中不可对实例进行任何操作。
单次

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
	否	String	付费类型。 PREPAID：预付费，即包年包月。 POSTPAID：后付费。
	否	Array of String	二层网络专线ID列表。最多支持100个ID查询。
privateConnectName	否	String	机器实例名称。该条件为模糊匹配。
	否	String	EIP状态。
endpointTypes	否	Array of String	二层网络专线端点的类型。可选值有：
resourceGroupId	否	String	资源组的ID。如果不传，则返回该用户可见的所有资源组内的EIP。
pageNum	否	Integer	返回的分页数。默认为1。
pageSize	否	Integer	返回的分页大小。默认为20，最大为1000。

参数名称

必选

类型

描述

否

String

付费类型。

PREPAID：预付费，即包年包月。

POSTPAID：后付费。

否

Array of String

二层网络专线ID列表。最多支持100个ID查询。

privateConnectName

否

String

机器实例名称。该条件为模糊匹配。

否

String

EIP状态。

endpointTypes

否

Array of String

二层网络专线端点的类型。可选值有：

resourceGroupId

否

String

资源组的ID。

如果不传，则返回该用户可见的所有资源组内的EIP。

pageNum

否

Integer

返回的分页数。

默认为1。

pageSize

否

Integer

返回的分页大小。

默认为20，最大为1000。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
dataSet	Array of EipAddress	EIP列表。
totalCount	Integer	符合条件的EIP总数量。

参数名称

类型

描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

dataSet

Array of EipAddress

EIP列表。

totalCount

Integer

符合条件的EIP总数量。

4. 代码示例

1. 列表根据eipChargeType搜索

POST / HTTP/1.1
Host: console.zenlayer.com/api/v2/bmc
Content-Type: application/json
X-ZC-Action: DescribeEipAddresses
<Common Request Params>

Request：
{
    "eipChargeType": "PREPAID"
}

Response：
{   
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"，
     "dataSet": [
         {
            "eipId": "eipId1",
            "zoneId": "SEL-A",
            "ipAddress": "x.x.x.x",
            "instanceId": "instanceId1",
            "instanceName": "instanceName",
            "eipChargeType": "PREPAID",
            "period": 1,
            "createTime": "2022-09-25T16:53:38Z",
            "expiredTime": "2022-10-25T16:53:38Z",
            "eipStatus": "AVAILABLE",
            "resourceGroupId": "xx",
            "resourceGroupName": "xx"
         }
     ],
     totalCount: 1
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

最后更新于11小时前