Download OpenAPI specification:Download
REST API for Omnistrate Service Registration
{- "ids": [
- "s-12345678",
- "s-abcdefgh",
- "s-1234efgh"
], - "nextPageToken": "next-token",
- "services": [
- {
- "createdAt": "2019-01-01T00:00:00Z",
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "s-12345678",
- "key": "mysql",
- "name": "MySQL multi-writer service",
- "roleType": "admin",
- "serviceEnvironments": [
- {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}
], - "serviceProviderID": "sp-12345678",
- "serviceProviderName": "Omnistrate, Inc."
}, - {
- "createdAt": "2019-01-01T00:00:00Z",
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "s-12345678",
- "key": "mysql",
- "name": "MySQL multi-writer service",
- "roleType": "admin",
- "serviceEnvironments": [
- {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}
], - "serviceProviderID": "sp-12345678",
- "serviceProviderName": "Omnistrate, Inc."
}, - {
- "createdAt": "2019-01-01T00:00:00Z",
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "s-12345678",
- "key": "mysql",
- "name": "MySQL multi-writer service",
- "roleType": "admin",
- "serviceEnvironments": [
- {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}
], - "serviceProviderID": "sp-12345678",
- "serviceProviderName": "Omnistrate, Inc."
}, - {
- "createdAt": "2019-01-01T00:00:00Z",
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "s-12345678",
- "key": "mysql",
- "name": "MySQL multi-writer service",
- "roleType": "admin",
- "serviceEnvironments": [
- {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}
], - "serviceProviderID": "sp-12345678",
- "serviceProviderName": "Omnistrate, Inc."
}
]
}
description required | string A brief description of the service |
name required | string Name of the Service |
serviceLogoURL | string <uri> The logo for the service |
{- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "name": "MySQL multi-writer service",
}
"s-12345678"
id required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID to operate on |
{- "createdAt": "2019-01-01T00:00:00Z",
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "s-12345678",
- "key": "mysql",
- "name": "MySQL multi-writer service",
- "roleType": "admin",
- "serviceEnvironments": [
- {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}, - {
- "id": "se-12345678",
- "name": "dev",
- "saasPortalStatus": "READY",
- "servicePlans": [
- {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}, - {
- "description": "A Basic product tier",
- "modelType": "CUSTOMER_HOSTED",
- "name": "Basic",
- "productTierID": "pt-12345678",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
], - "type": "DEV",
- "visibility": "private"
}
], - "serviceProviderID": "sp-12345678",
- "serviceProviderName": "Omnistrate, Inc."
}
id required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID to operate on |
description | string A brief description of the service |
name | string Name of the Service |
serviceLogoURL | string <uri> The logo for the service |
{- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "name": "MySQL multi-writer service",
}
id required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service |
{- "health": "UP",
- "id": "s-12345678",
- "report": {
- "se-12345678": {
- "sm-12345678": {
- "vu-11111111": "UNKNOWN",
- "vu-12345678": "UP",
- "vu-87654321": "DOWN"
}
}
}
}
description required | string A brief description of the service |
fileContent required | string Base64 encoded Compose Spec YAML in docker compose format |
fileFormat required | string MIME type of file format |
fileName required | string Name of compose spec YAML file that is uploaded |
name required | string Name of the Service |
serviceLogoURL | string <uri> The logo for the service |
{- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "fileContent": "Aliquam aut labore necessitatibus et eos qui.",
- "fileFormat": "text/plain",
- "fileName": "mysql.yaml",
- "name": "MySQL multi-writer service",
}
"s-12345678"
object Configs for the service. Key is the compose spec name of the config and value is base64 encoded config content | |
description | string A brief description of the service |
environment | string The environment to build the service in |
environmentType | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" The type of the environment |
fileContent required | string Base64 encoded Compose Spec YAML in docker compose format |
name required | string Name of the Service |
release | boolean Release the service after building |
releaseAsPreferred | boolean Release the service as preferred |
object Secrets for the service. Key is the compose spec name of the secret and value is base64 encoded secret content | |
serviceLogoURL | string <uri> The logo for the service |
{- "configs": {
- "Porro natus.": "Earum minima voluptates cupiditate."
}, - "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "environment": "dev",
- "environmentType": "DEV",
- "fileContent": "Voluptatem veniam excepturi ex vel.",
- "name": "MySQL multi-writer service",
- "release": true,
- "releaseAsPreferred": true,
- "secrets": {
- "Aliquid pariatur molestiae quod unde.": "Labore quisquam dolore.",
- "Vero reiciendis.": "Qui consequuntur doloremque ullam esse."
},
}
{- "productTierID": "pt-12345678",
- "serviceEnvironmentID": "se-12345678",
- "serviceID": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service this environment belongs to |
{- "ids": [
- "se-12345678",
- "se-23456789"
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service this environment belongs to |
autoApproveSubscription | boolean Auto approve subscription or not |
deploymentConfigId required | string^(?P<entitytype>dc)-(?P<entityid>[a-zA-Z0-9][... The deployment configuration ID |
description required | string A brief description of the service environment |
name required | string Name of the Service Environment |
serviceAuthPublicKey | string PEM-encoded Public key part of the key used to sign the JWT tokens for the service control plane APIs |
sourceEnvironmentId | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... The ID of the service environment to use for promoting changes to this environment |
type | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" |
visibility | string Enum: "PUBLIC" "PRIVATE" This parameter is used to configure the visibility of the service control-plane APIs |
{- "autoApproveSubscription": false,
- "deploymentConfigId": "dc-12345678",
- "description": "The production environment for the MySQL multi-writer service",
- "name": "Production",
- "serviceAuthPublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
- "sourceEnvironmentId": "se-12345678",
- "type": "DEV",
- "visibility": "PUBLIC"
}
"se-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service this environment belongs to |
id required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 The ID of the service environment |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service this environment belongs to |
id required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 The ID of the service environment |
{- "autoApproveSubscription": false,
- "deploymentConfigId": "dc-12345678",
- "description": "The production environment for the MySQL multi-writer service",
- "id": "se-12345678",
- "key": "production",
- "name": "Production",
- "roleType": "admin",
- "saasPortalStatus": "READY",
- "serviceAuthPublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
- "serviceId": "s-12345678",
- "sourceEnvironmentId": "se-12345678",
- "type": "DEV",
- "visibility": "PUBLIC"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service this environment belongs to |
id required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 The ID of the service environment |
autoApproveSubscription | boolean Auto approve subscription or not |
deploymentConfigId | string^(?P<entitytype>dc)-(?P<entityid>[a-zA-Z0-9][... The deployment configuration ID |
description | string A brief description of the service environment |
name | string Name of the Service Environment |
serviceAuthPublicKey | string PEM-encoded Public key part of the key used to sign the JWT tokens for the service control plane APIs |
sourceEnvironmentId | string The ID of the service environment to use for promoting changes to this environment |
visibility | string Enum: "PUBLIC" "PRIVATE" This parameter is used to configure the visibility of the service control-plane APIs |
{- "autoApproveSubscription": false,
- "deploymentConfigId": "dc-12345678",
- "description": "The production environment for the MySQL multi-writer service",
- "name": "Production",
- "serviceAuthPublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
- "sourceEnvironmentId": "se-12345678",
- "visibility": "PRIVATE"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service this environment belongs to |
id required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 The ID of the service environment |
[- {
- "status": "IN_SYNC",
- "targetEnvironmentID": "se-12345678"
}, - {
- "status": "IN_SYNC",
- "targetEnvironmentID": "se-12345678"
}
]
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service this environment belongs to |
id required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 The ID of the service environment |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service this model is for |
accountConfigIds | Array of strings[^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...] The infrastructure account configuration ID list |
description required | string A brief description of the service model |
modelType required | string Enum: "OMNISTRATE_HOSTED" "CUSTOMER_HOSTED" "BYOA" The model type encapsulating this service |
name required | string Name of the Service Model |
serviceApiId required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... The service API this model is for |
{- "accountConfigIds": [
- "ac-12345678",
- "ac-23456789"
], - "description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "modelType": "CUSTOMER_HOSTED",
- "name": "MySQL multi-writer service hosted model",
- "serviceApiId": "sa-12345678"
}
"sm-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID this model belongs to |
id required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 The service model ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID this model belongs to |
id required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 The service model ID |
{- "accountConfigIds": [
- "ac-12345678",
- "ac-23456789"
], - "activeAccountConfigIds": {
- "aws": "ac-12345678",
- "gcp": "ac-23456789"
}, - "description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "id": "sm-12345678",
- "key": "mysql-multi-writer-service-hosted-model",
- "modelType": "CUSTOMER_HOSTED",
- "name": "MySQL multi-writer service hosted model",
- "productTiers": [
- "pt-12345678",
- "pt-87654321"
], - "serviceApiId": "sa-12345678",
- "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID this model belongs to |
id required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 The service model ID |
description | string A brief description of the service model |
name | string Name of the Service Model |
{- "description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "name": "MySQL multi-writer service hosted model"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID this model belongs to |
id required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 The service model ID |
accountConfigId required | string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][... The infrastructure account configuration ID |
{- "accountConfigId": "ac-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID this model belongs to |
id required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 The service model ID |
accountConfigId required | string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][... The infrastructure account configuration ID |
{- "accountConfigId": "ac-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID this model belongs to |
id required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 The service model ID |
accountConfigId required | string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][... Example: ac-12345678 The infrastructure account configuration ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID this model belongs to |
id required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 The service model ID |
{- "status": "READY"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID this model belongs to |
sourceId required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 The source service model ID |
accountConfigIds | Array of strings[^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][...] The infrastructure account configuration ID list |
description required | string A brief description of the service model |
name required | string Name of the Service Model |
targetServiceModelType required | string Enum: "OMNISTRATE_HOSTED" "CUSTOMER_HOSTED" "BYOA" The model type encapsulating this service |
targetTierType | string Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY" "CUSTOM_TENANCY" Target product tier type |
{- "accountConfigIds": [
- "ac-12345678",
- "ac-23456789"
], - "description": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "name": "MySQL multi-writer service hosted model",
- "targetServiceModelType": "CUSTOMER_HOSTED",
- "targetTierType": "OMNISTRATE_DEDICATED_TENANCY"
}
"sm-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
serviceApiId required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... Example: sa-12345678 The service API ID |
{- "ids": [
- "sm-12345678",
- "sm-87654321"
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
serviceModelId required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 Service model ID |
{- "ids": [
- "pt-X19",
- "pt-I"
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
awsRegions | Array of strings The AWS regions that this product tier is available on |
description required | string A brief description of the product tier |
documentation | string Documentation |
gcpRegions | Array of strings The GCP regions that this product tier is available on |
isDisabled | boolean Create the product tier in a disabled state. Enabling the product tier will let end-customers subscribe and use the service plan. |
name required | string Name of the product tier |
planDescription required | string A brief description for the end user of the product tier |
pricing | string <binary> Pricing |
serviceModelId required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Service model ID |
support | string Support |
tierType required | string Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY" "CUSTOM_TENANCY" Tier type |
{- "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "description": "A premium product tier",
- "documentation": "Any documentation",
- "gcpRegions": [
- "us-central1"
], - "isDisabled": false,
- "name": "Premium",
- "planDescription": "A premium plan",
- "pricing": {
- "price1": "value1"
}, - "serviceModelId": "sm-12345678",
- "support": "Any support",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
"pt-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
id required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
id required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
version | string Example: version=3.0 The version number for the specific version set |
{- "apiGroups": {
- "r-12345678": "v1",
- "r-23456789": "v2",
- "r-34567890": "v3"
}, - "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "description": "A premium product tier",
- "documentation": "Any documentation",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "gcpRegions": [
- "us-central1"
], - "id": "pt-12345678",
- "isDisabled": false,
- "key": "premium",
- "name": "Premium",
- "planDescription": "A premium plan",
- "pricing": {
- "price1": "value1"
}, - "serviceId": "s-12345678",
- "serviceModelId": "sm-12345678",
- "support": "Any support",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
id required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
awsRegions | Array of strings The AWS regions that this product tier is available on |
description | string A brief description of the product tier |
documentation | string Documentation |
gcpRegions | Array of strings The GCP regions that this product tier is available on |
isDisabled | boolean Update the product tier's state as enabled/disabled. Enabling the product tier will let end-customers subscribe and use the service plan. |
name | string Name of the product tier |
planDescription | string A brief description for the end user of the product tier |
pricing | string <binary> Pricing |
support | string Support |
tierType | string Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY" "CUSTOM_TENANCY" Tier type |
{- "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "description": "A premium product tier",
- "documentation": "Any documentation",
- "gcpRegions": [
- "us-central1"
], - "isDisabled": false,
- "name": "Premium",
- "planDescription": "A premium plan",
- "pricing": {
- "price1": "value1"
}, - "support": "Any support",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
id required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
{- "billingPlans": [
- {
- "allowCreatesWhenPaymentNotConfigured": true,
- "id": "bp-12345678",
- "maxNumberofInstances": 5,
- "planName": "STARTER",
- "pricing": {
- "cpuCoreHours": "0.001",
- "memoryGiBHours": "0.0001",
- "storageGiBHours": "0.0001"
}, - "productTierId": "pt-12345678",
- "serviceId": "s-12345678"
}, - {
- "allowCreatesWhenPaymentNotConfigured": true,
- "id": "bp-12345678",
- "maxNumberofInstances": 5,
- "planName": "STARTER",
- "pricing": {
- "cpuCoreHours": "0.001",
- "memoryGiBHours": "0.0001",
- "storageGiBHours": "0.0001"
}, - "productTierId": "pt-12345678",
- "serviceId": "s-12345678"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
id required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
allowCreatesWhenPaymentNotConfigured required | boolean Allow creates when payment not configured |
maxNumberofInstances required | integer <int64> Maximum number of instances |
planName required | string Plan name |
pricing required | string <binary> Pricing in dollars. |
{- "allowCreatesWhenPaymentNotConfigured": true,
- "maxNumberofInstances": 5,
- "planName": "STARTER",
- "pricing": {
- "cpuCoreHours": "0.001",
- "memoryGiBHours": "0.0001",
- "storageGiBHours": "0.0001"
}
}
{- "allowCreatesWhenPaymentNotConfigured": true,
- "id": "bp-12345678",
- "maxNumberofInstances": 5,
- "planName": "STARTER",
- "pricing": {
- "cpuCoreHours": "0.001",
- "memoryGiBHours": "0.0001",
- "storageGiBHours": "0.0001"
}, - "productTierId": "pt-12345678",
- "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
id required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
feature required | string Enum: "LOGS" "METRICS" "BILLING" "ALERTS" "CLOUD_INSURANCE" "MARKETPLACE" "OPERATIONAL_STATUS" Feature to disable |
scope | string Enum: "INTERNAL" "CUSTOMER" Feature scope |
{- "feature": "BILLING",
- "scope": "INTERNAL"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
id required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
object The configuration parameters of the product tier feature | |
feature required | string Enum: "LOGS" "METRICS" "BILLING" "ALERTS" "CLOUD_INSURANCE" "MARKETPLACE" "OPERATIONAL_STATUS" Feature to enable |
scope | string Enum: "INTERNAL" "CUSTOMER" Feature scope |
{- "configuration": {
- "S3BucketArn": "arn:aws:s3:::my_billing_bucket_name"
}, - "feature": "BILLING",
- "scope": "INTERNAL"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
id required | string^(?P<entitytype>bp)-(?P<entityid>[a-zA-Z0-9][... Example: bp-12345678 Product tier billing plan ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
id required | string^(?P<entitytype>bp)-(?P<entityid>[a-zA-Z0-9][... Example: bp-12345678 Product tier billing plan ID |
{- "allowCreatesWhenPaymentNotConfigured": true,
- "id": "bp-12345678",
- "maxNumberofInstances": 5,
- "planName": "STARTER",
- "pricing": {
- "cpuCoreHours": "0.001",
- "memoryGiBHours": "0.0001",
- "storageGiBHours": "0.0001"
}, - "productTierId": "pt-12345678",
- "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
id required | string^(?P<entitytype>bp)-(?P<entityid>[a-zA-Z0-9][... Example: bp-12345678 Product tier billing plan ID |
allowCreatesWhenPaymentNotConfigured | boolean Allow creates when payment not configured |
maxNumberofInstances | integer <int64> Maximum number of instances |
planName | string Plan name |
pricing | string <binary> Pricing in dollars. |
{- "allowCreatesWhenPaymentNotConfigured": true,
- "maxNumberofInstances": 5,
- "planName": "STARTER",
- "pricing": {
- "cpuCoreHours": "0.001",
- "memoryGBHours": "0.0001"
}
}
{- "allowCreatesWhenPaymentNotConfigured": true,
- "id": "bp-12345678",
- "maxNumberofInstances": 5,
- "planName": "STARTER",
- "pricing": {
- "cpuCoreHours": "0.001",
- "memoryGiBHours": "0.0001",
- "storageGiBHours": "0.0001"
}, - "productTierId": "pt-12345678",
- "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
sourceId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 The source product tier ID |
awsRegions | Array of strings The AWS regions that this product tier is available on |
description required | string A brief description of the product tier |
documentation | string Documentation |
gcpRegions | Array of strings The GCP regions that this product tier is available on |
name required | string Name of the product tier |
planDescription | string A brief description for the end user of the product tier |
pricing | string <binary> Pricing |
serviceModelId required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Service model ID |
support | string Support |
targetTierType | string Enum: "OMNISTRATE_DEDICATED_TENANCY" "OMNISTRATE_MULTI_TENANCY" "CUSTOM_TENANCY" Tier type |
{- "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "description": "A premium product tier",
- "documentation": "Any documentation",
- "gcpRegions": [
- "us-central1"
], - "name": "Premium",
- "planDescription": "A premium plan",
- "pricing": {
- "price1": "value1"
}, - "serviceModelId": "sm-12345678",
- "support": "Any support",
- "targetTierType": "OMNISTRATE_DEDICATED_TENANCY"
}
"pt-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
description required | string A brief description of the service API bundle |
serviceEnvironmentId required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... The service environment ID |
{- "description": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
- "serviceEnvironmentId": "se-12345678"
}
"sa-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... Example: sa-12345678 The service API ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... Example: sa-12345678 The service API ID |
{- "apiVersion": "v1",
- "deploymentConfigId": "dc-12345678",
- "description": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
- "id": "sa-12345678",
- "serviceEnvironmentId": "se-12345678",
- "serviceId": "s-12345678",
- "serviceName": "mysql"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... Example: sa-12345678 The service API ID |
description | string A brief description of the service API bundle |
{- "description": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... Example: sa-12345678 The service API ID |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: productTierId=pt-12345678 ProductTierID of the resource to describe pending changes forNeeds to specified in combination with the product tier version |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... Example: sa-12345678 The service API ID |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: productTierId=pt-12345678 ProductTierID of the resource to describe pending changes forNeeds to specified in combination with the product tier version |
{- "id": "sa-12345678",
- "resourceChangeSets": {
- "r-K": {
- "categorizedResourceChanges": {
- "Et accusamus.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}, - "Quia soluta ex qui ut.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}
}, - "imageConfigChanges": {
- "changeState": "PENDING_NEW",
- "imageConfigId": "imgc-12345678",
- "imageName": "mysql"
}, - "infraConfigChanges": {
- "changeState": "PENDING_NEW",
- "infraConfigId": "ic-12345678",
- "name": "MySQL Writer Infra Config"
}, - "overallResourceStatus": "PENDING_UPDATE",
- "productTierFeatureChanges": "PENDING_UPDATE",
- "resourceChanges": "PENDING_DELETE",
- "resourceName": "Hic quaerat."
}, - "r-u": {
- "categorizedResourceChanges": {
- "Et accusamus.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}, - "Quia soluta ex qui ut.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}
}, - "imageConfigChanges": {
- "changeState": "PENDING_NEW",
- "imageConfigId": "imgc-12345678",
- "imageName": "mysql"
}, - "infraConfigChanges": {
- "changeState": "PENDING_NEW",
- "infraConfigId": "ic-12345678",
- "name": "MySQL Writer Infra Config"
}, - "overallResourceStatus": "PENDING_UPDATE",
- "productTierFeatureChanges": "PENDING_UPDATE",
- "resourceChanges": "PENDING_DELETE",
- "resourceName": "Hic quaerat."
}
}, - "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... Example: sa-12345678 The service API ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>sa)-(?P<entityid>[a-zA-Z0-9][... Example: sa-12345678 The service API ID |
isPreferred | boolean Default: false Indicates whether this version set is preferred. |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... The product tier ID |
versionSetName | string The name of the version set to release |
versionSetType | string Enum: "Major" "Incremental" "UserDefined" The version-set type of the product-tier. |
{- "isPreferred": true,
- "productTierId": "pt-12345678",
- "versionSetName": "v1",
- "versionSetType": "Major"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
serviceEnvironmentId required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 The service environment ID |
{- "ids": [
- "sa-12345678"
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
serviceEnvironmentId required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 Service environment ID |
{- "nextPageToken": "next-token",
- "servicePlans": [
- {
- "AutoApproveSubscription": false,
- "accountConfigIds": [
- "ac-12345678",
- "ac-23456789"
], - "activeAccountConfigIds": {
- "aws": "ac-12345678",
- "gcp": "ac-23456789"
}, - "apiVersion": "v1",
- "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "deploymentConfigId": "dc-12345678",
- "gcpRegions": [
- "us-central1"
], - "hasPendingChanges": true,
- "isProductTierDisabled": true,
- "latestMajorVersion": "3.0",
- "modelType": "CUSTOMER_HOSTED",
- "productTierDescription": "A premium product tier",
- "productTierDocumentation": "Any documentation",
- "productTierFeatures": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "productTierId": "pt-12345678",
- "productTierKey": "premium",
- "productTierName": "Premium",
- "productTierPlanDescription": "A premium plan",
- "productTierPricing": {
- "price1": "value1"
}, - "productTierSupport": "Any support",
- "serviceApiDescription": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
- "serviceApiId": "sa-12345678",
- "serviceEnvironmentId": "se-12345678",
- "serviceModelDescription": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "serviceModelId": "sm-12345678",
- "serviceModelName": "MySQL multi-writer service hosted model",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY",
- "versionSetStatus": "Active"
}, - {
- "AutoApproveSubscription": false,
- "accountConfigIds": [
- "ac-12345678",
- "ac-23456789"
], - "activeAccountConfigIds": {
- "aws": "ac-12345678",
- "gcp": "ac-23456789"
}, - "apiVersion": "v1",
- "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "deploymentConfigId": "dc-12345678",
- "gcpRegions": [
- "us-central1"
], - "hasPendingChanges": true,
- "isProductTierDisabled": true,
- "latestMajorVersion": "3.0",
- "modelType": "CUSTOMER_HOSTED",
- "productTierDescription": "A premium product tier",
- "productTierDocumentation": "Any documentation",
- "productTierFeatures": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "productTierId": "pt-12345678",
- "productTierKey": "premium",
- "productTierName": "Premium",
- "productTierPlanDescription": "A premium plan",
- "productTierPricing": {
- "price1": "value1"
}, - "productTierSupport": "Any support",
- "serviceApiDescription": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
- "serviceApiId": "sa-12345678",
- "serviceEnvironmentId": "se-12345678",
- "serviceModelDescription": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "serviceModelId": "sm-12345678",
- "serviceModelName": "MySQL multi-writer service hosted model",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY",
- "versionSetStatus": "Active"
}, - {
- "AutoApproveSubscription": false,
- "accountConfigIds": [
- "ac-12345678",
- "ac-23456789"
], - "activeAccountConfigIds": {
- "aws": "ac-12345678",
- "gcp": "ac-23456789"
}, - "apiVersion": "v1",
- "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "deploymentConfigId": "dc-12345678",
- "gcpRegions": [
- "us-central1"
], - "hasPendingChanges": true,
- "isProductTierDisabled": true,
- "latestMajorVersion": "3.0",
- "modelType": "CUSTOMER_HOSTED",
- "productTierDescription": "A premium product tier",
- "productTierDocumentation": "Any documentation",
- "productTierFeatures": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "productTierId": "pt-12345678",
- "productTierKey": "premium",
- "productTierName": "Premium",
- "productTierPlanDescription": "A premium plan",
- "productTierPricing": {
- "price1": "value1"
}, - "productTierSupport": "Any support",
- "serviceApiDescription": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
- "serviceApiId": "sa-12345678",
- "serviceEnvironmentId": "se-12345678",
- "serviceModelDescription": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "serviceModelId": "sm-12345678",
- "serviceModelName": "MySQL multi-writer service hosted model",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY",
- "versionSetStatus": "Active"
}, - {
- "AutoApproveSubscription": false,
- "accountConfigIds": [
- "ac-12345678",
- "ac-23456789"
], - "activeAccountConfigIds": {
- "aws": "ac-12345678",
- "gcp": "ac-23456789"
}, - "apiVersion": "v1",
- "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "deploymentConfigId": "dc-12345678",
- "gcpRegions": [
- "us-central1"
], - "hasPendingChanges": true,
- "isProductTierDisabled": true,
- "latestMajorVersion": "3.0",
- "modelType": "CUSTOMER_HOSTED",
- "productTierDescription": "A premium product tier",
- "productTierDocumentation": "Any documentation",
- "productTierFeatures": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "productTierId": "pt-12345678",
- "productTierKey": "premium",
- "productTierName": "Premium",
- "productTierPlanDescription": "A premium plan",
- "productTierPricing": {
- "price1": "value1"
}, - "productTierSupport": "Any support",
- "serviceApiDescription": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
- "serviceApiId": "sa-12345678",
- "serviceEnvironmentId": "se-12345678",
- "serviceModelDescription": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "serviceModelId": "sm-12345678",
- "serviceModelName": "MySQL multi-writer service hosted model",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY",
- "versionSetStatus": "Active"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 Product tier ID |
{- "AutoApproveSubscription": false,
- "accountConfigIds": [
- "ac-12345678",
- "ac-23456789"
], - "activeAccountConfigIds": {
- "aws": "ac-12345678",
- "gcp": "ac-23456789"
}, - "apiVersion": "v1",
- "awsRegions": [
- "us-east-2",
- "ca-central-1"
], - "deploymentConfigId": "dc-12345678",
- "gcpRegions": [
- "us-central1"
], - "hasPendingChanges": true,
- "isProductTierDisabled": true,
- "latestMajorVersion": "3.0",
- "modelType": "CUSTOMER_HOSTED",
- "productTierDescription": "A premium product tier",
- "productTierDocumentation": "Any documentation",
- "productTierFeatures": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "productTierId": "pt-12345678",
- "productTierKey": "premium",
- "productTierName": "Premium",
- "productTierPlanDescription": "A premium plan",
- "productTierPricing": {
- "price1": "value1"
}, - "productTierSupport": "Any support",
- "serviceApiDescription": "A MySQL SaaS API specializing in multi-writer multi-tenant clusters for high availability",
- "serviceApiId": "sa-12345678",
- "serviceEnvironmentId": "se-12345678",
- "serviceModelDescription": "A MySQL Hosted SaaS specializing in multi-writer clusters for high availability",
- "serviceModelId": "sm-12345678",
- "serviceModelName": "MySQL multi-writer service hosted model",
- "tierType": "OMNISTRATE_DEDICATED_TENANCY",
- "versionSetStatus": "Active"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: si-12345678 The ID of the service to list resources for |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: pt-12345678 The product tier ID |
managed | boolean Example: managed=false Is resource managed by omnistrate |
ProductTierVersion | string Example: ProductTierVersion=Eligendi non a. Product tier version of the instance to describe. If not specified, the latest version is described. |
{- "ids": [
- "r-12345678",
- "r-abcdefgh",
- "r-1234abcd"
], - "nextPageToken": "next-token",
- "resources": [
- {
- "actionHooks": [
- {
- "command": "curl -v -X POST https://$HOSTNAME:8080/cluster/init",
- "scope": "CLUSTER",
- "type": "INIT"
}
], - "additionalSecurityContext": {
- "AddCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "DropCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "SupplementalGroupIDs": [
- 1001,
- 999
]
}, - "backupConfiguration": {
- "backupPeriodInHours": 24,
- "backupRetentionInDays": 7
}, - "capabilities": [
- {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}
], - "customLabels": {
- "key": "value"
}, - "customSysCTLs": {
- "net.ipv4.tcp_syncookies": "1"
}, - "customULimits": [
- {
- "ULimitsName": "NoProc",
- "ULimitsType": "Soft",
- "ULimitsValue": 1000
}, - {
- "ULimitsName": "NoFile",
- "ULimitsType": "Hard",
- "ULimitsValue": 2048
}
], - "dependencies": [
- {
- "parameterMap": {
- "clusterId": "writerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-12345678"
}, - {
- "parameterMap": {
- "clusterId": "readerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-abcdef12"
}
], - "description": "An resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
- "environmentVariables": [
- {
- "description": "The root password for the MySQL instance",
- "name": "MYSQL_ROOT_PASSWORD",
- "value": "password"
}
], - "fileSystemConfiguration": {
- "EFSFileSystemConfiguration": {
- "PerformanceMode": "maxIO",
- "ProvisionedThroughputInMibps": 125,
- "ThroughputMode": "provisioned"
}
}, - "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "internal": false,
- "isDeprecated": true,
- "key": "galera",
- "l4LoadBalancerConfiguration": {
- "ingressPortConfiguration": [
- {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8080,
- "ingressPort": 1234
}, - {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8081,
- "ingressPort": 5678
}, - {
- "associatedResourceIDs": [
- "r-vwxybz12",
- "r-poij122v"
], - "backendPort": 8082,
- "ingressPort": 9012
}
]
}, - "l7LoadBalancerConfiguration": {
- "paths": [
- {
- "associatedResourceID": "r-12345678",
- "path": "/path",
- "port": 8080
}
]
}, - "name": "Galera",
- "operatorCRDConfiguration": {
- "helmChartDependencies": [
- {
- "chartName": "cert-manager",
- "chartVersion": "v1.5.3"
}, - {
- "chartName": "nginx-ingress",
- "chartVersion": "v0.48.1"
}, - {
- "chartName": "external-dns",
- "chartVersion": "v0.7.0"
}, - {
- "chartName": "cnpg-operator",
- "chartVersion": "v0.23.1"
}
], - "outputParameters": {
- "expiresAt": "$out.status.notAfter",
- "issuerName": "letsencrypt-prod"
}, - "readinessConditions": {
- "$out.status.conditions[?(@.type=='Ready')].status": "True"
}, - "template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n name: letsencrypt-prod\nspec:\n acme:\n server: https://acme-v02.api.letsencrypt.org/directory\n email: test@example.com\n privateKeySecretRef:\n name: letsencrypt-prod\n solvers:\n - http01:\n ingress:\n class: nginx"
}, - "productTierId": "pt-12345678",
- "proxyType": "PortsBasedProxy",
- "resourceType": "Generic",
- "serviceId": "s-12345678"
}, - {
- "actionHooks": [
- {
- "command": "curl -v -X POST https://$HOSTNAME:8080/cluster/init",
- "scope": "CLUSTER",
- "type": "INIT"
}
], - "additionalSecurityContext": {
- "AddCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "DropCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "SupplementalGroupIDs": [
- 1001,
- 999
]
}, - "backupConfiguration": {
- "backupPeriodInHours": 24,
- "backupRetentionInDays": 7
}, - "capabilities": [
- {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}
], - "customLabels": {
- "key": "value"
}, - "customSysCTLs": {
- "net.ipv4.tcp_syncookies": "1"
}, - "customULimits": [
- {
- "ULimitsName": "NoProc",
- "ULimitsType": "Soft",
- "ULimitsValue": 1000
}, - {
- "ULimitsName": "NoFile",
- "ULimitsType": "Hard",
- "ULimitsValue": 2048
}
], - "dependencies": [
- {
- "parameterMap": {
- "clusterId": "writerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-12345678"
}, - {
- "parameterMap": {
- "clusterId": "readerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-abcdef12"
}
], - "description": "An resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
- "environmentVariables": [
- {
- "description": "The root password for the MySQL instance",
- "name": "MYSQL_ROOT_PASSWORD",
- "value": "password"
}
], - "fileSystemConfiguration": {
- "EFSFileSystemConfiguration": {
- "PerformanceMode": "maxIO",
- "ProvisionedThroughputInMibps": 125,
- "ThroughputMode": "provisioned"
}
}, - "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "internal": false,
- "isDeprecated": true,
- "key": "galera",
- "l4LoadBalancerConfiguration": {
- "ingressPortConfiguration": [
- {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8080,
- "ingressPort": 1234
}, - {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8081,
- "ingressPort": 5678
}, - {
- "associatedResourceIDs": [
- "r-vwxybz12",
- "r-poij122v"
], - "backendPort": 8082,
- "ingressPort": 9012
}
]
}, - "l7LoadBalancerConfiguration": {
- "paths": [
- {
- "associatedResourceID": "r-12345678",
- "path": "/path",
- "port": 8080
}
]
}, - "name": "Galera",
- "operatorCRDConfiguration": {
- "helmChartDependencies": [
- {
- "chartName": "cert-manager",
- "chartVersion": "v1.5.3"
}, - {
- "chartName": "nginx-ingress",
- "chartVersion": "v0.48.1"
}, - {
- "chartName": "external-dns",
- "chartVersion": "v0.7.0"
}, - {
- "chartName": "cnpg-operator",
- "chartVersion": "v0.23.1"
}
], - "outputParameters": {
- "expiresAt": "$out.status.notAfter",
- "issuerName": "letsencrypt-prod"
}, - "readinessConditions": {
- "$out.status.conditions[?(@.type=='Ready')].status": "True"
}, - "template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n name: letsencrypt-prod\nspec:\n acme:\n server: https://acme-v02.api.letsencrypt.org/directory\n email: test@example.com\n privateKeySecretRef:\n name: letsencrypt-prod\n solvers:\n - http01:\n ingress:\n class: nginx"
}, - "productTierId": "pt-12345678",
- "proxyType": "PortsBasedProxy",
- "resourceType": "Generic",
- "serviceId": "s-12345678"
}, - {
- "actionHooks": [
- {
- "command": "curl -v -X POST https://$HOSTNAME:8080/cluster/init",
- "scope": "CLUSTER",
- "type": "INIT"
}
], - "additionalSecurityContext": {
- "AddCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "DropCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "SupplementalGroupIDs": [
- 1001,
- 999
]
}, - "backupConfiguration": {
- "backupPeriodInHours": 24,
- "backupRetentionInDays": 7
}, - "capabilities": [
- {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}
], - "customLabels": {
- "key": "value"
}, - "customSysCTLs": {
- "net.ipv4.tcp_syncookies": "1"
}, - "customULimits": [
- {
- "ULimitsName": "NoProc",
- "ULimitsType": "Soft",
- "ULimitsValue": 1000
}, - {
- "ULimitsName": "NoFile",
- "ULimitsType": "Hard",
- "ULimitsValue": 2048
}
], - "dependencies": [
- {
- "parameterMap": {
- "clusterId": "writerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-12345678"
}, - {
- "parameterMap": {
- "clusterId": "readerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-abcdef12"
}
], - "description": "An resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
- "environmentVariables": [
- {
- "description": "The root password for the MySQL instance",
- "name": "MYSQL_ROOT_PASSWORD",
- "value": "password"
}
], - "fileSystemConfiguration": {
- "EFSFileSystemConfiguration": {
- "PerformanceMode": "maxIO",
- "ProvisionedThroughputInMibps": 125,
- "ThroughputMode": "provisioned"
}
}, - "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "internal": false,
- "isDeprecated": true,
- "key": "galera",
- "l4LoadBalancerConfiguration": {
- "ingressPortConfiguration": [
- {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8080,
- "ingressPort": 1234
}, - {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8081,
- "ingressPort": 5678
}, - {
- "associatedResourceIDs": [
- "r-vwxybz12",
- "r-poij122v"
], - "backendPort": 8082,
- "ingressPort": 9012
}
]
}, - "l7LoadBalancerConfiguration": {
- "paths": [
- {
- "associatedResourceID": "r-12345678",
- "path": "/path",
- "port": 8080
}
]
}, - "name": "Galera",
- "operatorCRDConfiguration": {
- "helmChartDependencies": [
- {
- "chartName": "cert-manager",
- "chartVersion": "v1.5.3"
}, - {
- "chartName": "nginx-ingress",
- "chartVersion": "v0.48.1"
}, - {
- "chartName": "external-dns",
- "chartVersion": "v0.7.0"
}, - {
- "chartName": "cnpg-operator",
- "chartVersion": "v0.23.1"
}
], - "outputParameters": {
- "expiresAt": "$out.status.notAfter",
- "issuerName": "letsencrypt-prod"
}, - "readinessConditions": {
- "$out.status.conditions[?(@.type=='Ready')].status": "True"
}, - "template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n name: letsencrypt-prod\nspec:\n acme:\n server: https://acme-v02.api.letsencrypt.org/directory\n email: test@example.com\n privateKeySecretRef:\n name: letsencrypt-prod\n solvers:\n - http01:\n ingress:\n class: nginx"
}, - "productTierId": "pt-12345678",
- "proxyType": "PortsBasedProxy",
- "resourceType": "Generic",
- "serviceId": "s-12345678"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
object (AdditionalSecurityContext) | |
object (BackupConfiguration) | |
object Custom labels for the resource | |
object Custom sysctl settings for the resource | |
Array of objects (CustomULimits) Custom ulimits for the resource | |
description required | string A brief description of the resource |
Array of objects (EnvironmentVariable) The environment variables that this resource requires | |
object (FileSystemConfiguration) | |
imageConfigId | string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9... The ID of the image configuration that this resource refers to |
infraConfigId | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... The ID of the infrastructure configuration that this resource refers to |
internal | boolean Default: false Whether this resource is internal or not |
isProxy | boolean Default: false Whether this resource is a proxy or not |
key | string The key of the resource |
object (L4LoadBalancerConfiguration) | |
object (L7LoadBalancerConfiguration) | |
name required | string Name of the resource |
object (OperatorCRDConfiguration) | |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... The product tier ID |
proxyType | string Default: "PortsBasedProxy" Value: "PortsBasedProxy" A proxy type of resource |
Array of objects (ResourceDependency) | |
resourceType | string Enum: "" "Generic" "L7LoadBalancer" "L4LoadBalancer" "FileSystem" "OperatorCRD" The type of the resource |
{- "additionalSecurityContext": {
- "AddCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "DropCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "SupplementalGroupIDs": [
- 1001,
- 999
]
}, - "backupConfiguration": {
- "backupPeriodInHours": 24,
- "backupRetentionInDays": 7
}, - "customLabels": {
- "key": "value"
}, - "customSysCTLs": {
- "net.ipv4.tcp_syncookies": "1"
}, - "customULimits": [
- {
- "ULimitsName": "NoProc",
- "ULimitsType": "Soft",
- "ULimitsValue": 1000
}, - {
- "ULimitsName": "NoFile",
- "ULimitsType": "Hard",
- "ULimitsValue": 2048
}
], - "description": "A resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
- "environmentVariables": [
- {
- "key": "MYSQL_ROOT_PASSWORD",
- "value": "password"
}
], - "fileSystemConfiguration": {
- "EFSFileSystemConfiguration": {
- "PerformanceMode": "generalPurpose",
- "ProvisionedThroughputInMibps": 125,
- "ThroughputMode": "provisioned"
}
}, - "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "internal": false,
- "isProxy": true,
- "key": "galera",
- "l4LoadBalancerConfiguration": {
- "ingressPortConfiguration": [
- {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8080,
- "ingressPort": 1234
}, - {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8081,
- "ingressPort": 5678
}, - {
- "associatedResourceIDs": [
- "r-vwxybz12",
- "r-poij122v"
], - "backendPort": 8082,
- "ingressPort": 9012
}
]
}, - "l7LoadBalancerConfiguration": {
- "paths": [
- {
- "associatedResourceID": "r-12345678",
- "path": "/path",
- "port": 8080
}
]
}, - "name": "Galera",
- "operatorCRDConfiguration": {
- "helmChartDependencies": [
- {
- "chartName": "cert-manager",
- "chartVersion": "v1.5.3"
}, - {
- "chartName": "nginx-ingress",
- "chartVersion": "v0.48.1"
}, - {
- "chartName": "external-dns",
- "chartVersion": "v0.7.0"
}, - {
- "chartName": "cnpg-operator",
- "chartVersion": "v0.23.1"
}
], - "outputParameters": {
- "expiresAt": "$out.status.notAfter",
- "issuerName": "letsencrypt-prod"
}, - "readinessConditions": {
- "$out.status.conditions[?(@.type=='Ready')].status": "True"
}, - "template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n name: letsencrypt-prod\nspec:\n acme:\n server: https://acme-v02.api.letsencrypt.org/directory\n email: test@example.com\n privateKeySecretRef:\n name: letsencrypt-prod\n solvers:\n - http01:\n ingress:\n class: nginx"
}, - "productTierId": "pt-12345678",
- "proxyType": "PortsBasedProxy",
- "resourceDependencies": [
- {
- "parameterMap": {
- "userDatabase": "clusterOrg",
- "writerId": "clusterWriterId"
}, - "resourceId": "r-12345678"
}, - {
- "parameterMap": {
- "readerId": "clusterReaderId",
- "userDatabase": "clusterOrg"
}, - "resourceId": "r-abcdef12"
}
], - "resourceType": "Generic"
}
"r-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
ProductTierVersion | string Example: ProductTierVersion=Ratione hic similique repellendus atque optio maxime. Product tier version of the resource to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the resource to describe. Needs to specified in combination with the product tier version |
{- "actionHooks": [
- {
- "command": "curl -v -X POST https://$HOSTNAME:8080/cluster/init",
- "scope": "CLUSTER",
- "type": "INIT"
}
], - "additionalSecurityContext": {
- "AddCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "DropCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "SupplementalGroupIDs": [
- 1001,
- 999
]
}, - "backupConfiguration": {
- "backupPeriodInHours": 24,
- "backupRetentionInDays": 7
}, - "capabilities": [
- {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}
], - "customLabels": {
- "key": "value"
}, - "customSysCTLs": {
- "net.ipv4.tcp_syncookies": "1"
}, - "customULimits": [
- {
- "ULimitsName": "NoProc",
- "ULimitsType": "Soft",
- "ULimitsValue": 1000
}, - {
- "ULimitsName": "NoFile",
- "ULimitsType": "Hard",
- "ULimitsValue": 2048
}
], - "dependencies": [
- {
- "parameterMap": {
- "clusterId": "writerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-12345678"
}, - {
- "parameterMap": {
- "clusterId": "readerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-abcdef12"
}
], - "description": "An resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
- "environmentVariables": [
- {
- "description": "The root password for the MySQL instance",
- "name": "MYSQL_ROOT_PASSWORD",
- "value": "password"
}
], - "fileSystemConfiguration": {
- "EFSFileSystemConfiguration": {
- "PerformanceMode": "maxIO",
- "ProvisionedThroughputInMibps": 125,
- "ThroughputMode": "provisioned"
}
}, - "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "internal": true,
- "isDeprecated": true,
- "key": "galera",
- "l4LoadBalancerConfiguration": {
- "ingressPortConfiguration": [
- {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8080,
- "ingressPort": 1234
}, - {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8081,
- "ingressPort": 5678
}, - {
- "associatedResourceIDs": [
- "r-vwxybz12",
- "r-poij122v"
], - "backendPort": 8082,
- "ingressPort": 9012
}
]
}, - "l7LoadBalancerConfiguration": {
- "paths": [
- {
- "associatedResourceID": "r-12345678",
- "path": "/path",
- "port": 8080
}
]
}, - "name": "Galera",
- "operatorCRDConfiguration": {
- "helmChartDependencies": [
- {
- "chartName": "cert-manager",
- "chartVersion": "v1.5.3"
}, - {
- "chartName": "nginx-ingress",
- "chartVersion": "v0.48.1"
}, - {
- "chartName": "external-dns",
- "chartVersion": "v0.7.0"
}, - {
- "chartName": "cnpg-operator",
- "chartVersion": "v0.23.1"
}
], - "outputParameters": {
- "expiresAt": "$out.status.notAfter",
- "issuerName": "letsencrypt-prod"
}, - "readinessConditions": {
- "$out.status.conditions[?(@.type=='Ready')].status": "True"
}, - "template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n name: letsencrypt-prod\nspec:\n acme:\n server: https://acme-v02.api.letsencrypt.org/directory\n email: test@example.com\n privateKeySecretRef:\n name: letsencrypt-prod\n solvers:\n - http01:\n ingress:\n class: nginx"
}, - "productTierId": "pt-12345678",
- "proxyType": "PortsBasedProxy",
- "resourceType": "Generic",
- "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
object (AdditionalSecurityContext) | |
object (BackupConfiguration) | |
object Custom labels for the resource | |
object Custom sysctl settings for the resource | |
Array of objects (CustomULimits) Custom ulimits for the resource | |
Array of objects (ResourceDependency) | |
description | string A brief description of the resource |
Array of objects (EnvironmentVariable) The environment variables that this resource requires | |
imageConfigId | string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9... The ID of the image configuration that this resource refers to |
infraConfigId | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... The ID of the infrastructure configuration that this resource refers to |
object (L4LoadBalancerConfiguration) | |
object (L7LoadBalancerConfiguration) | |
name | string Name of the resource |
object (OperatorCRDConfiguration) |
{- "additionalSecurityContext": {
- "AddCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "DropCapabilities": [
- "CAP_NET_ADMIN",
- "CAP_NET_RAW"
], - "SupplementalGroupIDs": [
- 1001,
- 999
]
}, - "backupConfiguration": {
- "backupPeriodInHours": 24,
- "backupRetentionInDays": 7
}, - "customLabels": {
- "key": "value"
}, - "customSysCTLs": {
- "net.ipv4.tcp_syncookies": "1"
}, - "customULimits": [
- {
- "ULimitsName": "NoProc",
- "ULimitsType": "Soft",
- "ULimitsValue": 1000
}, - {
- "ULimitsName": "NoFile",
- "ULimitsType": "Hard",
- "ULimitsValue": 2048
}
], - "dependencies": [
- {
- "parameterMap": {
- "clusterId": "writerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-12345678"
}, - {
- "parameterMap": {
- "clusterId": "readerId",
- "clusterOrg": "userDatabase"
}, - "resourceId": "r-abcdef12"
}
], - "description": "A resource to manage a hosted public SaaS offering of a multi-writer MySQL service",
- "environmentVariables": [
- {
- "key": "MYSQL_ROOT_PASSWORD",
- "value": "password"
}
], - "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "l4LoadBalancerConfiguration": {
- "ingressPortConfiguration": [
- {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8080,
- "ingressPort": 1234
}, - {
- "associatedResourceIDs": [
- "r-12345678",
- "r-abcdef12"
], - "backendPort": 8081,
- "ingressPort": 5678
}, - {
- "associatedResourceIDs": [
- "r-vwxybz12",
- "r-poij122v"
], - "backendPort": 8082,
- "ingressPort": 9012
}
]
}, - "l7LoadBalancerConfiguration": {
- "paths": [
- {
- "associatedResourceID": "r-12345678",
- "path": "/path",
- "port": 8080
}
]
}, - "name": "Galera",
- "operatorCRDConfiguration": {
- "helmChartDependencies": [
- {
- "chartName": "cert-manager",
- "chartVersion": "v1.5.3"
}, - {
- "chartName": "nginx-ingress",
- "chartVersion": "v0.48.1"
}, - {
- "chartName": "external-dns",
- "chartVersion": "v0.7.0"
}, - {
- "chartName": "cnpg-operator",
- "chartVersion": "v0.23.1"
}
], - "outputParameters": {
- "expiresAt": "$out.status.notAfter",
- "issuerName": "letsencrypt-prod"
}, - "readinessConditions": {
- "$out.status.conditions[?(@.type=='Ready')].status": "True"
}, - "template": "apiVersion: cert-manager.io/v1\nkind: ClusterIssuer\nmetadata:\n name: letsencrypt-prod\nspec:\n acme:\n server: https://acme-v02.api.letsencrypt.org/directory\n email: test@example.com\n privateKeySecretRef:\n name: letsencrypt-prod\n solvers:\n - http01:\n ingress:\n class: nginx"
}
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service to which the hook belongs |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource to which the hook belongs |
scope required | string Enum: "CLUSTER" "NODE" The scope of the hook |
type required | string Enum: "INIT" "ADD" "REMOVE" "PROMOTE" "DEMOTE" "HEALTH_CHECK" "POST_START" "POST_UPGRADE" "PRE_STOP" The type of hook to execute |
{- "scope": "CLUSTER",
- "type": "ADD"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service to which the hook belongs |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource to which the hook belongs |
{- "hooks": [
- {
- "commandTemplate": "ZWNobyAiaGVsbG8gd29ybGQi",
- "scope": "CLUSTER",
- "type": "ADD"
}, - {
- "commandTemplate": "ZWNobyAiaGVsbG8gd29ybGQi",
- "scope": "CLUSTER",
- "type": "ADD"
}, - {
- "commandTemplate": "ZWNobyAiaGVsbG8gd29ybGQi",
- "scope": "CLUSTER",
- "type": "ADD"
}, - {
- "commandTemplate": "ZWNobyAiaGVsbG8gd29ybGQi",
- "scope": "CLUSTER",
- "type": "ADD"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service to which the hook belongs |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource to which the hook belongs |
commandTemplate required | string The Base64 encoded command template to execute |
scope required | string Enum: "CLUSTER" "NODE" The scope of the hook |
type required | string Enum: "INIT" "ADD" "REMOVE" "PROMOTE" "DEMOTE" "HEALTH_CHECK" "POST_START" "POST_UPGRADE" "PRE_STOP" The type of hook to execute |
{- "commandTemplate": "ZWNobyAiaGVsbG8gd29ybGQi",
- "scope": "CLUSTER",
- "type": "ADD"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
capability required | string Enum: "SERVERLESS" "SERVICE_ACCOUNT_POLICIES" "PROCESS_CORE_DUMP" "CUSTOM_DNS" The capability to disable |
{- "capability": "SERVERLESS"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
ProductTierVersion | string Example: ProductTierVersion=Perferendis asperiores itaque libero quod. Product tier version of the instance to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. Product tier id of the instance to describe. Needs to specified in combination with the product tier version |
{- "capabilities": [
- {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}, - {
- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ProxyId": "r-123456",
- "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
capability required | string Enum: "SERVERLESS" "SERVICE_ACCOUNT_POLICIES" "PROCESS_CORE_DUMP" "CUSTOM_DNS" The type of capability of a resource |
object The configuration parameters of a capability of a resource |
{- "capability": "SERVERLESS",
- "configuration": {
- "EnableAutoStop": true,
- "MinimumNodesInPool": 5,
- "PortsMappingProxyConfig": {
- "MaxNumberOfClustersPerProxyInstance": 50,
- "NumberOfPortsPerCluster": 4
}, - "ReferenceProxyKey": "resource-proxy",
- "TargetPort": 5432
}
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
{- "id": "r-12345678",
- "ids": [
- "r-12345678",
- "r-abcdefgh",
- "r-1234abcd"
], - "nextPageToken": "next-token",
- "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
Array of objects (EnvironmentVariable) The environment variables that this resource requires |
{- "environmentVariables": [
- {
- "key": "MYSQL_ROOT_PASSWORD",
- "value": "password"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
Array of objects (EnvironmentVariable) The environment variables that this resource requires |
{- "environmentVariables": [
- {
- "key": "MYSQL_ROOT_PASSWORD",
- "value": "password"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: productTierId=pt-12345678 ProductTierId of the config file to describe |
productTierVersion | string Example: productTierVersion=1.0 Product tier version of the config file to describe. If missing, last version is described |
{- "files": [
- {
- "description": "A file to store the configuration for the resource",
- "fileId": "f-12345678",
- "mountPath": "/etc/config",
- "name": "file.txt",
- "size": 1234,
- "type": "Config",
- "uploadTime": "2023-01-10T00:00:00Z",
- "uploadedBy": "user"
}, - {
- "description": "A file to store the configuration for the resource",
- "fileId": "f-12345678",
- "mountPath": "/etc/config",
- "name": "file.txt",
- "size": 1234,
- "type": "Config",
- "uploadTime": "2023-01-10T00:00:00Z",
- "uploadedBy": "user"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
Content-Type | stringmultipart/[^;]+; boundary=.+ Default: multipart/form-data; boundary=boundary Example: multipart/form-data; boundary=boundary Content-Type header, must define value for multipart boundary. |
Name required | string Example: file.txt The name of the file |
Description required | string Example: A file to store the configuration for the resource The description of the file |
FileType required | string Enum: "Config" "Secret" Example: Config The type of the file |
MountPath required | string Example: /etc/config The mount path of the file |
"file-t"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
fileId required | string^(?P<entitytype>file)-(?P<entityid>[a-zA-Z0-9... Example: file-12345678 The ID of the file |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
fileId required | string^(?P<entitytype>file)-(?P<entityid>[a-zA-Z0-9... Example: f-12345678 The ID of the file |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: productTierId=pt-12345678 Product Tier ID of the config files to list |
productTierVersion | string Example: productTierVersion=1.0 Product Tier version of the config files to list. If missing, last version is used |
"string"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
fileId required | string^(?P<entitytype>file)-(?P<entityid>[a-zA-Z0-9... Example: f-12345678 The ID of the file |
Content-Type | stringmultipart/[^;]+; boundary=.+ Default: multipart/form-data; boundary=boundary Example: multipart/form-data; boundary=boundary Content-Type header, must define value for multipart boundary. |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
fileId required | string^(?P<entitytype>file)-(?P<entityid>[a-zA-Z0-9... Example: f-12345678 The ID of the file |
description | string The description of the file |
mountPath | string The mount path of the file |
name | string The name of the file |
{- "description": "A file to store the configuration for the resource",
- "mountPath": "/etc/config",
- "name": "file.txt"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
ProductTierVersion | string Example: ProductTierVersion=Explicabo nostrum autem. Product tier version of the resource to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the resource to describe. Needs to specified in combination with the product tier version |
{- "id": "r-12345678",
- "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
metricEndpoint required | string The local host endpoint to supply prometheus metric |
{
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
resourceDependencyId required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource dependency to remove |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID that this API bundle belongs to |
id required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource |
resourceDependencyId required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource to be added as a dependency |
object A map of the source parameter to the dependency resource parameter |
{- "parameterMap": {
- "clusterId": "writerId",
- "clusterOrg": "userDatabase"
}
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 ID of the Service |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: Consequatur vitae. The product tier ID that this version set belongs to. |
latestMajorVersionOnly | boolean Example: latestMajorVersionOnly=true If true, the latest major version is returned. The parameter needs to be specified in isolation. |
latestIncrementalVersionForMajorVersion | string Example: latestIncrementalVersionForMajorVersion=3.0 Returns the latest incremental version for the given major version. The paramenter needs to be specified in isolation. |
{- "nextPageToken": "next-token",
- "tierVersionSets": [
- {
- "autoApproveSubscription": false,
- "baseVersion": "3.0",
- "createdAt": "2020-01-01T00:00:00Z",
- "createdBy": "John Doe",
- "description": "Aliquid explicabo et ut error delectus quaerat.",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "instanceCount": 12,
- "latestUpgradePathId": "upgrade-12345678",
- "name": "Regular version set",
- "parentVersion": "2.0",
- "productTierId": "pt-T2",
- "releasedAt": "2020-01-01T00:00:00Z",
- "releasedBy": "John Doe",
- "resources": [
- {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}
], - "serviceId": "s-12345678",
- "serviceModelId": "sm-Sc",
- "status": "Active",
- "type": "Major",
- "updatedAt": "2020-01-01T00:00:00Z",
- "version": "3.0"
}, - {
- "autoApproveSubscription": false,
- "baseVersion": "3.0",
- "createdAt": "2020-01-01T00:00:00Z",
- "createdBy": "John Doe",
- "description": "Aliquid explicabo et ut error delectus quaerat.",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "instanceCount": 12,
- "latestUpgradePathId": "upgrade-12345678",
- "name": "Regular version set",
- "parentVersion": "2.0",
- "productTierId": "pt-T2",
- "releasedAt": "2020-01-01T00:00:00Z",
- "releasedBy": "John Doe",
- "resources": [
- {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}
], - "serviceId": "s-12345678",
- "serviceModelId": "sm-Sc",
- "status": "Active",
- "type": "Major",
- "updatedAt": "2020-01-01T00:00:00Z",
- "version": "3.0"
}, - {
- "autoApproveSubscription": false,
- "baseVersion": "3.0",
- "createdAt": "2020-01-01T00:00:00Z",
- "createdBy": "John Doe",
- "description": "Aliquid explicabo et ut error delectus quaerat.",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "instanceCount": 12,
- "latestUpgradePathId": "upgrade-12345678",
- "name": "Regular version set",
- "parentVersion": "2.0",
- "productTierId": "pt-T2",
- "releasedAt": "2020-01-01T00:00:00Z",
- "releasedBy": "John Doe",
- "resources": [
- {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}
], - "serviceId": "s-12345678",
- "serviceModelId": "sm-Sc",
- "status": "Active",
- "type": "Major",
- "updatedAt": "2020-01-01T00:00:00Z",
- "version": "3.0"
}, - {
- "autoApproveSubscription": false,
- "baseVersion": "3.0",
- "createdAt": "2020-01-01T00:00:00Z",
- "createdBy": "John Doe",
- "description": "Aliquid explicabo et ut error delectus quaerat.",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "instanceCount": 12,
- "latestUpgradePathId": "upgrade-12345678",
- "name": "Regular version set",
- "parentVersion": "2.0",
- "productTierId": "pt-T2",
- "releasedAt": "2020-01-01T00:00:00Z",
- "releasedBy": "John Doe",
- "resources": [
- {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}
], - "serviceId": "s-12345678",
- "serviceModelId": "sm-Sc",
- "status": "Active",
- "type": "Major",
- "updatedAt": "2020-01-01T00:00:00Z",
- "version": "3.0"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 ID of the Service |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: Consequatur vitae. The product tier ID that this version set belongs to. |
description | string A brief description of the product-tier version set. |
name | string The name of the product-tier version set. |
parentVersion | string The parent version of this version set. |
type required | string Enum: "Major" "Incremental" "UserDefined" The version-set type of the product-tier. |
{- "description": "Laborum eum eum.",
- "name": "Major version set",
- "parentVersion": "2.0",
- "type": "Major"
}
{- "version": "3.0"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 ID of the Service |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: Consequatur vitae. The product tier ID that this version set belongs to. |
version required | string Example: 3.0 The version number for the specific version set. |
{- "autoApproveSubscription": false,
- "baseVersion": "3.0",
- "createdAt": "2020-01-01T00:00:00Z",
- "createdBy": "John Doe",
- "description": "Tenetur officiis facere.",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "instanceCount": 12,
- "latestUpgradePathId": "upgrade-12345678",
- "name": "Regular version set",
- "parentVersion": "2.0",
- "productTierId": "pt-kI6",
- "releasedAt": "2020-01-01T00:00:00Z",
- "releasedBy": "John Doe",
- "resources": [
- {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}
], - "serviceId": "s-12345678",
- "serviceModelId": "sm-Nd",
- "status": "Active",
- "type": "Major",
- "updatedAt": "2020-01-01T00:00:00Z",
- "version": "3.0"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 ID of the Service |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: Consequatur vitae. The product tier ID that this version set belongs to. |
version required | string Example: 3.0 The version number for the specific version set. |
{- "autoApproveSubscription": false,
- "baseVersion": "3.0",
- "createdAt": "2020-01-01T00:00:00Z",
- "createdBy": "John Doe",
- "description": "Tenetur explicabo reiciendis repudiandae.",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "instanceCount": 12,
- "latestUpgradePathId": "upgrade-12345678",
- "name": "Regular version set",
- "parentVersion": "2.0",
- "productTierId": "pt-hD",
- "releasedAt": "2020-01-01T00:00:00Z",
- "releasedBy": "John Doe",
- "resources": [
- {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}
], - "serviceId": "s-12345678",
- "serviceModelId": "sm-V",
- "status": "Active",
- "type": "Major",
- "updatedAt": "2020-01-01T00:00:00Z",
- "version": "3.0"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 ID of the Service |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: Consequatur vitae. The product tier ID that this version set belongs to. |
version required | string Example: 3.0 The version number for the version set. |
anotherVersion required | string Example: 3.1 The target version to compare against. |
{- "anotherVersion": "3.1",
- "productTierId": "pt-ZV",
- "resourceChangeSets": {
- "r-idq": {
- "categorizedResourceChanges": {
- "Et accusamus.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}, - "Quia soluta ex qui ut.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}
}, - "imageConfigChanges": {
- "changeState": "PENDING_NEW",
- "imageConfigId": "imgc-12345678",
- "imageName": "mysql"
}, - "infraConfigChanges": {
- "changeState": "PENDING_NEW",
- "infraConfigId": "ic-12345678",
- "name": "MySQL Writer Infra Config"
}, - "overallResourceStatus": "PENDING_UPDATE",
- "productTierFeatureChanges": "PENDING_UPDATE",
- "resourceChanges": "PENDING_DELETE",
- "resourceName": "Hic quaerat."
}, - "r-j": {
- "categorizedResourceChanges": {
- "Et accusamus.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}, - "Quia soluta ex qui ut.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}
}, - "imageConfigChanges": {
- "changeState": "PENDING_NEW",
- "imageConfigId": "imgc-12345678",
- "imageName": "mysql"
}, - "infraConfigChanges": {
- "changeState": "PENDING_NEW",
- "infraConfigId": "ic-12345678",
- "name": "MySQL Writer Infra Config"
}, - "overallResourceStatus": "PENDING_UPDATE",
- "productTierFeatureChanges": "PENDING_UPDATE",
- "resourceChanges": "PENDING_DELETE",
- "resourceName": "Hic quaerat."
}, - "r-s": {
- "categorizedResourceChanges": {
- "Et accusamus.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}, - "Quia soluta ex qui ut.": {
- "changes": [
- {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}, - {
- "attributes": {
- "resourceId": "r-12345678"
}, - "changeType": "PENDING_NEW",
- "name": "Customer metrics"
}
], - "status": "PENDING_UPDATE"
}
}, - "imageConfigChanges": {
- "changeState": "PENDING_NEW",
- "imageConfigId": "imgc-12345678",
- "imageName": "mysql"
}, - "infraConfigChanges": {
- "changeState": "PENDING_NEW",
- "infraConfigId": "ic-12345678",
- "name": "MySQL Writer Infra Config"
}, - "overallResourceStatus": "PENDING_UPDATE",
- "productTierFeatureChanges": "PENDING_UPDATE",
- "resourceChanges": "PENDING_DELETE",
- "resourceName": "Hic quaerat."
}
}, - "serviceId": "s-12345678",
- "version": "3.0"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 ID of the Service |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: Consequatur vitae. The product tier ID that this version set belongs to. |
version required | string Example: 3.0 The version number for the specific version set. |
{- "autoApproveSubscription": false,
- "baseVersion": "3.0",
- "createdAt": "2020-01-01T00:00:00Z",
- "createdBy": "John Doe",
- "description": "Quis aut.",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "instanceCount": 12,
- "latestUpgradePathId": "upgrade-12345678",
- "name": "Regular version set",
- "parentVersion": "2.0",
- "productTierId": "pt-a4",
- "releasedAt": "2020-01-01T00:00:00Z",
- "releasedBy": "John Doe",
- "resources": [
- {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}
], - "serviceId": "s-12345678",
- "serviceModelId": "sm-w",
- "status": "Active",
- "type": "Major",
- "updatedAt": "2020-01-01T00:00:00Z",
- "version": "3.0"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 ID of the Service |
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: Consequatur vitae. The product tier ID that this version set belongs to. |
version required | string Example: 3.0 The version number for the specific version set. |
isPreferred | boolean Indicates whether this version set is preferred. |
name | string The name of the product-tier version set. |
{- "isPreferred": true,
- "name": "Major version set"
}
{- "autoApproveSubscription": false,
- "baseVersion": "3.0",
- "createdAt": "2020-01-01T00:00:00Z",
- "createdBy": "John Doe",
- "description": "Impedit sit.",
- "enabledFeatures": [
- {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}, - {
- "configuration": {
- "provider": "native"
}, - "feature": "LOGS",
- "scope": "INTERNAL"
}
], - "features": {
- "BILLING": false,
- "LOGS": true,
- "METRICS": false
}, - "instanceCount": 12,
- "latestUpgradePathId": "upgrade-12345678",
- "name": "Regular version set",
- "parentVersion": "2.0",
- "productTierId": "pt-i",
- "releasedAt": "2020-01-01T00:00:00Z",
- "releasedBy": "John Doe",
- "resources": [
- {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}, - {
- "description": "A MySQL SaaS specializing in multi-writer clusters for high availability",
- "id": "r-12345678",
- "imageConfigId": "imgc-12345678",
- "infraConfigId": "ic-12345678",
- "isExternal": true,
- "managedResourceType": "PortsBasedProxy",
- "name": "MySQL multi-writer service"
}
], - "serviceId": "s-12345678",
- "serviceModelId": "sm-WCX",
- "status": "Active",
- "type": "Major",
- "updatedAt": "2020-01-01T00:00:00Z",
- "version": "3.0"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
defaultValue | string Default value to use for an optional input parameter represented as a string |
dependentResourceId | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... The ID of the resource whose instance this input parameter depends on |
description required | string A brief description of the input parameter |
hasOptions | boolean Default: false Marks the input parameter to be selectable from a list of values |
isList | boolean Default: false Marks the input parameter as a list of values |
key required | string non-empty ^[a-zA-Z][a-zA-Z0-9_]*$ Key of the input parameter |
object A map for labeled options. The key is the label and the value is the option. When the option is selected, the label will be displayed to the end customer. Specify either options or labeledOptions when defining the input parameter. | |
object (Limits) Limit of a parameter | |
modifiable required | boolean Marks the input parameter as immutable |
name required | string non-empty External name for the input parameter |
options | Array of strings A list of options to restrict the value of the input parameter to (represented as a string) |
required required | boolean Enforces the input parameter as a required parameter |
resourceId required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... The ID of the resource that this input parameter belongs to |
type required | string Enum: "Boolean" "Float64" "String" "Resource" "Secret" "Password" |
{- "defaultValue": "default value",
- "dependentResourceId": "r-12345678",
- "description": "Corrupti doloribus cumque sit eos illo.",
- "hasOptions": true,
- "isList": true,
- "key": "h",
- "labeledOptions": {
- "large": "t3.xlarge",
- "medium": "t3.large",
- "small": "t3.medium"
}, - "limits": {
- "max": "Voluptatem provident laboriosam omnis sed.",
- "maxLength": "Odit placeat distinctio et consequatur.",
- "min": "Cupiditate et dolor modi exercitationem et ut.",
- "minLength": "Id provident."
}, - "modifiable": false,
- "name": "uw",
- "options": [
- "a",
- "b",
- "c",
- "default value"
], - "required": true,
- "resourceId": "r-12345678",
- "type": "Float64"
}
"ip-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
id required | string^(?P<entitytype>ip)-(?P<entityid>[a-zA-Z0-9][... Example: var-12345678 ID of the input parameter |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
id required | string^(?P<entitytype>ip)-(?P<entityid>[a-zA-Z0-9][... Example: var-12345678 ID of the input parameter |
ProductTierVersion | string Example: ProductTierVersion=Suscipit earum illum. Product tier version of the instance to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. Product tier id of the instance to describe. Needs to specified in combination with the product tier version |
{- "defaultValue": "true",
- "dependentResourceId": "r-12345678",
- "description": "Sit eaque ab molestiae quas.",
- "hasOptions": false,
- "id": "var-12345678",
- "isList": false,
- "key": "4",
- "labeledOptions": {
- "large": "t3.xlarge",
- "medium": "t3.large",
- "small": "t3.medium"
}, - "limits": {
- "max": "Enim ipsa quaerat eveniet.",
- "maxLength": "Perferendis mollitia consequatur ex quas.",
- "min": "Aut ipsum harum delectus aliquid.",
- "minLength": "Est ut et vero alias."
}, - "modifiable": true,
- "name": "n",
- "options": [
- "true",
- "false"
], - "required": false,
- "resourceId": "r-12345678",
- "serviceId": "s-12345678",
- "type": "Boolean"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
id required | string^(?P<entitytype>ip)-(?P<entityid>[a-zA-Z0-9][... Example: var-12345678 ID of the input parameter |
defaultValue | string Default value to use for an optional input parameter represented as a string |
description | string A brief description of the input parameter |
hasOptions | boolean Marks the input parameter to be selectable from a list of values |
object A map for labeled options. The key is the label and the value is the option. When the option is selected, the label will be displayed to the end customer. Specify either options or labeledOptions when defining the input parameter. | |
object (Limits) Limit of a parameter | |
modifiable | boolean Marks the input parameter as immutable |
name | string non-empty External name for the input parameter |
options | Array of strings A list of options to restrict the value of the input parameter to (represented as a string) |
required | boolean Enforces the input parameter as a required parameter |
{- "defaultValue": "[\"1\", \"2.8\", \"3\"]",
- "description": "Nisi consequuntur minus qui odio laudantium illum.",
- "hasOptions": false,
- "labeledOptions": {
- "large": "t3.xlarge",
- "medium": "t3.large",
- "small": "t3.medium"
}, - "limits": {
- "max": "Voluptatem provident laboriosam omnis sed.",
- "maxLength": "Odit placeat distinctio et consequatur.",
- "min": "Cupiditate et dolor modi exercitationem et ut.",
- "minLength": "Id provident."
}, - "modifiable": false,
- "name": "bk",
- "options": [
- "[\"1\", \"2.8\", \"3\"]",
- "[\"3.4\", \"4.5\"]"
], - "required": true
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
resourceId required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource that this input parameter belongs to |
ProductTierVersion | string Example: ProductTierVersion=Cumque tempore numquam temporibus doloremque ut inventore. Product tier version of the instance to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. Product tier id of the instance to describe. Needs to specified in combination with the product tier version |
{- "ids": [
- "ip-12345678",
- "ip-12345679"
], - "inputParameters": [
- {
- "defaultValue": "true",
- "dependentResourceId": "r-12345678",
- "description": "Nemo libero doloremque velit et.",
- "hasOptions": false,
- "id": "var-12345678",
- "isList": false,
- "key": "mq",
- "labeledOptions": {
- "large": "t3.xlarge",
- "medium": "t3.large",
- "small": "t3.medium"
}, - "limits": {
- "max": "Enim ipsa quaerat eveniet.",
- "maxLength": "Perferendis mollitia consequatur ex quas.",
- "min": "Aut ipsum harum delectus aliquid.",
- "minLength": "Est ut et vero alias."
}, - "modifiable": true,
- "name": "t3p",
- "options": [
- "true",
- "false"
], - "required": true,
- "resourceId": "r-12345678",
- "serviceId": "s-12345678",
- "type": "Secret"
}, - {
- "defaultValue": "true",
- "dependentResourceId": "r-12345678",
- "description": "Nemo libero doloremque velit et.",
- "hasOptions": false,
- "id": "var-12345678",
- "isList": false,
- "key": "mq",
- "labeledOptions": {
- "large": "t3.xlarge",
- "medium": "t3.large",
- "small": "t3.medium"
}, - "limits": {
- "max": "Enim ipsa quaerat eveniet.",
- "maxLength": "Perferendis mollitia consequatur ex quas.",
- "min": "Aut ipsum harum delectus aliquid.",
- "minLength": "Est ut et vero alias."
}, - "modifiable": true,
- "name": "t3p",
- "options": [
- "true",
- "false"
], - "required": true,
- "resourceId": "r-12345678",
- "serviceId": "s-12345678",
- "type": "Secret"
}, - {
- "defaultValue": "true",
- "dependentResourceId": "r-12345678",
- "description": "Nemo libero doloremque velit et.",
- "hasOptions": false,
- "id": "var-12345678",
- "isList": false,
- "key": "mq",
- "labeledOptions": {
- "large": "t3.xlarge",
- "medium": "t3.large",
- "small": "t3.medium"
}, - "limits": {
- "max": "Enim ipsa quaerat eveniet.",
- "maxLength": "Perferendis mollitia consequatur ex quas.",
- "min": "Aut ipsum harum delectus aliquid.",
- "minLength": "Est ut et vero alias."
}, - "modifiable": true,
- "name": "t3p",
- "options": [
- "true",
- "false"
], - "required": true,
- "resourceId": "r-12345678",
- "serviceId": "s-12345678",
- "type": "Secret"
}
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
description required | string non-empty Description of the output variable being exported |
key required | string non-empty ^[a-zA-Z][a-zA-Z0-9_]*$ Key of the output variable being exported |
name required | string non-empty External name of the output variable being exported |
resourceId required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... The ID of the resource that this output parameter belongs to |
value | string Value of the output variable being exported |
valueRef | string Reference to another variable that will be used to set the value of the output variable being exported |
valueType | string Enum: "Boolean" "Float64" "String" "Secret" "Password" |
{- "description": "Username of the user created in the target system",
- "key": "username",
- "name": "Username",
- "resourceId": "r-12345678",
- "value": "johndoe",
- "valueRef": "$var.username",
- "valueType": "Boolean"
}
"op-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
id required | string^(?P<entitytype>op)-(?P<entityid>[a-zA-Z0-9][... Example: op-12345678 The ID of the output parameter |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
id required | string^(?P<entitytype>op)-(?P<entityid>[a-zA-Z0-9][... Example: op-12345678 The ID of the output parameter |
ProductTierVersion | string Example: ProductTierVersion=Aut possimus autem nihil. Product tier version of the resource to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the resource to describe. Needs to specified in combination with the product tier version |
{- "description": "Username of the user created in the target system",
- "id": "op-12345678",
- "key": "username",
- "name": "Username",
- "resourceId": "r-12345678",
- "serviceId": "s-12345678",
- "value": "johndoe",
- "valueRef": "$var.username",
- "valueType": "Password"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
id required | string^(?P<entitytype>op)-(?P<entityid>[a-zA-Z0-9][... Example: op-12345678 The ID of the output parameter |
description | string non-empty Description of the output variable being exported |
name | string non-empty External name of the output variable being exported |
value | string non-empty Value of the output variable being exported |
valueRef | string Reference to an input variable that will be used to set the value of the output variable being exported |
valueType | string Enum: "Boolean" "Float64" "String" "Secret" "Password" |
{- "description": "Username of the user created in the target system",
- "name": "Username",
- "value": "johndoe",
- "valueRef": "$var.username",
- "valueType": "Password"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service that this output parameter belongs to |
resourceId required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The ID of the resource that this output parameter belongs to |
ProductTierVersion | string Example: ProductTierVersion=Dolorum et. Product tier version of the resource to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the resource to describe. Needs to specified in combination with the product tier version |
{- "ids": [
- "op-12345678"
], - "nextPageToken": "next-token",
- "outputParameters": [
- {
- "description": "Username of the user created in the target system",
- "id": "op-12345678",
- "key": "username",
- "name": "Username",
- "resourceId": "r-12345678",
- "serviceId": "s-12345678",
- "value": "johndoe",
- "valueRef": "$var.username",
- "valueType": "String"
}, - {
- "description": "Username of the user created in the target system",
- "id": "op-12345678",
- "key": "username",
- "name": "Username",
- "resourceId": "r-12345678",
- "serviceId": "s-12345678",
- "value": "johndoe",
- "valueRef": "$var.username",
- "valueType": "String"
}, - {
- "description": "Username of the user created in the target system",
- "id": "op-12345678",
- "key": "username",
- "name": "Username",
- "resourceId": "r-12345678",
- "serviceId": "s-12345678",
- "value": "johndoe",
- "valueRef": "$var.username",
- "valueType": "String"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID for the VUnit |
serviceModelId required | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: sm-12345678 Service Model ID for the VUnit |
cloudProvider required | string Enum: "aws" "azure" "gcp" "all" The infra / cloud provider name |
region required | string Region code specific to the cloud-provider |
{- "cloudProvider": "aws",
- "region": "us-west-2"
}
{- "ids": {
- "aws": [
- "vu-12345678",
- "vu-abcdefgh"
], - "gcp": [
- "vu-1234efgh"
]
}, - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID context |
id required | string^(?P<entitytype>n)-(?P<entityid>[a-zA-Z0-9][a... Example: n-12345678 Network to operate on |
{- "cidr": "10.0.0.0/16",
- "id": "n-12345678",
- "networkConfigId": "nc-12345678",
- "serviceId": "s-12345678",
- "type": "PUBLIC",
- "vunitId": "vu-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 Service ID for the VUnit |
id required | string^(?P<entitytype>vu)-(?P<entityid>[a-zA-Z0-9][... Example: vu-12345678 VUnit to operate on |
{- "cloudProvider": "aws",
- "id": "vu-12345678",
- "networkIds": [
- "n-12345678",
- "n-abcdefgh",
- "n-1234efgh"
], - "region": "us-west-2",
- "serviceId": "s-12345678",
- "serviceModelId": "sm-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
computeConfigId | string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][... The compute config ID |
object (EnvironmentVariable) A service environment variable | |
description required | string The description for the infra config |
name required | string The name of the infra config |
networkConfigId | string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][... The network config ID |
serviceEnvironmentId required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... The service environment ID |
storageConfigId | string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][... The storage config ID |
{- "computeConfigId": "cc-12345678",
- "customTag": {
- "key": "customKey",
- "value": "customValue"
}, - "description": "Infra config used for the base tier MySQL service",
- "name": "MySQL Writer Infra Config",
- "networkConfigId": "nc-12345678",
- "serviceEnvironmentId": "se-12345678",
- "storageConfigId": "sc-12345678"
}
"ic-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
ProductTierVersion | string Example: ProductTierVersion=Consequatur vel fugiat eveniet. Product tier version of the infra config to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the infra config to describe. Needs to specified in combination with the product tier version |
{- "computeConfigId": "cc-12345678",
- "customTag": {
- "key": "customKey",
- "value": "customValue"
}, - "description": "Infra config used for the base tier MySQL service",
- "id": "ic-12345678",
- "name": "MySQL Writer Infra Config",
- "networkConfigId": "nc-12345678",
- "serviceEnvironmentId": "se-12345678",
- "serviceId": "s-12345678",
- "storageConfigId": "sc-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
computeConfigId | string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][... The compute config ID |
object (EnvironmentVariable) A service environment variable | |
description | string The description for the infra config |
name | string The name of the infra config |
networkConfigId | string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][... The network config ID |
storageConfigId | string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][... The storage config ID per compute node |
{- "computeConfigId": "cc-12345678",
- "customTag": {
- "key": "customKey",
- "value": "customValue"
}, - "description": "Infra config used for the base tier MySQL service",
- "name": "MySQL Writer Infra Config",
- "networkConfigId": "nc-12345678",
- "storageConfigId": "sc-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
{- "id": "ic-12345678",
- "resourceIds": [
- "r-12345678",
- "r-abcdefgh"
], - "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... The product tier ID |
{- "productTierId": "pt-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
{- "status": "IN_PROGRESS"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>ic)-(?P<entityid>[a-zA-Z0-9][... Example: ic-12345678 Infra Config ID to operate on |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
serviceEnvironmentId required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 The service environment ID |
managed | boolean Example: managed=false Is infra config managed by omnistrate |
{- "ids": [
- "ic-12345678",
- "ic-abcdefgh",
- "ic-1234efgh"
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID to use for the infra |
object (CustomImageCommandsAndArgs) Commands and arguments to run in the container | |
description required | string A brief description of the image configuration |
imageName required | string non-empty Name of the container image |
imageRegistryId | string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][... The image registry ID to use for the infra |
imageSignaturePublicKeyPEM | string PEM-encoded Public key part of the key used to sign the container image |
imageTag | string Default: "latest" Tag representing the specific software image version |
serviceEnvironmentId required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... The service environment ID |
{- "customImageCommandsAndArgs": {
- "args": [
- "-d",
- "mysql"
], - "commands": [
- "echo",
- "Hello, World!"
]
}, - "description": "A image configuration for my new entity",
- "imageName": "mysql",
- "imageRegistryId": "ir-12345678",
- "imageSignaturePublicKeyPEM": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
- "imageTag": "latest",
- "serviceEnvironmentId": "se-12345678"
}
"imgc-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9... Example: imgc-12345678 The image configuration ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9... Example: imgc-12345678 The image configuration ID |
ProductTierVersion | string Example: ProductTierVersion=Rerum dicta. Product tier version of the image config to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the image config to describe. Needs to specified in combination with the product tier version |
{- "customImageCommandsAndArgs": {
- "args": [
- "-d",
- "mysql"
], - "commands": [
- "echo",
- "Hello, World!"
]
}, - "description": "An image configuration for my new entity",
- "id": "imgc-12345678",
- "imageName": "mysql",
- "imageRegistryId": "ir-12345678",
- "imageSignaturePublicKeyPEM": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
- "imageTag": "v1",
- "serviceEnvironmentId": "se-12345678",
- "serviceId": "s-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9... Example: imgc-12345678 The image configuration ID |
object (CustomImageCommandsAndArgs) Commands and arguments to run in the container | |
description | string A brief description of the image configuration |
imageName | string non-empty Name of the container image |
imageRegistryId | string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][... The image registry ID to use for the infra |
imageSignaturePublicKeyPEM | string PEM-encoded Public key part of the key used to sign the container image |
imageTag | string Tag representing the software image version that is currently preferred |
{- "customImageCommandsAndArgs": {
- "args": [
- "-d",
- "mysql"
], - "commands": [
- "echo",
- "Hello, World!"
]
}, - "description": "An image configuration for my new entity",
- "imageName": "mysql",
- "imageRegistryId": "ir-12345678",
- "imageSignaturePublicKeyPEM": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExXBS01nPRugGbKCN8m9sSSTkGvPT\n7a1Jn74No2dTkp+tQ+ZyBa7ClKbEXFaR2mzy06q0ivJAxPi1pixofIXE0Q==\n-----END PUBLIC KEY-----\n",
- "imageTag": "v1"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9... Example: imgc-12345678 The image configuration ID |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... The product tier ID |
{- "productTierId": "pt-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9... Example: imgc-12345678 The image configuration ID |
{- "status": "IN_PROGRESS"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>imgc)-(?P<entityid>[a-zA-Z0-9... Example: imgc-12345678 The image configuration ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID to use for the infra |
serviceEnvironmentId required | string^(?P<entitytype>se)-(?P<entityid>[a-zA-Z0-9][... Example: se-12345678 The service environment ID |
{- "ids": [
- "imgc-12345678",
- "imgc-87654321"
], - "nextPageToken": "next-token"
}
The deployment config API manages the deployment config for Omnistrate entities
description required | string A brief description of the deployment config |
object (InfraRollConfiguration) The rollout configuration to use for making changes to the resources backed by this infra | |
name required | string Name of the deployment config |
rolloutPriorityList | Array of strings[^(?P<entitytype>region)-(?P<entityid>[a-zA-Z0...] |
{- "description": "A production deployment config",
- "infraRollConfiguration": {
- "infraRolloutStrategy": "NEW_DEPLOYMENT_ONLY",
- "maximumNumberOfResourceInstancesPerBatch": 1,
- "maximumUnavailableReplicas": 1
}, - "name": "Production",
- "rolloutPriorityList": [
- "region-12345678",
- "region-abcd1234",
- "region-3c3c3c3c"
]
}
"dc-12345678"
id required | string Examples:
The deployment configuration ID |
{- "description": "A production deployment config",
- "id": "dc-12345678",
- "infraRollConfiguration": {
- "infraRolloutStrategy": "NEW_DEPLOYMENT_ONLY",
- "maximumNumberOfResourceInstancesPerBatch": 1,
- "maximumUnavailableReplicas": 1
}, - "name": "Production",
- "rolloutPriorityList": [
- "region-12345678",
- "region-abcd1234",
- "region-3c3c3c3c"
]
}
id required | string^(?P<entitytype>dc)-(?P<entityid>[a-zA-Z0-9][... Example: dc-12345678 The deployment configuration ID |
description | string A brief description of the deployment config |
object (InfraRollConfiguration) The rollout configuration to use for making changes to the resources backed by this infra | |
name | string Name of the deployment config |
rolloutPriorityList | Array of strings[^(?P<entitytype>region)-(?P<entityid>[a-zA-Z0...] |
{- "description": "A production deployment config",
- "infraRollConfiguration": {
- "infraRolloutStrategy": "NEW_DEPLOYMENT_ONLY",
- "maximumNumberOfResourceInstancesPerBatch": 1,
- "maximumUnavailableReplicas": 1
}, - "name": "Production",
- "rolloutPriorityList": [
- "region-12345678",
- "region-abcd1234",
- "region-3c3c3c3c"
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
managed | boolean Example: managed=false Is compute config managed by omnistrate |
{- "ids": [
- "cc-12345678",
- "cc-abcdefgh",
- "cc-1234efgh"
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
object (AutoscalingPolicy) Autoscaling policy for compute nodes | |
cpuArchitecture | string Enum: "X86_64" "ARM64" Processor architecture |
description required | string non-empty Description of the compute config |
name required | string non-empty Name of the compute config |
replicaCount | string Number of replicas to provision for this logical pool of nodes per instance of the resource |
object (ResourceSpec) Resource requirements | |
rootVolumeSizeGi | integer <int64> Size of the root volume in Gi |
object (WarmPoolConfiguration) Warm pool configuration for compute nodes |
{- "autoscalingPolicy": {
- "maxReplicas": 4,
- "minReplicas": 1
}, - "cpuArchitecture": "X86_64",
- "description": "my compute config description",
- "name": "my compute config",
- "replicaCount": "3",
- "resources": {
- "limits": {
- "cpu": "1",
- "memory": "500Mi"
}, - "requests": {
- "cpu": "0.5",
- "memory": "200Mi"
}
}, - "rootVolumeSizeGi": 10,
- "warmPoolConfiguration": {
- "minimumNodesInPool": 1
}
}
"cc-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][... Example: cc-12345678 ID of the compute config |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][... Example: cc-12345678 ID of the compute config |
ProductTierVersion | string Example: ProductTierVersion=Et voluptatum dolore deleniti eum. Product tier version of the compute config to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the compute config to describe. Needs to specified in combination with the product tier version |
{- "autoscalingPolicy": {
- "maxReplicas": 4,
- "minReplicas": 1
}, - "cpuArchitecture": "X86_64",
- "description": "my compute config description",
- "id": "cc-12345678",
- "infraConfigIDs": [
- "ic-12345678",
- "ic-abcdefgh"
], - "instanceTypes": {
- "aws": [
- "t3.micro",
- "t3.small"
], - "azure": [
- "Standard_B1ls",
- "Standard_B1ms"
], - "gcp": [
- "$var.instance_type"
]
}, - "name": "my compute config",
- "replicaCount": "3",
- "resources": {
- "limits": {
- "cpu": "1",
- "memory": "500Mi"
}, - "requests": {
- "cpu": "0.5",
- "memory": "200Mi"
}
}, - "rootVolumeSizeGi": 10,
- "serviceId": "s-12345678",
- "warmPoolConfiguration": {
- "minimumNodesInPool": 1
}
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][... Example: cc-12345678 ID of the compute config |
object (AutoscalingPolicy) Autoscaling policy for compute nodes | |
cpuArchitecture | string Enum: "X86_64" "ARM64" Processor architecture |
description | string non-empty Description of the compute config |
name | string non-empty Name of the compute config |
replicaCount | string Number of replicas to provision for this logical pool of nodes per instance of the resource |
object (ResourceSpec) Resource requirements | |
rootVolumeSizeGi | integer <int64> Size of the root volume in Gi |
object (WarmPoolConfiguration) Warm pool configuration for compute nodes |
{- "autoscalingPolicy": {
- "maxReplicas": 4,
- "minReplicas": 1
}, - "cpuArchitecture": "X86_64",
- "description": "my compute config description",
- "name": "my compute config",
- "replicaCount": "3",
- "resources": {
- "limits": {
- "cpu": "1",
- "memory": "500Mi"
}, - "requests": {
- "cpu": "0.5",
- "memory": "200Mi"
}
}, - "rootVolumeSizeGi": 10,
- "warmPoolConfiguration": {
- "minimumNodesInPool": 1
}
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][... Example: cc-12345678 ID of the compute config |
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" The cloud provider for this compute instance type config |
instanceType required | string The instance type for this compute instance type config |
{- "cloudProviderName": "aws",
- "instanceType": "t3.micro"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>cc)-(?P<entityid>[a-zA-Z0-9][... Example: cc-12345678 ID of the compute config |
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" The cloud provider for this compute instance type config |
instanceType required | string The instance type for this compute instance type config |
{- "cloudProviderName": "aws",
- "instanceType": "t3.micro"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" Example: aws The cloud provider for this compute instance type config |
{- "nextPageToken": "next-token",
- "types": [
- "m5.xlarge",
- "c5.xlarge",
- "r5.xlarge"
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service id to filter by |
managed | boolean Example: managed=false Is storage config managed by omnistrate |
{- "ids": [
- "sc-12345678"
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service to which this storage config belongs |
description required | string non-empty Description of the storage config |
name required | string non-empty Name of the storage config |
{- "description": "my-storage-config-description",
- "name": "my-storage-config"
}
"sc-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][... Example: sc-12345678 The storage config ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][... Example: sc-12345678 The storage config ID |
ProductTierVersion | string Example: ProductTierVersion=Impedit ea error ut et. Product tier version of the storage config to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the storage config to describe. Needs to specified in combination with the product tier version |
{- "description": "my-storage-config-description",
- "id": "sc-12345678",
- "infraConfigIDs": [
- "ic-12345678",
- "ic-abcdefgh"
], - "name": "my-storage-config",
- "serviceId": "s-12345678",
- "volumes": {
- "svc-12345678": [
- "/data",
- "/mnt/logs"
], - "svc-23456789": [
- "/config"
]
}
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][... Example: sc-12345678 The storage config ID |
description | string A brief description of the service model |
name | string Name of the Service Model |
{- "description": "my-storage-config-description",
- "name": "my-storage-config"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][... Example: sc-12345678 The storage config ID |
storageVolumeConfigId required | string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]... Example: svc-12345678 The storage volume config ID |
mountPath | string The path where the storage volume will be mounted |
{- "mountPath": "/data"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>sc)-(?P<entityid>[a-zA-Z0-9][... Example: sc-12345678 The storage config ID |
storageVolumeConfigId required | string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]... Example: svc-12345678 The storage volume config ID |
mountPath | string The path where the storage volume will be mounted |
{- "mountPath": "/data"
}
The storage volume config API manages the storage volume config for Omnistrate entities
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service to list storage volume configs for |
managed | boolean Example: managed=false Is storage volume config managed by omnistrate |
{- "ids": [
- "svc-12345678"
], - "nextPageToken": "next-token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
clusterStorageType | string The type of the fixed storage for the cluster |
description required | string A brief description of the context for the storage volume pool |
disableBackup | boolean Disable backup for the storage volume |
instanceStorageIops | string The IOPS provisioned for the configured instance storage type |
instanceStorageSizeGi | string The storage size (in Gi) provisioned for the configured instance storage type |
instanceStorageThroughputMiBps | string The throughput (in MiBps) provisioned for the configured instance storage type |
instanceStorageType | string The type of the storage for a compute instance |
name required | string Name of the storage volume pool |
storageResourceID | string The storage resource ID |
{- "clusterStorageType": "AWS::EFS",
- "description": "A storage volume set to store the MySQL data directory",
- "disableBackup": false,
- "instanceStorageIops": "$var.storageIops",
- "instanceStorageSizeGi": "$var.storage_size",
- "instanceStorageThroughputMiBps": "128",
- "instanceStorageType": "$var.storageType",
- "name": "MySQL Data Volume",
- "storageResourceID": "r-12345678"
}
"svc-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]... Example: svc-12345678 The storage volume config ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]... Example: svc-12345678 The storage volume config ID |
ProductTierVersion | string Example: ProductTierVersion=Dolore recusandae tempore enim aut culpa. Product tier version of the network config to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the network config to describe. Needs to specified in combination with the product tier version |
{- "cloudProviderName": "aws",
- "clusterStorageType": "AWS::EFS",
- "description": "A storage volume set to store the MySQL data directory",
- "disableBackup": false,
- "id": "svc-12345678",
- "instanceStorageIops": "7500",
- "instanceStorageSizeGi": "128",
- "instanceStorageThroughputMiBps": "128",
- "instanceStorageType": "$var.storageType",
- "name": "MySQL Data Volume",
- "serviceId": "s-12345678",
- "storageResourceID": "r-12345678"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]... Example: svc-12345678 The storage volume config ID |
description | string A brief description of the context for the storage volume pool |
disableBackup | boolean Disable backup for the storage volume |
name | string Name of the storage volume pool |
{- "description": "A storage volume set to store the MySQL data directory",
- "disableBackup": false,
- "name": "MySQL Data Volume"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]... Example: svc-12345678 The storage volume config ID |
instanceStorageIops | string The IOPS provisioned for the configured instance storage type |
instanceStorageThroughputMiBps | string The throughput (in MiBps) provisioned for the configured instance storage type |
instanceStorageType | string The type of the storage for a compute instance |
{- "instanceStorageIops": "7500",
- "instanceStorageThroughputMiBps": "128",
- "instanceStorageType": "AWS::EBS_GP2"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
id required | string^(?P<entitytype>svc)-(?P<entityid>[a-zA-Z0-9]... Example: svc-12345678 The storage volume config ID |
instanceStorageSizeGi required | string The storage size (in Gi) provisioned for the configured instance storage type |
{- "instanceStorageSizeGi": "$var.storage_size"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID to list network configs for |
managed | boolean Example: managed=false Is network config managed by omnistrate |
{- "ids": [
- "nc-hh",
- "nc-l",
- "nc-llX",
- "nc-gxq"
], - "nextPageToken": "token"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service |
description required | string A brief description of the network config |
endpointPerReplica required | boolean Generates a DNS endpoint per-replica for this network config |
internal | boolean Default: false Restrict access to this network config to the internal network |
name required | string Name of the network config |
openPorts | Array of integers <int64> [ items <int64 > ] Ports to map to the generated DNS endpoint |
object (PublicNetworkingConfiguration) The public networking configuration for the network config | |
stableEgressIP | boolean Enable stable egress IP |
tlsTerminationPort | integer <int64> The port that hosts the reverse proxy for TLS termination |
zoneConfiguration | string Enum: "SINGLE_ZONE_OMNISTRATE_RECOMMENDED" "SINGLE_ZONE_CUSTOMER_PROVIDED" "MULTI_ZONE" The preferred type of zonal availability for this resource and the specific zone(s) to deploy in |
{- "description": "A multi-zone HA network config",
- "endpointPerReplica": true,
- "internal": true,
- "name": "Multi-zone",
- "openPorts": [
- 1299,
- 3306
], - "publicNetworkingConfiguration": {
- "enableClusterLoadBalancer": true,
- "enableNodeLoadBalancer": true
}, - "stableEgressIP": true,
- "tlsTerminationPort": 443,
- "zoneConfiguration": "SINGLE_ZONE_OMNISTRATE_RECOMMENDED"
}
"nc-12345678"
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service |
id required | string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][... Example: nc-12345678 The ID of the network config |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service |
id required | string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][... Example: nc-12345678 The ID of the network config |
ProductTierVersion | string Example: ProductTierVersion=Velit repellendus modi ut quasi ut. Product tier version of the network config to describe. If not specified, the latest version is described. |
ProductTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: ProductTierId=Consequatur vitae. ProductTierId of the network config to describe. Needs to specified in combination with the product tier version |
{- "description": "A multi-zone HA network config",
- "endpointPerReplica": true,
- "id": "nc-12345678",
- "infraConfigIDs": [
- "ic-12345678",
- "ic-abcdefgh"
], - "internal": true,
- "name": "Multi-zone",
- "openPorts": [
- 1299,
- 3306
], - "publicNetworkingConfiguration": {
- "enableClusterLoadBalancer": true,
- "enableNodeLoadBalancer": true
}, - "serviceId": "s-12345678",
- "stableEgressIP": true,
- "tlsTerminationPort": 443,
- "zoneConfiguration": "SINGLE_ZONE_CUSTOMER_PROVIDED"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The ID of the service |
id required | string^(?P<entitytype>nc)-(?P<entityid>[a-zA-Z0-9][... Example: nc-12345678 The ID of the network config |
description | string A brief description of the network config |
endpointPerReplica | boolean Generates a DNS endpoint per-replica for this network config |
internal | boolean Restrict access to this network config to the internal network |
name | string Name of the network config |
openPorts | Array of integers <int64> [ items <int64 > ] Ports to map to the generated DNS endpoint |
object (PublicNetworkingConfiguration) The public networking configuration for the network config | |
stableEgressIP | boolean Create an external node load balancer per node rather than expose the node ip directly |
tlsTerminationPort | integer <int64> The port that hosts the reverse proxy for TLS termination |
zoneConfiguration | string Enum: "SINGLE_ZONE_OMNISTRATE_RECOMMENDED" "SINGLE_ZONE_CUSTOMER_PROVIDED" "MULTI_ZONE" The preferred type of zonal availability for this resource and the specific zone(s) to deploy in |
{- "description": "A multi-zone HA network config",
- "endpointPerReplica": true,
- "internal": true,
- "name": "Multi-zone",
- "openPorts": [
- 1299,
- 3306
], - "publicNetworkingConfiguration": {
- "enableClusterLoadBalancer": true,
- "enableNodeLoadBalancer": true
}, - "stableEgressIP": true,
- "tlsTerminationPort": 443,
- "zoneConfiguration": "SINGLE_ZONE_CUSTOMER_PROVIDED"
}
id required | string^(?P<entitytype>az)-(?P<entityid>[a-zA-Z0-9][... Example: az-12345678 ID of an AZ |
{- "cloudProviderName": "aws",
- "code": "us-east-1a",
- "description": "US East (N. Virginia) Availability Zone A",
- "id": "az-12345678",
- "regionCode": "us-east-1"
}
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" Example: aws The cloud provider for this compute instance type config |
{- "ids": [
- "az-12345678",
- "az-87654321"
], - "nextPageToken": "next-token"
}
code required | string Example: us-east-1a Cloud-provider native availability zone code |
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" Example: aws The cloud provider for this compute instance type config |
"az-m"
regionCode required | string Example: us-east-1 |
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" Example: aws The cloud provider for this compute instance type config |
{- "ids": [
- "az-12345678",
- "az-87654321"
], - "nextPageToken": "next-token"
}
id required | string^(?P<entitytype>region)-(?P<entityid>[a-zA-Z0... Example: region-12345678 ID of the Region |
{- "cloudProviderId": "infra-12345678",
- "cloudProviderName": "aws",
- "code": "us-east-1",
- "description": "US East (N. Virginia)",
- "id": "region-12345678"
}
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" Example: aws The cloud provider for this compute instance type config |
serviceId | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: serviceId=s-12345678 Service ID. If specified together with serviceModelId,list the regions of the service model. Otherwise list all regions. |
serviceModelId | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: serviceModelId=sm-12345678 Service model ID. If specified together with serviceId,list the regions of the service model. Otherwise list all regions. |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: productTierId=pt-12345678 Product tier ID. If specified together with serviceId,list the regions of the product tier. Otherwise list all regions. |
modelType | string Enum: "OMNISTRATE_HOSTED" "CUSTOMER_HOSTED" "BYOA" Example: modelType=OMNISTRATE_HOSTED Model type. If specified, list regions for the specified model type. |
{- "ids": [
- "region-12345678",
- "region-87654321"
], - "nextPageToken": "next-token"
}
code required | string non-empty Example: us-east-1 Cloud-provider native region code |
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" Example: aws The cloud provider for this compute instance type config |
"region-2"
serviceId | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: serviceId=s-12345678 Service ID. If specified together with serviceModelId,list the cloud provider of the service model. Otherwise list all cloud provider. |
serviceModelId | string^(?P<entitytype>sm)-(?P<entityid>[a-zA-Z0-9][... Example: serviceModelId=sm-12345678 Service model ID. If specified together with serviceId,list the cloud provider of the service model. Otherwise list all cloud provider. |
productTierId | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... Example: productTierId=pt-12345678 Product tier ID. If specified together with serviceId,list the cloud provider of the product tier. Otherwise list all cloud provider. |
{- "ids": [
- "infra-12345678",
- "infra-87654321"
], - "nextPageToken": "next-token"
}
id required | string^(?P<entitytype>infra)-(?P<entityid>[a-zA-Z0-... Example: infra-12345678 ID of the CloudProvider |
{- "description": "Amazon Web Services",
- "id": "infra-12345678",
- "name": "aws"
}
company required | string non-empty |
email required | string <email> non-empty |
name required | string non-empty |
phone | string |
{- "company": "ABC",
- "email": "abc@gmail.com",
- "name": "John Doe",
- "phone": "+1-234567890"
}
company required | string non-empty |
email required | string <email> non-empty |
message required | string non-empty |
name required | string non-empty |
{- "company": "ABC",
- "email": "abc@gmail.com",
- "message": "this is a test",
- "name": "John Doe"
}
authorizationCode required | string The authorization code from the Identity Provider |
companyDescription | string non-empty |
companyUrl | string non-empty |
identityProviderName required | string Enum: "Google" "GitHub" The name of the Identity Provider |
invitedEmail | string <email> Email address that the user was invited with |
legalCompanyName | string non-empty |
redirectUri | string The redirect URI used to get the authorization code |
{- "authorizationCode": "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&",
- "companyDescription": "We sell xyz database software",
- "identityProviderName": "Google",
- "invitedEmail": "abc@gmail.com",
- "legalCompanyName": "mywebsite",
}
{- "jwtToken": ""
}
email required | string <email> non-empty |
hashedPassword | string non-empty |
password | string non-empty |
{- "email": "abc@gmail.com",
- "hashedPassword": "deprecated",
- "password": "password"
}
{- "jwtToken": ""
}
email required | string <email> non-empty |
password required | string non-empty |
token required | string non-empty |
{- "email": "abc@gmail.com",
- "password": "password",
- "token": "fc7b8dea-a50b-4c9a-8864-fc3d845a2be6"
}
companyDescription | string non-empty |
companyUrl | string non-empty |
email required | string <email> non-empty |
legalCompanyName required | string non-empty |
name required | string non-empty |
password required | string non-empty |
{- "companyDescription": "We sell xyz database software",
- "email": "abc@gmail.com",
- "legalCompanyName": "mywebsite",
- "name": "John Doe",
- "password": "password"
}
{- "modifiedAt": "2023-01-01T00:00:00Z",
- "nextChargeDate": "2023-02-01",
- "paymentConfigured": true,
- "planCoreHourCost": 0.05,
- "planDescription": "The starter plan is priced at 'X' units",
- "planFrequency": "MONTHLY",
- "planMonthlyCost": 49,
- "planName": "STARTER",
- "remainingCredits": "100",
- "startDate": "2023-01-01"
}
planName required | string Enum: "STARTER_NO_COMMIT" "STARTER" "GROWTH" "ENTERPRISE" The name of the plan this user is changing to |
{- "planName": "STARTER"
}
{- "invoices": [
- {
- "currency": "USD",
- "invoiceDate": "2021-01-01T00:00:00.000Z",
- "invoiceId": "123MyCoolCorp980-2021-01-01-1234567890",
- "invoicePaymentTerm": "30",
- "invoiceStatus": "Open",
- "taxAmount": 10,
- "totalAmount": 110,
- "totalAmountWithoutTax": 100
}, - {
- "currency": "USD",
- "invoiceDate": "2021-01-01T00:00:00.000Z",
- "invoiceId": "123MyCoolCorp980-2021-01-01-1234567890",
- "invoicePaymentTerm": "30",
- "invoiceStatus": "Open",
- "taxAmount": 10,
- "totalAmount": 110,
- "totalAmountWithoutTax": 100
}, - {
- "currency": "USD",
- "invoiceDate": "2021-01-01T00:00:00.000Z",
- "invoiceId": "123MyCoolCorp980-2021-01-01-1234567890",
- "invoicePaymentTerm": "30",
- "invoiceStatus": "Open",
- "taxAmount": 10,
- "totalAmount": 110,
- "totalAmountWithoutTax": 100
}, - {
- "currency": "USD",
- "invoiceDate": "2021-01-01T00:00:00.000Z",
- "invoiceId": "123MyCoolCorp980-2021-01-01-1234567890",
- "invoicePaymentTerm": "30",
- "invoiceStatus": "Open",
- "taxAmount": 10,
- "totalAmount": 110,
- "totalAmountWithoutTax": 100
}
]
}
authorizationCode required | string The authorization code from the Identity Provider |
companyDescription | string non-empty |
companyUrl | string non-empty |
environmentType | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" The environment type of the portal that the customer is signing in to |
identityProviderName required | string Enum: "Google" "GitHub" The name of the Identity Provider |
invitedEmail | string <email> Email address that the user was invited with |
legalCompanyName | string non-empty |
redirectUri | string The redirect URI used to get the authorization code |
{- "authorizationCode": "4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&",
- "companyDescription": "We sell xyz database software",
- "environmentType": "DEV",
- "identityProviderName": "Google",
- "invitedEmail": "abc@gmail.com",
- "legalCompanyName": "mywebsite",
}
{- "jwtToken": ""
}
email required | string <email> non-empty |
environmentType | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" The environment type of the portal that the customer is signing in to |
hashedPassword | string non-empty |
password | string non-empty |
{- "email": "abc@gmail.com",
- "environmentType": "DEV",
- "hashedPassword": "deprecated",
- "password": "password"
}
{- "jwtToken": ""
}
companyDescription | string non-empty |
companyUrl | string non-empty |
email required | string <email> non-empty |
legalCompanyName required | string non-empty |
name required | string non-empty |
password required | string non-empty |
{- "companyDescription": "We sell xyz database software",
- "email": "abc@gmail.com",
- "legalCompanyName": "mywebsite",
- "name": "John Doe",
- "password": "password"
}
email required | string <email> non-empty |
roleType required | string Enum: "root" "editor" "reader" "service_editor" "service_reader" "admin" "service_operator" |
{- "email": "abc@gmail.com",
- "roleType": "reader"
}
email required | string <email> non-empty |
roleType required | string Enum: "root" "editor" "reader" "service_editor" "service_reader" "admin" "service_operator" |
{- "email": "abc@gmail.com",
- "roleType": "reader"
}
currentPassword | string non-empty |
currentPasswordHash | string non-empty |
password required | string non-empty |
{- "currentPassword": "currentPassword",
- "currentPasswordHash": "currentPasswordHash",
- "password": "password"
}
{- "address": {
- "addressLine1": "1234 Main St",
- "addressLine2": "Apt 123",
- "addressLine3": "Building 123",
- "city": "San Francisco",
- "country": "US",
- "state": "CA",
- "zip": "94123"
}, - "createdAt": "2023-01-10T00:00:00Z",
- "email": "abc@gmail.com",
- "id": "user-abcd1234",
- "lastModifiedAt": "2023-01-20T00:00:00Z",
- "name": "John Dae",
- "orgDescription": "ACME Inc.",
- "orgId": "org-aKQ8G13QeR",
- "orgName": "ACME",
- "orgPrivacyPolicy": "Temporibus architecto autem cupiditate eius enim.",
- "orgSupportEmail": "support@example.com",
- "orgTermsOfUse": "Qui ut eum sed et quam quidem.",
- "orgURL": "something.acme",
- "planName": "STARTER",
- "roleType": "reader"
}
id required | string Example: user-abcd1234 The User ID |
object (Address) | |
name | string The name of the user |
orgDescription | string The description of the org that this user owns |
orgFavIconURL | string <uri> The favicon of the org that this user owns |
orgLogoURL | string <uri> The logo of the org that this user owns |
orgName | string The org name that this user owns |
orgPrivacyPolicy | string The privacy policy for the org that this user owns in an HTML format |
orgSupportEmail | string The support email of the org that this user owns |
orgTermsOfUse | string The terms of use for the org that this user owns in an HTML format |
orgURL | string The url of the org that this user owns |
{- "address": {
- "addressLine1": "1234 Main St",
- "addressLine2": "Apt 123",
- "addressLine3": "Building 123",
- "city": "San Francisco",
- "country": "US",
- "state": "CA",
- "zip": "94123"
}, - "name": "John Dae",
- "orgDescription": "ACME Inc.",
- "orgName": "ACME",
- "orgPrivacyPolicy": "Eum magni.",
- "orgSupportEmail": "support@example.com",
- "orgTermsOfUse": "Qui laboriosam recusandae qui est at.",
- "orgURL": "something.acme"
}
subscriptionId required | string Example: sub-abcd1234 The subscription ID |
email required | string <email> non-empty |
roleType required | string Enum: "root" "editor" "reader" "service_editor" "service_reader" "admin" "service_operator" |
{- "email": "abc@gmail.com",
- "roleType": "reader"
}
subscriptionId required | string Example: sub-abcd1234 The subscription ID |
email required | string <email> non-empty |
roleType required | string Enum: "root" "editor" "reader" "service_editor" "service_reader" "admin" "service_operator" |
{- "email": "abc@gmail.com",
- "roleType": "reader"
}
subscriptionId required | string Example: sub-abcd1234 The subscription ID |
{- "Id": "sub-abcd1234",
- "subscriptionUsers": [
- {
- "email": "abc@gmail.com",
- "name": "John Doe",
- "roleType": "reader",
- "userId": "user-abcd1234"
}
]
}
id required | string^(?P<entitytype>user)-(?P<entityid>[a-zA-Z0-9... Example: user-abcd1234 ID of a User |
{- "name": "John Dae",
- "paymentConfigured": true,
- "userId": "user-abcd1234"
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service key |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
{- "ids": [
- "instance-abcd1234",
- "instance-abcd1235"
], - "nextPageToken": "next-token"
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
cloud_provider | string The cloud provider name |
externalBillingId | string The external billing id to record which customer should pay for this resource instance |
network_type | string Enum: "PUBLIC" "PRIVATE_VPC_PEERING" "PRIVATE_LINK" The network type |
region | string The region code |
requestParams | string <binary> The request parameters |
{- "cloud_provider": "aws",
- "externalBillingId": "external-billing-id-1234",
- "network_type": "PUBLIC",
- "region": "us-east-1",
- "requestParams": {
- "param1": "value1",
- "param2": "value2"
}
}
{- "id": "Inventore repellat numquam."
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
{- "active": true,
- "awsAccountID": "123456789012",
- "backupStatus": {
- "earliestRestoreTime": "2021-09-01T00:00:00Z"
}, - "cloud_provider": "aws",
- "created_at": "2023-01-10T00:00:00Z",
- "createdByUserId": "user-12345678",
- "createdByUserName": "John Doe",
- "detailedNetworkTopology": {
- "r-abcd1234": {
- "allowedIPRanges": [
- "0.0.0.0/0"
], - "clusterEndpoint": "primary.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
- "clusterPorts": [
- 3306
], - "main": true,
- "networkingType": "PUBLIC",
- "nodes": [
- {
- "availabilityZone": "us-east-2a",
- "endpoint": "primary-0.instance-abcd1234.us-east-2.aws.omnistrate.cloud",
- "healthStatus": "healthy",
- "id": "primary-0",
- "ports": [
- 3306
], - "status": "RUNNING"
}
], - "privateNetworkCIDR": "10.0.0.2/24",
- "privateNetworkID": "n-1234abcd",
- "publiclyAccessible": true,
- "resourceKey": "primary",
- "resourceName": "Primary MySQL Instance"
}
}, - "externalPayerId": "external-payer-id-1234",
- "gcpProjectID": "my-project",
- "highAvailability": true,
- "id": "instance-abcd1234",
- "last_modified_at": "2023-01-20T00:00:00Z",
- "network_type": "PUBLIC",
- "productTierFeatures": {
- "BILLING": {
- "enabled": false
}, - "LOGS": {
- "auth": {
- "password": "px3c4d5f6g7h8i",
- "username": "abcd1234"
}, - "enabled": true,
- "websocketBaseUrl": "wss://r-injectedobserve.instance-abcdefgh.us-east-2.aws.omnistrate.cloud/logs"
}, - "METRICS": {
- "enabled": false
}
}, - "region": "us-east-1",
- "result_params": {
- "param1": "value1",
- "param2": "value2"
}, - "status": "RUNNING",
- "subscriptionId": "sub-abcd1234"
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
requestParams | string <binary> The request parameters |
{- "requestParams": {
- "param1": "value1",
- "param2": "value2"
}
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
capacityToBeAdded required | integer <int64> Number of replicas to be added |
{- "capacityToBeAdded": 3
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: http-service The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: http-service The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
customDNS required | string The custom DNS to add |
targetPort | integer <int64> The target port |
{- "customDNS": "my-custom-dns.com",
- "targetPort": 8080
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
failedReplicaAction | string Enum: "FAILOVER_ONLY" "FAILOVER_AND_RESTART" "FAILOVER_AND_RECREATE" The failed replica action |
failedReplicaID required | string The failed replica ID |
{- "failedReplicaAction": "FAILOVER_AND_RESTART",
- "failedReplicaID": "db-0"
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
capacityToBeRemoved required | integer <int64> Number of replicas to be removed |
{- "capacityToBeRemoved": 3
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
network_type | string Enum: "PUBLIC" "PRIVATE_VPC_PEERING" "PRIVATE_LINK" The network type |
targetRestoreTime required | string The target restore time |
{- "network_type": "PUBLIC",
- "targetRestoreTime": "2021-09-01T00:00:00Z"
}
{- "id": "Saepe officia nobis ratione est."
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
resourceKey required | string Example: mysql The resource key |
id required | string Example: instance-abcd1234 The instance ID |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
The Account Config API manages the access information for a Service Provider account
awsAccessKey | string The AWS access key |
awsAccountID | string The AWS account ID |
awsBootstrapRoleARN | string The security role ARN or service account ARN that grants access to operate the infra |
awsSecretKey | string The AWS secret key |
byoaInstanceID | string The BYOA instance ID that this account config is tied to |
cloudProviderId required | string^(?P<entitytype>infra)-(?P<entityid>[a-zA-Z0-... Cloud Provider ID to operate on |
description required | string The description for the account |
gcpProjectID | string The GCP project ID |
gcpProjectNumber | string The GCP project number |
gcpServiceAccountEmail | string The GCP service account email |
gcpServiceAccountKey | string The GCP service account key |
name required | string The name of the account |
{- "awsAccessKey": "Atque aut illo molestiae delectus et.",
- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "awsSecretKey": "Aliquid voluptatem maiores voluptatem ab voluptas nulla.",
- "byoaInstanceID": "instance-12345678",
- "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "gcpServiceAccountKey": "Sequi qui illo enim sit.",
- "name": "Dev AWS account"
}
"ac-12345678"
id required | string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][... Example: ac-12345678 Account Config ID to operate on |
{- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}
id required | string^(?P<entitytype>ac)-(?P<entityid>[a-zA-Z0-9][... Example: ac-12345678 Account Config ID to operate on |
awsAccessKey | string The AWS access key |
awsSecretKey | string The AWS secret key |
bootstrapRoleARN | string The security role ARN or service account ARN that grants access to operate the infra |
description | string The description for the account |
gcpServiceAccountEmail | string The GCP service account email |
gcpServiceAccountKey | string The GCP service account key |
name | string The name of the account |
{- "awsAccessKey": "Ad et architecto tempore et ratione minima.",
- "awsSecretKey": "Debitis hic aut non.",
- "bootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "description": "An AWS account hosting multiple dev environments",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "gcpServiceAccountKey": "Perferendis placeat consequatur voluptas dolor rerum non.",
- "name": "Dev AWS account"
}
awsAccountID required | string Example: 123456789012 The AWS account ID |
{- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" Cloud Provider name to filter on |
{- "cloudProviderName": "aws"
}
{- "accountConfigs": [
- {
- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}, - {
- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}, - {
- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}, - {
- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}
], - "ids": [
- "ac-12345678",
- "ac-abcdefgh",
- "ac-1234efgh"
], - "nextPageToken": "next-token"
}
cloudProviderName required | string Enum: "aws" "azure" "gcp" "all" Example: aws Cloud Provider name to filter on |
{- "accountConfigs": [
- {
- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}, - {
- "awsAccountID": "123456789012",
- "awsBootstrapRoleARN": "arn:aws:iam::<ACCOUNT_ID>:role/<ROLE_NAME>",
- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}
], - "ids": [
- "ac-12345678",
- "ac-abcdefgh",
- "ac-1234efgh"
], - "nextPageToken": "next-token"
}
gcpProjectID required | string Example: my-project The GCP project ID |
{- "byoaInstanceIDs": [
- "instance-12345678",
- "instance-abcdefgh"
], - "cloudProviderId": "infra-12345678",
- "description": "An AWS account hosting multiple dev environments",
- "gcpProjectID": "my-project",
- "gcpProjectNumber": "123456789012",
- "gcpServiceAccountEmail": "bootstrap@my-project.iam.gserviceaccount.com",
- "id": "ac-12345678",
- "name": "Dev AWS account",
- "status": "READY",
- "statusMessage": "Account is ready"
}
{- "CustomDomains": [
- {
- "customDomain": "mydomain.dev",
- "description": "Description of the domain",
- "id": "cd-12345678",
- "name": "Dev domain",
- "route53Configuration": {
- "awsAccountID": "123456789012",
}, - "status": "READY",
- "statusMessage": "Account is ready"
}, - {
- "customDomain": "mydomain.dev",
- "description": "Description of the domain",
- "id": "cd-12345678",
- "name": "Dev domain",
- "route53Configuration": {
- "awsAccountID": "123456789012",
}, - "status": "READY",
- "statusMessage": "Account is ready"
}, - {
- "customDomain": "mydomain.dev",
- "description": "Description of the domain",
- "id": "cd-12345678",
- "name": "Dev domain",
- "route53Configuration": {
- "awsAccountID": "123456789012",
}, - "status": "READY",
- "statusMessage": "Account is ready"
}
], - "ids": [
- "cd-12345678",
- "cd-abcdefgh",
- "cd-1234efgh"
], - "nextPageToken": "next-token"
}
customDomain required | string The root domain of the domain to use as suffix |
description required | string The description for the domain |
name required | string The name of the custom domain |
required | object (Route53Configuration) |
{- "customDomain": "mydomain.dev",
- "description": "Description of the domain",
- "name": "Dev domain",
- "route53Configuration": {
- "awsAccountID": "123456789012"
}
}
"cd-12345678"
id required | string^(?P<entitytype>cd)-(?P<entityid>[a-zA-Z0-9][... Example: cd-12345678 custom domain ID to operate on |
{- "customDomain": "mydomain.dev",
- "description": "Description of the domain",
- "id": "cd-12345678",
- "name": "Dev domain",
- "route53Configuration": {
- "awsAccountID": "123456789012",
}, - "status": "READY",
- "statusMessage": "Account is ready"
}
family required | string Enum: "SERVICE" "COMPUTE_INFRA" "STORAGE_INFRA" "NETWORK_INFRA" "OTHER_INFRA" Limit family |
{- "family": "COMPUTE_INFRA"
}
{- "keys": [
- "MAX_VIRTUAL_CORES_PER_RESOURCE"
], - "nextPageToken": "next-token"
}
family required | string Enum: "SERVICE" "COMPUTE_INFRA" "STORAGE_INFRA" "NETWORK_INFRA" "OTHER_INFRA" Example: COMPUTE_INFRA Limit family |
key required | string Example: MAX_VIRTUAL_CORES_PER_RESOURCE Unique key to identify the limit |
family required | string Enum: "SERVICE" "COMPUTE_INFRA" "STORAGE_INFRA" "NETWORK_INFRA" "OTHER_INFRA" Example: COMPUTE_INFRA Limit family |
key required | string Example: MAX_VIRTUAL_CORES_PER_RESOURCE Unique key to identify the limit |
{- "description": "A premium limit",
- "family": "COMPUTE_INFRA",
- "key": "MAX_VIRTUAL_CORES_PER_RESOURCE",
- "modifiable": true,
- "name": "Premium Tier",
- "value": 4
}
family required | string Enum: "SERVICE" "COMPUTE_INFRA" "STORAGE_INFRA" "NETWORK_INFRA" "OTHER_INFRA" Example: COMPUTE_INFRA Limit family |
key required | string Example: MAX_VIRTUAL_CORES_PER_RESOURCE Unique key to identify the limit |
description | string A brief description of the limit |
name | string Name of the limit |
value required | integer <int64> Value of the limit being enforced |
{- "description": "A premium limit",
- "name": "Premium Tier",
- "value": 4
}
description required | string A brief description of the Image Registry |
host required | string The Image Registry host |
name required | string Name of the Image Registry |
password | string The password to use when authenticating to the Image Registry |
username | string The username to use when authenticating to the Image Registry |
{- "description": "DockerHub is a public Docker Image Registry",
- "host": "docker.io",
- "name": "DockerHub",
- "password": "mypassword",
- "username": "myusername"
}
"ir-12345678"
id required | string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][... Example: ir-12345678 The ID of the Image Registry |
{- "description": "DockerHub is a public Docker Image Registry",
- "host": "docker.io",
- "id": "ir-12345678",
- "name": "DockerHub",
- "password": "mypassword",
- "username": "myusername"
}
id required | string^(?P<entitytype>ir)-(?P<entityid>[a-zA-Z0-9][... Example: ir-12345678 The ID of the Image Registry |
description | string A brief description of the Image Registry |
host | string The Image Registry host |
name | string Name of the Image Registry |
password | string The password to use when authenticating to the Image Registry |
username | string The username to use when authenticating to the Image Registry |
{- "description": "DockerHub is a public Docker Image Registry",
- "host": "docker.io",
- "name": "DockerHub",
- "password": "mypassword",
- "username": "myusername"
}
orgId | string^(?P<entitytype>org)-(?P<entityid>[a-zA-Z0-9]... Example: orgId=org-12345678 Org Id |
visibility | string Enum: "PUBLIC" "PRIVATE" Example: visibility=PRIVATE The visibility of service offering |
environmentType | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" Example: environmentType=DEV The environment type to filter by |
{- "nextPageToken": "next-token",
- "serviceIds": [
- "s-12345678",
- "s-abcdefgh"
], - "services": [
- {
- "createdAt": "2019-01-01T00:00:00Z",
- "isDeprecated": false,
- "offerings": [
- {
- "productTierName": "Premium",
- "productTierURLKey": "premium",
- "resourceParameters": [
- {
- "name": "MySQL",
- "urlKey": "mysql"
}, - {
- "name": "Redis",
- "urlKey": "redis"
}
], - "serviceAPIID": "sa-12345678",
- "serviceAPIVersion": "v1",
- "serviceEnvironmentName": "Production",
- "serviceEnvironmentURLKey": "prod",
- "serviceEnvironmentVisibility": "PRIVATE",
- "serviceModelName": "Bring Your Own Account",
- "serviceModelURLKey": "byoa"
}, - {
- "productTierName": "Basic",
- "productTierURLKey": "basic",
- "resourceParameters": [
- {
- "name": "MySQL",
- "urlKey": "mysql"
}, - {
- "name": "Redis",
- "urlKey": "redis"
}
], - "serviceAPIID": "sa-abcdefgh",
- "serviceAPIVersion": "v1",
- "serviceEnvironmentName": "Production",
- "serviceEnvironmentURLKey": "prod",
- "serviceEnvironmentVisibility": "PUBLIC",
- "serviceModelName": "Hosted",
- "serviceModelURLKey": "hosted"
}
], - "serviceDescription": "MySQL is a relational database",
- "serviceId": "s-12345678",
- "serviceName": "MySQL",
- "serviceOrgId": "org-12345678",
- "serviceProviderId": "sp-9zrg9W8Are",
- "serviceProviderName": "Omnistrate, Inc.",
- "serviceURLKey": "mysql"
}, - {
- "createdAt": "2019-01-01T00:00:00Z",
- "isDeprecated": false,
- "offerings": [
- {
- "productTierName": "Premium",
- "productTierURLKey": "premium",
- "resourceParameters": [
- {
- "name": "MySQL",
- "urlKey": "mysql"
}, - {
- "name": "Redis",
- "urlKey": "redis"
}
], - "serviceAPIID": "sa-12345678",
- "serviceAPIVersion": "v1",
- "serviceEnvironmentName": "Production",
- "serviceEnvironmentURLKey": "prod",
- "serviceEnvironmentVisibility": "PRIVATE",
- "serviceModelName": "Bring Your Own Account",
- "serviceModelURLKey": "byoa"
}, - {
- "productTierName": "Basic",
- "productTierURLKey": "basic",
- "resourceParameters": [
- {
- "name": "MySQL",
- "urlKey": "mysql"
}, - {
- "name": "Redis",
- "urlKey": "redis"
}
], - "serviceAPIID": "sa-abcdefgh",
- "serviceAPIVersion": "v1",
- "serviceEnvironmentName": "Production",
- "serviceEnvironmentURLKey": "prod",
- "serviceEnvironmentVisibility": "PUBLIC",
- "serviceModelName": "Hosted",
- "serviceModelURLKey": "hosted"
}
], - "serviceDescription": "MySQL is a relational database",
- "serviceId": "s-12345678",
- "serviceName": "MySQL",
- "serviceOrgId": "org-12345678",
- "serviceProviderId": "sp-9zrg9W8Are",
- "serviceProviderName": "Omnistrate, Inc.",
- "serviceURLKey": "mysql"
}, - {
- "createdAt": "2019-01-01T00:00:00Z",
- "isDeprecated": false,
- "offerings": [
- {
- "productTierName": "Premium",
- "productTierURLKey": "premium",
- "resourceParameters": [
- {
- "name": "MySQL",
- "urlKey": "mysql"
}, - {
- "name": "Redis",
- "urlKey": "redis"
}
], - "serviceAPIID": "sa-12345678",
- "serviceAPIVersion": "v1",
- "serviceEnvironmentName": "Production",
- "serviceEnvironmentURLKey": "prod",
- "serviceEnvironmentVisibility": "PRIVATE",
- "serviceModelName": "Bring Your Own Account",
- "serviceModelURLKey": "byoa"
}, - {
- "productTierName": "Basic",
- "productTierURLKey": "basic",
- "resourceParameters": [
- {
- "name": "MySQL",
- "urlKey": "mysql"
}, - {
- "name": "Redis",
- "urlKey": "redis"
}
], - "serviceAPIID": "sa-abcdefgh",
- "serviceAPIVersion": "v1",
- "serviceEnvironmentName": "Production",
- "serviceEnvironmentURLKey": "prod",
- "serviceEnvironmentVisibility": "PUBLIC",
- "serviceModelName": "Hosted",
- "serviceModelURLKey": "hosted"
}
], - "serviceDescription": "MySQL is a relational database",
- "serviceId": "s-12345678",
- "serviceName": "MySQL",
- "serviceOrgId": "org-12345678",
- "serviceProviderId": "sp-9zrg9W8Are",
- "serviceProviderName": "Omnistrate, Inc.",
- "serviceURLKey": "mysql"
}
]
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
visibility | string Enum: "PUBLIC" "PRIVATE" Example: visibility=PRIVATE The visibility of service offering |
environmentType | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" Example: environmentType=DEV The environment type to filter by |
{- "createdAt": "2019-01-01T00:00:00Z",
- "isDeprecated": false,
- "offerings": [
- {
- "productTierName": "Premium",
- "productTierURLKey": "premium",
- "resourceParameters": [
- {
- "name": "MySQL",
- "urlKey": "mysql"
}, - {
- "name": "Redis",
- "urlKey": "redis"
}
], - "serviceAPIID": "sa-12345678",
- "serviceAPIVersion": "v1",
- "serviceEnvironmentName": "Production",
- "serviceEnvironmentURLKey": "prod",
- "serviceEnvironmentVisibility": "PRIVATE",
- "serviceModelName": "Bring Your Own Account",
- "serviceModelURLKey": "byoa"
}, - {
- "productTierName": "Basic",
- "productTierURLKey": "basic",
- "resourceParameters": [
- {
- "name": "MySQL",
- "urlKey": "mysql"
}, - {
- "name": "Redis",
- "urlKey": "redis"
}
], - "serviceAPIID": "sa-abcdefgh",
- "serviceAPIVersion": "v1",
- "serviceEnvironmentName": "Production",
- "serviceEnvironmentURLKey": "prod",
- "serviceEnvironmentVisibility": "PUBLIC",
- "serviceModelName": "Hosted",
- "serviceModelURLKey": "hosted"
}
], - "serviceDescription": "MySQL is a relational database",
- "serviceId": "s-12345678",
- "serviceName": "MySQL",
- "serviceOrgId": "org-12345678",
- "serviceProviderId": "sp-9zrg9W8Are",
- "serviceProviderName": "Omnistrate, Inc.",
- "serviceURLKey": "mysql"
}
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: s-12345678 The service ID |
resourceId required | string^(?P<entitytype>r)-(?P<entityid>[a-zA-Z0-9][a... Example: r-12345678 The resource ID |
instanceId required | string Default: "none" Example: instance-12345678 The instance ID |
{- "apis": [
- {
- "inputParameters": [
- {
- "defaultValue": null,
- "description": "The name of the server",
- "displayName": "Server Name",
- "isList": false,
- "key": "serverName",
- "modifiable": true,
- "options": null,
- "required": true,
- "type": "string"
}, - {
- "defaultValue": "option1",
- "description": "The type of the server",
- "displayName": "Server Type",
- "isList": false,
- "key": "serverType",
- "modifiable": true,
- "options": [
- "option1",
- "option2"
], - "required": true,
- "type": "string"
}
], - "outputParameters": [
- {
- "description": "The name of the server",
- "displayName": "Server Name",
- "isList": false,
- "key": "serverName",
- "type": "string"
}, - {
- "description": "The type of the server",
- "displayName": "Server Type",
- "isList": false,
- "key": "serverType",
- "type": "string"
}
], - "verb": "create"
}, - {
- "inputParameters": [
- {
- "defaultValue": null,
- "description": "The name of the server",
- "displayName": "Server Name",
- "isList": false,
- "key": "serverName",
- "modifiable": true,
- "options": null,
- "required": true,
- "type": "string"
}
], - "outputParameters": [
- {
- "description": "The name of the server",
- "displayName": "Server Name",
- "isList": false,
- "key": "serverName",
- "type": "string"
}, - {
- "description": "The type of the server",
- "displayName": "Server Type",
- "isList": false,
- "key": "serverType",
- "type": "string"
}
], - "verb": "describe"
}
]
}
instanceId required | string Example: instance-12345678 The ID of the resource instance |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
{- "events": [
- {
- "id": "event-12345678",
- "message": "instance-abcd1234 created",
- "resourceInstanceId": "instance-abcd1234",
- "resourceName": "Galera",
- "time": "2023-01-10T00:00:00Z"
}, - {
- "id": "event-12345678",
- "message": "instance-abcd1234 created",
- "resourceInstanceId": "instance-abcd1234",
- "resourceName": "Galera",
- "time": "2023-01-10T00:00:00Z"
}
], - "ids": [
- "event-12345678"
], - "nextPageToken": "token"
}
serviceProviderId required | string^(?P<entitytype>sp)-(?P<entityid>[a-zA-Z0-9][... Example: omnistrate The service provider ID |
serviceKey required | string Example: service-orchestration The service name |
serviceAPIVersion required | string Example: v1 The service API version |
serviceEnvironmentKey required | string Example: dev The service environment name |
serviceModelKey required | string Example: hosted The service model name |
productTierKey required | string Example: premium The product tier name |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
{- "events": [
- {
- "id": "event-12345678",
- "message": "instance-abcd1234 created",
- "resourceInstanceId": "instance-abcd1234",
- "resourceName": "Galera",
- "time": "2023-01-10T00:00:00Z"
}, - {
- "id": "event-12345678",
- "message": "instance-abcd1234 created",
- "resourceInstanceId": "instance-abcd1234",
- "resourceName": "Galera",
- "time": "2023-01-10T00:00:00Z"
}, - {
- "id": "event-12345678",
- "message": "instance-abcd1234 created",
- "resourceInstanceId": "instance-abcd1234",
- "resourceName": "Galera",
- "time": "2023-01-10T00:00:00Z"
}
], - "ids": [
- "event-12345678"
], - "nextPageToken": "token"
}
id required | string^(?P<entitytype>event)-(?P<entityid>[a-zA-Z0-... Example: event-12345678 The ID of the event |
subscriptionId | string Example: subscriptionId=sub-abcd1234 Subscription Id |
{- "id": "event-12345678",
- "message": "instance-abcd1234 created",
- "resourceInstanceId": "instance-abcd1234",
- "resourceName": "Galera",
- "time": "2023-01-10T00:00:00Z"
}
serviceId | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... Example: serviceId=service-12345678 Service Id |
{- "ids": [
- "sub-12345678",
- "sub-abcdefgh",
- "sub-1234efgh"
], - "nextPageToken": "next-token",
- "subscriptions": [
- {
- "accountConfigIdentityId": "org-12345678",
- "cloudProviderNames": [
- "aws",
- "gcp"
], - "createdAt": "2019-01-01T00:00:00Z",
- "defaultSubscription": true,
- "id": "sub-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "roleType": "root",
- "rootUserId": "user-12345678",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "serviceOrgId": "org-12345678",
- "serviceOrgName": "Omnistrate",
- "status": "ACTIVE",
- "subscriptionOwnerName": "John Doe"
}, - {
- "accountConfigIdentityId": "org-12345678",
- "cloudProviderNames": [
- "aws",
- "gcp"
], - "createdAt": "2019-01-01T00:00:00Z",
- "defaultSubscription": true,
- "id": "sub-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "roleType": "root",
- "rootUserId": "user-12345678",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "serviceOrgId": "org-12345678",
- "serviceOrgName": "Omnistrate",
- "status": "ACTIVE",
- "subscriptionOwnerName": "John Doe"
}, - {
- "accountConfigIdentityId": "org-12345678",
- "cloudProviderNames": [
- "aws",
- "gcp"
], - "createdAt": "2019-01-01T00:00:00Z",
- "defaultSubscription": true,
- "id": "sub-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "roleType": "root",
- "rootUserId": "user-12345678",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "serviceOrgId": "org-12345678",
- "serviceOrgName": "Omnistrate",
- "status": "ACTIVE",
- "subscriptionOwnerName": "John Doe"
}, - {
- "accountConfigIdentityId": "org-12345678",
- "cloudProviderNames": [
- "aws",
- "gcp"
], - "createdAt": "2019-01-01T00:00:00Z",
- "defaultSubscription": true,
- "id": "sub-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "roleType": "root",
- "rootUserId": "user-12345678",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "serviceOrgId": "org-12345678",
- "serviceOrgName": "Omnistrate",
- "status": "ACTIVE",
- "subscriptionOwnerName": "John Doe"
}
]
}
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... The product tier ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... The service ID |
{- "productTierId": "pt-12345678",
- "serviceId": "s-12345678"
}
"sub-12345678"
id required | string^(?P<entitytype>sub)-(?P<entityid>[a-zA-Z0-9]... Example: sub-12345678 The subscription ID |
{- "accountConfigIdentityId": "org-12345678",
- "cloudProviderNames": [
- "aws",
- "gcp"
], - "createdAt": "2019-01-01T00:00:00Z",
- "defaultSubscription": true,
- "id": "sub-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "roleType": "root",
- "rootUserId": "user-12345678",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "serviceOrgId": "org-12345678",
- "serviceOrgName": "Omnistrate",
- "status": "ACTIVE",
- "subscriptionOwnerName": "John Doe"
}
The subscription request API for end customers to issue subscription requests
status | string Enum: "PENDING" "APPROVED" "DENIED" "CANCELLED" Example: status=PENDING The status of the subscription request to filter by |
{- "ids": [
- "subr-12345678",
- "subr-abcdefgh",
- "subr-1234efgh"
], - "nextPageToken": "next-token",
- "subscriptionRequests": [
- {
- "createdAt": "2019-01-01T00:00:00Z",
- "id": "subr-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "rootUserEmail": "abc@gmail.com",
- "rootUserId": "org-12345678",
- "rootUserName": "John Doe",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "status": "PENDING",
- "updatedAt": "2019-01-01T00:00:00Z",
- "updatedByUserId": "user-12345678",
- "updatedByUserName": "John Doe"
}, - {
- "createdAt": "2019-01-01T00:00:00Z",
- "id": "subr-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "rootUserEmail": "abc@gmail.com",
- "rootUserId": "org-12345678",
- "rootUserName": "John Doe",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "status": "PENDING",
- "updatedAt": "2019-01-01T00:00:00Z",
- "updatedByUserId": "user-12345678",
- "updatedByUserName": "John Doe"
}, - {
- "createdAt": "2019-01-01T00:00:00Z",
- "id": "subr-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "rootUserEmail": "abc@gmail.com",
- "rootUserId": "org-12345678",
- "rootUserName": "John Doe",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "status": "PENDING",
- "updatedAt": "2019-01-01T00:00:00Z",
- "updatedByUserId": "user-12345678",
- "updatedByUserName": "John Doe"
}
]
}
productTierId required | string^(?P<entitytype>pt)-(?P<entityid>[a-zA-Z0-9][... The product tier ID |
serviceId required | string^(?P<entitytype>s)-(?P<entityid>[a-zA-Z0-9][a... The service ID |
{- "productTierId": "pt-12345678",
- "serviceId": "s-12345678"
}
"subr-12345678"
id required | string^(?P<entitytype>subr)-(?P<entityid>[a-zA-Z0-9... Example: subr-12345678 The subscription ID |
{- "createdAt": "2019-01-01T00:00:00Z",
- "id": "subr-12345678",
- "productTierId": "pt-12345678",
- "productTierName": "Omnistrate Multi Tenancy",
- "rootUserEmail": "abc@gmail.com",
- "rootUserId": "org-12345678",
- "rootUserName": "John Doe",
- "serviceId": "s-12345678",
- "serviceName": "MySQL multi-writer service",
- "status": "PENDING",
- "updatedAt": "2019-01-01T00:00:00Z",
- "updatedByUserId": "user-12345678",
- "updatedByUserName": "John Doe"
}
{- "identityProviders": [
- {
- "clientId": "205376496935-vtfpdnseqmjhsynlh0bsufl38k0test.apps.googleusercontent.com",
- "clientSecret": "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",
- "id": "idp-12345678",
- "identityProviderName": "Google",
- "status": "Ready"
}, - {
- "clientId": "205376496935-vtfpdnseqmjhsynlh0bsufl38k0test.apps.googleusercontent.com",
- "clientSecret": "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",
- "id": "idp-12345678",
- "identityProviderName": "Google",
- "status": "Ready"
}, - {
- "clientId": "205376496935-vtfpdnseqmjhsynlh0bsufl38k0test.apps.googleusercontent.com",
- "clientSecret": "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",
- "id": "idp-12345678",
- "identityProviderName": "Google",
- "status": "Ready"
}
]
}
clientId required | string The Client ID of the Identity Provider |
clientSecret required | string The Client Secret of the Identity Provider |
identityProviderName required | string Enum: "Google" "GitHub" The name of the Identity Provider |
{- "clientId": "205376496935-vtfpdnseqmjhsynlh0bsufl38k0test.apps.googleusercontent.com",
- "clientSecret": "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",
- "identityProviderName": "Google"
}
"idp-12345678"
id required | string^(?P<entitytype>idp)-(?P<entityid>[a-zA-Z0-9]... Example: idp-12345678 The Identity Provider ID |
{- "clientId": "205376496935-vtfpdnseqmjhsynlh0bsufl38k0test.apps.googleusercontent.com",
- "clientSecret": "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",
- "id": "idp-12345678",
- "identityProviderName": "Google",
- "status": "Ready"
}
id required | string^(?P<entitytype>idp)-(?P<entityid>[a-zA-Z0-9]... Example: idp-12345678 The Identity Provider ID |
clientId | string The Client ID of the Identity Provider |
clientSecret | string The Client Secret of the Identity Provider |
{- "clientId": "205376496935-vtfpdnseqmjhsynlh0bsufl38k0test.apps.googleusercontent.com",
- "clientSecret": "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"
}
id required | string^(?P<entitytype>idp)-(?P<entityid>[a-zA-Z0-9]... Example: idp-12345678 The Identity Provider ID |
{- "clientId": "205376496935-vtfpdnseqmjhsynlh0bsufl38k0test.apps.googleusercontent.com",
- "clientSecret": "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",
- "id": "idp-12345678",
- "identityProviderName": "Google",
- "status": "Ready"
}
{- "saasPortals": [
- {
- "customDomain": "mycustomdomain.com",
- "customDomainStatus": "READY",
- "emailConfig": {
- "smtpFromEmail": "example@gmail.com",
- "smtpHost": "smtp.gmail.com",
- "smtpPassword": "password",
- "smtpPort": 587,
- "smtpUsername": "username"
}, - "environmentType": "DEV",
- "googleAnalyticsTagID": "G-123456789",
- "imageConfig": {
- "imageName": "myimage",
- "imageRegistry": "ghcr.io",
- "imageTag": "latest"
}, - "status": "READY"
}, - {
- "customDomain": "mycustomdomain.com",
- "customDomainStatus": "READY",
- "emailConfig": {
- "smtpFromEmail": "example@gmail.com",
- "smtpHost": "smtp.gmail.com",
- "smtpPassword": "password",
- "smtpPort": 587,
- "smtpUsername": "username"
}, - "environmentType": "DEV",
- "googleAnalyticsTagID": "G-123456789",
- "imageConfig": {
- "imageName": "myimage",
- "imageRegistry": "ghcr.io",
- "imageTag": "latest"
}, - "status": "READY"
}, - {
- "customDomain": "mycustomdomain.com",
- "customDomainStatus": "READY",
- "emailConfig": {
- "smtpFromEmail": "example@gmail.com",
- "smtpHost": "smtp.gmail.com",
- "smtpPassword": "password",
- "smtpPort": 587,
- "smtpUsername": "username"
}, - "environmentType": "DEV",
- "googleAnalyticsTagID": "G-123456789",
- "imageConfig": {
- "imageName": "myimage",
- "imageRegistry": "ghcr.io",
- "imageTag": "latest"
}, - "status": "READY"
}
]
}
{- "customDomains": [
- {
- "clusterEndpoint": "example.com",
- "customDomain": "mycustomdomain.com",
- "description": "My custom domain description",
- "environmentType": "DEV",
- "name": "MyCustomDomain",
- "status": "READY"
}, - {
- "clusterEndpoint": "example.com",
- "customDomain": "mycustomdomain.com",
- "description": "My custom domain description",
- "environmentType": "DEV",
- "name": "MyCustomDomain",
- "status": "READY"
}, - {
- "clusterEndpoint": "example.com",
- "customDomain": "mycustomdomain.com",
- "description": "My custom domain description",
- "environmentType": "DEV",
- "name": "MyCustomDomain",
- "status": "READY"
}
]
}
customDomain required | string The custom domain |
description required | string The custom domain description |
environmentType required | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" The environment type for the custom domain |
name required | string The custom domain name |
{- "customDomain": "mycustomdomain.com",
- "description": "My custom domain description",
- "environmentType": "DEV",
- "name": "MyCustomDomain"
}
environmentType required | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" Example: DEV The environment type for the saas portal custom domain to update |
customDomain | string The custom domain |
description | string The custom domain description |
name | string The custom domain name |
{- "customDomain": "mycustomdomain.com",
- "description": "My custom domain description",
- "name": "MyCustomDomain"
}
environmentType required | string Enum: "PROD" "PRIVATE" "CANARY" "STAGING" "QA" "DEV" Example: DEV The environment type for the saas portal custom domain to update |
customDomain | string The custom domain for the SaaS portal |
object (SaaSPortalEmailConfig) | |
googleAnalyticsTagID | string The Google Analytics tag ID for the SaaS portal |
object (SaaSPortalImageConfig) |
{- "customDomain": "mycustomdomain.com",
- "emailConfig": {
- "smtpFromEmail": "example@gmail.com",
- "smtpHost": "smtp.gmail.com",
- "smtpPassword": "password",
- "smtpPort": 587,
- "smtpUsername": "username"
}, - "googleAnalyticsTagID": "G-123456789",
- "imageConfig": {
- "imageName": "myimage",
- "imageRegistry": "ghcr.io",
- "imageTag": "latest"
}
}
chartName | string Example: chartName=my-chart The chart name to filter by |
{- "helmPackages": [
- {
- "chartName": "my-chart",
- "chartRepoName": "my-repo",
- "chartType": "SYSTEM",
- "chartValues": {
- "key1": "value1",
- "key2": 3,
- "key3": {
- "key4": "value4"
}
}, - "chartVersion": "1.0.0",
- "namespace": "default"
}, - {
- "chartName": "my-chart",
- "chartRepoName": "my-repo",
- "chartType": "SYSTEM",
- "chartValues": {
- "key1": "value1",
- "key2": 3,
- "key3": {
- "key4": "value4"
}
}, - "chartVersion": "1.0.0",
- "namespace": "default"
}
]
}
required | object (HelmPackage) |
{- "helmPackage": {
- "chartName": "my-chart",
- "chartRepoName": "my-repo",
- "chartType": "OPERATOR",
- "chartValues": {
- "key1": "value1",
- "key2": 3,
- "key3": {
- "key4": "value4"
}
}, - "chartVersion": "1.0.0",
- "namespace": "default"
}
}
chartName required | string Example: my-chart The chart name of the Helm package to describe |
chartVersion required | string Example: 1.0.0 The chart version of the Helm package to describe |
{- "chartName": "my-chart",
- "chartRepoName": "my-repo",
- "chartType": "GENERIC",
- "chartValues": {
- "key1": "value1",
- "key2": 3,
- "key3": {
- "key4": "value4"
}
}, - "chartVersion": "1.0.0",
- "namespace": "default"
}
operationType required | string Enum: "CREATE" "READ" "UPDATE" "LIST" "DELETE" "CUSTOM" |
resourceId required | string |
serviceInstanceId required | string |
object (WorkflowVerb) |
{- "operationType": "DELETE",
- "resourceId": "Modi doloremque voluptatem aut omnis neque dignissimos.",
- "serviceInstanceId": "Iusto unde enim.",
- "verb": {
- "id": "Voluptatem quia sapiente nihil commodi ea.",
- "name": "In rerum amet qui maxime."
}
}
"Ressie Wisoky"
id required | string^(?P<entitytype>workflowtemplate)-(?P<entityi... Example: w-12345 |
{- "code": "12-999",
- "message": "Required field `x` was not provided in the request",
- "name": "missing_field"
}
id required | string^(?P<entitytype>workflowtemplate)-(?P<entityi... Example: w-12345 |
{- "code": "12-999",
- "message": "Required field `x` was not provided in the request",
- "name": "missing_field"
}