Chilkat Online Tools

PureBasic / Core Services API / AddPublicIpPoolCapacity

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

    ; This example assumes the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "byoipRangeId": "occaecat quis laboris c",
    ;   "cidrBlock": "do et commo"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"byoipRangeId","occaecat quis laboris c")
    CkJsonObject::ckUpdateString(json,"cidrBlock","do et commo")

    CkHttp::ckSetRequestHeader(http,"opc-retry-token","aliqua enim i")
    CkHttp::ckSetRequestHeader(http,"opc-request-id","8wF")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
    CkHttp::ckSetRequestHeader(http,"x-content-sha256","{{content_sha256}}")
    CkHttp::ckSetRequestHeader(http,"Authorization","{{signature}}")
    CkHttp::ckSetRequestHeader(http,"Date","{{date}}")

    resp.i = CkHttp::ckPostJson3(http,"https://iaas.{{region}}.oraclecloud.com/20160918/publicIpPools/:publicIpPoolId/actions/addCapacity","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; Sample JSON response:
    ; (Sample code for parsing the JSON response is shown below)

    ; {
    ;   "id": "occaecat non consequat",
    ;   "compartmentId": "est veniam",
    ;   "timeCreated": "1946-12-13T16:16:10.938Z",
    ;   "cidrBlocks": [
    ;     "Lorem tempor",
    ;     "commodo ipsum minim"
    ;   ],
    ;   "definedTags": {},
    ;   "displayName": "incididunt labore officia minim irure",
    ;   "freeformTags": {},
    ;   "lifecycleState": "ACTIVE"
    ; }

    ; Sample code for parsing the JSON response...
    ; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    strVal.s

    id.s = CkJsonObject::ckStringOf(jResp,"id")
    compartmentId.s = CkJsonObject::ckStringOf(jResp,"compartmentId")
    timeCreated.s = CkJsonObject::ckStringOf(jResp,"timeCreated")
    displayName.s = CkJsonObject::ckStringOf(jResp,"displayName")
    lifecycleState.s = CkJsonObject::ckStringOf(jResp,"lifecycleState")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"cidrBlocks")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        strVal = CkJsonObject::ckStringOf(jResp,"cidrBlocks[i]")
        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "opc-request-id: 8wF"
	-H "opc-retry-token: aliqua enim i"
	-H "Content-Type: application/json"
	-H "Date: {{date}}"
	-H "Authorization: {{signature}}"
	-H "x-content-sha256: {{content_sha256}}"
	-d '{
    "byoipRangeId": "occaecat quis laboris c",
    "cidrBlock": "do et commo"
}'
https://iaas.{{region}}.oraclecloud.com/20160918/publicIpPools/:publicIpPoolId/actions/addCapacity

Postman Collection Item JSON

{
  "name": "AddPublicIpPoolCapacity",
  "request": {
    "method": "POST",
    "header": [
      {
        "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
        "key": "opc-request-id",
        "value": "8wF"
      },
      {
        "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
        "key": "opc-retry-token",
        "value": "aliqua enim i"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Date",
        "value": "{{date}}",
        "description": "(Required) Current Date",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "{{signature}}",
        "description": "(Required) Signature Authentication on Authorization header",
        "type": "text"
      },
      {
        "key": "x-content-sha256",
        "value": "{{content_sha256}}",
        "description": "(Required) Content sha256 for POST, PUT and PATCH operations",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"byoipRangeId\": \"occaecat quis laboris c\",\n    \"cidrBlock\": \"do et commo\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/publicIpPools/:publicIpPoolId/actions/addCapacity",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "publicIpPools",
        ":publicIpPoolId",
        "actions",
        "addCapacity"
      ],
      "variable": [
        {
          "key": "publicIpPoolId",
          "value": "amet ut",
          "description": "(Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
        }
      ]
    },
    "description": "Adds some or all of a CIDR block to a public IP pool.\n\nThe CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.\n"
  },
  "response": [
    {
      "name": "The CIDR block was added to the IP pool.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"byoipRangeId\": \"occaecat quis laboris c\",\n    \"cidrBlock\": \"do et commo\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIpPools/:publicIpPoolId/actions/addCapacity",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIpPools",
            ":publicIpPoolId",
            "actions",
            "addCapacity"
          ],
          "variable": [
            {
              "key": "publicIpPoolId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "etag",
          "value": "officia sed",
          "description": "For optimistic concurrency control. See `if-match`.\n"
        },
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"occaecat non consequat\",\n \"compartmentId\": \"est veniam\",\n \"timeCreated\": \"1946-12-13T16:16:10.938Z\",\n \"cidrBlocks\": [\n  \"Lorem tempor\",\n  \"commodo ipsum minim\"\n ],\n \"definedTags\": {},\n \"displayName\": \"incididunt labore officia minim irure\",\n \"freeformTags\": {},\n \"lifecycleState\": \"ACTIVE\"\n}"
    },
    {
      "name": "Bad Request",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"byoipRangeId\": \"occaecat quis laboris c\",\n    \"cidrBlock\": \"do et commo\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIpPools/:publicIpPoolId/actions/addCapacity",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIpPools",
            ":publicIpPoolId",
            "actions",
            "addCapacity"
          ],
          "variable": [
            {
              "key": "publicIpPoolId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"byoipRangeId\": \"occaecat quis laboris c\",\n    \"cidrBlock\": \"do et commo\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIpPools/:publicIpPoolId/actions/addCapacity",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIpPools",
            ":publicIpPoolId",
            "actions",
            "addCapacity"
          ],
          "variable": [
            {
              "key": "publicIpPoolId"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Conflict",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"byoipRangeId\": \"occaecat quis laboris c\",\n    \"cidrBlock\": \"do et commo\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIpPools/:publicIpPoolId/actions/addCapacity",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIpPools",
            ":publicIpPoolId",
            "actions",
            "addCapacity"
          ],
          "variable": [
            {
              "key": "publicIpPoolId"
            }
          ]
        }
      },
      "status": "Conflict",
      "code": 409,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "Internal Server Error",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"byoipRangeId\": \"occaecat quis laboris c\",\n    \"cidrBlock\": \"do et commo\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIpPools/:publicIpPoolId/actions/addCapacity",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIpPools",
            ":publicIpPoolId",
            "actions",
            "addCapacity"
          ],
          "variable": [
            {
              "key": "publicIpPoolId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    },
    {
      "name": "An error has occurred.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
            "key": "opc-request-id",
            "value": "8wF"
          },
          {
            "description": "A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
            "key": "opc-retry-token",
            "value": "aliqua enim i"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"byoipRangeId\": \"occaecat quis laboris c\",\n    \"cidrBlock\": \"do et commo\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/publicIpPools/:publicIpPoolId/actions/addCapacity",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "publicIpPools",
            ":publicIpPoolId",
            "actions",
            "addCapacity"
          ],
          "variable": [
            {
              "key": "publicIpPoolId"
            }
          ]
        }
      },
      "status": "Internal Server Error",
      "code": 500,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "opc-request-id",
          "value": "officia sed",
          "description": "Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"code\": \"et exercitation Excepteur\",\n \"message\": \"irure sit\"\n}"
    }
  ]
}