All Products
Search
Document Center

Elastic Compute Service:ModifyInstanceMetadataOptions

Last Updated:Mar 19, 2024

Modifies the metadata of an Elastic Compute Service (ECS) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
InstanceIdstringNo

The ID of the instance.

i-bp67acfmxaz****
HttpEndpointstringYes

Specifies whether to enable the access channel for instance metadata. Valid values:

  • enabled
  • disabled

Default value: enabled.

Note For more information about instance metadata, see Overview of ECS instance metadata.
enabled
HttpTokensstringNo

Specifies whether to forcefully use the security-enhanced mode (IMDSv2) to access instance metadata. Valid values:

  • optional: does not forcefully use the security-enhanced mode (IMDSv2).
  • required: forcefully uses the security-enhanced mode (IMDSv2). After you set this parameter to required, you cannot access instance metadata in normal mode.

Default value: optional.

Note For more information about the modes of accessing instance metadata, see Access mode of instance metadata.
optional
HttpPutResponseHopLimitintegerNo
Note This parameter is in invitational preview and is not publicly available.
1
InstanceMetadataTagsstringNo
Note This parameter is in invitational preview and is not publicly available.
null

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidHttpEndpoint.NotSupportedThe 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.
400InvalidHttpTokens.NotSupportedThe 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.
400InvalidHttpPutResponseHopLimit.NotSupportedThe 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.
400InvalidInstanceMetadataTags.NotSupportedThe specified InstanceMetadataTags not supported.-
404InvalidInstanceId.NotFoundThe 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 timeSummary of changesOperation
2023-07-17The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 404