API-referens

Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.

Container Instance Backup Policy

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/backup-policy

Remove the instance's backup policy; backups already taken stay until they expire

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/backup-policy

The instance's backup policy, as the operator reports it

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/backup-policy

Set the instance's backup policy: schedule, retention, method, hooks

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja

Begärans innehåll: BackupPolicySpecDto

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

Container Instance Compute Plans

GET /boundaries/{boundaryId}/resources/containerinstancecomputeplans

List all available containerinstancecomputeplans

• Autentisering: krävs
• Operationsnamn: ListContainerInstanceComputePlans

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK	PagedListResponse<ContainerInstancePlanDto>
401	Inte inloggad, eller ogiltig token
500	Internt fel	ProblemDetails

GET /boundaries/{boundaryId}/resources/containerinstancecomputeplans/{resourceId}

Get a specific containerinstancecomputeplan by ID

• Autentisering: krävs
• Operationsnamn: GetContainerInstanceComputePlan

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceId	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK	ContainerInstancePlanDto
401	Inte inloggad, eller ogiltig token
404	Hittades inte
500	Internt fel	ProblemDetails

Container Instance Crates

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/crates

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/crates/{crateId}

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
crateId	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/crates/{crateId}/logs

• Autentisering: krävs
• IAM-åtgärd: containerinstance/readLogs — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
crateId	sökväg	string	Ja
previous	frågesträng	boolean	Nej
process	frågesträng	string	Nej
tail	frågesträng	integer	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/readLogs på det utvärderade omfånget

Container Instance Files

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files

• Autentisering: krävs
• IAM-åtgärd: containerinstance/writeFiles — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
component	frågesträng	string	Nej
path	frågesträng	string	Nej
recursive	frågesträng	boolean	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/writeFiles på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files

• Autentisering: krävs
• IAM-åtgärd: containerinstance/readFiles — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
component	frågesträng	string	Nej
path	frågesträng	string	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/readFiles på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/archive

• Autentisering: krävs
• IAM-åtgärd: containerinstance/readFiles — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
component	frågesträng	string	Nej
path	frågesträng	string	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/readFiles på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/directory

• Autentisering: krävs
• IAM-åtgärd: containerinstance/writeFiles — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja

Begärans innehåll: MakeDirectoryRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/writeFiles på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/download

• Autentisering: krävs
• IAM-åtgärd: containerinstance/readFiles — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
component	frågesträng	string	Nej
path	frågesträng	string	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/readFiles på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/move

• Autentisering: krävs
• IAM-åtgärd: containerinstance/writeFiles — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja

Begärans innehåll: MoveRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/writeFiles på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/files/upload

• Autentisering: krävs
• IAM-åtgärd: containerinstance/writeFiles — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
component	frågesträng	string	Nej
name	frågesträng	string	Nej
path	frågesträng	string	Nej

Begärans innehåll: binary

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/writeFiles på det utvärderade omfånget

Container Instance Revisions

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/revisions

List a container instance's revisions, newest first

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/revisions/{from}/diff/{to}

Structured diff between two revisions

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
from	sökväg	integer	Ja
to	sökväg	integer	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/revisions/{number}

Read one revision, with its spec and parameters

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
number	sökväg	integer	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/revisions/{number}/rollback

Roll a container instance back to an earlier revision

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
number	sökväg	integer	Ja
ifMatchRevision	frågesträng	integer	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

Container Instances

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroup}/resources/containerinstances/{name}/components/{component}/actions/redeploy

Re-deploy a single component of a container instance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroup	sökväg	string	Ja
name	sökväg	string	Ja
component	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

POST /boundaries/{boundaryId}/resources/containerinstances/url

Preview the default public URL for a container instance endpoint

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Begärans innehåll: ContainerInstanceUrlRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

ContainerInstance

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances

List all containerinstances in a resource group

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen
• Operationsnamn: ListContainerInstances

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/config

Get list configuration for containerinstances

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetContainerInstancesConfig

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	string	Ja
resourceGroupName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}

Delete a containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/delete — utvärderas på resursen i sökvägen
• Operationsnamn: DeleteContainerInstance

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/delete på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}

Get a specific containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetContainerInstance

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}

Partially update an existing containerinstance using JSON Merge Patch

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen
• Operationsnamn: PatchContainerInstance

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: any

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}

Create a new containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen
• Operationsnamn: CreateContainerInstance

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: ContainerInstanceDto

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}

Update an existing containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen
• Operationsnamn: UpdateContainerInstance

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: ContainerInstanceDto

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/actions/{action}

Execute a lifecycle action (start, stop, restart) on a containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/write — utvärderas på resursen i sökvägen
• Operationsnamn: ExecuteContainerInstanceAction

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja
action	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/write på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/scale

Get current scale of a containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetContainerInstanceScale

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/scale

Scale a containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/scale — utvärderas på resursen i sökvägen
• Operationsnamn: ScaleContainerInstance

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: ScaleRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/scale på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots

List snapshots of a containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen
• Operationsnamn: ListContainerInstanceSnapshots

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots

Create a snapshot of a containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/createSnapshot — utvärderas på resursen i sökvägen
• Operationsnamn: CreateContainerInstanceSnapshot

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: CreateSnapshotRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/createSnapshot på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots/pitr-window

The point-in-time recovery window of a containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetContainerInstancePitrWindow

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots/{snapshotId}

Delete a snapshot of a containerinstance

• Autentisering: krävs
• IAM-åtgärd: containerinstance/deleteSnapshot — utvärderas på resursen i sökvägen
• Operationsnamn: DeleteContainerInstanceSnapshot

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja
snapshotId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/deleteSnapshot på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/containerinstances/{resourceName}/snapshots/{snapshotId}/restore

Restore a containerinstance from a snapshot

• Autentisering: krävs
• IAM-åtgärd: containerinstance/restoreSnapshot — utvärderas på resursen i sökvägen
• Operationsnamn: RestoreContainerInstanceFromSnapshot

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja
snapshotId	sökväg	uuid	Ja

Begärans innehåll: RestoreSnapshotRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/restoreSnapshot på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/containerinstances

List all containerinstances across all resource groups

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen
• Operationsnamn: ListAllContainerInstances

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/containerinstances/config

Get list configuration for all containerinstances

• Autentisering: krävs
• IAM-åtgärd: containerinstance/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetAllContainerInstancesConfig

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte containerinstance/read på det utvärderade omfånget

Docs

GET /docs/containerinstances/manifest.json

• Autentisering: krävs
• Operationsnamn: DocsManifest_containerinstances

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token

GET /docs/containerinstances/{path}

• Autentisering: krävs
• Operationsnamn: DocsFile_containerinstances

Parametrar

Namn	Plats	Typ	Obligatorisk
path	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token

Övriga slutpunkter

GET /instance-auth/check

• Autentisering: ingen — anonyma anrop accepteras

Parametrar

Namn	Plats	Typ	Obligatorisk
mi	frågesträng	string	Nej

Svar

Status	Betydelse	Innehåll
200	OK

GET /instance-auth/oauth2/callback

• Autentisering: ingen — anonyma anrop accepteras

Svar

Status	Betydelse	Innehåll
200	OK

POST /instance-auth/oauth2/callback

• Autentisering: ingen — anonyma anrop accepteras

Svar

Status	Betydelse	Innehåll
200	OK

POST /instance-auth/oauth2/sign_out

• Autentisering: ingen — anonyma anrop accepteras

Svar

Status	Betydelse	Innehåll
200	OK

GET /instance-auth/oauth2/start

• Autentisering: ingen — anonyma anrop accepteras

Parametrar

Namn	Plats	Typ	Obligatorisk
rd	frågesträng	string	Nej

Svar

Status	Betydelse	Innehåll
200	OK

GET /readyz

• Autentisering: ingen — anonyma anrop accepteras
• Operationsnamn: StackshipReadiness

Svar

Status	Betydelse	Innehåll

Scheman

BackupPolicyHookDto

Egenskap	Typ	Kan vara null
backup	string []	Ja
container	string	Nej
restore	string []	Ja
timeout	string	Ja

BackupPolicySpecDto

Egenskap	Typ	Kan vara null
hooks	BackupPolicyHookDto []	Ja
method	string	Nej
paused	boolean	Nej
retention	string	Nej
schedule	string	Nej

ContainerInstanceComponentDto

Egenskap	Typ	Kan vara null
computePlan	string	Ja
containers	ContainerInstanceContainerDto []	Nej
cpu	string	Ja
hardened	boolean	Nej
identityInjection	boolean	Nej
initContainers	ContainerInstanceContainerDto []	Ja
memory	string	Ja
name	string	Nej
replicas	integer	Nej
runAsGroup	integer	Ja
runAsUser	integer	Ja
scaling	ContainerInstanceScalingDto	Ja
startupOrder	integer	Nej
volumes	ContainerInstanceVolumeDto []	Ja

ContainerInstanceComponentStatusDto

Egenskap	Typ	Kan vara null
message	string	Ja
name	string	Nej
observedImageDigests	map (string)	Ja
phase	string	Ja
readyReplicas	integer	Nej

ContainerInstanceContainerDto

Egenskap	Typ	Kan vara null
args	string []	Ja
command	string []	Ja
env	ContainerInstanceEnvVarDto []	Ja
image	string	Nej
mounts	ContainerInstanceMountDto []	Ja
name	string	Nej
ports	ContainerInstancePortDto []	Ja
probes	ContainerInstanceProbesDto	Ja
sourceRef	string	Ja
tag	string	Nej

ContainerInstanceDto

Egenskap	Typ	Kan vara null
backupable	boolean	Nej
boundary	string	Nej
boundaryId	uuid	Nej
clusterId	uuid	Nej
clusterName	string	Nej
collection	string	Nej
componentStatus	ContainerInstanceComponentStatusDto []	Ja
components	ContainerInstanceComponentDto []	Nej
createdAt	date-time	Nej
currentWave	integer	Ja
endpointStatus	ContainerInstanceEndpointStatusDto []	Ja
endpoints	ContainerInstanceEndpointDto []	Ja
hasIdentity	boolean	Nej
id	uuid	Nej
name	string	Nej
phase	string	Ja
region	string	Nej
resourceGroup	string	Nej
status	string	Nej
tags	map (string)	Nej
templateRef	ContainerInstanceTemplateRefDto	Ja

ContainerInstanceEmptyDirDto

Egenskap	Typ	Kan vara null
sizeLimit	string	Ja

ContainerInstanceEndpointDto

Egenskap	Typ	Kan vara null
authGuard	boolean	Nej
component	string	Nej
expose	string	Nej
hostname	string	Ja
issuer	string	Ja
name	string	Nej
paths	string []	Ja
port	string	Nej
ssl	string	Ja

ContainerInstanceEndpointStatusDto

Egenskap	Typ	Kan vara null
address	string	Ja
name	string	Nej
tlsReady	boolean	Ja
url	string	Ja

ContainerInstanceEnvVarDto

Egenskap	Typ	Kan vara null
name	string	Nej
secretRef	ContainerInstanceSecretRefDto	Ja
value	string	Ja

ContainerInstanceFilesDto

Egenskap	Typ	Kan vara null
content	map (string)	Ja
sensitive	boolean	Nej

ContainerInstanceHpaDto

Egenskap	Typ	Kan vara null
maxReplicas	integer	Nej
minReplicas	integer	Nej
targetCpuPercent	integer	Nej

ContainerInstanceMountDto

Egenskap	Typ	Kan vara null
path	string	Nej
readOnly	boolean	Nej
subPath	string	Ja
volume	string	Nej

ContainerInstancePersistentVolumeDto

Egenskap	Typ	Kan vara null
fsGroup	integer	Ja
retainOnDelete	boolean	Nej
size	string	Nej
storageClass	string	Ja
tier	string	Ja

ContainerInstancePlanDto

Egenskap	Typ	Kan vara null
cpu	string	Nej
description	string	Nej
id	string	Nej
isProductionReady	boolean	Nej
memory	string	Nej
name	string	Nej

ContainerInstancePortDto

Egenskap	Typ	Kan vara null
name	string	Nej
port	integer	Nej
protocol	string	Ja

ContainerInstanceProbeDto

Egenskap	Typ	Kan vara null
command	string []	Ja
failureThreshold	integer	Ja
initialDelaySeconds	integer	Ja
path	string	Ja
periodSeconds	integer	Ja
port	string	Nej
timeoutSeconds	integer	Ja
type	string	Nej

ContainerInstanceProbesDto

Egenskap	Typ	Kan vara null
liveness	ContainerInstanceProbeDto	Ja
readiness	ContainerInstanceProbeDto	Ja
startup	ContainerInstanceProbeDto	Ja

ContainerInstanceScalingDto

Egenskap	Typ	Kan vara null
hpa	ContainerInstanceHpaDto	Ja
strategy	string	Nej

ContainerInstanceSecretRefDto

Egenskap	Typ	Kan vara null
key	string	Nej
vault	string	Nej

ContainerInstanceTemplateRefDto

Egenskap	Typ	Kan vara null
slug	string	Ja
version	string	Ja

ContainerInstanceVolumeDto

Egenskap	Typ	Kan vara null
emptyDir	ContainerInstanceEmptyDirDto	Ja
files	ContainerInstanceFilesDto	Ja
name	string	Nej
persistent	ContainerInstancePersistentVolumeDto	Ja

CreateSnapshotRequest

Egenskap	Typ	Kan vara null
description	string	Ja
ttlHours	integer	Ja

MakeDirectoryRequest

Egenskap	Typ	Kan vara null
component	string	Ja
path	string	Nej

MoveRequest

Egenskap	Typ	Kan vara null
component	string	Ja
from	string	Nej
to	string	Nej

PagedListResponse<ContainerInstancePlanDto>

Egenskap	Typ	Kan vara null
items	ContainerInstancePlanDto []	Nej
pagination	PaginationMeta	Nej

PaginationMeta

Egenskap	Typ	Kan vara null
hasNextPage	boolean	Nej
hasPreviousPage	boolean	Nej
page	integer	Nej
pageSize	integer	Nej
totalItems	integer	Nej
totalPages	integer	Nej

RestoreSnapshotRequest

Egenskap	Typ	Kan vara null
targetTime	date-time	Ja

ScaleRequest

Egenskap	Typ	Kan vara null
targetScale	integer	Nej