Updates app instance state.

put

https://cluster.ip.address/irisservices/api/v1/public/appInstances/{appInstanceId}/states

Privileges: APP_LAUNCH

Changes the state of the app instances.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

appInstanceId

int64

required

Specifies the app instance Id.

Body Params

Request to update app instance state.

Specifies update app instance state parameters.

qosTier

string | null

enum

Optional QoS tier override for resume. If set when resuming (state =
kRunning), the app instance will be resumed with this QoS tier. Only
allowed when there is a single instance of the app on the cluster.
Specifies QoS Tier for an app instance. App instances are allocated
resources such as memory, CPU and IO based on their QoS Tier.
kLow - Low QoS Tier.
kMedium - Medium QoS Tier.
kHigh - High QoS Tier.
kMax - Max QoS Tier.

Allowed:

state

string | null

enum

Specifies the desired app instance state type.
Specifies operational status of an app instance.
kInitializing - The app instance has been launched or resumed, but is not fully running yet.
kRunning - The app instance is running. Check health_status for the actual health.
kPausing - The app instance is being paused.
kPaused - The app instance has been paused.
kTerminating - The app instance is being terminated.
kTerminated - The app instance has been terminated.
kFailed - The app instance has failed due to an unrecoverable error.

Allowed:

Responses

202

No Content

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultError