Modifies the metadata of an Elastic Compute Service (ECS) instance. When you call this operation, you can specify parameters, such as InstanceID and HttpEndpoint, in the request.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:ModifyInstanceMetadataOptions | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
| InstanceId | string | No | The ID of the instance. | i-bp67acfmxaz**** |
| HttpEndpoint | string | Yes | Specifies whether to enable the access channel for instance metadata. Valid values:
Default value: enabled. Note
For information about instance metadata, see Obtain instance metadata.
| enabled |
| HttpTokens | string | No | Specifies whether to forcefully use the security hardening mode (IMDSv2) to access instance metadata. Valid values:
Default value: optional. Note
For more information about modes of accessing instance metadata, see Obtain instance metadata.
| optional |
| HttpPutResponseHopLimit | integer | No | Note
This parameter is not publicly available.
| 1 |
| InstanceMetadataTags | string | No | Note
This parameter is in invitational preview and is not publicly available.
| null |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidHttpEndpoint.NotSupported | The specified HttpEndpoint not supported, you can use enabled(default) or disabled. | The specified HttpEndpoint parameter is invalid. The valid values of this parameter are enabled and disabled. The default value is enabled. |
| 400 | InvalidHttpTokens.NotSupported | The specified HttpTokens not supported, you can use optional(default) or required. | The specified HttpTokens parameter is invalid. The valid values of this parameter are optional and required. The default value is optional. |
| 400 | InvalidHttpPutResponseHopLimit.NotSupported | The specified HttpPutResponseHopLimit not supported, more than 1 and less than 64 is reasonable. | The specified HttpPutResponseHopLimit parameter is invalid. The valid values of this parameter are 1 to 64. |
| 400 | InvalidInstanceMetadataTags.NotSupported | The specified InstanceMetadataTags not supported. | - |
| 404 | InvalidInstanceId.NotFound | The specified InstanceId is not found. | The specified instance ID does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-07-17 | The Error code has changed | View Change Details |