绑定HaVip和ecs实例

POST

/v4/vpc/havip/bind

将HaVip绑定到ECS实例上，由于绑定是异步操作，在第一次请求后，并不会立即返回绑定结果，
调用者在获取到绑定状态为 in_progress 时，继续使用相同参数进行请求，获取最新的绑定结果，
直到最后的绑定状态为 done 即可停止请求。

请求参数

Header 参数

Authorization

string

可选

示例值:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJbmZvIjp7InVzZXJJRCI6ImVmMzc4ZjczLTFjNTItNDM1ZS05MGYyLTZhOWNkMjI1OGM4ZSIsInVzZXJOYW1lIjoi6LaF57qn566h55CG5ZGYIiwicm9sZUxpc3QiOlsiVkRDQWRtaW4iLCJTdXBlckFkbWluIl0sImlzQWRtaW4iOnRydWUsImlzVkRDQWRtaW4iOnRydWUsImJvdW5kR3JvdXBMaXN0IjpbImU1Y2EyMDg1LTdmZDgtNDY1YS05MzRhLTI2N2M5NWZiNjZlNyJdLCJ1c2VyVHlwZSI6NCwicGFzc3dvcmRFeHBpcmVkIjpmYWxzZX0sImlzcyI6IkNUU3RhY2tDTVAiLCJzdWIiOiJyYmFjIiwiZXhwIjoxNzA2NzIzODk3LCJpYXQiOjE3MDY3MTY5OTd9.dyfHmAQznCguBQpBlmRf5uWF1AkokZn_p_AtLmKrNLc

userId

string

可选

示例值:

ef378f73-1c52-435e-90f2-6a9cd2258c8e

vdcId

string

可选

示例值:

002ccb7f-8168-4694-b1af-e96df496a61b

ctUserId

string

可选

示例值:

ef378f73-1c52-435e-90f2-6a9cd2258c8e

Body 参数application/json

regionID

string

资源池id

必需

haVipID

string

VIP ID

必需

instanceID

string

可选

ECS示例ID，当 resourceType 为 VM / PM 时，必填

azName

string

可用区名称

可选

projectID

string

可选

项目id（非必填，并且此字段在私有云不具有实际意义）

resourceType

string

必需

绑定实例类型
VM-虚拟机ECS；PM-裸金属,；NETWORK-弹性 IP

networkInterfaceID

string

网卡ID

必需

clientToken

string

可选

客户端存根，可传但是不进行校验（非必填，并且此字段在私有云不具有实际意义）

floatingID

string

可选

弹性IP ID，当 resourceType 为 NETWORK 时，必填

示例

{
    "regionID": "TestRegionID",
    "haVipID": "52f17564-6a39-46e7-8da4-bb5dc27f9651",
    "instanceID": "eb610c26-69af-42d8-a9a9-12cd7bf7b9df",
    "resourceType": "VM",
    "networkInterfaceID": "29d29941-f0dd-496c-8f93-d028d24333f6"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v4/vpc/havip/bind' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJbmZvIjp7InVzZXJJRCI6ImVmMzc4ZjczLTFjNTItNDM1ZS05MGYyLTZhOWNkMjI1OGM4ZSIsInVzZXJOYW1lIjoi6LaF57qn566h55CG5ZGYIiwicm9sZUxpc3QiOlsiVkRDQWRtaW4iLCJTdXBlckFkbWluIl0sImlzQWRtaW4iOnRydWUsImlzVkRDQWRtaW4iOnRydWUsImJvdW5kR3JvdXBMaXN0IjpbImU1Y2EyMDg1LTdmZDgtNDY1YS05MzRhLTI2N2M5NWZiNjZlNyJdLCJ1c2VyVHlwZSI6NCwicGFzc3dvcmRFeHBpcmVkIjpmYWxzZX0sImlzcyI6IkNUU3RhY2tDTVAiLCJzdWIiOiJyYmFjIiwiZXhwIjoxNzA2NzIzODk3LCJpYXQiOjE3MDY3MTY5OTd9.dyfHmAQznCguBQpBlmRf5uWF1AkokZn_p_AtLmKrNLc' \
--header 'userId: ef378f73-1c52-435e-90f2-6a9cd2258c8e' \
--header 'vdcId: 002ccb7f-8168-4694-b1af-e96df496a61b' \
--header 'ctUserId: ef378f73-1c52-435e-90f2-6a9cd2258c8e' \
--header 'Content-Type: application/json' \
--data-raw '{
    "regionID": "TestRegionID",
    "haVipID": "52f17564-6a39-46e7-8da4-bb5dc27f9651",
    "instanceID": "eb610c26-69af-42d8-a9a9-12cd7bf7b9df",
    "resourceType": "VM",
    "networkInterfaceID": "29d29941-f0dd-496c-8f93-d028d24333f6"
}'

返回响应

🟢200successful operation

application/json

Body

returnObj

array[string]

响应对象

可选

statusCode

integer

可选

返回状态码（800 为成功，900 为失败）

description

string

描述

可选

errorCode

string

错误码

可选

message

string

错误说明

可选

示例

{
    "description": "虚拟ip访问底层失败",
    "errorCode": "vip.phybcloud.001",
    "message": "原因：Vip matching query does not exist.",
    "statusCode": 900
}

修改于 2024-08-07 09:10:48

查询HaVip

解绑HaVip