Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Querying the Task List in the Task Center

Function

This API is used to query the task list in the task center.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/tasks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

limit

No

Integer

Number of records displayed on each page. The minimum value is 1. The maximum value is 1000*. If this parameter is not specified, 10 records are displayed on each page by default.

start_time

No

String

Query start time (UTC). Format: yyyyMMddHHmmss, for example, 20200609160000.

end_time

No

String

Query end time (UTC). Format: yyyyMMddHHmmss. For example, 20230612155959.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

task_count

String

Number of tasks.

tasks

Array of ListCenterTasksResp objects

Array of task details in the task center.

Table 4 ListCenterTasksResp

Parameter

Type

Description

id

String

Background task ID.

name

String

Background task name. Options:

EXTEND: modifying specifications

BindEip: enabling public access

UnBindEip: disabling public access

AddReplica: adding replicas

DelReplica: deleting replicas

AddWhitelist: configuring an IP whitelist

UpdatePort: changing the port

RemoveIpFromDns: removing IP addresses

masterStandbySwapJob: master/standby switchover

modify: changing the password

details

DetailsBody object

Details.

user_name

String

Username.

user_id

String

User ID.

params

String

Task parameters.

status

String

Task status.

created_at

String

Task start time, in the format 2020-06-17T07:38:42.503Z.

updated_at

String

Task end time, in the format 2020-06-17T07:38:42.503Z.

error_code

String

Error code.

enable_show

Boolean

Task details that can be expanded.

job_id

String

Task ID.

Table 5 DetailsBody

Parameter

Type

Description

old_capacity

String

Capacity before the modification. This parameter has a value only when the specifications are modified.

new_capacity

String

Capacity after the modification. This parameter has a value only when the specifications are modified.

enable_public_ip

Boolean

Whether to enable public access. This parameter has a value only when public access is enabled.

public_ip_id

String

ID of the IP address used for public access. This parameter has a value only when public access is enabled.

public_ip_address

String

IP address used for public access. This parameter has a value only when public access is enabled.

enable_ssl

Boolean

Whether to enable SSL. This parameter has a value only when SSL is enabled.

old_cache_mode

String

Cache type before the modification. This parameter has a value only when the specifications are modified.

new_cache_mode

String

Cache type after the modification. This parameter has a value only when the specifications are modified.

old_resource_spec_code

String

Specification parameter before the modification. This parameter has a value only when the specifications are modified.

new_resource_spec_code

String

Specification parameter after the modification. This parameter has a value only when the specifications are modified.

old_replica_num

Integer

Number of replicas before the modification. This parameter has a value only when the specifications are modified.

new_replica_num

Integer

Number of replicas after the modification. This parameter has a value only when the specifications are modified.

old_cache_type

String

Cache type before the modification. This parameter has a value only when the specifications are modified.

new_cache_type

String

Specification type after the modification. This parameter has a value only when the specifications are modified.

replica_ip

String

Replica IP address.

replica_az

String

AZ where the replica is in.

group_name

String

Group name.

old_port

Integer

Old port.

new_port

Integer

New port.

is_only_adjust_charging

Boolean

Indicates whether to only change the billing mode.

account_name

String

Account name.

source_ip

String

Source IP address.

target_ip

String

Target IP address.

node_name

String

Node information.

rename_commands

Array of strings

Renamed command.

updated_config_length

Integer

Length of the updated configuration item.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_msg

String

Error message.

error_code

String

Error code.

error_ext_msg

String

Extended error information. This parameter is not used currently and is set to null.

Example Requests

GET https://{dcs_endpoint}/v2/{project_id}/tasks

Example Responses

Status code: 200

Successfully queried the task list in the task center.

{
  "task_count" : 2,
  "tasks" : [ {
    "id" : "8abf6e1e72c12e7c0172c15b508500aa",
    "name" : "ChangeInstanceSpec",
    "job_id" : "8abf6e1e87bce0740187bd32748b0530",
    "user_name" : "paas_dcs_a00421997_02",
    "user_id" : "d53977d1adfb49c5b025ba7d33a13fd7",
    "details" : {
      "old_cache_mode" : "single",
      "new_cache_mode" : "single",
      "old_capacity" : 0.125,
      "new_capacity" : 0.25
    },
    "status" : "SUCCESS",
    "created_at" : "2023-06-17T08:18:06.597Z",
    "updated_at" : "2023-06-17T08:18:10.106Z",
    "error_code" : "111400063",
    "enable_show" : true
  }, {
    "id" : "ff80808188bfde180188c36bb9ca4a30",
    "name" : "dcsExportJob",
    "job_id" : "ff80808188bfde180188c36bb9c44a2f",
    "user_name" : "paas_dcs_004_01",
    "user_id" : "bb259bd2b8b644a1b4a573a20318af51",
    "details" : null,
    "status" : "SUCCESS",
    "created_at" : "2023-06-17T08:18:06.597Z",
    "updated_at" : "2023-06-17T08:18:10.106Z",
    "error_code" : "111400063",
    "enable_show" : true
  } ]
}

Status Codes

Status Code

Description

200

Successfully queried the task list in the task center.

400

Invalid request.

500

Internal service error.

Error Codes

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback