Executing Customized Scripts

script_uuid

Yes

String

Definition:

Script UUID.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

X-Auth-Token

Yes

String

Definition:

Tenant token.

Constraints:

Tenant token obtained from IAM.

Value range:

N/A.

Default value:

N/A.

X-Language

No

String

Definition:

Internationalization tag. zh-cn indicates Chinese, and en-us or no value indicates English.

Constraints:

zh-cn indicates Chinese, and en-us or no value indicates English.

Value range:

zh-cn and en-us

Default value:

N/A.

x-project-id

No

String

Definition:

The project ID.

Constraints:

Project ID corresponding to the region.

Value range:

N/A.

Default value:

N/A.

x-user-profile

No

String

Definition:

IAM 5.0 user information.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

execute_param

Yes

ScriptExecuteParam object

Definition:

Script execution parameter.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

execute_batches

Yes

Array of ExecuteInstancesBatchInfo objects

Definition:

Batch information of the target instance

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

resourceful

No

Boolean

Definition:

This parameter has been discarded and does not take effect when it is transferred.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

timeout

Yes

Integer

Definition:

Timeout.

Constraints:

The unit is second. The value range is 5 < timeout < 1800.

Value range:

N/A.

Default value:

N/A.

success_rate

Yes

Double

Definition:

Success rate.

Constraints:

A value with one decimal place is supported.

Value range:

1–100

Default value:

N/A.

execute_user

Yes

String

Definition:

User who executes the script. The script must be executed by user root.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

script_params

No

Array of ScriptExecuteInputParam objects

Definition:

Script input parameters.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

param_name

Yes

String

Definition:

Name of a script input parameter. The parameter name must be unique in the same script.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

param_value

Yes

String

Definition:

Value of the script input parameter, which is mandatory by default. This parameter can be left empty when there are referenced parameters (param_refer is not empty).

Constraints:

The parameter value contains 1 to 4096 characters.

The value can contain uppercase letters, lowercase letters, digits, and special characters (_-/.*?:",=+@#[{]}).

Consecutive periods (.) are not allowed.

Value range:

N/A.

Default value:

N/A.

param_order

No

Integer

Definition:

This parameter has been discarded and does not take effect when it is configured.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

param_refer

No

ScriptExecuteParamReference object

Definition:

Parameter reference.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

refer_type

Yes

String

Definition:

Parameter reference type: PARAM_STORE

Constraints:

N/A

Value range:

• PARAM_STORE: Parameter center reference.

Default value:

N/A

param_id

Yes

String

Definition:

Unique primary key ID of a referenced parameter.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

param_version

No

String

Definition:

Version of the reference parameter.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

batch_index

Yes

Integer

Definition:

Batch index, starting from 1.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

target_instances

Yes

Array of ExecuteResourceInstance objects

Definition:

Target nodes.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

rotation_strategy

Yes

String

Definition:

Policy for determining whether to pause or continue an execution

Constraints:

• CONTINUE: Continue a task.

• PAUSE: Pause the task.

Value range:

• CONTINUE: Continue a task.

• PAUSE: Pause the task.

Default value:

N/A

resource_id

Yes

String

Definition:

ECS ID.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

region_id

Yes

String

Definition:

Region to which the server belongs.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

provider

No

String

Definition:

Resource provider: ECS. If this parameter is not specified, the default value ECS is used. Ensure that the provider of each instance is the same. CCE instances will be supported later.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

type

No

String

Definition:

Resource type of the resource provider. If this parameter is not specified, CLOUDSERVER is used by default.

CLOUDSERVER: Cloud server type.

Constraints:

Cross-type support is not allowed.

Value range:

• CLOUDSERVER: Cloud server type.

Default value:

N/A

custom_attributes

No

Array of Customttribute objects

Definition:

Custom attributes in the key_value format. A maximum of five attributes can be customized.

Constraints:

The length of the key is 10.

The length of the value is 20.

The maximum length of the map is 5.

Do not enter sensitive data.

Value range:

N/A.

Default value:

N/A.

agent_sn

No

String

Definition:

This parameter has been discarded and does not take effect when it is configured.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

project_id

No

String

Definition:

This parameter has been discarded and does not take effect when it is configured.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

key

Yes

String

Definition:

Key of a custom attribute.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

value

Yes

String

Definition:

Value of a custom attribute.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

data

String

Definition:

Execution UUID.

Value range:

N/A.

error_code

String

Definition:

Error code.

Value range:

See the error code section.

error_msg

String

Definition:

Error description.

Value range:

See the error code section.

200

Request result is returned.

For more status codes, see Status Codes.

204

The contained error information is returned.

For more status codes, see Status Codes.