Modify Instance

This API modifies AWS PaaS Database Instance for Oracle.

Path Parameters

• InstanceID string required

  Oracle RDS Instance ID

application/json

Request Body

• instanceProperties object

  instance object required

  instanceName string required

  applicationId integer

  Default value: 22

  clientName string required

  planEntity object

  planId integer

  oracleInstance object

  sqlConnect object

  userName string

  domainName string

  password string

  confirmPassword string

  rdsConfig object

  s3Bucket string

  dbTLSConnectOptions object

  sslEnabled boolean

  port integer

Responses

• 200
• 400
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  warningCode integer

  errorCode integer

  warningMessage string

  entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "string",
    "entity": {
      "subclientId": 0,
      "clientId": 0,
      "instanceName": "string",
      "instanceId": 0,
      "_type_": 0
    }
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "warningCode": 0,
    "errorCode": 0,
    "warningMessage": "",
    "entity": {
      "subclientId": 0,
      "clientId": 214,
      "instanceName": "awsorcldb14[us-east-1]",
      "instanceId": 80,
      "_type_": 0
    }
  }
}

Bad Request

Internal Server Error

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• errorMessage string
• errorCode integer
• entity object

  subclientId integer

  clientId integer

  instanceName string

  instanceId integer

  _type_ integer

{
  "errorMessage": "string",
  "errorCode": 0,
  "entity": {
    "subclientId": 0,
    "clientId": 0,
    "instanceName": "string",
    "instanceId": 0,
    "_type_": 0
  }
}

{
  "errorMessage": "Connection to PostgreSQL Server failed.\n[~Connection to Database Failed: could not connect to server: Connection timed out (0x0000274C/10060)\tIs the server running on host \"x.x.x.x\" and accepting\tTCP/IP connections on port 1532?~]",
  "errorCode": 4444,
  "entity": {
    "subclientId": 0,
    "clientId": 214,
    "instanceName": "jah-pg14[us-east-2]",
    "instanceId": 2,
    "_type_": 0
  }
}

POST /instance/:instanceid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

InstanceID — path required

Body

• Default
• Example 1

---

{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 22,
      "clientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "oracleInstance": {
      "sqlConnect": {
        "userName": "string",
        "domainName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "rdsConfig": {
        "s3Bucket": "string",
        "dbTLSConnectOptions": {
          "sslEnabled": true,
          "port": 0
        }
      }
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InStance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 22,
      "clientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "oracleInstance": {
      "sqlConnect": {
        "userName": "string",
        "domainName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "rdsConfig": {
        "s3Bucket": "string",
        "dbTLSConnectOptions": {
          "sslEnabled": true,
          "port": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InStance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 22,
      "clientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "oracleInstance": {
      "sqlConnect": {
        "userName": "string",
        "domainName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "rdsConfig": {
        "s3Bucket": "string",
        "dbTLSConnectOptions": {
          "sslEnabled": true,
          "port": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InStance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 22,
      "clientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "oracleInstance": {
      "sqlConnect": {
        "userName": "string",
        "domainName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "rdsConfig": {
        "s3Bucket": "string",
        "dbTLSConnectOptions": {
          "sslEnabled": true,
          "port": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InStance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 22,
      "clientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "oracleInstance": {
      "sqlConnect": {
        "userName": "string",
        "domainName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "rdsConfig": {
        "s3Bucket": "string",
        "dbTLSConnectOptions": {
          "sslEnabled": true,
          "port": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InStance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 22,
      "clientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "oracleInstance": {
      "sqlConnect": {
        "userName": "string",
        "domainName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "rdsConfig": {
        "s3Bucket": "string",
        "dbTLSConnectOptions": {
          "sslEnabled": true,
          "port": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InStance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 22,
      "clientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "oracleInstance": {
      "sqlConnect": {
        "userName": "string",
        "domainName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "rdsConfig": {
        "s3Bucket": "string",
        "dbTLSConnectOptions": {
          "sslEnabled": true,
          "port": 0
        }
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InStance/:InstanceID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instanceProperties": {
    "instance": {
      "instanceName": "string",
      "applicationId": 22,
      "clientName": "string"
    },
    "planEntity": {
      "planId": 0
    },
    "oracleInstance": {
      "sqlConnect": {
        "userName": "string",
        "domainName": "string",
        "password": "string",
        "confirmPassword": "string"
      },
      "rdsConfig": {
        "s3Bucket": "string",
        "dbTLSConnectOptions": {
          "sslEnabled": true,
          "port": 0
        }
      }
    }
  }
}'