接口功能介绍
调用此接口可删除未绑定云产品实例的弹性公网IP
准备工作:
构造请求:在调用前需要了解如何构造请求,详情查看构造请求
认证鉴权:openapi请求需要进行加密调用,详细查看认证鉴权
接口约束
1.待删除的弹性公网IP需未绑定任何云产品实例。
URI
POST /v4/ecs/eip/delete
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
clientToken | 是 | String | 客户端存根,用于保证订单幂等性。要求单个云平台账户内唯一,使用同一个ClientToken值,则代表为同一个请求。保留时间为24小时 | delete-eip-test | |
regionID | 是 | String | 资源池ID,您可以查看地域和可用区来了解资源池 获取: 查 资源池列表查询 |
bb9fdb42056f11eda1610242ac110002 | |
projectID | 否 | String | 企业项目ID,企业项目管理服务提供统一的云资源按企业项目管理,以及企业项目内的资源管理,成员管理。您可以通过查看创建企业项目了解如何创建企业项目 注:默认值为"0" |
0 | |
eipID | 是 | String | 弹性公网IP的ID,您可以查看产品定义-弹性IP来了解弹性公网IP 获取: 查 查询指定地域已创建的弹性IP |
eip-ltx6mbna3g |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 | |
errorCode | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
error | String | 错误码,为product.module.code三段式码 | Openapi.PatternCheck.NotValid | |
message | String | 失败时的错误信息 | success | |
description | String | 失败时的错误描述 | 成功 | |
returnObj | Object | 成功时返回的数据 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后,可以使用materOrderID进一步确认订单状态及资源状态 | 235145e4489811eda8330242ac110002 | |
masterOrderNO | String | 订单号 | 20221010142913884246 | |
regionID | String | 资源池ID | 81f7728662dd11ec810800155d307d5b |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
示例:删除一个弹性IP
{
"regionID": "bb9fdb42056f11eda1610242ac110002",
"clientToken": "delete-eip-test",
"eipID": "eip-ltx6mbna3g"
}
响应示例
{
"statusCode": 800,
"message": "SUCCESS",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": {
"masterOrderID": "55d531d7bf2d47658897c42ffb918423",
"masterOrderNO": "20221021191602644224",
"regionID": "81f7728662dd11ec810800155d307d5b"
}
}
状态码
请参考 状态码
错误码
请参考 错误码