Querying ECS Metadata Configuration

This API is used to query the metadata configuration of an ECS.

This function is only available in the LA-Sao Paulo1 region.
The ECS status (which is specified by OS-EXT-STS:vm_state) must be active, stopped, paused, or suspended.

You can debug this API in API Explorer.

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
If you are using identity policy-based authorization, the permissions listed below are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ecs:cloudServers:showMetadataOptions	read	-	g:ResourceTag/<tag-key> g:EnterpriseProjectId	-	-

GET /v1/{project_id}/cloudservers/{server_id}/metadata-options

**Table 1** Parameter description
Parameter	Mandatory	Description
project_id	Yes	Definition Specifies the project ID. For details about how to obtain the ID, see Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A
server_id	Yes	Definition Specifies the ECS ID. Constraints N/A Range N/A Default Value N/A

None.

**Table 2** Parameter description
Parameter	Mandatory	Type	Description
http_endpoint	No	String	Definition Specifies whether the IMDS service is enabled. The default value is enabled. Constraints N/A Range enabled: IMDS is enabled. disabled: IMDS is disabled. Default Value N/A
http_tokens	No	String	Definition Specifies whether the token is optional. The default value is optional. Constraints N/A Range optional: The token is optional. required: The token is required, which means IMDS v1 is disabled and IMDS v2 is enabled. Default Value N/A

Query the metadata configuration of an ECS.

GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/metadata-options

{
    "http_endpoint": "enabled",
    "http_tokens": "required"
}

Parent topic: Metadata Configuration Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.