ModifyInstanceClockOptions-阿里云帮助中心

Operation description

When you call this operation, take note of the following items:

This operation is asynchronous. After you call this operation, an asynchronous task ID is returned. You can query the asynchronous task result to check whether the task is completed.
To modify PtpStatus, the instance type must support this parameter. For more information about supported instance types, call the DescribeInstanceTypes operation to query the instance type list.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:ModifyInstanceClockOptions

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The idempotency parameter.	123e4567-e89b-12d3-a456-426655440000
RegionId	string	Yes	The region ID of the ECS instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
InstanceId	string	Yes	The instance ID.	i-bp67acfmxazb4ph****
PtpStatus	string	No	The PTP status. Valid values: enabled: Enables PTP. disabled: Disables PTP. Default value: disabled.	enabled
DryRun	boolean	No	Specifies whether to perform only a dry run. Valid values: true: sends a check request without querying resource status. The check items include whether the AccessKey pair is valid, the authorization of the Resource Access Management (RAM) user, and whether required parameters are specified. If the check fails, the corresponding error is returned. If the check passes, the `DryRunOperation` error code is returned. false: sends a Normal request. If the request passes the check, a 2xx HTTP status code is returned and the resource status is directly queried. Default value: false.	false

Response elements

Element	Type	Description	Example
	object	The response information.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TaskId	string	The modification task ID. You can call the DescribeTasks operation to query the modification result.	t-bp1hvgwromzv32iq****

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TaskId": "t-bp1hvgwromzv32iq****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidInstanceId.NotFound	The specified instanceId does not exist.	The specified instance does not exist.
400	InvalidParameter.ClientToken	The parameter ClientToken is invalid.	The specified parameter ClientToken is invalid.
400	InvalidParameter.PtpStatus	The specified parameter PtpStatus: %s is not valid.	The specified parameter PtpStatus: %s is not valid.
400	InvalidInstanceType.NotSupportEnablePtp	The specified instance type does not support enable PTP.	The specified instance type does not support enable PTP.
403	Abs.InvalidRegionId.MalFormed	The specified parameter RegionId is not valid.	The specified parameter RegionId is illegal.
403	InvalidOperation.PtpStatusAlreadyEnabled	The specified instance already has PTP enabled.	The specified instance already has PTP enabled.
403	InvalidOperation.PtpStatusAlreadyDisabled	The specified instance does not have PTP enabled.	The specified instance does not have PTP enabled.
403	OperationDenied.HardwareNotSupportEnablePtp	The hardware of the instance does not support enable PTP.	The hardware of the specified instance does not support enabling PTP. Shut down and enable PTP before starting the instance.
403	OperationDenied.ClockPtpNoStock	The resource of PTP is out of usage.	The resource of PTP is out of usage.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.