EIP说明

弹性公网IP是可以独立购买和持有的公网IP地址资源,可以动态的与云服务器、云路由器以及负载均衡器绑定,使其与互联网相连接。绑定和解绑弹性公网IP时无需停机。 云服务器和负载均衡器允许绑定多个公网IP。云路由器仅可绑定一个公网IP,为云路由器及挂载在云路由器上的子网提供互联网接入。

EIP相关接口

1. CreateEIP

创建EIP实例,创建弹性IP的计费模式有两种,一种是包年包月(预付费),一种是按需计(后付费),其中按需计费又有两种计费方式:按带宽和按共享带宽。模式为:异步。

请求方式:POST

请求参数

名称 类型 是否必须 描述
Action String CreateEip
Bandwidth Integer EIP带宽大小
BillType String 计费方式---1.monthly:按月; 2.hourlySettlement:按小时实时结算(即按需)。
Duration String 购买时长---BillType为monthly时必传。

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

创建一条EIP(按需计费)

请求示例

URL:

https://eip.cn-north-3.inspurcloudapi.com/?Action=CreateEip&Bandwidth=2&BillType=hourlySettlement&Nonce=6213&Timestamp=1555717904&Version=2019-01-31

响应示例

{
    "result": {
        "result": true,
        "orderId": "158268118095429632"
    },
    "code": "0",
    "requestId": "f30fc46d-b451-4fc5-bee2-3a51abde7b62",
    "message": "创建订单成功!"
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999400 SC_PARAM_ERROR 400
106.102503 SC_OPENSTACK_FIPCREATE_ERROR 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

示例

创建一条EIP(包年包月计费)

请求示例

URL:

https://eip.cn-north-3.inspurcloudapi.com/?Action=CreateEip&Bandwidth=2&BillType=monthly&Nonce=625&Timestamp=1555717904&Version=2019-01-31&Duration=1

响应示例

{
    "result": {
        "result": true,
        "orderId": "160048706731835392"
    },
    "code": "0",
    "requestId": "5ccbaaa0-cc37-4e9c-845f-1a9fac724a86",
    "message": "创建订单成功!"
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999400 SC_PARAM_ERROR 400
106.102503 SC_OPENSTACK_FIPCREATE_ERROR 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

2. DeleteEip

第三方调用,释放EIP实例。 请求方式:DELETE

请求参数

名称 类型 是否必须 描述
Action String DeleteEip
EipId String EIPUUID

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

删除一条Eip

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=DeleteEip&EipId=a3c9a4f3-7d0b-4a2c-93aa-600437f36ecc&Nonce=21631&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "DeleteEipResponse":{
    "result": {
      "result": "true",
      "orderId": "160049681802657792"
    },
    "code": "0",
    "requestId": "ee27e798-0dca-4d57-8ab5-00f181426d4e",
    "message": "创建订单成功!"
}
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.994400 SC_PARAM_UNKONWERROR 400
106.999500 SC_INTERNAL_SERVER_ERROR 500

3. Bind EIP

将一条EIP绑定到一台ECS服务器上。

请求方式:PUT

请求参数

名称 类型 是否必须 描述
Action String BindEip
EipId String EIP的Id
PortId String 绑定服务器的端口的Id
ServerId String 绑定服务器的Id
Type String 用来区分EIP绑定的是云服务器,云物理机,负载均衡(1.云服务器.2.云物理机.3.负载均衡)

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

一条EIP绑定到一台ECS服务器上。

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=BindEip&EipId=616b3c47-8e57-43e1-bb01-b78ee61db540&PortId=65ad697d-aad0-460d-b332-02650be2d730&ServerId=1f1305f4-034f-4a03-8fe1-12f1c0c986bb&Type=1&Nonce=221332&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "BindEipResponse": {
    "RequestId": "9eb56bf9-5dc3-4841-bc25-91bd7e82b1ab",
    "Eip": {
      "Eip_address": "10.110.38.136",
      "Resourceset": {
        "Resourceid": "1f1305f4-034f-4a03-8fe1-12f1c0c986bb",
        "Resourcetype": "1"
      },
      "OldBandwidth": "2",
      "Bandwidth": "3",
      "Chargemode": "Bandwidth",
      "Eipid": "616b3c47-8e57-43e1-bb01-b78ee61db540",
      "BillType": "monthly",
      "Private_ip_address": "172.31.0.28",
      "Iptype": "BGP",
      "Create_at": "2019-03-17 15:36:27",
      "Region": "cn-north-3",
      "Status": "ACTIVE"
    }

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
006.999400 SC_PARAM_ERROR 400
006.999500 SC_INTERNAL_SERVER_ERROR 500
006.994404 SC_NOT_FOUND 404
006.991400 EIP_BIND_HAS_BAND 400
006.101503 SC_OPENSTACK_SERVER_ERROR 500

4. Unbind EIP

将一条EIP与一台ECS服务器解绑。

请求方式:PUT

请求参数

名称 类型 是否必须 描述
Action String UnbindEip
EipId String EIP的Id
PortId String 绑定服务器的端口的Id
ServerId String 绑定服务器的Id
Type String 表示绑的是云服务器

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

一条EIP与一台ECS服务器解绑。

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=UnbindEip&EipId=616b3c47-8e57-43e1-bb01-b78ee61db540&PortId=&ServerId=&Type=&Nonce=2212&Timestamp=1555717904&Version=2019-01-31

响应示例


{
  "UnbindEipResponse": {
    "RequestId": "e4899ffd-ec35-472f-94fd-91c356236efb",
    "Eip": {
      "Eip_address": "10.110.38.136",
      "Resourceset": {
        "Resourceid": "null",
        "Resourcetype": "null"
      },
      "OldBandwidth": "2",
      "Bandwidth": "3",
      "Chargemode": "Bandwidth",
      "Eipid": "616b3c47-8e57-43e1-bb01-b78ee61db540",
      "BillType": "monthly",
      "Iptype": "BGP",
      "Create_at": "2019-03-17 07:36:27",
      "Region": "cn-north-3",
      "Status": "DOWN"
    }
  }

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.101503 SC_OPENSTACK_SERVER_ERROR 400
106.994400 SC_RESOURCE_ERROR 500
106.999400 SC_PARAM_ERROR 500
106.994404 SC_NOT_FOUND 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

5. Update the Eip bindwidth

当业务量发生变动需要变更带宽时,可以在线调带宽,支持增大和减小带宽。 注意:按需eip的带宽可调大或调小,包年包月的带宽只能调大

请求方式:PUT

请求参数

名称 类型 是否必须 描述
Action String UpdateBindWidth
EipId String EIP的Id
NewBandwidth String 升级的EIP的带宽

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

更新一条EIP的带宽(按需计费)。

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=UpdateBindWidth&EipId=c9254416-b96c-4ae1-b781-41b7e105bae5&NewBandwidth=9&Nonce=2116&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "UpdateBindWidthResponse": {
    "Result": {
      "Result": "true",
      "OrderId": "160056673372667904"
    },
    "Code": "0",
    "RequestId": "d62ab180-ed0e-4652-add5-bad1388a7b3b",
    "Message": "创建订单成功!"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.994404 SC_NOT_FOUND 404
106.999400 SC_PARAM_ERROR 400
106.201503 SC_FIREWALL_SERVER_ERROR 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

示例

更新一条EIP的带宽(包年包月计费)。

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=UpdateBindWidth&EipId=d8932410-ab8f-41b3-908f-d2fd9d6cb83c&NewBandwidth=5&Nonce=21165&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "UpdateBindWidthResponse": {
    "Result": {
      "Result": "true",
      "OrderId": "160062565782585344"
    },
    "Code": "0",
    "RequestId": "4c1e9e54-0f53-4400-a684-1f4f3e96968c",
    "Message": "创建订单成功!"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.994404 SC_NOT_FOUND 404
106.999400 SC_PARAM_ERROR 400
106.201503 SC_FIREWALL_SERVER_ERROR 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

6. List Eips

查询所有EIP信息

请求方式:GET

请求参数

名称 类型 是否必须 描述
Action String ListEip
CurrentPage String 当前页
Limit String 每页记录条数

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

查询所有EIP信息

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=ListEip&CurrentPage=1&Limit=20&Nonce=921&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "ListEipResponse": {
    "CurrentPagePer": "20",
    "RequestId": "5716fda1-b0b6-46ab-9842-3c9b258127b4",
    "EipsContainer": {
      "Eips": [
        {
          "Eip_address": "10.110.38.139",
          "Resourceset": {
            "Resourceid": "null",
            "Resourcetype": "null"
          },
          "OldBandwidth": "1",
          "Bandwidth": "2",
          "Chargemode": "Bandwidth",
          "Eipid": "fe7b0c2c-e208-4f36-af40-654e943f2142",
          "BillType": "monthly",
          "Iptype": "BGP",
          "Create_at": "2019-03-18 08:13:29",
          "Region": "cn-north-3",
          "Status": "DOWN"
        },
        {
          "Eip_address": "10.110.38.136",
          "Resourceset": {
            "Resourceid": "null",
            "Resourcetype": "null"
          },
          "OldBandwidth": "1",
          "Bandwidth": "2",
          "Chargemode": "Bandwidth",
          "Eipid": "616b3c47-8e57-43e1-bb01-b78ee61db540",
          "BillType": "monthly",
          "Iptype": "BGP",
          "Create_at": "2019-03-18 07:36:27",
          "Region": "cn-north-3",
          "Status": "DOWN"
        }
      ]
    },
    "TotalPages": "1",
    "CurrentPage": "1",
    "TotalElements": "2"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.001403 SC_FORBIDDEN 401
106.999500 SC_INTERNAL_SERVER_ERROR 500
106.999400 SC_PARAM_ERROR 400

7. Show a EIP details

查询单个EIP信息

请求方式:GET

请求参数

名称 类型 是否必须 描述
Action String GetEip
EipId String EIPUUID

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

显示单个Eip的相关信息

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=GetEip&EipId=5676dd4a-923b-4460-9ef3-2fe328c82a1f&Nonce=541&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "GetEipResponse": {
    "RequestId": "8a634b46-5e44-401d-9332-67542a5a4ba4",
    "Eip": {
      "Eip_address": "10.110.38.137",
      "Resourceset": {
        "Resourceid": "null",
        "Resourcetype": "null"
      },
      "OldBandwidth": "2",
      "Bandwidth": "8",
      "Chargemode": "Bandwidth",
      "Eipid": "5676dd4a-923b-4460-9ef3-2fe328c82a1f",
      "BillType": "hourlySettlement",
      "Iptype": "BGP",
      "Create_at": "2019-03-18 07:29:15",
      "Region": "cn-north-3",
      "Status": "DOWN"
    }
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.001403 SC_FORBIDDEN 401
106.999500 SC_INTERNAL_SERVER_ERROR 500

8. Renew EIP

EIP续费(包年包月)

请求方式:PUT

请求参数

名称 类型 是否必须 描述
Action String RenewEip
EipId String EIPUUID
Duration String 购买时长

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

对包年包月类型的Eip进行续费操作

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=RenewEip&EipId=fceeaabf—fc6d-4270-8abe-68ae597ecb3f&Duration=2&Nonce=922182&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "RenewEipResponse": {
    "Result": {
      "Result": "true",
      "OrderId": "160468936183709696"
    },
    "Code": "0",
    "RequestId": "0c460499-5cca-44ad-b8b9-aee938c8e4be",
    "Message": "创建订单成功!"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.994404 SC_NOT_FOUND 404
106.999500 Bad Request 400
106.999500 Forbiden 403
106.999500 SC_INTERNAL_SERVER_ERROR 500

共享带宽相关接口

1. CreateSbw

创建共享带宽实例,创建共享带宽的计费模式有两种,一种是包年包月(预付费),一种是按需计(后付费)。模式为:异步。 目前支持包年包月模式创建。

请求方式:POST

请求参数

名称 类型 是否必须 描述
Action String CreateSbw
Bandwidth Integer 共享带宽大小
BillType String 计费方式---1.monthly:按月; 2.hourlySettlement:按小时实时结算(即按需)。
sbwName String 共享带宽的名字
Duration String 购买时长---BillType为monthly时必传。
DurationUnit String 购买时长单位---默认值:M(区分大小写)。BillType为monthly时必传。

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

创建一条共享带宽(包年包月)

请求示例

URL:

https://eip.cn-north-3.inspurcloudapi.com/?Action=CreateSbw&Bandwidth=7&BillType=monthly&Nonce=62372&Timestamp=1555717904&Version=2019-01-31&Format=json&sbwName=openapitest-smz&Duration=1&DurationUnit=M

响应示例

{
    "result": {
        "result": true,
        "orderId": "158268118095429632"
    },
    "code": "0",
    "requestId": "f30fc46d-b451-4fc5-bee2-3a51abde7b62",
    "message": "创建订单成功!"
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999400 SC_PARAM_ERROR 400
106.102503 SC_OPENSTACK_FIPCREATE_ERROR 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

示例

创建一条共享带宽(按需计费)

请求示例

URL:

https://eip.cn-north-3.inspurcloudapi.com/?Action=CreateSbw&Bandwidth=6&BillType=hourlySettlement&Nonce=62350&Timestamp=1555717904&Version=2019-01-31&sbwName=ccc

响应示例

{
    "result": {
        "result": true,
        "orderId": "169044120576655360"
    },
    "code": "0",
    "requestId": "8fb0977c-77dd-4cf0-b729-04823b2df8b1",
    "message": "创建订单成功!"
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999400 SC_PARAM_ERROR 400
106.102503 SC_OPENSTACK_FIPCREATE_ERROR 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

2. DeleteSbw

第三方调用,释放共享带宽实例。 请求方式:DELETE

请求参数

名称 类型 是否必须 描述
Action String DeleteSbw
SbwId String SBWUUID

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

删除一条共享带宽。

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=DeleteSbw&SbwId=eacef739-0486-4d6c-ad07-878ced4c35e9&Nonce=2163589&Timestamp=1555717904&Version=2019-01-31&Format=json

响应示例

{
    "result": {
        "result": true,
        "orderId": "169044564027834368"
    },
    "code": "0",
    "requestId": "58fb56f8-0320-4045-84ed-f560646dd83c",
    "message": "创建订单成功!"
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.994400 SC_PARAM_UNKONWERROR 400
106.999500 SC_INTERNAL_SERVER_ERROR 500

3. List Sbws

查询所有共享带宽信息

请求方式:GET

请求参数

名称 类型 是否必须 描述
Action String ListSbw
pageIndex String 当前页
pageSize String 每页记录条数

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

查询所有共享带宽信息

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=ListSbw&pageIndex=1&pageSize=20&Nonce=920&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "ListSbwResponse": {
    "CurrentPagePer": "2",
    "RequestId": "46820f58-3333-49cc-926b-4ac2d26293b5",
    "TotalPages": "1",
    "CurrentPage": "1",
    "SbwsContainer": {
      "Sbws": [
        {
          "Duration": "2",
          "Sbwid": "b9141748-a6ec-48b2-a242-bebf8fa165b2",
          "Bandwidth": "343",
          "Chargemode": "Bandwidth",
          "BillType": "monthly",
          "Ipcount": "1",
          "Create_at": "2019-03-28 23:45:34",
          "Sharedbandwidthname": "bbbbb",
          "Status": "ACTIVE"
        },
        {
          "Duration": "1",
          "Sbwid": "dad9c446-6c9c-4b61-8481-056111ccca62",
          "Bandwidth": "6",
          "Chargemode": "Bandwidth",
          "BillType": "hourlySettlement",
          "Ipcount": "0",
          "Create_at": "2019-04-12 01:40:45",
          "Sharedbandwidthname": "aaa",
          "Status": "ACTIVE"
        }
      ]
    },
    "TotalElements": "2"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.001403 SC_FORBIDDEN 401
106.999500 SC_INTERNAL_SERVER_ERROR 500
106.999400 SC_PARAM_ERROR 400

4. Sbw Details

查询共享带宽信息

请求方式:GET

请求参数

名称 类型 是否必须 描述
Action String SbwDetails
EipId String SbwId

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

显示单个Eip的相关信息

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=SbwDetails&SbwId=f383788e-6cb0-49aa-9e34-bc37f90b2844&Nonce=920&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "SbwDetailsResponse": {
    "RequestId": "57605b03-5ca6-41ee-b98c-f9d78531095f",
    "Sbw": {
      "Duration": "1",
      "Sbwid": "f383788e-6cb0-49aa-9e34-bc37f90b2844",
      "Bandwidth": "20",
      "Chargemode": "Bandwidth",
      "BillType": "hourlySettlement",
      "Ipcount": "0",
      "Create_at": "2019-04-12 08:01:07",
      "Sharedbandwidthname": "openapi-test",
      "Status": "ACTIVE"
    }
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.001404 SC_FORBIDDEN 404
106.999500 SC_INTERNAL_SERVER_ERROR 500

5. Sbw EipList

查询当前共享带宽下的EIP列表

请求方式:GET

请求参数

名称 类型 是否必须 描述
Action String SbwEipList
SbwId String SbwId

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

显示单个Eip的相关信息

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=SbwEipList&SbwId=86ac66dc-0264-4715-9b97-62ad1a952197&Nonce=92059&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "SbwEipListResponse": {
    "CurrentPagePer": "10",
    "RequestId": "6b18d5fd-c4ee-4af2-beb3-ef65cdf04d5d",
    "EipsContainer": {
      "Eips": {
        "Eip_address": "10.110.38.64",
        "Resourceset": {
          "Resourceid": "null",
          "Resourcetype": "null"
        },
        "OldBandwidth": "7",
        "Bandwidth": "5",
        "Chargemode": "SharedBandwidth",
        "Eipid": "c9254416-b96c-4ae1-b781-41b7e105bae5",
        "BillType": "hourlySettlement",
        "Sharedbandwidth_id": "86ac66dc-0264-4715-9b97-62ad1a952197",
        "Iptype": "BGP",
        "Create_at": "2019-04-15 02:45:09",
        "Region": "cn-north-3",
        "Status": "DOWN"
      }
    },
    "TotalPages": "1",
    "CurrentPage": "1",
    "TotalElements": "1"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.994400 SC_PARAM_UNKONWERROR 400
106.001403 SC_FORBIDDEN 401
106.999500 SC_INTERNAL_SERVER_ERROR 500

6. Rename Sbw

对当前共享带宽重新命名

请求方式:GET

请求参数

名称 类型 是否必须 描述
Action String RenameSbw
SbwId String SbwId
SbwName String 共享带宽的名字

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

重命名当前共享带宽

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=RenameSbw&SbwId=86ac66dc-0264-4715-9b97-62ad1a952197&SbwName=abb&Nonce=9205212&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "RenameSbwResponse": {
    "RequestId": "7779df8a-b606-4894-b12a-dcc3cf3e871f",
    "Sbw": {
      "Duration": "1",
      "Sbwid": "86ac66dc-0264-4715-9b97-62ad1a952197",
      "Bandwidth": "5",
      "Chargemode": "Bandwidth",
      "BillType": "hourlySettlement",
      "Ipcount": "1",
      "Create_at": "2019-04-15 02:44:30",
      "Sharedbandwidthname": "abb",
      "Status": "ACTIVE"
    }
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.994400 SC_PARAM_UNKONWERROR 400
106.001403 SC_FORBIDDEN 401
106.999500 SC_INTERNAL_SERVER_ERROR 500

7. Sbw UnbindEipList

查询当前用户共享带宽未绑定的Eip列表(EIP类型都是按需付费)

请求方式:GET

请求参数

名称 类型 是否必须 描述
Action String SbwUnbindEipList
SbwId String SbwId

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

查询当前用户共享带宽未绑定的Eip列表(EIP类型都是按需付费)

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=SbwUnbindEipList&SbwId=86ac66dc-0264-4715-9b97-62ad1a952197&Nonce=12356&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "SbwUnbindEipListResponse": {
    "RequestId": "fabbebd2-b1c2-45ce-aa40-cc167d9b874b",
    "EipsContainer": {
      "Eips": [
        {
          "Eip_address": "10.110.38.150",
          "OldBandwidth": "6",
          "Bandwidth": "6",
          "Chargemode": "Bandwidth",
          "Eipid": "63aa185b-f8c3-4b3a-b3d9-2bbc31bad62e",
          "BillType": "hourlySettlement",
          "Iptype": "BGP",
          "Create_at": "2019-04-12 07:57:20",
          "Region": "cn-north-3",
          "Status": "DOWN"
        },
        {
          "Eip_address": "10.110.38.111",
          "OldBandwidth": "1",
          "Bandwidth": "43",
          "Chargemode": "Bandwidth",
          "Eipid": "8e0a6afd-6234-43c5-a785-e43b7f2b3c13",
          "BillType": "hourlySettlement",
          "Iptype": "BGP",
          "Create_at": "2019-04-12 08:46:50",
          "Region": "cn-north-3",
          "Status": "DOWN"
        }
      ]
    }
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.001403 SC_FORBIDDEN 401
106.999500 SC_INTERNAL_SERVER_ERROR 500

8. Eip AddSbw

EIP加入共享带宽,。

请求方式:PUT

请求参数

名称 类型 是否必须 描述
Action String EipAddSbw
EipId String EIPUUID
SbwId String SBWUUID

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

将一条EIP加入到共享带宽。

请求示例

URL:

https://eip.cn-north-3.inspurcloudapi.com/?Action=EipAddSbw&EipId=63aa185b-f8c3-4b3a-b3d9-2bbc31bad62e&SbwId=f383788e-6cb0-49aa-9e34-bc37f90b2844&Nonce=2213&Timestamp=1555717904&Version=2019-01-31&Format=json

响应示例

{
    "result": {
        "result": true,
        "orderId": "169115899834466304"
    },
    "code": "0",
    "requestId": "9203519b-7dae-45a0-a658-b0f895f58ff7",
    "message": "创建订单成功!"
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999400 SC_PARAM_ERROR 400
106.999500 Forbiden 403
106.001404 SC_FORBIDDEN 404
106.999500 SC_INTERNAL_SERVER_ERROR 500

9. Eip RemoveSbw

EIP移出共享带宽,。

请求方式:PUT

请求参数

名称 类型 是否必须 描述
Action String EipAddSbw
EipId String EIPUUID
SbwId String SBWUUID

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

将一条EIP从共享带宽中移出。

请求示例

URL:

https://eip.cn-north-3.inspurcloudapi.com/?Action=EipRemoveSbw&EipId=63aa185b-f8c3-4b3a-b3d9-2bbc31bad62e&SbwId=f383788e-6cb0-49aa-9e34-bc37f90b2844&Nonce=221376&Timestamp=1555717904&Version=2019-01-31&Format=json

响应示例

{
    "result": {
        "result": true,
        "orderId": "169128733758783488"
    },
    "code": "0",
    "requestId": "e96d82a4-5696-4354-9bae-f6e5af184bfa",
    "message": "创建订单成功!"
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999400 SC_PARAM_ERROR 400
106.999500 Forbiden 403
106.001404 SC_FORBIDDEN 404
106.999500 SC_INTERNAL_SERVER_ERROR 500

10. Update the Sbw bindwidth

当业务量发生变动需要变更带宽时,可以在线调整共享带宽,支持增大和减小带宽。 注意:按需的共享带宽可调大或调小,包年包月的共享带宽只能调大。

请求方式:POST

请求参数

名称 类型 是否必须 描述
Action String UpdateSbwBindWidth
SbwId String SBW的Id
NewSbwBandwidth String 升级的共享带宽大小

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

更新一条共享带宽的带宽(按需计费)。

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=UpdateSbwBindWidth&SbwId=f383788e-6cb0-49aa-9e34-bc37f90b2844&NewSbwBandwidth=20&BillType=hourlySettlement&Nonce=2132367&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "UpdateBindWidthResponse": {
    "Result": {
      "Result": "true",
      "OrderId": "169130744604590080"
    },
    "Code": "0",
    "RequestId": "19eaba6c-6c2d-425f-bbcc-41d3f3e86f19",
    "Message": "创建订单成功!"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999400 SC_PARAM_ERROR 400
106.999500 Forbiden 403
106.994404 SC_NOT_FOUND 404
106.201503 SC_FIREWALL_SERVER_ERROR 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

示例

更新一条共享带宽的带宽(包年包月计费)。

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=UpdateSbwBindWidth&SbwId=9bca7a0a-9e9d-4c18-9651-787587ee38e9&NewSbwBandwidth=12&Nonce=2132369&Timestamp=1555717904&Version=2019-01-31&Duration=1

响应示例

{
  "UpdateBindWidthResponse": {
    "Result": {
      "Result": "true",
      "OrderId": "169132922664714240"
    },
    "Code": "0",
    "RequestId": "f21eb0c7-0c86-4f3d-bebc-51c28c7f73f3",
    "Message": "创建订单成功!"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999400 SC_PARAM_ERROR 400
106.999500 Forbiden 403
106.994404 SC_NOT_FOUND 404
106.201503 SC_FIREWALL_SERVER_ERROR 500
106.999500 SC_INTERNAL_SERVER_ERROR 500

11. Renew SBW

共享带宽续费(包年包月)

请求方式:PUT

请求参数

名称 类型 是否必须 描述
Action String RenewSbw
SbwId String SBWUUID
Duration String 购买时长

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。
result body String 返回结果

示例

对包年包月类型的Eip进行续费操作

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=RenewEip&EipId=fceeaabf—fc6d-4270-8abe-68ae597ecb3f&Duration=2&Nonce=922182&Timestamp=1555717904&Version=2019-01-31

响应示例

{
  "RenewEipResponse": {
    "Result": {
      "Result": "true",
      "OrderId": "160468936183709696"
    },
    "Code": "0",
    "RequestId": "0c460499-5cca-44ad-b8b9-aee938c8e4be",
    "Message": "创建订单成功!"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码
106.999500 Bad Request 400
106.999500 Forbiden 403
106.994404 SC_NOT_FOUND 404
106.999500 SC_INTERNAL_SERVER_ERROR 500

IPV6转换服务相关接口

1. CreateEipv6

创建eipv6实例,创建eipv6有两种方式,一是选择已有的eip,二是eip和eipv6同时创建。 (目前创建的Eipv6只能是按需的方式。)

请求方式:POST

请求参数

名称 位置 类型 是否必须 描述
Action path String CreateIpts
eipId path String Eip的Id
Bandwidth path String EIP带宽大小
BillType path String 计费方式---1.monthly:按月; 2.hourlySettlement:按小时实时结算(即按需)。

返回参数

名称 位置 类型 是否必须 描述
eipv6Id body String ipv6的Id
ipv6 body String ipv6地址
status body String ipv6的状态
createdTime body Date ipv6的创建时间
ipv4 body String eip的地址

示例

创建一条eipv6(使用已有的EIP)

请求示例

URL:

https://eip.cn-north-3.inspurcloudapi.com/?Action=CreateIpts&eipId=71936f16-f403-45a1-9db7-3c83279f8aba&Nonce=623566&Timestamp=1655717904&Version=2019-01-31

响应示例

{
  "CreateIptsResponse": {
    "Ipv4": "10.110.38.30",
    "Eipv6Id": "4599f9dd-594d-480a-a998-f99efd3ba23e",
    "CreateTime": "2019-07-15T09:52:30Z",
    "Ipv6": "1001::6e92:bfff:fe13:f403",
    "RequestId": "e40d865a-2fec-48e2-aba3-79206d5a8496",
    "Status": "ACTIVE"
  }
}

示例

创建一条eipv6(创建新的EIP)

请求示例

URL:

https://eip.cn-north-3.inspurcloudapi.com/?Action=CreateIptsBindEip&Bandwidth=2&Nonce=6266556&Timestamp=1655717904&BillType=hourlySettlement&Version=2019-01-31

响应示例

{
  "CreateIptsResponse": {
    "Ipv4": "10.110.38.30",
    "Eipv6Id": "4599f9dd-594d-480a-a998-f99efd3ba23e",
    "CreateTime": "2019-07-15T09:52:30Z",
    "Ipv6": "1001::6e92:bfff:fe13:f403",
    "RequestId": "e40d865a-2fec-48e2-aba3-79206d5a8496",
    "Status": "ACTIVE"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码 描述
106.999400 SC_PARAM_ERROR 400 请求参数错误
106.993400 SC_RESOURCE_NOTENOUGH 400 找不到资源
106.999500 SC_INTERNAL_SERVER_ERROR 500 内部服务错误

2. Delete Eipv6

URI

第三方调用,释放EIP实例。 请求方式:DELETE

请求参数

名称 位置 类型 是否必须 描述
Action path String DeleteIpts
eipv6Id path String ipv6的Id

返回参数

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。

示例

删除一条Eipv6

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=DeleteIpts&Eipv6Id=4599f9dd-594d-480a-a998-f99efd3ba23e&Nonce=920212&Timestamp=1655717904&Version=2019-01-31

响应示例

{
  "DeleteIptsResponse": { 
  "RequestId": "f9a43f0a-fcf3-48c1-9d2b-96f48adbdc6d" 
   }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码 描述
106.999400 SC_PARAM_ERROR 400 请求错误
106.999500 SC_INTERNAL_SERVER_ERROR 500 系统内部错误

3. Get Eipv6 List

查询当前用户下所有eipv6信息

请求方式:GET

请求参数

名称 位置 类型 是否必须 描述
Action path String ListEipv6
pageNo path String 当前页
pageSize path String 每页记录条数

返回参数

名称 位置 类型 是否必须 描述
eipv6Id body String eipv6的id。
ipv6 body String ipv6地址
status body String ipv6的状态。
ipv4 body String 弹性公网IP地址。
eipv6Bandwidth body Int ipv6的带宽值
eipBillType body String 实例的计费方式,取值范围:
  • PrePaid:预付费,即包年包月。此时,您必须确认自己的账号支持余额支付或者信用支付。
  • PostPaid:按量付费。
eipBandwidth body Int 弹性公网IP带宽大小(Mbps)
region body String 地区
createTime body Date 创建时间
eipId boby String 弹性公网IP的id
pageNo body Integer 页数
pageSize body Integer 每页大小(个数)
totalCount body Integer 总个数

示例

查询所有eipv6信息

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=ListEipv6&PageNo=1&PageSize=20&Nonce=92022&Timestamp=1655717904&Version=2019-01-31

响应示例

{
  "ListEipv6Response": {
    "DataContainer": {
      "Data": {
        "Eipv6Bandwidth": "2",
        "Ipv4": "10.110.38.30",
        "CreateTime": "2019-07-15T10:06:03Z",
        "Ipv6": "1001::6e92:bfff:fe13:f403",
        "EipBillType": "hourlySettlement",
        "EipId": "71936f16-f403-45a1-9db7-3c83279f8aba",
        "Id": "6e899b0d-6d30-4daf-8601-c5d5ddb99059",
        "Region": "cn-north-3",
        "EipBandwidth": "2",
        "Status": "ACTIVE"
      }
    },
    "PageNo": "1",
    "RequestId": "40b45e74-e7df-4a1a-af27-5e023a45ddf0",
    "PageSize": "20",
    "TotalCount": "1"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码 描述
106.001403 SC_FORBIDDEN 401 认证失败
106.999500 SC_INTERNAL_SERVER_ERROR 500 内部服务错误
106.999400 SC_PARAM_ERROR 400 请求错误

4. Get Eipv6

查询当前用户下eipv6详情

请求方式:GET

请求参数

名称 位置 类型 是否必须 描述
Action path String GetIpv6Details
eipv6Id path String eipv6的Id

返回参数

名称 位置 类型 是否必须 描述
eipv6Id body String eipv6的id。
ipv6 body String ipv6地址
status body String ipv6的状态。
ipv4 body String 弹性公网IP地址。
eipv6Bandwidth body Int ipv6的带宽值
eipBillType body String 实例的计费方式,取值范围:
  • PrePaid:预付费,即包年包月。此时,您必须确认自己的账号支持余额支付或者信用支付。
  • PostPaid:按量付费。
eipBandwidth body Int 弹性公网IP带宽大小(Mbps)
region body String 地区
createTime body Date 创建时间
eipId boby String 弹性公网IP的id

示例

显示单个eipv6的相关信息

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=GetIpv6Details&Eipv6Id=6e899b0d-6d30-4daf-8601-c5d5ddb99059&Nonce=92021&Timestamp=1655717904&Version=2019-01-31

响应示例

{
  "GetIpv6DetailsResponse": {
    "Eipv6Bandwidth": "0",
    "Ipv4": "10.110.38.30",
    "CreateTime": "2019-07-15T10:06:03Z",
    "Ipv6": "1001::6e92:bfff:fe13:f403",
    "EipBillType": "hourlySettlement",
    "RequestId": "c2d333a8-bb3c-444a-8986-f4d21cf14984",
    "EipId": "71936f16-f403-45a1-9db7-3c83279f8aba",
    "Id": "6e899b0d-6d30-4daf-8601-c5d5ddb99059",
    "Region": "cn-north-3",
    "EipBandwidth": "2",
    "Status": "ACTIVE"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码 描述
106.202404 SC_NOT_FOUND 404 找不到资源
106.999500 SC_INTERNAL_SERVER_ERROR 500 内部服务异常

5. Update Eipv6

修改eipv6映射的eip地址

请求方式:PUT

请求参数

名称 位置 类型 是否必须 描述
Action path String UpdateEipv6Ip
eipAddress body String eip地址
eipv6Id path String eipv6的Id

返回参数

名称 位置 类型 描述
code body String 返回码(错误时返回相应错误码)。
message body String 返回信息 有效值:成功 或 失败。

示例

更换eip地址

请求示例

https://eip.cn-north-3.inspurcloudapi.com/?Action=UpdateEipv6Ip&Eipv6Id=6e899b0d-6d30-4daf-8601-c5d5ddb99059&Nonce=92021&Timestamp=1655717904&Version=2019-01-31&eipAddress=10.110.38.36

响应示例

{
  "UpdateEipv6IpResponse": {
    "Code": "200",
    "RequestId": "1142300f-d413-4bb1-83d9-1de4f25f10de",
    "Message": "update success"
  }
}

错误码

以下为本接口特有的错误码。

错误代码 错误信息 Http状态码 描述
106.994404 SC_NOT_FOUND 404 没有发现此数据
106.999400 SC_PARAM_ERROR 400 参数错误
106.202404 SC_FIREWALL_NAT_UNAVAILABLE 404 防火墙nat错误
106.999500 SC_INTERNAL_SERVER_ERROR 500 服务异常