S3-lagringAnvändareMaskinöversatt

API-referens

Alla HTTP-slutpunkter i modulen s3: autentisering, IAM-åtgärd, parametrar, innehåll och statuskoder.

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

Docs

`GET /docs/s3/manifest.json`

Autentisering: krävs
Operationsnamn: DocsManifest_s3

Svar

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

`GET /docs/s3/{path}`

Autentisering: krävs
Operationsnamn: DocsFile_s3

Parametrar

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

Svar

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

S3 Access Keys

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/managedidentities/{managedIdentityId}/s3accesskeys`

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

Parametrar

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

Svar

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

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/managedidentities/{managedIdentityId}/s3accesskeys`

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

Parametrar

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

Begärans innehåll: IssueAccessKeyRequest

Svar

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

`DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/managedidentities/{managedIdentityId}/s3accesskeys/{keyId}`

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

Parametrar

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

Svar

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

`PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/managedidentities/{managedIdentityId}/s3accesskeys/{keyId}`

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

Parametrar

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

Begärans innehåll: UpdateAccessKeyStatusRequest

Svar

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

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{accountName}/accesskeys`

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

Parametrar

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

Svar

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

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{accountName}/accesskeys`

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

Parametrar

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

Begärans innehåll: IssueAccessKeyRequest

Svar

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

S3 Buckets

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{accountName}/buckets`

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

Parametrar

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

Svar

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

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{accountName}/buckets`

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

Parametrar

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

Begärans innehåll: BucketCreateDto

Svar

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

`DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{accountName}/buckets/{bucketName}`

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

Parametrar

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

Svar

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

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{accountName}/buckets/{bucketName}`

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

Parametrar

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

Svar

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

S3 STS

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{name}/sts/sessions`

Autentisering: krävs
IAM-åtgärd: s3sts/issue — utvärderas på resursen i sökvägen
Operationsnamn: IssueS3StsSession

Parametrar

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

Begärans innehåll: IssueStsRequest

Svar

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

S3 Storage Accounts

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts`

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

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 s3storageaccounts/read på det utvärderade omfånget

`DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{name}`

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

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	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 s3storageaccounts/delete på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{name}`

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

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	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 s3storageaccounts/read på det utvärderade omfånget

`PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{name}`

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

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	sökväg	`string`	Ja
`name`	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 s3storageaccounts/write på det utvärderade omfånget

`POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{name}`

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

Parametrar

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

Begärans innehåll: S3StorageAccountCreateDto

Svar

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

`PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{name}`

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

Parametrar

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

Begärans innehåll: S3StorageAccountCreateDto

Svar

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

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{name}/audit`

Autentisering: krävs
IAM-åtgärd: s3/audit/read — utvärderas på resursen i sökvägen
Operationsnamn: GetS3StorageAccountAudit

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	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 s3/audit/read på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/s3storageaccounts/{name}/usage`

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

Parametrar

Namn	Plats	Typ	Obligatorisk
`boundaryId`	sökväg	`uuid`	Ja
`resourceGroupName`	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 s3storageaccounts/read på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resources/s3storageaccounts`

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

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 s3storageaccounts/read på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resources/s3storageaccounts/config`

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

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 s3storageaccounts/read på det utvärderade omfånget

`GET /boundaries/{boundaryId}/resources/s3storageaccounts/runtime-info`

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

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 s3storageaccounts/read på det utvärderade omfånget

Övriga slutpunkter

`GET /readyz`

Autentisering: ingen — anonyma anrop accepteras
Operationsnamn: StackshipReadiness

Svar

Status	Betydelse	Innehåll

Scheman

`BucketCreateDto`

Egenskap	Typ	Kan vara null
`name`	`string`	Nej

`IssueAccessKeyRequest`

Egenskap	Typ	Kan vara null
`description`	`string`	Ja

`IssueStsRequest`

Egenskap	Typ	Kan vara null
`ttlSeconds`	`integer`	Ja

`S3AccessKeyStatus`

Ett av: 0 = Active, 1 = Disabled.

`S3ComputeSpecDto`

Egenskap	Typ	Kan vara null
`cpu`	`string`	Nej
`memory`	`string`	Nej

`S3CorsSpecDto`

Egenskap	Typ	Kan vara null
`additionalOrigins`	`string` `[]`	Nej

`S3EndpointSpecDto`

Egenskap	Typ	Kan vara null
`hostname`	`string`	Nej
`httpOnly`	`boolean`	Nej
`issuer`	`string`	Nej
`provider`	`SslProvider`	Nej
`sslCertificateSecretName`	`string`	Ja

`S3StorageAccountCreateDto`

Egenskap	Typ	Kan vara null
`clusterId`	`uuid`	Nej
`spec`	`S3StorageAccountSpecDto`	Nej

`S3StorageAccountSpecDto`

Egenskap	Typ	Kan vara null
`allowS3ApiBucketLifecycle`	`boolean`	Nej
`compute`	`S3ComputeSpecDto`	Nej
`cors`	`S3CorsSpecDto`	Ja
`endpoint`	`S3EndpointSpecDto`	Nej
`storage`	`S3StorageSpecDto`	Nej

`S3StorageSpecDto`

Egenskap	Typ	Kan vara null
`backend`	`StorageBackend`	Nej
`quota`	`string`	Nej
`retainOnDelete`	`boolean`	Nej
`storageClass`	`string`	Ja

`SslProvider`

Ett av: LetsEncrypt, Secret.

`StorageBackend`

Ett av: Pvc.

`UpdateAccessKeyStatusRequest`

Egenskap	Typ	Kan vara null
`status`	`S3AccessKeyStatus`	Nej