Obtaining Scheduled Tasks

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

offset

No

String

Index offset. The query starts from the first piece of data. The default value is 0. The value must be a number and cannot be a negative number.

limit

No

String

Number of records to be queried. The default value is 10.

status

No

String

Task execution status.

Value:

• Running: The task is being executed.
• Completed: The task is successfully executed.
• Failed: The task failed to be executed.
• Pending: The task is not executed.

start_time

No

String

Start time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

NOTE:

The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.

end_time

No

String

End time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

NOTE:

The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.

job_id

No

String

Task ID.

job_name

No

String

Task scheduling type.

X-Auth-Token

Yes

String

User token.

If the following response body is returned for calling the API used to obtain a user token, the request is successful.

After the request is processed, the value of X-Subject-Token in the message header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Value:

• en-us
• zh-cn

schedules

Array of ScheduleTask objects

Task details.

total_count

Integer

Total number of records.

job_id

String

Task ID.

instance_id

String

Instance ID.

instance_name

String

Instance name.

instance_status

String

Instance status.

Value:

• createfail: The DB instance fails to be created.
• creating: The DB instance is being created.
• normal: The DB instance is normal.
• abnormal: The DB instance is abnormal.
• deleted: The DB instance has been deleted.

project_id

String

Project ID of a tenant in a region.

job_name

String

Task name.

Value:

• CreateGaussDBforMySQLInstance: Creating a DB instance
• RestoreGaussDBforMySQLNewInstance: Restoring data to a new DB instance
• AddGaussDBforMySQLNodes: Adding a node
• DeleteGaussDBforMySQLNode: Deleting a node
• RebootGaussDBforMySQLInstance: Rebooting a DB instance
• ModifyGaussDBforMySQLPort: Changing a database port
• ModifyGaussDBforMySQLSecurityGroup: Changing a security group
• ResizeGaussDBforMySQLFlavor: Changing instance specifications
• SwitchoverGaussDBforMySQLMasterNode: Promoting a read replica to the primary node
• GaussDBforMySQLBindEIP: Binding an EIP
• GaussDBforMySQLUnbindEIP: Unbinding an EIP
• RenameGaussDBforMySQLInstance: Changing a DB instance name
• DeleteGaussDBforMySQLInstance: Deleting a DB instance
• UpgradeGaussDBforMySQLDatabaseVersion: Upgrading version
• EnlargeGaussDBforMySQLProxy: Adding nodes for a proxy instance
• OpenGaussDBforMySQLProxy: Creating a proxy instance
• CloseGaussDBforMySQLProxy: Deleting a proxy instance
• GaussdbforMySQLModifyProxyIp: Changing the IP address of a proxy instance
• ScaleGaussDBforMySQLProxy: Changing the node specifications of a proxy instance
• GaussDBforMySQLModifyInstanceMetricExtend: Enabling or disabling Monitoring by Seconds
• GaussDBforMySQLModifyInstanceDataVip: Changing the private IP address
• GaussDBforMySQLSwitchSSL: Enabling or disabling SSL
• GaussDBforMySQLModifyProxyConsist: Changing the proxy consistency
• GaussDBforMySQLModifyProxyWeight: Changing the read weights of nodes

create_time

String

Task creation time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

NOTE:

The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.

start_time

String

Task start time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

NOTE:

The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.

end_time

String

Task end time in the "yyyy-mm-ddThh:mm:ssZ" format. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, if the time zone offset is one hour, the value of Z is +0100.

NOTE:

The value is empty when the DB instance is being created. After the DB instance is created, the value is not empty.

job_status

String

Task execution status.

Value:

• Pending: The task is delayed and is not executed.
• Running: The task is being executed.
• Completed: The task is successfully executed.
• Failed: The task failed to be executed.

datastore_type

String

Database type.

target_config

Object

Instance configuration information, such as specifications.

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.