Download OpenAPI specification:Download
The Master Controller (MC) serves as the central API gateway for users to orchestrate edge resources and provides several APIs to both application developers and operators. Application developers can manage and monitor deployment of edge applications. Operators can manage and monitor the usage of cloudlet infrastructures. Both developers and operators can manage users within their Organization.
Authentication is done by a user name or email plus a password. The login function returns a JSON Web Token (JWT) once authenticated, that should be included with subsequent API calls to authenticate the user. The JWT will expire after a while for security, at which point you may need to log in again.
Login using account credentials
| apikey | string (deprecated) Use password field for ApiKey |
| apikeyid | string (deprecated) Use username field for ApiKeyId |
| password | string User's password |
| totp | string Temporary one-time password if 2-factor authentication is enabled |
| username | string User's name or email address |
{- "apikey": "string",
- "apikeyid": "string",
- "password": "string",
- "totp": "string",
- "username": "string"
}"string"Users can be assigned roles for Organizations, allowing them to view or manage resources associated with the Organizations.
Check if user is authorized
| action | string Action defines what type of action can be performed on a resource |
| object | string Optional object to act upon if auth claims has restriction |
| org | string Organization name |
| resource | string Resource defines a resource to act upon |
{- "action": "string",
- "object": "string",
- "org": "string",
- "resource": "string"
}{- "code": 0,
- "message": "string"
}Create an API key for reduced access, typically for automation
| ApiKey | string API key |
| Description | string Description of the purpose of this API key |
| Org | string Org to which API key has permissions to access its objects |
Array of objects or null (OrmapiRolePerm) List of API key permissions |
{- "ApiKey": "string",
- "Description": "string",
- "Org": "string",
- "permissions": [
- {
- "action": "string",
- "resource": "string",
- "role": "string"
}
]
}{- "ApiKey": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Description": "string",
- "Id": "string",
- "Org": "string",
- "permissions": [
- {
- "action": "string",
- "resource": "string",
- "role": "string"
}
]
}{- "CreatedAt": "2019-08-24T14:15:22Z",
- "Email": "string",
- "EmailVerified": true,
- "EnableTOTP": true,
- "FailedLogins": 0,
- "FamilyName": "string",
- "GivenName": "string",
- "LastFailedLogin": "2019-08-24T14:15:22Z",
- "LastLogin": "2019-08-24T14:15:22Z",
- "Locked": true,
- "Metadata": "string",
- "Name": "string",
- "Nickname": "string",
- "PassCrackTimeSec": 0,
- "Picture": "string",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}Delete an existing user
string User email | |
| EnableTOTP | boolean Enable or disable temporary one-time passwords for the account |
| FailedLogins | integer Number of failed login attempts since last successful login |
| FamilyName | string Family Name |
| GivenName | string Given Name |
| Metadata | string Metadata |
| Name | string User name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Nickname | string Nick Name |
| Picture | string Picture (currently not used) |
{- "Email": "string",
- "EnableTOTP": true,
- "FailedLogins": 0,
- "FamilyName": "string",
- "GivenName": "string",
- "Metadata": "string",
- "Name": "string",
- "Nickname": "string",
- "Picture": "string"
}{- "code": 0,
- "message": "string"
}Delete an API key
| ApiKey | string API key |
| Description | string Description of the purpose of this API key |
| Org | string Org to which API key has permissions to access its objects |
Array of objects or null (OrmapiRolePerm) List of API key permissions |
{- "ApiKey": "string",
- "Description": "string",
- "Org": "string",
- "permissions": [
- {
- "action": "string",
- "resource": "string",
- "role": "string"
}
]
}{- "code": 0,
- "message": "string"
}Set a new password while logged in, requires the existing password
| currentpassword | string User's current password |
| password | string User's new password |
{- "currentpassword": "string",
- "password": "string"
}{- "code": 0,
- "message": "string"
}Show users
string User email | |
| EnableTOTP | boolean Enable or disable temporary one-time passwords for the account |
| FailedLogins | integer Number of failed login attempts since last successful login |
| FamilyName | string Family Name |
| GivenName | string Given Name |
| Metadata | string Metadata |
| Name | string User name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Nickname | string Nick Name |
| Picture | string Picture (currently not used) |
| org | string Organization name |
| role | string Role name |
{- "Email": "string",
- "EnableTOTP": true,
- "FailedLogins": 0,
- "FamilyName": "string",
- "GivenName": "string",
- "Metadata": "string",
- "Name": "string",
- "Nickname": "string",
- "Picture": "string",
- "org": "string",
- "role": "string"
}[- {
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Email": "string",
- "EmailVerified": true,
- "EnableTOTP": true,
- "FailedLogins": 0,
- "FamilyName": "string",
- "GivenName": "string",
- "LastFailedLogin": "2019-08-24T14:15:22Z",
- "LastLogin": "2019-08-24T14:15:22Z",
- "Locked": true,
- "Metadata": "string",
- "Name": "string",
- "Nickname": "string",
- "PassCrackTimeSec": 0,
- "Picture": "string",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
]Show existing API keys
| ApiKey | string API key |
| Description | string Description of the purpose of this API key |
| Org | string Org to which API key has permissions to access its objects |
Array of objects or null (OrmapiRolePerm) List of API key permissions |
{- "ApiKey": "string",
- "Description": "string",
- "Org": "string",
- "permissions": [
- {
- "action": "string",
- "resource": "string",
- "role": "string"
}
]
}[- {
- "ApiKey": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "Description": "string",
- "Id": "string",
- "Org": "string",
- "permissions": [
- {
- "action": "string",
- "resource": "string",
- "role": "string"
}
]
}
]Update a user
string User email | |
| EnableTOTP | boolean Enable or disable temporary one-time passwords for the account |
| FailedLogins | integer Number of failed login attempts since last successful login |
| FamilyName | string Family Name |
| GivenName | string Given Name |
| Metadata | string Metadata |
| Name | string User name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Nickname | string Nick Name |
| Picture | string Picture (currently not used) |
object (OrmapiEmailRequest) |
{- "Email": "string",
- "EnableTOTP": true,
- "FailedLogins": 0,
- "FamilyName": "string",
- "GivenName": "string",
- "Metadata": "string",
- "Name": "string",
- "Nickname": "string",
- "Picture": "string",
- "verify": { }
}{- "Message": "string",
- "TOTPQRImage": [
- 0
], - "TOTPSharedKey": "string"
}Reset the password using the token from the password reset email
| password | string User's new password |
| token | string Authentication token |
{- "password": "string",
- "token": "string"
}{- "code": 0,
- "message": "string"
}Create a new user
string User email | |
| EnableTOTP | boolean Enable or disable temporary one-time passwords for the account |
| FailedLogins | integer Number of failed login attempts since last successful login |
| FamilyName | string Family Name |
| GivenName | string Given Name |
| Metadata | string Metadata |
| Name | string User name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Nickname | string Nick Name |
| Picture | string Picture (currently not used) |
object (OrmapiEmailRequest) |
{- "Email": "string",
- "EnableTOTP": true,
- "FailedLogins": 0,
- "FamilyName": "string",
- "GivenName": "string",
- "Metadata": "string",
- "Name": "string",
- "Nickname": "string",
- "Picture": "string",
- "verify": { }
}{- "Message": "string",
- "TOTPQRImage": [
- 0
], - "TOTPSharedKey": "string"
}Delete a locked user by supplying the password
string User email | |
| EnableTOTP | boolean Enable or disable temporary one-time passwords for the account |
| FailedLogins | integer Number of failed login attempts since last successful login |
| FamilyName | string Family Name |
| GivenName | string Given Name |
| Metadata | string Metadata |
| Name | string User name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Nickname | string Nick Name |
| Picture | string Picture (currently not used) |
{- "Email": "string",
- "EnableTOTP": true,
- "FailedLogins": 0,
- "FamilyName": "string",
- "GivenName": "string",
- "Metadata": "string",
- "Name": "string",
- "Nickname": "string",
- "Picture": "string"
}{- "code": 0,
- "message": "string"
}Verify a user's email account from the token in the email
| token | string Authentication token |
{- "token": "string"
}{- "code": 0,
- "message": "string"
}Roles can be assigned to users for Organizations, allowing the users to view or manage resources associated with the Organizations.
Add a role for the organization to the user
| org | string Organization name |
| role | string Role which defines the set of permissions |
| username | string User name |
{- "org": "string",
- "role": "string",
- "username": "string"
}{- "code": 0,
- "message": "string"
}Show roles for the current user
| org | string Organization name |
| role | string Role which defines the set of permissions |
| username | string User name |
{- "org": "string",
- "role": "string",
- "username": "string"
}[- {
- "org": "string",
- "role": "string",
- "username": "string"
}
]Show permissions associated with each role
| action | string Action defines what type of action can be performed on a resource |
| resource | string Resource defines a resource to act upon |
| role | string Role defines a collection of permissions, which are resource-action pairs |
{- "action": "string",
- "resource": "string",
- "role": "string"
}[- {
- "action": "string",
- "resource": "string",
- "role": "string"
}
]Remove the role for the organization from the user
| org | string Organization name |
| role | string Role which defines the set of permissions |
| username | string User name |
{- "org": "string",
- "role": "string",
- "username": "string"
}{- "code": 0,
- "message": "string"
}Show roles for the organizations the current user can add or remove roles to
| org | string Organization name |
| role | string Role which defines the set of permissions |
| username | string User name |
{- "org": "string",
- "role": "string",
- "username": "string"
}[- {
- "org": "string",
- "role": "string",
- "username": "string"
}
]Create a new developer or operator organization
| Address | string Organization address |
| Name | string Organization name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Phone | string Organization phone number |
| Type | string Organization type: "developer" or "operator" |
{- "Address": "string",
- "Name": "string",
- "Phone": "string",
- "Type": "string"
}{- "code": 0,
- "message": "string"
}Delete an organization
| Address | string Organization address |
| Name | string Organization name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Phone | string Organization phone number |
| Type | string Organization type: "developer" or "operator" |
{- "Address": "string",
- "Name": "string",
- "Phone": "string",
- "Type": "string"
}{- "code": 0,
- "message": "string"
}Show organizations
| Address | string Organization address |
| Name | string Organization name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Phone | string Organization phone number |
| Type | string Organization type: "developer" or "operator" |
{- "Address": "string",
- "Name": "string",
- "Phone": "string",
- "Type": "string"
}[- {
- "Address": "string",
- "CreatedAt": "2019-08-24T14:15:22Z",
- "DeleteInProgress": true,
- "EdgeboxOnly": true,
- "Name": "string",
- "Parent": "string",
- "Phone": "string",
- "PublicImages": true,
- "Type": "string",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
]Update an organization
| Address | string Organization address |
| Name | string Organization name. Can only contain letters, digits, underscore, period, hyphen. It cannot have leading or trailing spaces or period. It cannot start with hyphen |
| Phone | string Organization phone number |
| Type | string Organization type: "developer" or "operator" |
{- "Address": "string",
- "Name": "string",
- "Phone": "string",
- "Type": "string"
}{- "code": 0,
- "message": "string"
}Add alliance organization to the cloudlet
object (EdgeprotoCloudletAllianceOrg) | |
| Region | string Region name |
{- "CloudletAllianceOrg": {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "organization": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Add Optional Resource tag table
object (EdgeprotoCloudletResMap) | |
| Region | string Region name |
{- "CloudletResMap": {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "mapping": {
- "property1": "string",
- "property2": "string"
}
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Create Cloudlet. Sets up Cloudlet services on the Operators compute resources, and integrated as part of EdgeCloud edge resource portfolio. These resources are managed from the Edge Controller.
object (EdgeprotoCloudlet) | |
| Region | string Region name |
{- "Cloudlet": {
- "HostController": "string",
- "access_vars": {
- "property1": "string",
- "property2": "string"
}, - "alliance_orgs": [
- "string"
], - "chef_client_key": {
- "property1": "string",
- "property2": "string"
}, - "config": {
- "access_api_addr": "string",
- "app_dns_root": "string",
- "cache_dir": "string",
- "chef_client_interval": "string",
- "chef_server_path": "string",
- "cleanup_mode": true,
- "cloudlet_vm_image_path": "string",
- "commercial_certs": true,
- "container_registry_path": "string",
- "crm_access_private_key": "string",
- "deployment_tag": "string",
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "notify_ctrl_addrs": "string",
- "platform_tag": "string",
- "region": "string",
- "secondary_crm_access_private_key": "string",
- "span": "string",
- "test_mode": true,
- "thanos_recv_addr": "string",
- "tls_ca_file": "string",
- "tls_cert_file": "string",
- "tls_key_file": "string",
- "use_vault_pki": true
}, - "container_version": "string",
- "created_at": "string",
- "crm_access_key_upgrade_required": true,
- "crm_access_public_key": "string",
- "crm_override": "string",
- "default_resource_alert_threshold": 0,
- "delete_prepare": true,
- "deployment": "string",
- "deployment_local": true,
- "dns_label": "string",
- "enable_default_serverless_cluster": true,
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "errors": [
- "string"
], - "federation_config": {
- "federation_context_id": "string",
- "federation_db_id": 0,
- "federation_name": "string",
- "partner_federation_addr": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "gpu_config": {
- "driver": {
- "name": "string",
- "organization": "string"
}, - "license_config": "string",
- "license_config_md5sum": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "infra_api_access": "string",
- "infra_config": {
- "external_network_name": "string",
- "flavor_name": "string"
}, - "infra_flavors": [
- {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}
], - "ip_support": "string",
- "kafka_cluster": "string",
- "kafka_password": "string",
- "kafka_user": "string",
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "license_config_storage_path": "string",
- "location": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "maintenance_state": 0,
- "notify_srv_addr": "string",
- "num_dynamic_ips": 0,
- "override_policy_container_version": true,
- "physical_name": "string",
- "platform_high_availability": true,
- "platform_type": "string",
- "res_tag_map": {
- "property1": {
- "name": "string",
- "organization": "string"
}, - "property2": {
- "name": "string",
- "organization": "string"
}
}, - "resource_quotas": [
- {
- "alert_threshold": 0,
- "name": "string",
- "value": 0
}
], - "root_lb_fqdn": "string",
- "secondary_crm_access_key_upgrade_required": true,
- "secondary_crm_access_public_key": "string",
- "secondary_notify_srv_addr": "string",
- "single_kubernetes_cluster_owner": "string",
- "state": "string",
- "static_ips": "string",
- "time_limits": {
- "create_app_inst_timeout": "string",
- "create_cluster_inst_timeout": "string",
- "delete_app_inst_timeout": "string",
- "delete_cluster_inst_timeout": "string",
- "update_app_inst_timeout": "string",
- "update_cluster_inst_timeout": "string"
}, - "trust_policy": "string",
- "trust_policy_state": "string",
- "updated_at": "string",
- "vm_image_version": "string",
- "vm_pool": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete Cloudlet. Removes the Cloudlet services where they are no longer managed from the Edge Controller.
object (EdgeprotoCloudlet) | |
| Region | string Region name |
{- "Cloudlet": {
- "HostController": "string",
- "access_vars": {
- "property1": "string",
- "property2": "string"
}, - "alliance_orgs": [
- "string"
], - "chef_client_key": {
- "property1": "string",
- "property2": "string"
}, - "config": {
- "access_api_addr": "string",
- "app_dns_root": "string",
- "cache_dir": "string",
- "chef_client_interval": "string",
- "chef_server_path": "string",
- "cleanup_mode": true,
- "cloudlet_vm_image_path": "string",
- "commercial_certs": true,
- "container_registry_path": "string",
- "crm_access_private_key": "string",
- "deployment_tag": "string",
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "notify_ctrl_addrs": "string",
- "platform_tag": "string",
- "region": "string",
- "secondary_crm_access_private_key": "string",
- "span": "string",
- "test_mode": true,
- "thanos_recv_addr": "string",
- "tls_ca_file": "string",
- "tls_cert_file": "string",
- "tls_key_file": "string",
- "use_vault_pki": true
}, - "container_version": "string",
- "created_at": "string",
- "crm_access_key_upgrade_required": true,
- "crm_access_public_key": "string",
- "crm_override": "string",
- "default_resource_alert_threshold": 0,
- "delete_prepare": true,
- "deployment": "string",
- "deployment_local": true,
- "dns_label": "string",
- "enable_default_serverless_cluster": true,
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "errors": [
- "string"
], - "federation_config": {
- "federation_context_id": "string",
- "federation_db_id": 0,
- "federation_name": "string",
- "partner_federation_addr": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "gpu_config": {
- "driver": {
- "name": "string",
- "organization": "string"
}, - "license_config": "string",
- "license_config_md5sum": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "infra_api_access": "string",
- "infra_config": {
- "external_network_name": "string",
- "flavor_name": "string"
}, - "infra_flavors": [
- {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}
], - "ip_support": "string",
- "kafka_cluster": "string",
- "kafka_password": "string",
- "kafka_user": "string",
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "license_config_storage_path": "string",
- "location": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "maintenance_state": 0,
- "notify_srv_addr": "string",
- "num_dynamic_ips": 0,
- "override_policy_container_version": true,
- "physical_name": "string",
- "platform_high_availability": true,
- "platform_type": "string",
- "res_tag_map": {
- "property1": {
- "name": "string",
- "organization": "string"
}, - "property2": {
- "name": "string",
- "organization": "string"
}
}, - "resource_quotas": [
- {
- "alert_threshold": 0,
- "name": "string",
- "value": 0
}
], - "root_lb_fqdn": "string",
- "secondary_crm_access_key_upgrade_required": true,
- "secondary_crm_access_public_key": "string",
- "secondary_notify_srv_addr": "string",
- "single_kubernetes_cluster_owner": "string",
- "state": "string",
- "static_ips": "string",
- "time_limits": {
- "create_app_inst_timeout": "string",
- "create_cluster_inst_timeout": "string",
- "delete_app_inst_timeout": "string",
- "delete_cluster_inst_timeout": "string",
- "update_app_inst_timeout": "string",
- "update_cluster_inst_timeout": "string"
}, - "trust_policy": "string",
- "trust_policy_state": "string",
- "updated_at": "string",
- "vm_image_version": "string",
- "vm_pool": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Discover if flavor produces a matching platform flavor
object (EdgeprotoFlavorMatch) | |
| Region | string Region name |
{- "FlavorMatch": {
- "availability_zone": "string",
- "flavor_name": "string",
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
}, - "Region": "string"
}{- "availability_zone": "string",
- "flavor_name": "string",
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
}Generate new crm access key
object (EdgeprotoCloudletKey) | |
| Region | string Region name |
{- "CloudletKey": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Get Cloudlet Specific GPU Driver License Config. Returns the license config associated with the cloudlet
object (EdgeprotoCloudletKey) | |
| Region | string Region name |
{- "CloudletKey": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Get Cloudlet Manifest. Shows deployment manifest required to setup cloudlet
object (EdgeprotoCloudletKey) | |
| Region | string Region name |
{- "CloudletKey": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "Region": "string"
}{- "manifest": "string"
}Get Cloudlet Properties. Shows all the infra properties used to setup cloudlet
object (EdgeprotoCloudletProps) | |
| Region | string Region name |
{- "CloudletProps": {
- "organization": "string",
- "platform_type": "string",
- "properties": {
- "property1": {
- "description": "string",
- "internal": true,
- "mandatory": true,
- "name": "string",
- "secret": true,
- "value": "string"
}, - "property2": {
- "description": "string",
- "internal": true,
- "mandatory": true,
- "name": "string",
- "secret": true,
- "value": "string"
}
}
}, - "Region": "string"
}{- "organization": "string",
- "platform_type": "string",
- "properties": {
- "property1": {
- "description": "string",
- "internal": true,
- "mandatory": true,
- "name": "string",
- "secret": true,
- "value": "string"
}, - "property2": {
- "description": "string",
- "internal": true,
- "mandatory": true,
- "name": "string",
- "secret": true,
- "value": "string"
}
}
}Get Cloudlet Resource Quota Properties. Shows all the resource quota properties of the cloudlet
object (EdgeprotoCloudletResourceQuotaProps) | |
| Region | string Region name |
{- "CloudletResourceQuotaProps": {
- "organization": "string",
- "platform_type": "string",
- "properties": [
- {
- "alert_threshold": 0,
- "description": "string",
- "infra_max_value": 0,
- "name": "string",
- "quota_max_value": 0,
- "units": "string",
- "value": 0
}
]
}, - "Region": "string"
}{- "organization": "string",
- "platform_type": "string",
- "properties": [
- {
- "alert_threshold": 0,
- "description": "string",
- "infra_max_value": 0,
- "name": "string",
- "quota_max_value": 0,
- "units": "string",
- "value": 0
}
]
}Get Cloudlet resource information. Shows cloudlet resources used and their limits
object (EdgeprotoCloudletResourceUsage) | |
| Region | string Region name |
{- "CloudletResourceUsage": {
- "info": [
- {
- "alert_threshold": 0,
- "description": "string",
- "infra_max_value": 0,
- "name": "string",
- "quota_max_value": 0,
- "units": "string",
- "value": 0
}
], - "infra_usage": true,
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
}, - "Region": "string"
}{- "info": [
- {
- "alert_threshold": 0,
- "description": "string",
- "infra_max_value": 0,
- "name": "string",
- "quota_max_value": 0,
- "units": "string",
- "value": 0
}
], - "infra_usage": true,
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
}Get organizations of ClusterInsts and AppInsts on cloudlet
object (EdgeprotoCloudletKey) | |
| Region | string Region name |
{- "CloudletKey": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "Region": "string"
}{- "name": "string"
}Remove alliance organization from the cloudlet
object (EdgeprotoCloudletAllianceOrg) | |
| Region | string Region name |
{- "CloudletAllianceOrg": {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "organization": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Remove Optional Resource tag table
object (EdgeprotoCloudletResMap) | |
| Region | string Region name |
{- "CloudletResMap": {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "mapping": {
- "property1": "string",
- "property2": "string"
}
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Revoke crm access key
object (EdgeprotoCloudletKey) | |
| Region | string Region name |
{- "CloudletKey": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Cloudlets. Lists all the cloudlets managed from Edge Controller.
object (EdgeprotoCloudlet) | |
| Region | string Region name |
{- "Cloudlet": {
- "HostController": "string",
- "access_vars": {
- "property1": "string",
- "property2": "string"
}, - "alliance_orgs": [
- "string"
], - "chef_client_key": {
- "property1": "string",
- "property2": "string"
}, - "config": {
- "access_api_addr": "string",
- "app_dns_root": "string",
- "cache_dir": "string",
- "chef_client_interval": "string",
- "chef_server_path": "string",
- "cleanup_mode": true,
- "cloudlet_vm_image_path": "string",
- "commercial_certs": true,
- "container_registry_path": "string",
- "crm_access_private_key": "string",
- "deployment_tag": "string",
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "notify_ctrl_addrs": "string",
- "platform_tag": "string",
- "region": "string",
- "secondary_crm_access_private_key": "string",
- "span": "string",
- "test_mode": true,
- "thanos_recv_addr": "string",
- "tls_ca_file": "string",
- "tls_cert_file": "string",
- "tls_key_file": "string",
- "use_vault_pki": true
}, - "container_version": "string",
- "created_at": "string",
- "crm_access_key_upgrade_required": true,
- "crm_access_public_key": "string",
- "crm_override": "string",
- "default_resource_alert_threshold": 0,
- "delete_prepare": true,
- "deployment": "string",
- "deployment_local": true,
- "dns_label": "string",
- "enable_default_serverless_cluster": true,
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "errors": [
- "string"
], - "federation_config": {
- "federation_context_id": "string",
- "federation_db_id": 0,
- "federation_name": "string",
- "partner_federation_addr": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "gpu_config": {
- "driver": {
- "name": "string",
- "organization": "string"
}, - "license_config": "string",
- "license_config_md5sum": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "infra_api_access": "string",
- "infra_config": {
- "external_network_name": "string",
- "flavor_name": "string"
}, - "infra_flavors": [
- {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}
], - "ip_support": "string",
- "kafka_cluster": "string",
- "kafka_password": "string",
- "kafka_user": "string",
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "license_config_storage_path": "string",
- "location": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "maintenance_state": 0,
- "notify_srv_addr": "string",
- "num_dynamic_ips": 0,
- "override_policy_container_version": true,
- "physical_name": "string",
- "platform_high_availability": true,
- "platform_type": "string",
- "res_tag_map": {
- "property1": {
- "name": "string",
- "organization": "string"
}, - "property2": {
- "name": "string",
- "organization": "string"
}
}, - "resource_quotas": [
- {
- "alert_threshold": 0,
- "name": "string",
- "value": 0
}
], - "root_lb_fqdn": "string",
- "secondary_crm_access_key_upgrade_required": true,
- "secondary_crm_access_public_key": "string",
- "secondary_notify_srv_addr": "string",
- "single_kubernetes_cluster_owner": "string",
- "state": "string",
- "static_ips": "string",
- "time_limits": {
- "create_app_inst_timeout": "string",
- "create_cluster_inst_timeout": "string",
- "delete_app_inst_timeout": "string",
- "delete_cluster_inst_timeout": "string",
- "update_app_inst_timeout": "string",
- "update_cluster_inst_timeout": "string"
}, - "trust_policy": "string",
- "trust_policy_state": "string",
- "updated_at": "string",
- "vm_image_version": "string",
- "vm_pool": "string"
}, - "Region": "string"
}{- "HostController": "string",
- "access_vars": {
- "property1": "string",
- "property2": "string"
}, - "alliance_orgs": [
- "string"
], - "chef_client_key": {
- "property1": "string",
- "property2": "string"
}, - "config": {
- "access_api_addr": "string",
- "app_dns_root": "string",
- "cache_dir": "string",
- "chef_client_interval": "string",
- "chef_server_path": "string",
- "cleanup_mode": true,
- "cloudlet_vm_image_path": "string",
- "commercial_certs": true,
- "container_registry_path": "string",
- "crm_access_private_key": "string",
- "deployment_tag": "string",
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "notify_ctrl_addrs": "string",
- "platform_tag": "string",
- "region": "string",
- "secondary_crm_access_private_key": "string",
- "span": "string",
- "test_mode": true,
- "thanos_recv_addr": "string",
- "tls_ca_file": "string",
- "tls_cert_file": "string",
- "tls_key_file": "string",
- "use_vault_pki": true
}, - "container_version": "string",
- "created_at": "string",
- "crm_access_key_upgrade_required": true,
- "crm_access_public_key": "string",
- "crm_override": "string",
- "default_resource_alert_threshold": 0,
- "delete_prepare": true,
- "deployment": "string",
- "deployment_local": true,
- "dns_label": "string",
- "enable_default_serverless_cluster": true,
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "errors": [
- "string"
], - "federation_config": {
- "federation_context_id": "string",
- "federation_db_id": 0,
- "federation_name": "string",
- "partner_federation_addr": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "gpu_config": {
- "driver": {
- "name": "string",
- "organization": "string"
}, - "license_config": "string",
- "license_config_md5sum": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "infra_api_access": "string",
- "infra_config": {
- "external_network_name": "string",
- "flavor_name": "string"
}, - "infra_flavors": [
- {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}
], - "ip_support": "string",
- "kafka_cluster": "string",
- "kafka_password": "string",
- "kafka_user": "string",
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "license_config_storage_path": "string",
- "location": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "maintenance_state": 0,
- "notify_srv_addr": "string",
- "num_dynamic_ips": 0,
- "override_policy_container_version": true,
- "physical_name": "string",
- "platform_high_availability": true,
- "platform_type": "string",
- "res_tag_map": {
- "property1": {
- "name": "string",
- "organization": "string"
}, - "property2": {
- "name": "string",
- "organization": "string"
}
}, - "resource_quotas": [
- {
- "alert_threshold": 0,
- "name": "string",
- "value": 0
}
], - "root_lb_fqdn": "string",
- "secondary_crm_access_key_upgrade_required": true,
- "secondary_crm_access_public_key": "string",
- "secondary_notify_srv_addr": "string",
- "single_kubernetes_cluster_owner": "string",
- "state": "string",
- "static_ips": "string",
- "time_limits": {
- "create_app_inst_timeout": "string",
- "create_cluster_inst_timeout": "string",
- "delete_app_inst_timeout": "string",
- "delete_cluster_inst_timeout": "string",
- "update_app_inst_timeout": "string",
- "update_cluster_inst_timeout": "string"
}, - "trust_policy": "string",
- "trust_policy_state": "string",
- "updated_at": "string",
- "vm_image_version": "string",
- "vm_pool": "string"
}Show Cloudlet Platform Features. Shows platform specific features
object (EdgeprotoPlatformFeatures) | |
| Region | string Region name |
{- "PlatformFeatures": {
- "cloudlet_services_local": true,
- "ip_allocated_per_service": true,
- "is_fake": true,
- "is_prebuilt_kubernetes_cluster": true,
- "is_single_kubernetes_cluster": true,
- "is_vm_pool": true,
- "kubernetes_requires_worker_nodes": true,
- "no_kubernetes_cluster_auto_scale": true,
- "platform_type": "string",
- "supports_additional_networks": true,
- "supports_app_inst_dedicated_ip": true,
- "supports_image_type_ova": true,
- "supports_image_type_ovf": true,
- "supports_kubernetes_only": true,
- "supports_multi_tenant_cluster": true,
- "supports_platform_high_availability_on_docker": true,
- "supports_platform_high_availability_on_k8s": true,
- "supports_shared_volume": true,
- "supports_trust_policy": true
}, - "Region": "string"
}{- "cloudlet_services_local": true,
- "ip_allocated_per_service": true,
- "is_fake": true,
- "is_prebuilt_kubernetes_cluster": true,
- "is_single_kubernetes_cluster": true,
- "is_vm_pool": true,
- "kubernetes_requires_worker_nodes": true,
- "no_kubernetes_cluster_auto_scale": true,
- "platform_type": "string",
- "supports_additional_networks": true,
- "supports_app_inst_dedicated_ip": true,
- "supports_image_type_ova": true,
- "supports_image_type_ovf": true,
- "supports_kubernetes_only": true,
- "supports_multi_tenant_cluster": true,
- "supports_platform_high_availability_on_docker": true,
- "supports_platform_high_availability_on_k8s": true,
- "supports_shared_volume": true,
- "supports_trust_policy": true
}Find all meta flavors viable on cloudlet
object (EdgeprotoCloudletKey) | |
| Region | string Region name |
{- "CloudletKey": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "Region": "string"
}{- "name": "string"
}Update Cloudlet. Updates the Cloudlet configuration and manages the upgrade of Cloudlet services.
object (EdgeprotoCloudlet) | |
| Region | string Region name |
{- "Cloudlet": {
- "HostController": "string",
- "access_vars": {
- "property1": "string",
- "property2": "string"
}, - "alliance_orgs": [
- "string"
], - "chef_client_key": {
- "property1": "string",
- "property2": "string"
}, - "config": {
- "access_api_addr": "string",
- "app_dns_root": "string",
- "cache_dir": "string",
- "chef_client_interval": "string",
- "chef_server_path": "string",
- "cleanup_mode": true,
- "cloudlet_vm_image_path": "string",
- "commercial_certs": true,
- "container_registry_path": "string",
- "crm_access_private_key": "string",
- "deployment_tag": "string",
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "notify_ctrl_addrs": "string",
- "platform_tag": "string",
- "region": "string",
- "secondary_crm_access_private_key": "string",
- "span": "string",
- "test_mode": true,
- "thanos_recv_addr": "string",
- "tls_ca_file": "string",
- "tls_cert_file": "string",
- "tls_key_file": "string",
- "use_vault_pki": true
}, - "container_version": "string",
- "created_at": "string",
- "crm_access_key_upgrade_required": true,
- "crm_access_public_key": "string",
- "crm_override": "string",
- "default_resource_alert_threshold": 0,
- "delete_prepare": true,
- "deployment": "string",
- "deployment_local": true,
- "dns_label": "string",
- "enable_default_serverless_cluster": true,
- "env_var": {
- "property1": "string",
- "property2": "string"
}, - "errors": [
- "string"
], - "federation_config": {
- "federation_context_id": "string",
- "federation_db_id": 0,
- "federation_name": "string",
- "partner_federation_addr": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "gpu_config": {
- "driver": {
- "name": "string",
- "organization": "string"
}, - "license_config": "string",
- "license_config_md5sum": "string",
- "properties": {
- "property1": "string",
- "property2": "string"
}
}, - "infra_api_access": "string",
- "infra_config": {
- "external_network_name": "string",
- "flavor_name": "string"
}, - "infra_flavors": [
- {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}
], - "ip_support": "string",
- "kafka_cluster": "string",
- "kafka_password": "string",
- "kafka_user": "string",
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "license_config_storage_path": "string",
- "location": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "maintenance_state": 0,
- "notify_srv_addr": "string",
- "num_dynamic_ips": 0,
- "override_policy_container_version": true,
- "physical_name": "string",
- "platform_high_availability": true,
- "platform_type": "string",
- "res_tag_map": {
- "property1": {
- "name": "string",
- "organization": "string"
}, - "property2": {
- "name": "string",
- "organization": "string"
}
}, - "resource_quotas": [
- {
- "alert_threshold": 0,
- "name": "string",
- "value": 0
}
], - "root_lb_fqdn": "string",
- "secondary_crm_access_key_upgrade_required": true,
- "secondary_crm_access_public_key": "string",
- "secondary_notify_srv_addr": "string",
- "single_kubernetes_cluster_owner": "string",
- "state": "string",
- "static_ips": "string",
- "time_limits": {
- "create_app_inst_timeout": "string",
- "create_cluster_inst_timeout": "string",
- "delete_app_inst_timeout": "string",
- "delete_cluster_inst_timeout": "string",
- "update_app_inst_timeout": "string",
- "update_cluster_inst_timeout": "string"
}, - "trust_policy": "string",
- "trust_policy_state": "string",
- "updated_at": "string",
- "vm_image_version": "string",
- "vm_pool": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Create Operator Code. Create a code for an Operator.
object (EdgeprotoOperatorCode) | |
| Region | string Region name |
{- "OperatorCode": {
- "code": "string",
- "organization": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete Operator Code. Delete a code for an Operator.
object (EdgeprotoOperatorCode) | |
| Region | string Region name |
{- "OperatorCode": {
- "code": "string",
- "organization": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Operator Code. Show Codes for an Operator.
object (EdgeprotoOperatorCode) | |
| Region | string Region name |
{- "OperatorCode": {
- "code": "string",
- "organization": "string"
}, - "Region": "string"
}{- "code": "string",
- "organization": "string"
}Flavors define the compute, memory and storage capacity of computing instances. To put it simply, a flavor is an available hardware configuration for a server. It defines the size of a virtual server that can be launched.
Add Optional Resource
object (EdgeprotoFlavor) | |
| Region | string Region name |
{- "Flavor": {
- "delete_prepare": true,
- "disk": 0,
- "key": {
- "name": "string"
}, - "opt_res_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Create a Flavor
object (EdgeprotoFlavor) | |
| Region | string Region name |
{- "Flavor": {
- "delete_prepare": true,
- "disk": 0,
- "key": {
- "name": "string"
}, - "opt_res_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete a Flavor
object (EdgeprotoFlavor) | |
| Region | string Region name |
{- "Flavor": {
- "delete_prepare": true,
- "disk": 0,
- "key": {
- "name": "string"
}, - "opt_res_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Remove Optional Resource
object (EdgeprotoFlavor) | |
| Region | string Region name |
{- "Flavor": {
- "delete_prepare": true,
- "disk": 0,
- "key": {
- "name": "string"
}, - "opt_res_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Flavors
object (EdgeprotoFlavor) | |
| Region | string Region name |
{- "Flavor": {
- "delete_prepare": true,
- "disk": 0,
- "key": {
- "name": "string"
}, - "opt_res_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "Region": "string"
}{- "delete_prepare": true,
- "disk": 0,
- "key": {
- "name": "string"
}, - "opt_res_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}Update a Flavor
object (EdgeprotoFlavor) | |
| Region | string Region name |
{- "Flavor": {
- "delete_prepare": true,
- "disk": 0,
- "key": {
- "name": "string"
}, - "opt_res_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Add a Cloudlet to a CloudletPool
object (EdgeprotoCloudletPoolMember) | |
| Region | string Region name |
{- "CloudletPoolMember": {
- "cloudlet": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "key": {
- "name": "string",
- "organization": "string"
}
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Create a CloudletPool
object (EdgeprotoCloudletPool) | |
| Region | string Region name |
{- "CloudletPool": {
- "cloudlets": [
- {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
], - "created_at": "string",
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "updated_at": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete a CloudletPool
object (EdgeprotoCloudletPool) | |
| Region | string Region name |
{- "CloudletPool": {
- "cloudlets": [
- {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
], - "created_at": "string",
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "updated_at": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Remove a Cloudlet from a CloudletPool
object (EdgeprotoCloudletPoolMember) | |
| Region | string Region name |
{- "CloudletPoolMember": {
- "cloudlet": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "key": {
- "name": "string",
- "organization": "string"
}
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show CloudletPools
object (EdgeprotoCloudletPool) | |
| Region | string Region name |
{- "CloudletPool": {
- "cloudlets": [
- {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
], - "created_at": "string",
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "updated_at": "string"
}, - "Region": "string"
}{- "cloudlets": [
- {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
], - "created_at": "string",
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "updated_at": "string"
}Update a CloudletPool
object (EdgeprotoCloudletPool) | |
| Region | string Region name |
{- "CloudletPool": {
- "cloudlets": [
- {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}
], - "created_at": "string",
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "updated_at": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Add VMPoolMember. Adds a VM to existing VM Pool.
| Region | string Region name |
object (EdgeprotoVMPoolMember) |
{- "Region": "string",
- "VMPoolMember": {
- "crm_override": "string",
- "key": {
- "name": "string",
- "organization": "string"
}, - "vm": {
- "flavor": {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "group_name": "string",
- "internal_name": "string",
- "name": "string",
- "net_info": {
- "external_ip": "string",
- "internal_ip": "string"
}, - "state": "string",
- "updated_at": {
- "nanos": 0,
- "seconds": 0
}
}
}
}{- "code": 0,
- "message": "string"
}Create VMPool. Creates VM pool which will have VMs defined.
| Region | string Region name |
object (EdgeprotoVMPool) |
{- "Region": "string",
- "VMPool": {
- "crm_override": "string",
- "delete_prepare": true,
- "errors": [
- "string"
], - "key": {
- "name": "string",
- "organization": "string"
}, - "state": "string",
- "vms": [
- {
- "flavor": {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "group_name": "string",
- "internal_name": "string",
- "name": "string",
- "net_info": {
- "external_ip": "string",
- "internal_ip": "string"
}, - "state": "string",
- "updated_at": {
- "nanos": 0,
- "seconds": 0
}
}
]
}
}{- "code": 0,
- "message": "string"
}Delete VMPool. Deletes VM pool given that none of VMs part of this pool is used.
| Region | string Region name |
object (EdgeprotoVMPool) |
{- "Region": "string",
- "VMPool": {
- "crm_override": "string",
- "delete_prepare": true,
- "errors": [
- "string"
], - "key": {
- "name": "string",
- "organization": "string"
}, - "state": "string",
- "vms": [
- {
- "flavor": {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "group_name": "string",
- "internal_name": "string",
- "name": "string",
- "net_info": {
- "external_ip": "string",
- "internal_ip": "string"
}, - "state": "string",
- "updated_at": {
- "nanos": 0,
- "seconds": 0
}
}
]
}
}{- "code": 0,
- "message": "string"
}Remove VMPoolMember. Removes a VM from existing VM Pool.
| Region | string Region name |
object (EdgeprotoVMPoolMember) |
{- "Region": "string",
- "VMPoolMember": {
- "crm_override": "string",
- "key": {
- "name": "string",
- "organization": "string"
}, - "vm": {
- "flavor": {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "group_name": "string",
- "internal_name": "string",
- "name": "string",
- "net_info": {
- "external_ip": "string",
- "internal_ip": "string"
}, - "state": "string",
- "updated_at": {
- "nanos": 0,
- "seconds": 0
}
}
}
}{- "code": 0,
- "message": "string"
}Show VMPools. Lists all the VMs part of the VM pool.
| Region | string Region name |
object (EdgeprotoVMPool) |
{- "Region": "string",
- "VMPool": {
- "crm_override": "string",
- "delete_prepare": true,
- "errors": [
- "string"
], - "key": {
- "name": "string",
- "organization": "string"
}, - "state": "string",
- "vms": [
- {
- "flavor": {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "group_name": "string",
- "internal_name": "string",
- "name": "string",
- "net_info": {
- "external_ip": "string",
- "internal_ip": "string"
}, - "state": "string",
- "updated_at": {
- "nanos": 0,
- "seconds": 0
}
}
]
}
}{- "crm_override": "string",
- "delete_prepare": true,
- "errors": [
- "string"
], - "key": {
- "name": "string",
- "organization": "string"
}, - "state": "string",
- "vms": [
- {
- "flavor": {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "group_name": "string",
- "internal_name": "string",
- "name": "string",
- "net_info": {
- "external_ip": "string",
- "internal_ip": "string"
}, - "state": "string",
- "updated_at": {
- "nanos": 0,
- "seconds": 0
}
}
]
}Update VMPool. Updates a VM pools VMs.
| Region | string Region name |
object (EdgeprotoVMPool) |
{- "Region": "string",
- "VMPool": {
- "crm_override": "string",
- "delete_prepare": true,
- "errors": [
- "string"
], - "key": {
- "name": "string",
- "organization": "string"
}, - "state": "string",
- "vms": [
- {
- "flavor": {
- "disk": 0,
- "name": "string",
- "prop_map": {
- "property1": "string",
- "property2": "string"
}, - "ram": 0,
- "vcpus": 0
}, - "group_name": "string",
- "internal_name": "string",
- "name": "string",
- "net_info": {
- "external_ip": "string",
- "internal_ip": "string"
}, - "state": "string",
- "updated_at": {
- "nanos": 0,
- "seconds": 0
}
}
]
}
}{- "code": 0,
- "message": "string"
}Find events and audit events, results sorted by relevance
| allowedorgs | Array of strings or null Organizations allowed to access the event |
| endage | string End age relative to now of the time range |
| endtime | string <date-time> End time of the time range |
| from | integer Start offset if paging through results |
| limit | integer Display the last X events |
object (NodeEventMatch) | |
object (NodeEventMatch) | |
| startage | string Start age relative to now of the time range |
| starttime | string <date-time> Start time of the time range |
{- "allowedorgs": [
- "string"
], - "endage": "string",
- "endtime": "2019-08-24T14:15:22Z",
- "from": 0,
- "limit": 0,
- "match": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "notmatch": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "startage": "string",
- "starttime": "2019-08-24T14:15:22Z"
}[- {
- "error": "string",
- "mtags": {
- "property1": "string",
- "property2": "string"
}, - "name": "string",
- "org": [
- "string"
], - "region": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "timestamp": "2019-08-24T14:15:22Z",
- "type": "string"
}
]Show events and audit events
| allowedorgs | Array of strings or null Organizations allowed to access the event |
| endage | string End age relative to now of the time range |
| endtime | string <date-time> End time of the time range |
| from | integer Start offset if paging through results |
| limit | integer Display the last X events |
object (NodeEventMatch) | |
object (NodeEventMatch) | |
| startage | string Start age relative to now of the time range |
| starttime | string <date-time> Start time of the time range |
{- "allowedorgs": [
- "string"
], - "endage": "string",
- "endtime": "2019-08-24T14:15:22Z",
- "from": 0,
- "limit": 0,
- "match": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "notmatch": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "startage": "string",
- "starttime": "2019-08-24T14:15:22Z"
}[- {
- "error": "string",
- "mtags": {
- "property1": "string",
- "property2": "string"
}, - "name": "string",
- "org": [
- "string"
], - "region": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "timestamp": "2019-08-24T14:15:22Z",
- "type": "string"
}
]Show aggregated events terms
| allowedorgs | Array of strings or null Organizations allowed to access the event |
| endage | string End age relative to now of the time range |
| endtime | string <date-time> End time of the time range |
| from | integer Start offset if paging through results |
| limit | integer Display the last X events |
object (NodeEventMatch) | |
object (NodeEventMatch) | |
| startage | string Start age relative to now of the time range |
| starttime | string <date-time> Start time of the time range |
{- "allowedorgs": [
- "string"
], - "endage": "string",
- "endtime": "2019-08-24T14:15:22Z",
- "from": 0,
- "limit": 0,
- "match": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "notmatch": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "startage": "string",
- "starttime": "2019-08-24T14:15:22Z"
}{- "names": [
- {
- "count": 0,
- "key": "string"
}
], - "orgs": [
- {
- "count": 0,
- "key": "string"
}
], - "regions": [
- {
- "count": 0,
- "key": "string"
}
], - "tagkeys": [
- {
- "count": 0,
- "key": "string"
}
], - "types": [
- {
- "count": 0,
- "key": "string"
}
]
}Create an alert receiver
object (EdgeprotoAppInstKey) | |
object (EdgeprotoAppKey) | |
object (EdgeprotoClusterKey) | |
string Custom receiving email | |
| Name | string Receiver Name |
| PagerDutyApiVersion | string PagerDuty API version |
| PagerDutyIntegrationKey | string PagerDuty integration key |
| Region | string Region for the alert receiver |
| Severity | string Alert severity filter |
| SlackChannel | string Custom slack channel |
| SlackWebhook | string Custom slack webhook |
| Type | string Receiver type. Eg. email, slack, pagerduty |
| User | string User that created this receiver |
{- "AppInstKey": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "AppKey": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "ClusterKey": {
- "name": "string",
- "organization": "string"
}, - "Email": "string",
- "Name": "string",
- "PagerDutyApiVersion": "string",
- "PagerDutyIntegrationKey": "string",
- "Region": "string",
- "Severity": "string",
- "SlackChannel": "string",
- "SlackWebhook": "string",
- "Type": "string",
- "User": "string"
}{- "code": 0,
- "message": "string"
}Delete an alert receiver
object (EdgeprotoAppInstKey) | |
object (EdgeprotoAppKey) | |
object (EdgeprotoClusterKey) | |
string Custom receiving email | |
| Name | string Receiver Name |
| PagerDutyApiVersion | string PagerDuty API version |
| PagerDutyIntegrationKey | string PagerDuty integration key |
| Region | string Region for the alert receiver |
| Severity | string Alert severity filter |
| SlackChannel | string Custom slack channel |
| SlackWebhook | string Custom slack webhook |
| Type | string Receiver type. Eg. email, slack, pagerduty |
| User | string User that created this receiver |
{- "AppInstKey": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "AppKey": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "ClusterKey": {
- "name": "string",
- "organization": "string"
}, - "Email": "string",
- "Name": "string",
- "PagerDutyApiVersion": "string",
- "PagerDutyIntegrationKey": "string",
- "Region": "string",
- "Severity": "string",
- "SlackChannel": "string",
- "SlackWebhook": "string",
- "Type": "string",
- "User": "string"
}{- "code": 0,
- "message": "string"
}Show alert receivers
object (EdgeprotoAppInstKey) | |
object (EdgeprotoAppKey) | |
object (EdgeprotoClusterKey) | |
string Custom receiving email | |
| Name | string Receiver Name |
| PagerDutyApiVersion | string PagerDuty API version |
| PagerDutyIntegrationKey | string PagerDuty integration key |
| Region | string Region for the alert receiver |
| Severity | string Alert severity filter |
| SlackChannel | string Custom slack channel |
| SlackWebhook | string Custom slack webhook |
| Type | string Receiver type. Eg. email, slack, pagerduty |
| User | string User that created this receiver |
{- "AppInstKey": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "AppKey": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "ClusterKey": {
- "name": "string",
- "organization": "string"
}, - "Email": "string",
- "Name": "string",
- "PagerDutyApiVersion": "string",
- "PagerDutyIntegrationKey": "string",
- "Region": "string",
- "Severity": "string",
- "SlackChannel": "string",
- "SlackWebhook": "string",
- "Type": "string",
- "User": "string"
}[- {
- "AppInstKey": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "AppKey": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "ClusterKey": {
- "name": "string",
- "organization": "string"
}, - "Email": "string",
- "Name": "string",
- "PagerDutyApiVersion": "string",
- "PagerDutyIntegrationKey": "string",
- "Region": "string",
- "Severity": "string",
- "SlackChannel": "string",
- "SlackWebhook": "string",
- "Type": "string",
- "User": "string"
}
]Create a Network
object (EdgeprotoNetwork) | |
| Region | string Region name |
{- "Network": {
- "connection_type": "string",
- "delete_prepare": true,
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string"
}, - "routes": [
- {
- "destination_cidr": "string",
- "next_hop_ip": "string"
}
]
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete a Network
object (EdgeprotoNetwork) | |
| Region | string Region name |
{- "Network": {
- "connection_type": "string",
- "delete_prepare": true,
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string"
}, - "routes": [
- {
- "destination_cidr": "string",
- "next_hop_ip": "string"
}
]
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Networks. Any fields specified will be used to filter results.
object (EdgeprotoNetwork) | |
| Region | string Region name |
{- "Network": {
- "connection_type": "string",
- "delete_prepare": true,
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string"
}, - "routes": [
- {
- "destination_cidr": "string",
- "next_hop_ip": "string"
}
]
}, - "Region": "string"
}{- "connection_type": "string",
- "delete_prepare": true,
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string"
}, - "routes": [
- {
- "destination_cidr": "string",
- "next_hop_ip": "string"
}
]
}Update a Network
object (EdgeprotoNetwork) | |
| Region | string Region name |
{- "Network": {
- "connection_type": "string",
- "delete_prepare": true,
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string"
}, - "routes": [
- {
- "destination_cidr": "string",
- "next_hop_ip": "string"
}
]
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Manage Federation Consumer. Federation Consumer is where this platform consumes resources on another Federation partner.
Create Federation Guest
| AutoRegisterRegion | string Region used for automatically registered zones |
| AutoRegisterZones | boolean Automatically register any zone shared with me |
| FederationContextId | string Federation context id returned by partner |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this Federation Guest, will be used as an operator org for host's zones |
| NotifyClientId | string Auth ClientId for notify callbacks to this Guest OP |
| OperatorId | string Operator Organization that establishes the federation with a Host OP |
| PartnerAddr | string Partner Address |
object (OrmapiFederator) | |
| PartnerTokenUrl | string Partner token URL |
| ProviderClientId | string Auth ClientId for connecting to the Host OP |
| ProviderClientKey | string Auth ClientKey for connection to the Host OP (stored in secret storage) |
| Public | boolean Public means any developer will be able to use the cloudlets, otherwise (TODO) allowed developers will need to be added explicitly |
{- "AutoRegisterRegion": "string",
- "AutoRegisterZones": true,
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "NotifyClientId": "string",
- "OperatorId": "string",
- "PartnerAddr": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerTokenUrl": "string",
- "ProviderClientId": "string",
- "ProviderClientKey": "string",
- "Public": true
}{- "code": 0,
- "message": "string"
}Delete Federation Guest
| AutoRegisterRegion | string Region used for automatically registered zones |
| AutoRegisterZones | boolean Automatically register any zone shared with me |
| FederationContextId | string Federation context id returned by partner |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this Federation Guest, will be used as an operator org for host's zones |
| NotifyClientId | string Auth ClientId for notify callbacks to this Guest OP |
| OperatorId | string Operator Organization that establishes the federation with a Host OP |
| PartnerAddr | string Partner Address |
object (OrmapiFederator) | |
| PartnerTokenUrl | string Partner token URL |
| ProviderClientId | string Auth ClientId for connecting to the Host OP |
| ProviderClientKey | string Auth ClientKey for connection to the Host OP (stored in secret storage) |
| Public | boolean Public means any developer will be able to use the cloudlets, otherwise (TODO) allowed developers will need to be added explicitly |
{- "AutoRegisterRegion": "string",
- "AutoRegisterZones": true,
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "NotifyClientId": "string",
- "OperatorId": "string",
- "PartnerAddr": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerTokenUrl": "string",
- "ProviderClientId": "string",
- "ProviderClientKey": "string",
- "Public": true
}{- "code": 0,
- "message": "string"
}Set Partner Federation API Key
| AutoRegisterRegion | string Region used for automatically registered zones |
| AutoRegisterZones | boolean Automatically register any zone shared with me |
| FederationContextId | string Federation context id returned by partner |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this Federation Guest, will be used as an operator org for host's zones |
| NotifyClientId | string Auth ClientId for notify callbacks to this Guest OP |
| OperatorId | string Operator Organization that establishes the federation with a Host OP |
| PartnerAddr | string Partner Address |
object (OrmapiFederator) | |
| PartnerTokenUrl | string Partner token URL |
| ProviderClientId | string Auth ClientId for connecting to the Host OP |
| ProviderClientKey | string Auth ClientKey for connection to the Host OP (stored in secret storage) |
| Public | boolean Public means any developer will be able to use the cloudlets, otherwise (TODO) allowed developers will need to be added explicitly |
{- "AutoRegisterRegion": "string",
- "AutoRegisterZones": true,
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "NotifyClientId": "string",
- "OperatorId": "string",
- "PartnerAddr": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerTokenUrl": "string",
- "ProviderClientId": "string",
- "ProviderClientKey": "string",
- "Public": true
}{- "code": 0,
- "message": "string"
}Set Partner Federation API Key
| AutoRegisterRegion | string Region used for automatically registered zones |
| AutoRegisterZones | boolean Automatically register any zone shared with me |
| FederationContextId | string Federation context id returned by partner |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this Federation Guest, will be used as an operator org for host's zones |
| NotifyClientId | string Auth ClientId for notify callbacks to this Guest OP |
| OperatorId | string Operator Organization that establishes the federation with a Host OP |
| PartnerAddr | string Partner Address |
object (OrmapiFederator) | |
| PartnerTokenUrl | string Partner token URL |
| ProviderClientId | string Auth ClientId for connecting to the Host OP |
| ProviderClientKey | string Auth ClientKey for connection to the Host OP (stored in secret storage) |
| Public | boolean Public means any developer will be able to use the cloudlets, otherwise (TODO) allowed developers will need to be added explicitly |
{- "AutoRegisterRegion": "string",
- "AutoRegisterZones": true,
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "NotifyClientId": "string",
- "OperatorId": "string",
- "PartnerAddr": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerTokenUrl": "string",
- "ProviderClientId": "string",
- "ProviderClientKey": "string",
- "Public": true
}{- "code": 0,
- "message": "string"
}Update Federation Guest
| AutoRegisterRegion | string Region used for automatically registered zones |
| AutoRegisterZones | boolean Automatically register any zone shared with me |
| FederationContextId | string Federation context id returned by partner |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this Federation Guest, will be used as an operator org for host's zones |
| NotifyClientId | string Auth ClientId for notify callbacks to this Guest OP |
| OperatorId | string Operator Organization that establishes the federation with a Host OP |
| PartnerAddr | string Partner Address |
object (OrmapiFederator) | |
| PartnerTokenUrl | string Partner token URL |
| ProviderClientId | string Auth ClientId for connecting to the Host OP |
| ProviderClientKey | string Auth ClientKey for connection to the Host OP (stored in secret storage) |
| Public | boolean Public means any developer will be able to use the cloudlets, otherwise (TODO) allowed developers will need to be added explicitly |
{- "AutoRegisterRegion": "string",
- "AutoRegisterZones": true,
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "NotifyClientId": "string",
- "OperatorId": "string",
- "PartnerAddr": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerTokenUrl": "string",
- "ProviderClientId": "string",
- "ProviderClientKey": "string",
- "Public": true
}{- "code": 0,
- "message": "string"
}DeRegister Partner Federator Zone
| FedGuest | string Federation Guest name |
| Region | string Region to create local cloudlet versions of Host zones |
| Zones | Array of strings or null Partner federator zones to be registered/deregistered |
{- "FedGuest": "string",
- "Region": "string",
- "Zones": [
- "string"
]
}{- "code": 0,
- "message": "string"
}Register Partner Federator Zone
| FedGuest | string Federation Guest name |
| Region | string Region to create local cloudlet versions of Host zones |
| Zones | Array of strings or null Partner federator zones to be registered/deregistered |
{- "FedGuest": "string",
- "Region": "string",
- "Zones": [
- "string"
]
}{- "code": 0,
- "message": "string"
}Show Federated Partner Zones
| ConsumerName | string Name of the Federation Guest |
| GeoLocation | string GPS co-ordinates associated with the zone (in decimal format) |
| GeographyDetails | string Geography details |
| OperatorId | string Guest operator organization |
| Region | string Region in which zone is instantiated |
| ZoneId | string Zone unique name |
{- "ConsumerName": "string",
- "GeoLocation": "string",
- "GeographyDetails": "string",
- "OperatorId": "string",
- "Region": "string",
- "ZoneId": "string"
}[- {
- "ConsumerName": "string",
- "GeoLocation": "string",
- "GeographyDetails": "string",
- "OperatorId": "string",
- "Region": "string",
- "Status": "string",
- "ZoneId": "string"
}
]Manage Federation Provider. Federation Provider is where this platform hosts the applications being onboarded by another federation partner.
Show Apps onboarded by partner
| AppID | string App ID send by partner |
| AppName | string App name of federation app (not region app) |
| AppProviderId | string App provider ID |
| AppStatusCallbackLink | string App status callback link |
| AppVers | string App version of federation app (not region app) |
| ArtefactIds | Array of strings or null (PqStringArray) |
| DeploymentZones | Array of strings or null (PqStringArray) |
| FederationName | string Host Federation name |
{- "AppID": "string",
- "AppName": "string",
- "AppProviderId": "string",
- "AppStatusCallbackLink": "string",
- "AppVers": "string",
- "ArtefactIds": [
- "string"
], - "DeploymentZones": [
- "string"
], - "FederationName": "string"
}[- {
- "AppID": "string",
- "AppName": "string",
- "AppProviderId": "string",
- "AppStatusCallbackLink": "string",
- "AppVers": "string",
- "ArtefactIds": [
- "string"
], - "DeploymentZones": [
- "string"
], - "FederationName": "string"
}
]Delete App onboarded by partner, use only if partner cannot trigger delete themselves
| AppID | string App ID send by partner |
| AppName | string App name of federation app (not region app) |
| AppProviderId | string App provider ID |
| AppStatusCallbackLink | string App status callback link |
| AppVers | string App version of federation app (not region app) |
| ArtefactIds | Array of strings or null (PqStringArray) |
| DeploymentZones | Array of strings or null (PqStringArray) |
| FederationName | string Host Federation name |
{- "AppID": "string",
- "AppName": "string",
- "AppProviderId": "string",
- "AppStatusCallbackLink": "string",
- "AppVers": "string",
- "ArtefactIds": [
- "string"
], - "DeploymentZones": [
- "string"
], - "FederationName": "string"
}{- "code": 0,
- "message": "string"
}Show AppInsts onboarded by partner
| AppID | string AppID for ProviderApp |
| AppInstCallbackLink | string AppInst callback link |
| AppInstID | string AppInst unique ID |
| AppName | string App name for AppInstKey |
| AppVers | string App version for AppInstKey |
| Cloudlet | string Cloudlet name for AppInstKey |
| CloudletFedOrg | string Cloudlet federation org for AppInstKey (this should always be blank) |
| CloudletOrg | string Cloudlet org for AppInstKey |
| Error | string Error message if create failed |
| FederationName | string Host Federation name |
| Region | string Region for AppInst |
{- "AppID": "string",
- "AppInstCallbackLink": "string",
- "AppInstID": "string",
- "AppName": "string",
- "AppVers": "string",
- "Cloudlet": "string",
- "CloudletFedOrg": "string",
- "CloudletOrg": "string",
- "Error": "string",
- "FederationName": "string",
- "Region": "string"
}[- {
- "AppID": "string",
- "AppInstCallbackLink": "string",
- "AppInstID": "string",
- "AppName": "string",
- "AppVers": "string",
- "Cloudlet": "string",
- "CloudletFedOrg": "string",
- "CloudletOrg": "string",
- "Error": "string",
- "FederationName": "string",
- "Region": "string"
}
]Delete AppInst created by partner, use only if partner cannot trigger delete themselves
| AppID | string AppID for ProviderApp |
| AppInstCallbackLink | string AppInst callback link |
| AppInstID | string AppInst unique ID |
| AppName | string App name for AppInstKey |
| AppVers | string App version for AppInstKey |
| Cloudlet | string Cloudlet name for AppInstKey |
| CloudletFedOrg | string Cloudlet federation org for AppInstKey (this should always be blank) |
| CloudletOrg | string Cloudlet org for AppInstKey |
| Error | string Error message if create failed |
| FederationName | string Host Federation name |
| Region | string Region for AppInst |
{- "AppID": "string",
- "AppInstCallbackLink": "string",
- "AppInstID": "string",
- "AppName": "string",
- "AppVers": "string",
- "Cloudlet": "string",
- "CloudletFedOrg": "string",
- "CloudletOrg": "string",
- "Error": "string",
- "FederationName": "string",
- "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Artefacts created by partner
| AppName | string App name in region |
| AppProviderId | string App provider ID |
| AppVers | string App version in region |
| ArtefactID | string Artefact ID send by partner |
| ArtefactName | string Artefact name |
| ArtefactVersion | string Artefact version |
| DescType | string Descriptor Type |
| FederationName | string Host Federation name |
| FileIds | Array of strings or null (PqStringArray) |
| VirtType | string Virtualization Type |
{- "AppName": "string",
- "AppProviderId": "string",
- "AppVers": "string",
- "ArtefactID": "string",
- "ArtefactName": "string",
- "ArtefactVersion": "string",
- "DescType": "string",
- "FederationName": "string",
- "FileIds": [
- "string"
], - "VirtType": "string"
}[- {
- "AppName": "string",
- "AppProviderId": "string",
- "AppVers": "string",
- "ArtefactID": "string",
- "ArtefactName": "string",
- "ArtefactVersion": "string",
- "DescType": "string",
- "FederationName": "string",
- "FileIds": [
- "string"
], - "VirtType": "string"
}
]Delete Artefact onboarded by partner, use only if partner cannot trigger delete themselves
| AppName | string App name in region |
| AppProviderId | string App provider ID |
| AppVers | string App version in region |
| ArtefactID | string Artefact ID send by partner |
| ArtefactName | string Artefact name |
| ArtefactVersion | string Artefact version |
| DescType | string Descriptor Type |
| FederationName | string Host Federation name |
| FileIds | Array of strings or null (PqStringArray) |
| VirtType | string Virtualization Type |
{- "AppName": "string",
- "AppProviderId": "string",
- "AppVers": "string",
- "ArtefactID": "string",
- "ArtefactName": "string",
- "ArtefactVersion": "string",
- "DescType": "string",
- "FederationName": "string",
- "FileIds": [
- "string"
], - "VirtType": "string"
}{- "code": 0,
- "message": "string"
}Create Federation Host
| DefaultContainerDeployment | string Default container deployment type (either docker or kubernetes) |
| FederationContextId | string The federation context id we generated for this federation |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this federation Host, will be used as a developer org name for Guest OP's images and apps |
| OperatorId | string Operator Organization that provides the resources |
object (OrmapiFederator) | |
| PartnerNotifyClientId | string Partner notification client id |
| PartnerNotifyClientKey | string Partner notification client key (saved in secret storage) |
| PartnerNotifyDest | string Partner notification URI |
| PartnerNotifyTokenUrl | string Partner Oauth token URI |
| ProviderClientId | string Host client ID for inbound connections |
| Regions | Array of strings or null (PqStringArray) |
{- "DefaultContainerDeployment": "string",
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "OperatorId": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerNotifyClientId": "string",
- "PartnerNotifyClientKey": "string",
- "PartnerNotifyDest": "string",
- "PartnerNotifyTokenUrl": "string",
- "ProviderClientId": "string",
- "Regions": [
- "string"
]
}{- "ClientId": "string",
- "ClientKey": "string",
- "TargetAddr": "string",
- "TokenUrl": "string"
}Delete Federation Host
| DefaultContainerDeployment | string Default container deployment type (either docker or kubernetes) |
| FederationContextId | string The federation context id we generated for this federation |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this federation Host, will be used as a developer org name for Guest OP's images and apps |
| OperatorId | string Operator Organization that provides the resources |
object (OrmapiFederator) | |
| PartnerNotifyClientId | string Partner notification client id |
| PartnerNotifyClientKey | string Partner notification client key (saved in secret storage) |
| PartnerNotifyDest | string Partner notification URI |
| PartnerNotifyTokenUrl | string Partner Oauth token URI |
| ProviderClientId | string Host client ID for inbound connections |
| Regions | Array of strings or null (PqStringArray) |
{- "DefaultContainerDeployment": "string",
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "OperatorId": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerNotifyClientId": "string",
- "PartnerNotifyClientKey": "string",
- "PartnerNotifyDest": "string",
- "PartnerNotifyTokenUrl": "string",
- "ProviderClientId": "string",
- "Regions": [
- "string"
]
}{- "code": 0,
- "message": "string"
}Generate Federation Host API Key to share with Guest
| DefaultContainerDeployment | string Default container deployment type (either docker or kubernetes) |
| FederationContextId | string The federation context id we generated for this federation |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this federation Host, will be used as a developer org name for Guest OP's images and apps |
| OperatorId | string Operator Organization that provides the resources |
object (OrmapiFederator) | |
| PartnerNotifyClientId | string Partner notification client id |
| PartnerNotifyClientKey | string Partner notification client key (saved in secret storage) |
| PartnerNotifyDest | string Partner notification URI |
| PartnerNotifyTokenUrl | string Partner Oauth token URI |
| ProviderClientId | string Host client ID for inbound connections |
| Regions | Array of strings or null (PqStringArray) |
{- "DefaultContainerDeployment": "string",
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "OperatorId": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerNotifyClientId": "string",
- "PartnerNotifyClientKey": "string",
- "PartnerNotifyDest": "string",
- "PartnerNotifyTokenUrl": "string",
- "ProviderClientId": "string",
- "Regions": [
- "string"
]
}{- "ClientId": "string",
- "ClientKey": "string",
- "TargetAddr": "string",
- "TokenUrl": "string"
}Show Images uploaded by partner
| AppProviderId | string Partner app provider organization |
| Checksum | string MD5 checksum for VM and file-based image types, sha256 digest for containers and Helm charts |
| Description | string Image description |
| FederationName | string Host federation name |
| FileID | string File ID sent by partner |
| Name | string Image name |
| Path | string Image path |
| Status | string Image status |
| Type | string Image type (DOCKER, HELM, QCOW2, or OVA) |
| Version | string Image version |
{- "AppProviderId": "string",
- "Checksum": "string",
- "Description": "string",
- "FederationName": "string",
- "FileID": "string",
- "Name": "string",
- "Path": "string",
- "Status": "string",
- "Type": "string",
- "Version": "string"
}[- {
- "AppProviderId": "string",
- "Checksum": "string",
- "Description": "string",
- "FederationName": "string",
- "FileID": "string",
- "Name": "string",
- "Path": "string",
- "Status": "string",
- "Type": "string",
- "Version": "string"
}
]Delete Image onboarded by partner, use only if partner cannot trigger delete themselves
| AppProviderId | string Partner app provider organization |
| Checksum | string MD5 checksum for VM and file-based image types, sha256 digest for containers and Helm charts |
| Description | string Image description |
| FederationName | string Host federation name |
| FileID | string File ID sent by partner |
| Name | string Image name |
| Path | string Image path |
| Status | string Image status |
| Type | string Image type (DOCKER, HELM, QCOW2, or OVA) |
| Version | string Image version |
{- "AppProviderId": "string",
- "Checksum": "string",
- "Description": "string",
- "FederationName": "string",
- "FileID": "string",
- "Name": "string",
- "Path": "string",
- "Status": "string",
- "Type": "string",
- "Version": "string"
}{- "code": 0,
- "message": "string"
}Set Federation Host notify key for notify connections
| DefaultContainerDeployment | string Default container deployment type (either docker or kubernetes) |
| FederationContextId | string The federation context id we generated for this federation |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this federation Host, will be used as a developer org name for Guest OP's images and apps |
| OperatorId | string Operator Organization that provides the resources |
object (OrmapiFederator) | |
| PartnerNotifyClientId | string Partner notification client id |
| PartnerNotifyClientKey | string Partner notification client key (saved in secret storage) |
| PartnerNotifyDest | string Partner notification URI |
| PartnerNotifyTokenUrl | string Partner Oauth token URI |
| ProviderClientId | string Host client ID for inbound connections |
| Regions | Array of strings or null (PqStringArray) |
{- "DefaultContainerDeployment": "string",
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "OperatorId": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerNotifyClientId": "string",
- "PartnerNotifyClientKey": "string",
- "PartnerNotifyDest": "string",
- "PartnerNotifyTokenUrl": "string",
- "ProviderClientId": "string",
- "Regions": [
- "string"
]
}{- "code": 0,
- "message": "string"
}Show Federation Host
| DefaultContainerDeployment | string Default container deployment type (either docker or kubernetes) |
| FederationContextId | string The federation context id we generated for this federation |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this federation Host, will be used as a developer org name for Guest OP's images and apps |
| OperatorId | string Operator Organization that provides the resources |
object (OrmapiFederator) | |
| PartnerNotifyClientId | string Partner notification client id |
| PartnerNotifyClientKey | string Partner notification client key (saved in secret storage) |
| PartnerNotifyDest | string Partner notification URI |
| PartnerNotifyTokenUrl | string Partner Oauth token URI |
| ProviderClientId | string Host client ID for inbound connections |
| Regions | Array of strings or null (PqStringArray) |
{- "DefaultContainerDeployment": "string",
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "OperatorId": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerNotifyClientId": "string",
- "PartnerNotifyClientKey": "string",
- "PartnerNotifyDest": "string",
- "PartnerNotifyTokenUrl": "string",
- "ProviderClientId": "string",
- "Regions": [
- "string"
]
}[- {
- "CreatedAt": "2019-08-24T14:15:22Z",
- "DefaultContainerDeployment": "string",
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "OperatorId": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerNotifyClientId": "string",
- "PartnerNotifyClientKey": "string",
- "PartnerNotifyDest": "string",
- "PartnerNotifyTokenUrl": "string",
- "ProviderClientId": "string",
- "Regions": [
- "string"
], - "Status": "string",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
]Update Federation Host
| DefaultContainerDeployment | string Default container deployment type (either docker or kubernetes) |
| FederationContextId | string The federation context id we generated for this federation |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this federation Host, will be used as a developer org name for Guest OP's images and apps |
| OperatorId | string Operator Organization that provides the resources |
object (OrmapiFederator) | |
| PartnerNotifyClientId | string Partner notification client id |
| PartnerNotifyClientKey | string Partner notification client key (saved in secret storage) |
| PartnerNotifyDest | string Partner notification URI |
| PartnerNotifyTokenUrl | string Partner Oauth token URI |
| ProviderClientId | string Host client ID for inbound connections |
| Regions | Array of strings or null (PqStringArray) |
{- "DefaultContainerDeployment": "string",
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "OperatorId": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerNotifyClientId": "string",
- "PartnerNotifyClientKey": "string",
- "PartnerNotifyDest": "string",
- "PartnerNotifyTokenUrl": "string",
- "ProviderClientId": "string",
- "Regions": [
- "string"
]
}{- "code": 0,
- "message": "string"
}Show Shared Host Zones
| OperatorId | string Host operator organization |
| PartnerNotifyZoneURI | string Partner notify zone URI |
| ProviderName | string Name of the Federation Host OP |
| ZoneId | string Globally unique identifier of the federator zone |
{- "OperatorId": "string",
- "PartnerNotifyZoneURI": "string",
- "ProviderName": "string",
- "ZoneId": "string"
}[- {
- "OperatorId": "string",
- "PartnerNotifyZoneURI": "string",
- "ProviderName": "string",
- "Status": "string",
- "ZoneId": "string"
}
]Create Host Zone Base to package cloudlets into a zone
| Cloudlets | Array of strings or null (PqStringArray) |
| CountryCode | string ISO 3166-1 Alpha-2 code for the country where operator platform is located |
| GeoLocation | string GPS co-ordinates associated with the zone (in decimal format) |
| GeographyDetails | string Geography details |
| OperatorId | string Operator organization |
| Region | string Region in which cloudlets reside |
| ZoneId | string Unique name for zone |
{- "Cloudlets": [
- "string"
], - "CountryCode": "string",
- "GeoLocation": "string",
- "GeographyDetails": "string",
- "OperatorId": "string",
- "Region": "string",
- "ZoneId": "string"
}{- "code": 0,
- "message": "string"
}Delete Host Zone Base
| Cloudlets | Array of strings or null (PqStringArray) |
| CountryCode | string ISO 3166-1 Alpha-2 code for the country where operator platform is located |
| GeoLocation | string GPS co-ordinates associated with the zone (in decimal format) |
| GeographyDetails | string Geography details |
| OperatorId | string Operator organization |
| Region | string Region in which cloudlets reside |
| ZoneId | string Unique name for zone |
{- "Cloudlets": [
- "string"
], - "CountryCode": "string",
- "GeoLocation": "string",
- "GeographyDetails": "string",
- "OperatorId": "string",
- "Region": "string",
- "ZoneId": "string"
}{- "code": 0,
- "message": "string"
}Show Host Zone Bases
| Cloudlets | Array of strings or null (PqStringArray) |
| CountryCode | string ISO 3166-1 Alpha-2 code for the country where operator platform is located |
| GeoLocation | string GPS co-ordinates associated with the zone (in decimal format) |
| GeographyDetails | string Geography details |
| OperatorId | string Operator organization |
| Region | string Region in which cloudlets reside |
| ZoneId | string Unique name for zone |
{- "Cloudlets": [
- "string"
], - "CountryCode": "string",
- "GeoLocation": "string",
- "GeographyDetails": "string",
- "OperatorId": "string",
- "Region": "string",
- "ZoneId": "string"
}[- {
- "Cloudlets": [
- "string"
], - "CountryCode": "string",
- "GeoLocation": "string",
- "GeographyDetails": "string",
- "OperatorId": "string",
- "Region": "string",
- "ZoneId": "string"
}
]Update Host Zone Base
| Cloudlets | Array of strings or null (PqStringArray) |
| CountryCode | string ISO 3166-1 Alpha-2 code for the country where operator platform is located |
| GeoLocation | string GPS co-ordinates associated with the zone (in decimal format) |
| GeographyDetails | string Geography details |
| OperatorId | string Operator organization |
| Region | string Region in which cloudlets reside |
| ZoneId | string Unique name for zone |
{- "Cloudlets": [
- "string"
], - "CountryCode": "string",
- "GeoLocation": "string",
- "GeographyDetails": "string",
- "OperatorId": "string",
- "Region": "string",
- "ZoneId": "string"
}{- "code": 0,
- "message": "string"
}ClusterInst is an instance of a Cluster on a Cloudlet. It is defined by a Cluster, Cloudlet, and Developer key.
Create Cluster Instance. Creates an instance of a Cluster on a Cloudlet, defined by a Cluster Key and a Cloudlet Key. ClusterInst is a collection of compute resources on a Cloudlet on which AppInsts are deployed.
object (EdgeprotoClusterInst) | |
| Region | string Region name |
{- "ClusterInst": {
- "allocated_ip": "string",
- "auto": true,
- "auto_scale_policy": "string",
- "availability_zone": "string",
- "created_at": "string",
- "crm_override": "string",
- "delete_prepare": true,
- "deployment": "string",
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "flavor": {
- "name": "string"
}, - "fqdn": "string",
- "image_name": "string",
- "ip_access": "string",
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}
}, - "liveness": "string",
- "master_node_flavor": "string",
- "multi_tenant": true,
- "networks": [
- "string"
], - "node_flavor": "string",
- "num_masters": 0,
- "num_nodes": 0,
- "opt_res": "string",
- "reservable": true,
- "reservation_ended_at": "string",
- "reserved_by": "string",
- "resources": {
- "vms": [
- {
- "containers": [
- {
- "clusterip": "string",
- "name": "string",
- "restarts": 0,
- "status": "string",
- "type": "string"
}
], - "infraFlavor": "string",
- "ipaddresses": [
- {
- "externalIp": "string",
- "internalIp": "string"
}
], - "name": "string",
- "status": "string",
- "type": "string"
}
]
}, - "shared_volume_size": 0,
- "skip_crm_cleanup_on_failure": true,
- "state": "string",
- "updated_at": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete Cluster Instance. Deletes an instance of a Cluster deployed on a Cloudlet.
object (EdgeprotoClusterInst) | |
| Region | string Region name |
{- "ClusterInst": {
- "allocated_ip": "string",
- "auto": true,
- "auto_scale_policy": "string",
- "availability_zone": "string",
- "created_at": "string",
- "crm_override": "string",
- "delete_prepare": true,
- "deployment": "string",
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "flavor": {
- "name": "string"
}, - "fqdn": "string",
- "image_name": "string",
- "ip_access": "string",
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}
}, - "liveness": "string",
- "master_node_flavor": "string",
- "multi_tenant": true,
- "networks": [
- "string"
], - "node_flavor": "string",
- "num_masters": 0,
- "num_nodes": 0,
- "opt_res": "string",
- "reservable": true,
- "reservation_ended_at": "string",
- "reserved_by": "string",
- "resources": {
- "vms": [
- {
- "containers": [
- {
- "clusterip": "string",
- "name": "string",
- "restarts": 0,
- "status": "string",
- "type": "string"
}
], - "infraFlavor": "string",
- "ipaddresses": [
- {
- "externalIp": "string",
- "internalIp": "string"
}
], - "name": "string",
- "status": "string",
- "type": "string"
}
]
}, - "shared_volume_size": 0,
- "skip_crm_cleanup_on_failure": true,
- "state": "string",
- "updated_at": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Cleanup Reservable Cluster Instances. Deletes reservable cluster instances that are not in use.
object (EdgeprotoIdleReservableClusterInsts) | |
| Region | string Region name |
{- "IdleReservableClusterInsts": {
- "idle_time": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Cluster Instances. Lists all the cluster instances managed by Edge Controller.
object (EdgeprotoClusterInst) | |
| Region | string Region name |
{- "ClusterInst": {
- "allocated_ip": "string",
- "auto": true,
- "auto_scale_policy": "string",
- "availability_zone": "string",
- "created_at": "string",
- "crm_override": "string",
- "delete_prepare": true,
- "deployment": "string",
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "flavor": {
- "name": "string"
}, - "fqdn": "string",
- "image_name": "string",
- "ip_access": "string",
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}
}, - "liveness": "string",
- "master_node_flavor": "string",
- "multi_tenant": true,
- "networks": [
- "string"
], - "node_flavor": "string",
- "num_masters": 0,
- "num_nodes": 0,
- "opt_res": "string",
- "reservable": true,
- "reservation_ended_at": "string",
- "reserved_by": "string",
- "resources": {
- "vms": [
- {
- "containers": [
- {
- "clusterip": "string",
- "name": "string",
- "restarts": 0,
- "status": "string",
- "type": "string"
}
], - "infraFlavor": "string",
- "ipaddresses": [
- {
- "externalIp": "string",
- "internalIp": "string"
}
], - "name": "string",
- "status": "string",
- "type": "string"
}
]
}, - "shared_volume_size": 0,
- "skip_crm_cleanup_on_failure": true,
- "state": "string",
- "updated_at": "string"
}, - "Region": "string"
}{- "allocated_ip": "string",
- "auto": true,
- "auto_scale_policy": "string",
- "availability_zone": "string",
- "created_at": "string",
- "crm_override": "string",
- "delete_prepare": true,
- "deployment": "string",
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "flavor": {
- "name": "string"
}, - "fqdn": "string",
- "image_name": "string",
- "ip_access": "string",
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}
}, - "liveness": "string",
- "master_node_flavor": "string",
- "multi_tenant": true,
- "networks": [
- "string"
], - "node_flavor": "string",
- "num_masters": 0,
- "num_nodes": 0,
- "opt_res": "string",
- "reservable": true,
- "reservation_ended_at": "string",
- "reserved_by": "string",
- "resources": {
- "vms": [
- {
- "containers": [
- {
- "clusterip": "string",
- "name": "string",
- "restarts": 0,
- "status": "string",
- "type": "string"
}
], - "infraFlavor": "string",
- "ipaddresses": [
- {
- "externalIp": "string",
- "internalIp": "string"
}
], - "name": "string",
- "status": "string",
- "type": "string"
}
]
}, - "shared_volume_size": 0,
- "skip_crm_cleanup_on_failure": true,
- "state": "string",
- "updated_at": "string"
}Update Cluster Instance. Updates an instance of a Cluster deployed on a Cloudlet.
object (EdgeprotoClusterInst) | |
| Region | string Region name |
{- "ClusterInst": {
- "allocated_ip": "string",
- "auto": true,
- "auto_scale_policy": "string",
- "availability_zone": "string",
- "created_at": "string",
- "crm_override": "string",
- "delete_prepare": true,
- "deployment": "string",
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "flavor": {
- "name": "string"
}, - "fqdn": "string",
- "image_name": "string",
- "ip_access": "string",
- "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}
}, - "liveness": "string",
- "master_node_flavor": "string",
- "multi_tenant": true,
- "networks": [
- "string"
], - "node_flavor": "string",
- "num_masters": 0,
- "num_nodes": 0,
- "opt_res": "string",
- "reservable": true,
- "reservation_ended_at": "string",
- "reserved_by": "string",
- "resources": {
- "vms": [
- {
- "containers": [
- {
- "clusterip": "string",
- "name": "string",
- "restarts": 0,
- "status": "string",
- "type": "string"
}
], - "infraFlavor": "string",
- "ipaddresses": [
- {
- "externalIp": "string",
- "internalIp": "string"
}
], - "name": "string",
- "status": "string",
- "type": "string"
}
]
}, - "shared_volume_size": 0,
- "skip_crm_cleanup_on_failure": true,
- "state": "string",
- "updated_at": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Add an AlertPolicy to the application definition
object (EdgeprotoAppAlertPolicy) | |
| Region | string Region name |
{- "AppAlertPolicy": {
- "alert_policy": "string",
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Add an AutoProvPolicy to the application definition
object (EdgeprotoAppAutoProvPolicy) | |
| Region | string Region name |
{- "AppAutoProvPolicy": {
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "auto_prov_policy": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Create Application. Creates a definition for an application for Cloudlet deployment.
object (EdgeprotoApp) | |
| Region | string Region name |
{- "App": {
- "access_ports": "string",
- "access_type": "string",
- "alert_policies": [
- "string"
], - "allow_serverless": true,
- "android_package_name": "string",
- "annotations": "string",
- "auth_public_key": "string",
- "auto_prov_policies": [
- "string"
], - "auto_prov_policy": "string",
- "command": "string",
- "command_args": [
- "string"
], - "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "default_flavor": {
- "name": "string"
}, - "del_opt": "string",
- "delete_prepare": true,
- "deployment": "string",
- "deployment_generator": "string",
- "deployment_manifest": "string",
- "global_id": "string",
- "image_path": "string",
- "image_type": "string",
- "internal_ports": true,
- "key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "md5sum": "string",
- "official_fqdn": "string",
- "qos_session_duration": "string",
- "qos_session_profile": "string",
- "required_outbound_connections": [
- {
- "port_range_max": 0,
- "port_range_min": 0,
- "protocol": "string",
- "remote_cidr": "string"
}
], - "revision": "string",
- "scale_with_cluster": true,
- "serverless_config": {
- "gpu_config": {
- "model": "string",
- "num_gpu": 0,
- "ram": 0,
- "type": "string"
}, - "min_replicas": 0,
- "ram": 0,
- "vcpus": "string"
}, - "skip_hc_ports": "string",
- "template_delimiter": "string",
- "trusted": true,
- "updated_at": "string",
- "vm_app_os_type": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete Application. Deletes a definition of an application. Instances of the application must be deleted first.
object (EdgeprotoApp) | |
| Region | string Region name |
{- "App": {
- "access_ports": "string",
- "access_type": "string",
- "alert_policies": [
- "string"
], - "allow_serverless": true,
- "android_package_name": "string",
- "annotations": "string",
- "auth_public_key": "string",
- "auto_prov_policies": [
- "string"
], - "auto_prov_policy": "string",
- "command": "string",
- "command_args": [
- "string"
], - "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "default_flavor": {
- "name": "string"
}, - "del_opt": "string",
- "delete_prepare": true,
- "deployment": "string",
- "deployment_generator": "string",
- "deployment_manifest": "string",
- "global_id": "string",
- "image_path": "string",
- "image_type": "string",
- "internal_ports": true,
- "key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "md5sum": "string",
- "official_fqdn": "string",
- "qos_session_duration": "string",
- "qos_session_profile": "string",
- "required_outbound_connections": [
- {
- "port_range_max": 0,
- "port_range_min": 0,
- "protocol": "string",
- "remote_cidr": "string"
}
], - "revision": "string",
- "scale_with_cluster": true,
- "serverless_config": {
- "gpu_config": {
- "model": "string",
- "num_gpu": 0,
- "ram": 0,
- "type": "string"
}, - "min_replicas": 0,
- "ram": 0,
- "vcpus": "string"
}, - "skip_hc_ports": "string",
- "template_delimiter": "string",
- "trusted": true,
- "updated_at": "string",
- "vm_app_os_type": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Remove an AlertPolicy from the application definition
object (EdgeprotoAppAlertPolicy) | |
| Region | string Region name |
{- "AppAlertPolicy": {
- "alert_policy": "string",
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Remove an AutoProvPolicy from the application definition
object (EdgeprotoAppAutoProvPolicy) | |
| Region | string Region name |
{- "AppAutoProvPolicy": {
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "auto_prov_policy": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Applications. Lists all application definitions. Any fields specified will be used to filter results.
object (EdgeprotoApp) | |
| Region | string Region name |
{- "App": {
- "access_ports": "string",
- "access_type": "string",
- "alert_policies": [
- "string"
], - "allow_serverless": true,
- "android_package_name": "string",
- "annotations": "string",
- "auth_public_key": "string",
- "auto_prov_policies": [
- "string"
], - "auto_prov_policy": "string",
- "command": "string",
- "command_args": [
- "string"
], - "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "default_flavor": {
- "name": "string"
}, - "del_opt": "string",
- "delete_prepare": true,
- "deployment": "string",
- "deployment_generator": "string",
- "deployment_manifest": "string",
- "global_id": "string",
- "image_path": "string",
- "image_type": "string",
- "internal_ports": true,
- "key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "md5sum": "string",
- "official_fqdn": "string",
- "qos_session_duration": "string",
- "qos_session_profile": "string",
- "required_outbound_connections": [
- {
- "port_range_max": 0,
- "port_range_min": 0,
- "protocol": "string",
- "remote_cidr": "string"
}
], - "revision": "string",
- "scale_with_cluster": true,
- "serverless_config": {
- "gpu_config": {
- "model": "string",
- "num_gpu": 0,
- "ram": 0,
- "type": "string"
}, - "min_replicas": 0,
- "ram": 0,
- "vcpus": "string"
}, - "skip_hc_ports": "string",
- "template_delimiter": "string",
- "trusted": true,
- "updated_at": "string",
- "vm_app_os_type": "string"
}, - "Region": "string"
}{- "access_ports": "string",
- "access_type": "string",
- "alert_policies": [
- "string"
], - "allow_serverless": true,
- "android_package_name": "string",
- "annotations": "string",
- "auth_public_key": "string",
- "auto_prov_policies": [
- "string"
], - "auto_prov_policy": "string",
- "command": "string",
- "command_args": [
- "string"
], - "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "default_flavor": {
- "name": "string"
}, - "del_opt": "string",
- "delete_prepare": true,
- "deployment": "string",
- "deployment_generator": "string",
- "deployment_manifest": "string",
- "global_id": "string",
- "image_path": "string",
- "image_type": "string",
- "internal_ports": true,
- "key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "md5sum": "string",
- "official_fqdn": "string",
- "qos_session_duration": "string",
- "qos_session_profile": "string",
- "required_outbound_connections": [
- {
- "port_range_max": 0,
- "port_range_min": 0,
- "protocol": "string",
- "remote_cidr": "string"
}
], - "revision": "string",
- "scale_with_cluster": true,
- "serverless_config": {
- "gpu_config": {
- "model": "string",
- "num_gpu": 0,
- "ram": 0,
- "type": "string"
}, - "min_replicas": 0,
- "ram": 0,
- "vcpus": "string"
}, - "skip_hc_ports": "string",
- "template_delimiter": "string",
- "trusted": true,
- "updated_at": "string",
- "vm_app_os_type": "string"
}Discover cloudlets supporting deployments of App.DefaultFlavor
object (EdgeprotoDeploymentCloudletRequest) | |
| Region | string Region name |
{- "DeploymentCloudletRequest": {
- "app": {
- "access_ports": "string",
- "access_type": "string",
- "alert_policies": [
- "string"
], - "allow_serverless": true,
- "android_package_name": "string",
- "annotations": "string",
- "auth_public_key": "string",
- "auto_prov_policies": [
- "string"
], - "auto_prov_policy": "string",
- "command": "string",
- "command_args": [
- "string"
], - "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "default_flavor": {
- "name": "string"
}, - "del_opt": "string",
- "delete_prepare": true,
- "deployment": "string",
- "deployment_generator": "string",
- "deployment_manifest": "string",
- "global_id": "string",
- "image_path": "string",
- "image_type": "string",
- "internal_ports": true,
- "key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "md5sum": "string",
- "official_fqdn": "string",
- "qos_session_duration": "string",
- "qos_session_profile": "string",
- "required_outbound_connections": [
- {
- "port_range_max": 0,
- "port_range_min": 0,
- "protocol": "string",
- "remote_cidr": "string"
}
], - "revision": "string",
- "scale_with_cluster": true,
- "serverless_config": {
- "gpu_config": {
- "model": "string",
- "num_gpu": 0,
- "ram": 0,
- "type": "string"
}, - "min_replicas": 0,
- "ram": 0,
- "vcpus": "string"
}, - "skip_hc_ports": "string",
- "template_delimiter": "string",
- "trusted": true,
- "updated_at": "string",
- "vm_app_os_type": "string"
}, - "dry_run_deploy": true,
- "num_nodes": 0
}, - "Region": "string"
}{- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}Update Application. Updates the definition of an application.
object (EdgeprotoApp) | |
| Region | string Region name |
{- "App": {
- "access_ports": "string",
- "access_type": "string",
- "alert_policies": [
- "string"
], - "allow_serverless": true,
- "android_package_name": "string",
- "annotations": "string",
- "auth_public_key": "string",
- "auto_prov_policies": [
- "string"
], - "auto_prov_policy": "string",
- "command": "string",
- "command_args": [
- "string"
], - "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "default_flavor": {
- "name": "string"
}, - "del_opt": "string",
- "delete_prepare": true,
- "deployment": "string",
- "deployment_generator": "string",
- "deployment_manifest": "string",
- "global_id": "string",
- "image_path": "string",
- "image_type": "string",
- "internal_ports": true,
- "key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "md5sum": "string",
- "official_fqdn": "string",
- "qos_session_duration": "string",
- "qos_session_profile": "string",
- "required_outbound_connections": [
- {
- "port_range_max": 0,
- "port_range_min": 0,
- "protocol": "string",
- "remote_cidr": "string"
}
], - "revision": "string",
- "scale_with_cluster": true,
- "serverless_config": {
- "gpu_config": {
- "model": "string",
- "num_gpu": 0,
- "ram": 0,
- "type": "string"
}, - "min_replicas": 0,
- "ram": 0,
- "vcpus": "string"
}, - "skip_hc_ports": "string",
- "template_delimiter": "string",
- "trusted": true,
- "updated_at": "string",
- "vm_app_os_type": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}AppInst is an instance of an App on a Cloudlet where it is defined by an App plus a ClusterInst key.
Create Application Instance. Creates an instance of an App on a Cloudlet where it is defined by an App plus a ClusterInst key. Many of the fields here are inherited from the App definition.
object (EdgeprotoAppInst) | |
| Region | string Region name |
{- "AppInst": {
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "auto_cluster_ip_access": "string",
- "availability_zone": "string",
- "cloudlet_flavor": "string",
- "cloudlet_loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}, - "compatibility_version": 0,
- "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "crm_override": "string",
- "dedicated_ip": true,
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "fed_key": {
- "app_inst_id": "string",
- "federation_name": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "force_update": true,
- "health_check": 0,
- "internal_port_to_lb_ip": {
- "property1": "string",
- "property2": "string"
}, - "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "liveness": "string",
- "mapped_ports": [
- {
- "end_port": 0,
- "fqdn_prefix": "string",
- "internal_port": 0,
- "max_pkt_size": 0,
- "nginx": true,
- "proto": 0,
- "public_port": 0,
- "tls": true
}
], - "opt_res": "string",
- "power_state": "string",
- "real_cluster_name": "string",
- "revision": "string",
- "runtime_info": {
- "container_ids": [
- "string"
]
}, - "state": "string",
- "unique_id": "string",
- "update_multiple": true,
- "updated_at": "string",
- "uri": "string",
- "virtual_cluster_key": {
- "name": "string",
- "organization": "string"
}, - "vm_flavor": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete Application Instance. Deletes an instance of the App from the Cloudlet.
object (EdgeprotoAppInst) | |
| Region | string Region name |
{- "AppInst": {
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "auto_cluster_ip_access": "string",
- "availability_zone": "string",
- "cloudlet_flavor": "string",
- "cloudlet_loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}, - "compatibility_version": 0,
- "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "crm_override": "string",
- "dedicated_ip": true,
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "fed_key": {
- "app_inst_id": "string",
- "federation_name": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "force_update": true,
- "health_check": 0,
- "internal_port_to_lb_ip": {
- "property1": "string",
- "property2": "string"
}, - "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "liveness": "string",
- "mapped_ports": [
- {
- "end_port": 0,
- "fqdn_prefix": "string",
- "internal_port": 0,
- "max_pkt_size": 0,
- "nginx": true,
- "proto": 0,
- "public_port": 0,
- "tls": true
}
], - "opt_res": "string",
- "power_state": "string",
- "real_cluster_name": "string",
- "revision": "string",
- "runtime_info": {
- "container_ids": [
- "string"
]
}, - "state": "string",
- "unique_id": "string",
- "update_multiple": true,
- "updated_at": "string",
- "uri": "string",
- "virtual_cluster_key": {
- "name": "string",
- "organization": "string"
}, - "vm_flavor": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Refresh Application Instance. Restarts an App instance with new App settings or image.
object (EdgeprotoAppInst) | |
| Region | string Region name |
{- "AppInst": {
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "auto_cluster_ip_access": "string",
- "availability_zone": "string",
- "cloudlet_flavor": "string",
- "cloudlet_loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}, - "compatibility_version": 0,
- "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "crm_override": "string",
- "dedicated_ip": true,
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "fed_key": {
- "app_inst_id": "string",
- "federation_name": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "force_update": true,
- "health_check": 0,
- "internal_port_to_lb_ip": {
- "property1": "string",
- "property2": "string"
}, - "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "liveness": "string",
- "mapped_ports": [
- {
- "end_port": 0,
- "fqdn_prefix": "string",
- "internal_port": 0,
- "max_pkt_size": 0,
- "nginx": true,
- "proto": 0,
- "public_port": 0,
- "tls": true
}
], - "opt_res": "string",
- "power_state": "string",
- "real_cluster_name": "string",
- "revision": "string",
- "runtime_info": {
- "container_ids": [
- "string"
]
}, - "state": "string",
- "unique_id": "string",
- "update_multiple": true,
- "updated_at": "string",
- "uri": "string",
- "virtual_cluster_key": {
- "name": "string",
- "organization": "string"
}, - "vm_flavor": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Application Instances. Lists all the Application instances managed by the Edge Controller. Any fields specified will be used to filter results.
object (EdgeprotoAppInst) | |
| Region | string Region name |
{- "AppInst": {
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "auto_cluster_ip_access": "string",
- "availability_zone": "string",
- "cloudlet_flavor": "string",
- "cloudlet_loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}, - "compatibility_version": 0,
- "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "crm_override": "string",
- "dedicated_ip": true,
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "fed_key": {
- "app_inst_id": "string",
- "federation_name": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "force_update": true,
- "health_check": 0,
- "internal_port_to_lb_ip": {
- "property1": "string",
- "property2": "string"
}, - "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "liveness": "string",
- "mapped_ports": [
- {
- "end_port": 0,
- "fqdn_prefix": "string",
- "internal_port": 0,
- "max_pkt_size": 0,
- "nginx": true,
- "proto": 0,
- "public_port": 0,
- "tls": true
}
], - "opt_res": "string",
- "power_state": "string",
- "real_cluster_name": "string",
- "revision": "string",
- "runtime_info": {
- "container_ids": [
- "string"
]
}, - "state": "string",
- "unique_id": "string",
- "update_multiple": true,
- "updated_at": "string",
- "uri": "string",
- "virtual_cluster_key": {
- "name": "string",
- "organization": "string"
}, - "vm_flavor": "string"
}, - "Region": "string"
}{- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "auto_cluster_ip_access": "string",
- "availability_zone": "string",
- "cloudlet_flavor": "string",
- "cloudlet_loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}, - "compatibility_version": 0,
- "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "crm_override": "string",
- "dedicated_ip": true,
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "fed_key": {
- "app_inst_id": "string",
- "federation_name": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "force_update": true,
- "health_check": 0,
- "internal_port_to_lb_ip": {
- "property1": "string",
- "property2": "string"
}, - "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "liveness": "string",
- "mapped_ports": [
- {
- "end_port": 0,
- "fqdn_prefix": "string",
- "internal_port": 0,
- "max_pkt_size": 0,
- "nginx": true,
- "proto": 0,
- "public_port": 0,
- "tls": true
}
], - "opt_res": "string",
- "power_state": "string",
- "real_cluster_name": "string",
- "revision": "string",
- "runtime_info": {
- "container_ids": [
- "string"
]
}, - "state": "string",
- "unique_id": "string",
- "update_multiple": true,
- "updated_at": "string",
- "uri": "string",
- "virtual_cluster_key": {
- "name": "string",
- "organization": "string"
}, - "vm_flavor": "string"
}Update Application Instance. Updates an Application instance and then refreshes it.
object (EdgeprotoAppInst) | |
| Region | string Region name |
{- "AppInst": {
- "app_key": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "auto_cluster_ip_access": "string",
- "availability_zone": "string",
- "cloudlet_flavor": "string",
- "cloudlet_loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}, - "cluster_key": {
- "name": "string",
- "organization": "string"
}, - "compatibility_version": 0,
- "configs": [
- {
- "config": "string",
- "kind": "string"
}
], - "created_at": "string",
- "crm_override": "string",
- "dedicated_ip": true,
- "dns_label": "string",
- "errors": [
- "string"
], - "external_volume_size": 0,
- "fed_key": {
- "app_inst_id": "string",
- "federation_name": "string"
}, - "fields": [
- "string"
], - "flavor": {
- "name": "string"
}, - "force_update": true,
- "health_check": 0,
- "internal_port_to_lb_ip": {
- "property1": "string",
- "property2": "string"
}, - "key": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "liveness": "string",
- "mapped_ports": [
- {
- "end_port": 0,
- "fqdn_prefix": "string",
- "internal_port": 0,
- "max_pkt_size": 0,
- "nginx": true,
- "proto": 0,
- "public_port": 0,
- "tls": true
}
], - "opt_res": "string",
- "power_state": "string",
- "real_cluster_name": "string",
- "revision": "string",
- "runtime_info": {
- "container_ids": [
- "string"
]
}, - "state": "string",
- "unique_id": "string",
- "update_multiple": true,
- "updated_at": "string",
- "uri": "string",
- "virtual_cluster_key": {
- "name": "string",
- "organization": "string"
}, - "vm_flavor": "string"
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Add a Cloudlet to the Auto Provisioning Policy
object (EdgeprotoAutoProvPolicyCloudlet) | |
| Region | string Region name |
{- "AutoProvPolicyCloudlet": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "key": {
- "name": "string",
- "organization": "string"
}
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Create an Auto Provisioning Policy
object (EdgeprotoAutoProvPolicy) | |
| Region | string Region name |
{- "AutoProvPolicy": {
- "cloudlets": [
- {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}
}
], - "delete_prepare": true,
- "deploy_client_count": 0,
- "deploy_interval_count": 0,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_instances": 0,
- "min_active_instances": 0,
- "undeploy_client_count": 0,
- "undeploy_interval_count": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete an Auto Provisioning Policy
object (EdgeprotoAutoProvPolicy) | |
| Region | string Region name |
{- "AutoProvPolicy": {
- "cloudlets": [
- {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}
}
], - "delete_prepare": true,
- "deploy_client_count": 0,
- "deploy_interval_count": 0,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_instances": 0,
- "min_active_instances": 0,
- "undeploy_client_count": 0,
- "undeploy_interval_count": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Remove a Cloudlet from the Auto Provisioning Policy
object (EdgeprotoAutoProvPolicyCloudlet) | |
| Region | string Region name |
{- "AutoProvPolicyCloudlet": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "key": {
- "name": "string",
- "organization": "string"
}
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Auto Provisioning Policies. Any fields specified will be used to filter results.
object (EdgeprotoAutoProvPolicy) | |
| Region | string Region name |
{- "AutoProvPolicy": {
- "cloudlets": [
- {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}
}
], - "delete_prepare": true,
- "deploy_client_count": 0,
- "deploy_interval_count": 0,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_instances": 0,
- "min_active_instances": 0,
- "undeploy_client_count": 0,
- "undeploy_interval_count": 0
}, - "Region": "string"
}{- "cloudlets": [
- {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}
}
], - "delete_prepare": true,
- "deploy_client_count": 0,
- "deploy_interval_count": 0,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_instances": 0,
- "min_active_instances": 0,
- "undeploy_client_count": 0,
- "undeploy_interval_count": 0
}Update an Auto Provisioning Policy
object (EdgeprotoAutoProvPolicy) | |
| Region | string Region name |
{- "AutoProvPolicy": {
- "cloudlets": [
- {
- "key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "loc": {
- "altitude": 0,
- "course": 0,
- "horizontal_accuracy": 0,
- "latitude": 0,
- "longitude": 0,
- "speed": 0,
- "timestamp": {
- "nanos": 0,
- "seconds": 0
}, - "vertical_accuracy": 0
}
}
], - "delete_prepare": true,
- "deploy_client_count": 0,
- "deploy_interval_count": 0,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_instances": 0,
- "min_active_instances": 0,
- "undeploy_client_count": 0,
- "undeploy_interval_count": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}AutoScalePolicy defines when and how ClusterInsts will have their nodes scaled up or down.
Create an Auto Scale Policy
object (EdgeprotoAutoScalePolicy) | |
| Region | string Region name |
{- "AutoScalePolicy": {
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_nodes": 0,
- "min_nodes": 0,
- "scale_down_cpu_thresh": 0,
- "scale_up_cpu_thresh": 0,
- "stabilization_window_sec": 0,
- "target_active_connections": 0,
- "target_cpu": 0,
- "target_mem": 0,
- "trigger_time_sec": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Delete an Auto Scale Policy
object (EdgeprotoAutoScalePolicy) | |
| Region | string Region name |
{- "AutoScalePolicy": {
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_nodes": 0,
- "min_nodes": 0,
- "scale_down_cpu_thresh": 0,
- "scale_up_cpu_thresh": 0,
- "stabilization_window_sec": 0,
- "target_active_connections": 0,
- "target_cpu": 0,
- "target_mem": 0,
- "trigger_time_sec": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Auto Scale Policies. Any fields specified will be used to filter results.
object (EdgeprotoAutoScalePolicy) | |
| Region | string Region name |
{- "AutoScalePolicy": {
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_nodes": 0,
- "min_nodes": 0,
- "scale_down_cpu_thresh": 0,
- "scale_up_cpu_thresh": 0,
- "stabilization_window_sec": 0,
- "target_active_connections": 0,
- "target_cpu": 0,
- "target_mem": 0,
- "trigger_time_sec": 0
}, - "Region": "string"
}{- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_nodes": 0,
- "min_nodes": 0,
- "scale_down_cpu_thresh": 0,
- "scale_up_cpu_thresh": 0,
- "stabilization_window_sec": 0,
- "target_active_connections": 0,
- "target_cpu": 0,
- "target_mem": 0,
- "trigger_time_sec": 0
}Update an Auto Scale Policy
object (EdgeprotoAutoScalePolicy) | |
| Region | string Region name |
{- "AutoScalePolicy": {
- "delete_prepare": true,
- "key": {
- "name": "string",
- "organization": "string"
}, - "max_nodes": 0,
- "min_nodes": 0,
- "scale_down_cpu_thresh": 0,
- "scale_up_cpu_thresh": 0,
- "stabilization_window_sec": 0,
- "target_active_connections": 0,
- "target_cpu": 0,
- "target_mem": 0,
- "trigger_time_sec": 0
}, - "Region": "string"
}{- "code": 0,
- "message": "string"
}PrivacyPolicy defines security restrictions for cluster instances nodes scaled up or down.
ExecRequest is a common struct for enabling a connection to execute some work on a container.
Find events and audit events, results sorted by relevance
| allowedorgs | Array of strings or null Organizations allowed to access the event |
| endage | string End age relative to now of the time range |
| endtime | string <date-time> End time of the time range |
| from | integer Start offset if paging through results |
| limit | integer Display the last X events |
object (NodeEventMatch) | |
object (NodeEventMatch) | |
| startage | string Start age relative to now of the time range |
| starttime | string <date-time> Start time of the time range |
{- "allowedorgs": [
- "string"
], - "endage": "string",
- "endtime": "2019-08-24T14:15:22Z",
- "from": 0,
- "limit": 0,
- "match": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "notmatch": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "startage": "string",
- "starttime": "2019-08-24T14:15:22Z"
}[- {
- "error": "string",
- "mtags": {
- "property1": "string",
- "property2": "string"
}, - "name": "string",
- "org": [
- "string"
], - "region": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "timestamp": "2019-08-24T14:15:22Z",
- "type": "string"
}
]Show events and audit events
| allowedorgs | Array of strings or null Organizations allowed to access the event |
| endage | string End age relative to now of the time range |
| endtime | string <date-time> End time of the time range |
| from | integer Start offset if paging through results |
| limit | integer Display the last X events |
object (NodeEventMatch) | |
object (NodeEventMatch) | |
| startage | string Start age relative to now of the time range |
| starttime | string <date-time> Start time of the time range |
{- "allowedorgs": [
- "string"
], - "endage": "string",
- "endtime": "2019-08-24T14:15:22Z",
- "from": 0,
- "limit": 0,
- "match": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "notmatch": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "startage": "string",
- "starttime": "2019-08-24T14:15:22Z"
}[- {
- "error": "string",
- "mtags": {
- "property1": "string",
- "property2": "string"
}, - "name": "string",
- "org": [
- "string"
], - "region": "string",
- "tags": [
- {
- "key": "string",
- "value": "string"
}
], - "timestamp": "2019-08-24T14:15:22Z",
- "type": "string"
}
]Show aggregated events terms
| allowedorgs | Array of strings or null Organizations allowed to access the event |
| endage | string End age relative to now of the time range |
| endtime | string <date-time> End time of the time range |
| from | integer Start offset if paging through results |
| limit | integer Display the last X events |
object (NodeEventMatch) | |
object (NodeEventMatch) | |
| startage | string Start age relative to now of the time range |
| starttime | string <date-time> Start time of the time range |
{- "allowedorgs": [
- "string"
], - "endage": "string",
- "endtime": "2019-08-24T14:15:22Z",
- "from": 0,
- "limit": 0,
- "match": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "notmatch": {
- "error": "string",
- "failed": true,
- "names": [
- "string"
], - "orgs": [
- "string"
], - "regions": [
- "string"
], - "tags": {
- "property1": "string",
- "property2": "string"
}, - "types": [
- "string"
]
}, - "startage": "string",
- "starttime": "2019-08-24T14:15:22Z"
}{- "names": [
- {
- "count": 0,
- "key": "string"
}
], - "orgs": [
- {
- "count": 0,
- "key": "string"
}
], - "regions": [
- {
- "count": 0,
- "key": "string"
}
], - "tagkeys": [
- {
- "count": 0,
- "key": "string"
}
], - "types": [
- {
- "count": 0,
- "key": "string"
}
]
}Create an alert receiver
object (EdgeprotoAppInstKey) | |
object (EdgeprotoAppKey) | |
object (EdgeprotoClusterKey) | |
string Custom receiving email | |
| Name | string Receiver Name |
| PagerDutyApiVersion | string PagerDuty API version |
| PagerDutyIntegrationKey | string PagerDuty integration key |
| Region | string Region for the alert receiver |
| Severity | string Alert severity filter |
| SlackChannel | string Custom slack channel |
| SlackWebhook | string Custom slack webhook |
| Type | string Receiver type. Eg. email, slack, pagerduty |
| User | string User that created this receiver |
{- "AppInstKey": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "AppKey": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "ClusterKey": {
- "name": "string",
- "organization": "string"
}, - "Email": "string",
- "Name": "string",
- "PagerDutyApiVersion": "string",
- "PagerDutyIntegrationKey": "string",
- "Region": "string",
- "Severity": "string",
- "SlackChannel": "string",
- "SlackWebhook": "string",
- "Type": "string",
- "User": "string"
}{- "code": 0,
- "message": "string"
}Delete an alert receiver
object (EdgeprotoAppInstKey) | |
object (EdgeprotoAppKey) | |
object (EdgeprotoClusterKey) | |
string Custom receiving email | |
| Name | string Receiver Name |
| PagerDutyApiVersion | string PagerDuty API version |
| PagerDutyIntegrationKey | string PagerDuty integration key |
| Region | string Region for the alert receiver |
| Severity | string Alert severity filter |
| SlackChannel | string Custom slack channel |
| SlackWebhook | string Custom slack webhook |
| Type | string Receiver type. Eg. email, slack, pagerduty |
| User | string User that created this receiver |
{- "AppInstKey": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "AppKey": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "ClusterKey": {
- "name": "string",
- "organization": "string"
}, - "Email": "string",
- "Name": "string",
- "PagerDutyApiVersion": "string",
- "PagerDutyIntegrationKey": "string",
- "Region": "string",
- "Severity": "string",
- "SlackChannel": "string",
- "SlackWebhook": "string",
- "Type": "string",
- "User": "string"
}{- "code": 0,
- "message": "string"
}Show alert receivers
object (EdgeprotoAppInstKey) | |
object (EdgeprotoAppKey) | |
object (EdgeprotoClusterKey) | |
string Custom receiving email | |
| Name | string Receiver Name |
| PagerDutyApiVersion | string PagerDuty API version |
| PagerDutyIntegrationKey | string PagerDuty integration key |
| Region | string Region for the alert receiver |
| Severity | string Alert severity filter |
| SlackChannel | string Custom slack channel |
| SlackWebhook | string Custom slack webhook |
| Type | string Receiver type. Eg. email, slack, pagerduty |
| User | string User that created this receiver |
{- "AppInstKey": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "AppKey": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "ClusterKey": {
- "name": "string",
- "organization": "string"
}, - "Email": "string",
- "Name": "string",
- "PagerDutyApiVersion": "string",
- "PagerDutyIntegrationKey": "string",
- "Region": "string",
- "Severity": "string",
- "SlackChannel": "string",
- "SlackWebhook": "string",
- "Type": "string",
- "User": "string"
}[- {
- "AppInstKey": {
- "cloudlet_key": {
- "federated_organization": "string",
- "name": "string",
- "organization": "string"
}, - "name": "string",
- "organization": "string"
}, - "AppKey": {
- "name": "string",
- "organization": "string",
- "version": "string"
}, - "ClusterKey": {
- "name": "string",
- "organization": "string"
}, - "Email": "string",
- "Name": "string",
- "PagerDutyApiVersion": "string",
- "PagerDutyIntegrationKey": "string",
- "Region": "string",
- "Severity": "string",
- "SlackChannel": "string",
- "SlackWebhook": "string",
- "Type": "string",
- "User": "string"
}
]Remove App from partner federation
| AppName | string App name in region |
| AppOrg | string App org in region |
| AppVers | string App version in region |
| FederationName | string Target Guest Federation name |
| ID | string Unique ID, acts as both the App and Artefact IDs |
| ImageIds | Array of strings or null (PqStringArray) |
| Region | string Region name |
{- "AppName": "string",
- "AppOrg": "string",
- "AppVers": "string",
- "FederationName": "string",
- "ID": "string",
- "ImageIds": [
- "string"
], - "Region": "string"
}{- "code": 0,
- "message": "string"
}Onboard existing App to partner federation
| AppName | string App name in region |
| AppOrg | string App org in region |
| AppVers | string App version in region |
| FederationName | string Target Guest Federation name |
| ID | string Unique ID, acts as both the App and Artefact IDs |
| ImageIds | Array of strings or null (PqStringArray) |
| Region | string Region name |
{- "AppName": "string",
- "AppOrg": "string",
- "AppVers": "string",
- "FederationName": "string",
- "ID": "string",
- "ImageIds": [
- "string"
], - "Region": "string"
}{- "code": 0,
- "message": "string"
}Show Apps onboarded to partner federation
| AppName | string App name in region |
| AppOrg | string App org in region |
| AppVers | string App version in region |
| FederationName | string Target Guest Federation name |
| ID | string Unique ID, acts as both the App and Artefact IDs |
| ImageIds | Array of strings or null (PqStringArray) |
| Region | string Region name |
{- "AppName": "string",
- "AppOrg": "string",
- "AppVers": "string",
- "FederationName": "string",
- "ID": "string",
- "ImageIds": [
- "string"
], - "Region": "string"
}[- {
- "AppName": "string",
- "AppOrg": "string",
- "AppVers": "string",
- "FederationName": "string",
- "ID": "string",
- "ImageIds": [
- "string"
], - "Region": "string",
- "Status": "string"
}
]Create image on partner federation
| Checksum | string MD5 checksum for VM and file-based image types, sha256 digest for containers and Helm charts |
| FederationName | string Federation the image is copied to (FederationGuest) |
| ID | string ID |
| Name | string Image name |
| Organization | string Developer organization that owns the image |
| SourcePath | string Full path to source image as used in App, i.e. https://vm-registry.domain/org/image.img |
| Type | string Image type (DOCKER, HELM, QCOW2, or OVA) |
| Version | string Image version |
{- "Checksum": "string",
- "FederationName": "string",
- "ID": "string",
- "Name": "string",
- "Organization": "string",
- "SourcePath": "string",
- "Type": "string",
- "Version": "string"
}{- "code": 0,
- "message": "string"
}Delete image from partner federation
| Checksum | string MD5 checksum for VM and file-based image types, sha256 digest for containers and Helm charts |
| FederationName | string Federation the image is copied to (FederationGuest) |
| ID | string ID |
| Name | string Image name |
| Organization | string Developer organization that owns the image |
| SourcePath | string Full path to source image as used in App, i.e. https://vm-registry.domain/org/image.img |
| Type | string Image type (DOCKER, HELM, QCOW2, or OVA) |
| Version | string Image version |
{- "Checksum": "string",
- "FederationName": "string",
- "ID": "string",
- "Name": "string",
- "Organization": "string",
- "SourcePath": "string",
- "Type": "string",
- "Version": "string"
}{- "code": 0,
- "message": "string"
}Show images on partner federation
| Checksum | string MD5 checksum for VM and file-based image types, sha256 digest for containers and Helm charts |
| FederationName | string Federation the image is copied to (FederationGuest) |
| ID | string ID |
| Name | string Image name |
| Organization | string Developer organization that owns the image |
| SourcePath | string Full path to source image as used in App, i.e. https://vm-registry.domain/org/image.img |
| Type | string Image type (DOCKER, HELM, QCOW2, or OVA) |
| Version | string Image version |
{- "Checksum": "string",
- "FederationName": "string",
- "ID": "string",
- "Name": "string",
- "Organization": "string",
- "SourcePath": "string",
- "Type": "string",
- "Version": "string"
}[- {
- "Checksum": "string",
- "FederationName": "string",
- "ID": "string",
- "Name": "string",
- "Organization": "string",
- "SourcePath": "string",
- "Status": "string",
- "Type": "string",
- "Version": "string"
}
]Show federations for App deployment
| AutoRegisterRegion | string Region used for automatically registered zones |
| AutoRegisterZones | boolean Automatically register any zone shared with me |
| FederationContextId | string Federation context id returned by partner |
| ID | integer >= 0 Unique ID |
object (OrmapiFederator) | |
| Name | string Unique name of this Federation Guest, will be used as an operator org for host's zones |
| NotifyClientId | string Auth ClientId for notify callbacks to this Guest OP |
| OperatorId | string Operator Organization that establishes the federation with a Host OP |
| PartnerAddr | string Partner Address |
object (OrmapiFederator) | |
| PartnerTokenUrl | string Partner token URL |
| ProviderClientId | string Auth ClientId for connecting to the Host OP |
| ProviderClientKey | string Auth ClientKey for connection to the Host OP (stored in secret storage) |
| Public | boolean Public means any developer will be able to use the cloudlets, otherwise (TODO) allowed developers will need to be added explicitly |
{- "AutoRegisterRegion": "string",
- "AutoRegisterZones": true,
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "NotifyClientId": "string",
- "OperatorId": "string",
- "PartnerAddr": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerTokenUrl": "string",
- "ProviderClientId": "string",
- "ProviderClientKey": "string",
- "Public": true
}[- {
- "AutoRegisterRegion": "string",
- "AutoRegisterZones": true,
- "CreatedAt": "2019-08-24T14:15:22Z",
- "FederationContextId": "string",
- "ID": 0,
- "MyInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "Name": "string",
- "NotifyClientId": "string",
- "OperatorId": "string",
- "PartnerAddr": "string",
- "PartnerInfo": {
- "CountryCode": "string",
- "DiscoveryEndPoint": "string",
- "FederationId": "string",
- "FixedNetworkIds": [
- "string"
], - "InitialDate": "2019-08-24T14:15:22Z",
- "MCC": "string",
- "MNC": [
- "string"
]
}, - "PartnerTokenUrl": "string",
- "ProviderClientId": "string",
- "ProviderClientKey": "string",
- "Public": true,
- "Status": "string",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
]