Tasks

tasks

Methods

Acknowledge Client Tasks In Project Or Region ->
post/v1/tasks/acknowledge

Deprecated

Use /v1/tasks/acknowledge_all instead

Acknowledge All Client Tasks In Project Or Region ->
post/v1/tasks/acknowledge_all

Acknowledge all client tasks in project or region

Acknowledge One Task On Project Scope ->
post/v1/tasks/{task_id}/acknowledge

Acknowledge one task on project scope

List Tasks -> OffsetPage<>
get/v1/tasks

List tasks

Parameters
from_timestamp: string
Optional
(format: date-time)

ISO formatted datetime string. Filter the tasks by creation date greater than or equal to from_timestamp

is_acknowledged: boolean
Optional

Filter the tasks by their acknowledgement status

limit: number
Optional
(exclusiveMinimum: 0, maximum: 1000)

Limit the number of returned tasks. Falls back to default of 10 if not specified. Limited by max limit value of 1000

offset: number
Optional
(minimum: 0)

Offset value is used to exclude the first set of records from the result

project_id: Array<number>
Optional

The project ID to filter the tasks by project. Supports multiple values of kind key=value1&key=value2

region_id: Array<number>
Optional

The region ID to filter the tasks by region. Supports multiple values of kind key=value1&key=value2

sorting:
Optional

Sorting by creation date. Oldest first, or most recent first

"asc"
"desc"
state: Array<
Optional

Filter the tasks by state. Supports multiple values of kind key=value1&key=value2

"ERROR"
"FINISHED"
"NEW"
"RUNNING"
>
task_type: string
Optional

Filter the tasks by their type one of ['activate_ddos_profile', 'attach_bm_to_reserved_fixed_ip', 'attach_vm_interface', 'attach_vm_to_reserved_fixed_ip', 'attach_volume', 'create_ai_cluster_gpu', 'create_bm', 'create_caas_container', 'create_dbaas_postgres_cluster', 'create_ddos_profile', 'create_faas_function', 'create_faas_namespace', 'create_fip', 'create_image', 'create_inference_instance', 'create_inference_instance_key', 'create_k8s_cluster_pool_v2', 'create_k8s_cluster_v2', 'create_l7policy', 'create_l7rule', 'create_lblistener', 'create_lbmember', 'create_lbpool', 'create_lbpool_health_monitor', 'create_loadbalancer', 'create_network', 'create_reserved_fixed_ip', 'create_router', 'create_secret', 'create_servergroup', 'create_sfs', 'create_snapshot', 'create_subnet', 'create_vm', 'create_volume', 'deactivate_ddos_profile', 'delete_ai_cluster_gpu', 'delete_caas_container', 'delete_dbaas_postgres_cluster', 'delete_ddos_profile', 'delete_faas_function', 'delete_faas_namespace', 'delete_fip', 'delete_image', 'delete_inference_instance', 'delete_k8s_cluster_pool_v2', 'delete_k8s_cluster_v2', 'delete_l7policy', 'delete_l7rule', 'delete_lblistener', 'delete_lbmember', 'delete_lbmetadata', 'delete_lbpool', 'delete_loadbalancer', 'delete_network', 'delete_reserved_fixed_ip', 'delete_router', 'delete_secret', 'delete_servergroup', 'delete_sfs', 'delete_snapshot', 'delete_subnet', 'delete_vm', 'delete_volume', 'detach_vm_from_subnet', 'detach_vm_interface', 'detach_volume', 'download_image', 'downscale_ai_cluster_gpu', 'extend_sfs', 'extend_volume', 'failover_loadbalancer', 'hard_reboot_vm', 'patch_caas_container', 'patch_dbaas_postgres_cluster', 'patch_faas_function', 'patch_faas_namespace', 'patch_lblistener', 'patch_lbpool', 'put_into_server_group', 'put_l7policy', 'put_l7rule', 'rebuild_bm', 'rebuild_gpu_baremetal_node', 'remove_from_server_group', 'replace_lbmetadata', 'resize_k8s_cluster_v2', 'resize_loadbalancer', 'resize_vm', 'resume_vm', 'revert_volume', 'soft_reboot_vm', 'start_vm', 'stop_vm', 'suspend_vm', 'sync_private_flavors', 'update_ddos_profile', 'update_inference_instance', 'update_inference_instance_key', 'update_k8s_cluster_v2', 'update_lbmetadata', 'update_port_allowed_address_pairs', 'upgrade_k8s_cluster_v2', 'upscale_ai_cluster_gpu']

to_timestamp: string
Optional
(format: date-time)

ISO formatted datetime string. Filter the tasks by creation date less than or equal to to_timestamp

Response fields
Request example
200Example
List Active Tasks -> OffsetPage<>
get/v1/tasks/{project_id}/{region_id}/active

List active tasks

Parameters
project_id: number

Project ID

region_id: number

Region ID

limit: number
Optional
(exclusiveMinimum: 0, maximum: 1000)

Limit the number of returned tasks. Falls back to default of 10 if not specified. Limited by max limit value of 1000

offset: number
Optional
(minimum: 0)

Offset value is used to exclude the first set of records from the result

task_type: Array<string>
Optional

Filter the tasks by their type one of ['activate_ddos_profile', 'attach_bm_to_reserved_fixed_ip', 'attach_vm_interface', 'attach_vm_to_reserved_fixed_ip', 'attach_volume', 'create_ai_cluster_gpu', 'create_bm', 'create_caas_container', 'create_dbaas_postgres_cluster', 'create_ddos_profile', 'create_faas_function', 'create_faas_namespace', 'create_fip', 'create_image', 'create_inference_instance', 'create_inference_instance_key', 'create_k8s_cluster_pool_v2', 'create_k8s_cluster_v2', 'create_l7policy', 'create_l7rule', 'create_lblistener', 'create_lbmember', 'create_lbpool', 'create_lbpool_health_monitor', 'create_loadbalancer', 'create_network', 'create_reserved_fixed_ip', 'create_router', 'create_secret', 'create_servergroup', 'create_sfs', 'create_snapshot', 'create_subnet', 'create_vm', 'create_volume', 'deactivate_ddos_profile', 'delete_ai_cluster_gpu', 'delete_caas_container', 'delete_dbaas_postgres_cluster', 'delete_ddos_profile', 'delete_faas_function', 'delete_faas_namespace', 'delete_fip', 'delete_image', 'delete_inference_instance', 'delete_k8s_cluster_pool_v2', 'delete_k8s_cluster_v2', 'delete_l7policy', 'delete_l7rule', 'delete_lblistener', 'delete_lbmember', 'delete_lbmetadata', 'delete_lbpool', 'delete_loadbalancer', 'delete_network', 'delete_reserved_fixed_ip', 'delete_router', 'delete_secret', 'delete_servergroup', 'delete_sfs', 'delete_snapshot', 'delete_subnet', 'delete_vm', 'delete_volume', 'detach_vm_from_subnet', 'detach_vm_interface', 'detach_volume', 'download_image', 'downscale_ai_cluster_gpu', 'extend_sfs', 'extend_volume', 'failover_loadbalancer', 'hard_reboot_vm', 'patch_caas_container', 'patch_dbaas_postgres_cluster', 'patch_faas_function', 'patch_faas_namespace', 'patch_lblistener', 'patch_lbpool', 'put_into_server_group', 'put_l7policy', 'put_l7rule', 'rebuild_bm', 'rebuild_gpu_baremetal_node', 'remove_from_server_group', 'replace_lbmetadata', 'resize_k8s_cluster_v2', 'resize_loadbalancer', 'resize_vm', 'resume_vm', 'revert_volume', 'soft_reboot_vm', 'start_vm', 'stop_vm', 'suspend_vm', 'sync_private_flavors', 'update_ddos_profile', 'update_inference_instance', 'update_inference_instance_key', 'update_k8s_cluster_v2', 'update_lbmetadata', 'update_port_allowed_address_pairs', 'upgrade_k8s_cluster_v2', 'upscale_ai_cluster_gpu']

Response fields
Request example
200Example
Get Task ->
get/v1/tasks/{task_id}

Get task

Domain types

Task = { id, created_on, state, 18 more... }
TaskCollection = { count, results }