百度智能云

All Product Document

          Elastic IP

          Query EIP List

          • You can query EIP list according to multiple conditions.
          • If it is only needed to query the details of a single EIP, you only need to provide eip parameters.
          • If you only need to query the EIP bound to a specified instance, you only need to provide instanceType parameter.
          • If you only need to query the details of EIP bound to a specified instance, you only need to provide instanceType and instanceId parameters.
          • If you do not provide the query conditions, all EIP are overwritten by default.
          • The returned result is the query result of intersection of multiple conditions, i.e. when multiple conditions are provided, EIP meeting all conditions simultaneously is returned.
          • The query result above supports marker paging, with paging size of 1,000 by default, which can be specified via maxKeys parameter.

          Request Structure

          GET /v{version}/eip?eip={eip}&instanceType={instanceType}&instanceId={instanceId}&status={status}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
          Host: eip.bj.baidubce.com
          Authorization: authorization string

          There are no other special headers except the public headers.

          Request Parameter

          Parameter name Type Required or not Parameter position Description
          version String Yes URL parameter API version number (the current value is 1)
          eip String No Query parameter EIP to be queried, expressed with dotted decimal notation.
          instanceType instanceType No Query parameter Type of bound instance
          instanceId String No Query parameter Instance short ID, and if this parameter is specified, it is needed to provide instanceType parameter simultaneously.
          name String No Query parameters EIP name to be queried
          marker String No Query parameter The starting location of query for batch acquisition of lists, and is one string generated by the system.
          maxKeys int No Query parameter Maximum number contained in each page, generally not exceeding 1000. The default value is 1000.
          status String No Query parameter Instance status, only support the query of available, binded, paused

          Return Status Code

          200 is returned successfully, for the failed return, please see Error code.

          Return Header

          There are no other special headers except the public headers.

          Return Parameter

          Parameter name Type Description
          eipList List<EipModel> List containing query results
          marker string Mark the starting position of the query. The item does not exist if the result list is empty
          isTruncated boolean True means there are additional data in the following pages and false means the current page is the last page.
          nextMarker String The marker value requiring to be passed in order to acquire the next page. The domain doesn't appear when isTruncated is false.
          maxKeys int Maximum number contained in each page.
          tags List<TagModel> Collection of bound tags

          Request Example

          GET /v1/eip?instanceType=BCC&maxKeys=2 HTTP/1.1
          HOST eip.bj.baidubce.com
          Authorization bce-auth-v1/5e5a8adf11ae475ba95f1bd38228b44f/2016-04-10T08:26:52Z/1800/host;x-bce-date/ec3c0069f9abb1e247773a62707224124b2b31b4c171133677f9042969791f02

          Response Example

          HTTP/1.1 200 OK
          x-bce-request-id: 946002ee-cb4f-4aad-b686-5be55df27f09
          Date: Wed, 10 Apr 2016 08:26:52 GMT
          Transfer-Encoding: chunked
          Content-Type: application/json;charset=UTF-8
          Server: BWS
          
          {
              "eipList": [
                  {
                      "name":"eip-xrllt5M-1",
                      "eip": "180.181.3.133",
                      "status":"binded",
                      "instanceType": "BCC",
                      "instanceId": "i-IyWRtII7",
                      "shareGroupId": "eg-0c31c93a",
                      "eipInstanceType": "shared",
                      "bandwidthInMbps": 5,
                      "paymentTiming":"Prepaid",
                      "billingMethod":null,
                      "createTime":"2016-03-08T08:13:09Z",
                      "expireTime":"2016-04-08T08:13:09Z",
                      "tags": [
                      {
                          "tagKey": "aa",
                          "tagValue": "bb"
                      }
                  ]
                  },
                  {
                      "name":"eip-scewa1M-1",
                      "eip": "180.181.3.134",
                      "status":"binded",
                      "instanceType": "BCC",
                      "instanceId": "i-KjdgweC4",
                      "shareGroupId": null,
                      "eipInstanceType": "normal",
                      "bandwidthInMbps": 1,
                      "paymentTiming":"Postpaid",
                      "billingMethod":"ByTraffic",
                      "createTime":"2016-03-08T08:13:09Z",
                      "expireTime":null,
                      "tags": [
                      {
                          "tagKey": "key",
                          "tagValue": "value"
                      }
                  ]
                  },
              ],
              "marker":"eip-DCB50385",
              "isTruncated": true,
              "nextMarker": "eip-DCB50387",
              "maxKeys": 2
          }
          Previous
          Release EIP
          Next
          Renew EIP