All Products
Search
Document Center

Elastic Compute Service:ModifyInstanceMetadataOptions

更新時間:Nov 22, 2024

Modifies the metadata access configurations of instances in a specific region, including whether to enable the metadata access channel and whether to forcefully use the security hardening mode to access instance metadata.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:ModifyInstanceMetadataOptionsupdate
*Instance
acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
    none
none

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 information about instance metadata, see Obtain instance metadata.
enabled
HttpTokensstringNo

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

  • optional: does not forcefully use the security hardening mode (IMDSv2).
  • required: forcefully uses the security hardening 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 modes of accessing instance metadata, see Obtain instance metadata.
optional
HttpPutResponseHopLimitintegerNo
Note This parameter 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 changedView Change Details