Obtaining Scheduled Tasks

project_id

Yes

String

Definition:

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Constraints:

N/A

Range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

N/A

offset

No

String

Definition:

Index offset. The query starts from the next piece of data indexed by this parameter.

Constraints:

The value must be an integer and cannot be a negative number.

Range:

≥ 0

Default value:

0

limit

No

String

Definition:

Number of records to be queried.

Constraints:

The value must be an integer and cannot be a negative number.

Range:

1–100

Default value:

100

status

No

String

Definition:

Task execution status.

Constraints:

N/A

Range:

• 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.

• Unauthorized: The task is to be authorized.

• Canceled: The task is canceled.

Default value:

N/A

start_time

No

String

Definition:

Start time.

Constraints:

The format is yyyy-mm-ddThh:mm:ssZ. 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.

Range:

N/A

Default value:

N/A

end_time

No

String

Definition:

End time.

Constraints:

The format is yyyy-mm-ddThh:mm:ssZ. 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.

Range:

N/A

Default value:

N/A

job_id

No

String

Definition:

Job ID.

Constraints:

N/A

Range:

N/A

Default value:

N/A

job_name

No

String

Definition:

Task scheduling type.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Auth-Token

Yes

String

Definition:

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints:

N/A

Range:

N/A

Default value:

N/A

X-Language

No

String

Definition:

Request language type.

Constraints:

N/A

Range:

• en-us

• zh-cn

Default value:

en-us

schedules

Array of ScheduleTask objects

Definition:

Task details.

total_count

Integer

Definition:

Total number of records.

Range:

N/A

job_id

String

Definition:

Job ID.

Range:

N/A

instance_id

String

Definition:

Instance ID, which is compliant with the UUID format.

Range:

The value can contain 36 characters with a suffix of in07. Only letters and digits are allowed.

instance_name

String

Definition:

Instance name.

Range:

Instance name corresponding to the instance ID

instance_status

String

Definition:

Instance status.

Range:

• createfail: An instance failed to be created.

• creating: An instance is being created.

• normal: An instance is normal.

• abnormal: An instance is abnormal.

• deleted: An instance has been deleted.

project_id

String

Definition:

Project ID of a tenant in a region.

Range:

ID of the project the instance belongs to.

job_name

String

Definition:

Task name.

Range:

• CreateGaussDBforMySQLInstance: creating a DB instance

• RestoreGaussDBforMySQLNewInstance: restoring data to a new DB instance

• AddGaussDBforMySQLNodes: adding nodes

• DeleteGaussDBforMySQLNode: deleting nodes

• 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 primary

• GaussDBforMySQLBindEIP: binding an EIP

• GaussDBforMySQLUnbindEIP: unbinding an EIP

• RenameGaussDBforMySQLInstance: changing a DB instance name

• DeleteGaussDBforMySQLInstance: deleting a DB instance

• UpgradeGaussDBforMySQLDatabaseVersion: upgrading an instance version

• EnlargeGaussDBforMySQLProxy: adding nodes to a proxy instance

• OpenGaussDBforMySQLProxy: enabling database proxy

• CloseGaussDBforMySQLProxy: disabling database proxy

• GaussdbforMySQLModifyProxyIp: changing a proxy address

• 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 proxy nodes

create_time

String

Definition:

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.

Range:

N/A

start_time

String

Definition:

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.

Range:

N/A

end_time

String

Definition:

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.

Range:

N/A

job_status

String

Definition:

Task execution status.

Range:

• 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.

• Unauthorized: The task is to be authorized.

• Canceled: The task is canceled.

datastore_type

String

Definition:

Database type.

Range:

N/A

target_config

Object

Definition:

Instance configuration information, such as specifications.

Range:

N/A

error_code

String

Error code.

error_msg

String

Error message.

error_code

String

Error code.

error_msg

String

Error message.