Add Informix Instance

Select

SaaS

Customer Managed

This operation adds a Informix Instance in Client

application/json

Request Body

• instance object

  instanceId integer

  instanceName string required

  Name of the instance

  applicationId integer required

  Default value: 3

  Application ID

  clientId integer

  clientName string

  Name of the client

  commCellId integer
• planEntity object

  planId integer

  Plan ID to be associated to the Instance

• informixInstance object

  informixUser object

  userName string required

  Informix user name

  informixDir string required

  Informix ho

  onConfigFile string required

  onconfig file name

  sqlHostfile string required

  SQLHOSTS file path

  informixStorageDevice object

  dataBackupStoragePolicy object

  storagePolicyId integer

  commandLineStoragePolicy object

  storagePolicyId integer

  logBackupStoragePolicy object

  storagePolicyId integer

Responses

• 200
• 400
• 401
• 409
• 500

---

OK

application/json

• Schema
• Example (from schema)
• Example

---

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

  Name of the instance created

  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": 6,
      "instanceName": "ol_informix1210",
      "instanceId": 6933,
      "_type_": 0
    }
  }
}

Bad Request

Response Headers

application/json

• Schema
• Example

---

Schema

• string

Request body is empty or format is invalid

Unauthorized

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• errorMessage string
• errorCode integer

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Access Denied",
  "errorCode": 5
}

Conflict

application/json

• Schema
• Example (from schema)
• Example 2

---

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": "An instance by this name already exists.",
  "errorCode": 3,
  "entity": {
    "subclientId": 0,
    "clientId": 5,
    "instanceName": "ol_informix1210",
    "instanceId": -1,
    "_type_": 0
  }
}

Internal Server Error

application/json

• Schema
• Example (from schema)
• Invalid information

---

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": "Not a valid Informix Home Directory - Please Re-enter.",
  "errorCode": 1,
  "entity": {
    "subclientId": 0,
    "clientId": 6,
    "instanceName": "ol_informix1210",
    "instanceId": 6996,
    "_type_": 0
  }
}

POST /instance    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

token

Content-Type

application/jsonapplication/xmlmultipart/form-datatext/html

Body

• Default
• Create Informix Instance

---

{
  "instance": {
    "instanceId": 0,
    "instanceName": "string",
    "applicationId": 3,
    "clientId": 0,
    "clientName": "string",
    "commCellId": 0
  },
  "planEntity": {
    "planId": 0
  },
  "informixInstance": {
    "informixUser": {
      "userName": "string"
    },
    "informixDir": "string",
    "onConfigFile": "string",
    "sqlHostfile": "string",
    "informixStorageDevice": {
      "dataBackupStoragePolicy": {
        "storagePolicyId": 0
      },
      "commandLineStoragePolicy": {
        "storagePolicyId": 0
      },
      "logBackupStoragePolicy": {
        "storagePolicyId": 0
      }
    }
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instance": {
    "instanceId": 0,
    "instanceName": "string",
    "applicationId": 3,
    "clientId": 0,
    "clientName": "string",
    "commCellId": 0
  },
  "planEntity": {
    "planId": 0
  },
  "informixInstance": {
    "informixUser": {
      "userName": "string"
    },
    "informixDir": "string",
    "onConfigFile": "string",
    "sqlHostfile": "string",
    "informixStorageDevice": {
      "dataBackupStoragePolicy": {
        "storagePolicyId": 0
      },
      "commandLineStoragePolicy": {
        "storagePolicyId": 0
      },
      "logBackupStoragePolicy": {
        "storagePolicyId": 0
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instance": {
    "instanceId": 0,
    "instanceName": "string",
    "applicationId": 3,
    "clientId": 0,
    "clientName": "string",
    "commCellId": 0
  },
  "planEntity": {
    "planId": 0
  },
  "informixInstance": {
    "informixUser": {
      "userName": "string"
    },
    "informixDir": "string",
    "onConfigFile": "string",
    "sqlHostfile": "string",
    "informixStorageDevice": {
      "dataBackupStoragePolicy": {
        "storagePolicyId": 0
      },
      "commandLineStoragePolicy": {
        "storagePolicyId": 0
      },
      "logBackupStoragePolicy": {
        "storagePolicyId": 0
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instance": {
    "instanceId": 0,
    "instanceName": "string",
    "applicationId": 3,
    "clientId": 0,
    "clientName": "string",
    "commCellId": 0
  },
  "planEntity": {
    "planId": 0
  },
  "informixInstance": {
    "informixUser": {
      "userName": "string"
    },
    "informixDir": "string",
    "onConfigFile": "string",
    "sqlHostfile": "string",
    "informixStorageDevice": {
      "dataBackupStoragePolicy": {
        "storagePolicyId": 0
      },
      "commandLineStoragePolicy": {
        "storagePolicyId": 0
      },
      "logBackupStoragePolicy": {
        "storagePolicyId": 0
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instance": {
    "instanceId": 0,
    "instanceName": "string",
    "applicationId": 3,
    "clientId": 0,
    "clientName": "string",
    "commCellId": 0
  },
  "planEntity": {
    "planId": 0
  },
  "informixInstance": {
    "informixUser": {
      "userName": "string"
    },
    "informixDir": "string",
    "onConfigFile": "string",
    "sqlHostfile": "string",
    "informixStorageDevice": {
      "dataBackupStoragePolicy": {
        "storagePolicyId": 0
      },
      "commandLineStoragePolicy": {
        "storagePolicyId": 0
      },
      "logBackupStoragePolicy": {
        "storagePolicyId": 0
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instance": {
    "instanceId": 0,
    "instanceName": "string",
    "applicationId": 3,
    "clientId": 0,
    "clientName": "string",
    "commCellId": 0
  },
  "planEntity": {
    "planId": 0
  },
  "informixInstance": {
    "informixUser": {
      "userName": "string"
    },
    "informixDir": "string",
    "onConfigFile": "string",
    "sqlHostfile": "string",
    "informixStorageDevice": {
      "dataBackupStoragePolicy": {
        "storagePolicyId": 0
      },
      "commandLineStoragePolicy": {
        "storagePolicyId": 0
      },
      "logBackupStoragePolicy": {
        "storagePolicyId": 0
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instance": {
    "instanceId": 0,
    "instanceName": "string",
    "applicationId": 3,
    "clientId": 0,
    "clientName": "string",
    "commCellId": 0
  },
  "planEntity": {
    "planId": 0
  },
  "informixInstance": {
    "informixUser": {
      "userName": "string"
    },
    "informixDir": "string",
    "onConfigFile": "string",
    "sqlHostfile": "string",
    "informixStorageDevice": {
      "dataBackupStoragePolicy": {
        "storagePolicyId": 0
      },
      "commandLineStoragePolicy": {
        "storagePolicyId": 0
      },
      "logBackupStoragePolicy": {
        "storagePolicyId": 0
      }
    }
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Instance' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "instance": {
    "instanceId": 0,
    "instanceName": "string",
    "applicationId": 3,
    "clientId": 0,
    "clientName": "string",
    "commCellId": 0
  },
  "planEntity": {
    "planId": 0
  },
  "informixInstance": {
    "informixUser": {
      "userName": "string"
    },
    "informixDir": "string",
    "onConfigFile": "string",
    "sqlHostfile": "string",
    "informixStorageDevice": {
      "dataBackupStoragePolicy": {
        "storagePolicyId": 0
      },
      "commandLineStoragePolicy": {
        "storagePolicyId": 0
      },
      "logBackupStoragePolicy": {
        "storagePolicyId": 0
      }
    }
  }
}'