# 通过元数据获取ECS基本信息 #### 操作场景 弹性云服务器元数据是在ECS操作系统内可本地访问的特殊API，包含了弹性云服务器在云平台的基本信息，例如云服务器ID、主机名、网络信息等。通过ECS元数据，您可以在ECS内部实现基本的信息交互，可以更便捷、更安全地配置管理ECS的操作系统和应用。元数据通常用于ECS初始化时使能用户下发的配置，以及业务运行过程中获取的ECS业务信息。 弹性云服务器元数据支持：Openstack类型、兼容EC2类型、华为云类型，如[表1]所示。 对于支持的元数据类型，本节详细介绍了其URI和使用方法。 #### 使用须知 如果元数据中包含了敏感数据，您应当采取适当的措施来保护敏感数据，比如限制访问范围、加密等。 防火墙配置示例如下所示： - Windows 如果您不希望管理员之外的用户访问实例自定义数据，请以管理员身份开启防火墙后，在PowerShell 中执行下面的命令，阻止非管理员用户访问实例自定义数据： **PS C:\\\>$RejectPrincipal = New-Object -TypeName System.Security.Principal.NTAccount ("Everyone")** **PS C:\\\>$RejectPrincipalSID = $RejectPrincipal.Translate(\[System.Security.Principal.SecurityIdentifier\]).Value** **PS C:\\\>$ExceptPrincipal = New-Object -TypeName System.Security.Principal.NTAccount ("Administrator")** **PS C:\\\>$ExceptPrincipalSID = $ExceptPrincipal.Translate(\[System.Security.Principal.SecurityIdentifier\]).Value** **PS C:\\\>$PrincipalSDDL = "O:LSD:(D;;CC;;;$ExceptPrincipalSID)(A;;CC;;;$RejectPrincipalSID)"** **PS C:\\\>New-NetFirewallRule -DisplayName "Reject metadata service for $($RejectPrincipal.Value), exception: $($ExceptPrincipal.Value)" -Action block -Direction out -Protocol TCP -RemoteAddress 169.254.169.254 -LocalUser $PrincipalSDDL** - Linux 如果您不希望root之外的用户访问自定义实例自定义数据，请以root用户权限执行下面的命令，阻止非root用户访问自定义实例自定义数据： **iptables --append OUTPUT --proto tcp --destination 169.254.169.254 --match owner ! --uid-owner root --jump REJECT** #### 弹性云服务器元数据类别支持列表 [表1]中不包含兼容EC2类型的ami-id、ami-launch-index、ami-manifest-path、block-device-mapping、instance-action、instance-id、reservation-id、ramdisk-id、kernel-id元数据项，以上元数据项均无实际含义，不建议使用。 表1弹性云服务器元数据类别支持列表 | 元数据类型 | 实例元数据项 | 约束说明 | |:---|:---|:---| | OpenStack类型 | /openstack/latest/meta_data.json | 查询弹性云服务器的元数据信息。 元数据的关键字段请参见[表2]。 | | OpenStack类型 | /openstack/latest/password | 查询弹性云服务器的密码。 Windows系统使用keypairs创建弹性云服务器初始化时cloudbase-init用于保存密文密码。 | | OpenStack类型 | /openstack/latest/user_data | 查询弹性云服务器的自定义数据。 用户根据需要自行指定脚本和配置文件用于弹性云服务器初始化，用户自定义数据会由cloud-init/cloudbase-init等软件读取并解析处理，详细操作请参考[通过实例自定义数据配置ECS实例](https://support.huaweicloud.com/usermanual-ecs/zh-cn_topic_0032380449.html)。 若Linux系统云服务器采用密码方式创建，则保存注入密码的脚本。 | | OpenStack类型 | /openstack/latest/network_data.json | 查询弹性云服务器的网络信息。 | | OpenStack类型 | /openstack/latest/securitykey | 获取临时的AK、SK。 对弹性云服务器获取临时的AK、SK，需要在IAM上对op_svc_ecs账户进行委托授权，并对相应的弹性云服务器资源进行授权委托管理。 说明： 委托的授权权限由用户自行设置，建议根据实际业务需要进行最小化授权。 ECS服务本身不会使用委托对资源进行操作。 | | OpenStack类型 | /openstack/latest/spot/instance-action | 查询竞价实例关机提示。 | | 兼容EC2类型 | /latest/meta-data/hostname | 查询弹性云服务器的主机名称。 请参考以下链接为弹性云服务器去掉后缀.novalocal: [弹性云服务器的主机名带后缀.novalocal](https://support.huaweicloud.com/ecs_faq/ecs_faq_0604.html) | | 兼容EC2类型 | /latest/meta-data/local-hostname | 该字段含义同hostname一致。 | | 兼容EC2类型 | /latest/meta-data/public-hostname | 该字段含义同hostname一致。 | | 兼容EC2类型 | /latest/meta-data/instance-type | 查询弹性云服务器的规格名称。 | | 兼容EC2类型 | /latest/meta-data/local-ipv4 | 查询弹性云服务器的固定IP地址。 多网卡情况下，只显示主网卡的地址。 | | 兼容EC2类型 | /latest/meta-data/placement/availability-zone | 查询弹性云服务器的AZ信息。 | | 兼容EC2类型 | /latest/meta-data/public-ipv4 | 查询弹性云服务器的弹性公网IP地址。 多网卡情况下，只显示主网卡的弹性公网IP地址。 | | 兼容EC2类型 | /latest/meta-data/public-keys/0/openssh-key | 查询弹性云服务器的公钥。 | | 兼容EC2类型 | /latest/user-data | 查询弹性云服务器的自定义数据。与OpenStack类型的user-data场景相同。 | | 兼容EC2类型 | /latest/meta-data/security-groups | 查询弹性云服务器所使用的安全组名称。 | | 华为云元数据类型 | /meta-data/latest/instance-identity/document | 查询弹性云服务器的实例身份文档。 | | 华为云元数据类型 | /meta-data/latest/instance-identity/signature | 查询弹性云服务器的实例身份文档签名。 支持传入自定义audience参数，用于防止签名被非法冒用。 | 表2metadata关键字段 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | uuid | String | 弹性云服务器的ID。 | | availability_zone | String | 弹性云服务器所在可用区。 | | meta | Dict | 元数据信息，包括镜像名称、镜像ID、VPC ID等信息。 | | hostname | String | 弹性云服务器主机名。 请参考以下链接为弹性云服务器去掉后缀.novalocal: [弹性云服务器的主机名带后缀.novalocal](https://support.huaweicloud.com/ecs_faq/ecs_faq_0604.html) | | enterprise_project_id | String | 查询弹性云服务器的企业项目ID信息。 | #### 前提条件 - 已登录弹性云服务器。 - 请确保安全组出方向规则满足如下要求，否则访问元数据请求失败： - 协议：TCP - 端口范围：80 - 目的地址：169.254.0.0/16 ![](https://support.huaweicloud.com/usermanual-ecs/public_sys-resources/note_3.0-zh-cn.png) 如果您使用的是默认安全组出方向规则，则已经包括了如上要求，可以正常访问元数据。默认安全组出方向规则请参见[默认安全组和规则](https://support.huaweicloud.com/usermanual-ecs/ecs_03_0603.html)。 #### Metadata（OpenStack元数据API） 用于查询弹性云服务器的元数据。 - URI /169.254.169.254/openstack/latest/meta_data.json - 方法 支持GET请求。 - 示例： Linux操作系统：以使用CURL工具为例，介绍查询弹性云服务器元数据的方法。 **curl http://169.254.169.254/openstack/latest/meta_data.json** Windows操作系统：以使用Invoke-RestMethod工具为例，介绍查询弹性云服务器元数据的方法。 **Invoke-RestMethod http://169.254.169.254/openstack/latest/meta_data.json \| ConvertTo-Json** ``` { "random_seed": "rEocCViRS+dNwlYdGIxJHUp+00poeUsAdBFkbPbYQTmpNwpoEb43k9z+96TyrekNKS+iLYDdRNy4kKGoNPEVBCc05Hg1TcDblAPfJwgJS1okqEtlcofUhKmL3K0fto+5KXEDU3GNuGwyZXjdVb9HQWU+E1jztAJjjqsahnU+g/tawABTVySLBKlAT8fMGax1mTGgArucn/WzDcy19DGioKPE7F8ILtSQ4Ww3VClK5VYB/h0x+4r7IVHrPmYX/bi1Yhm3Dc4rRYNaTjdOV5gUOsbO3oAeQkmKwQ/NO0N8qw5Ya4l8ZUW4tMav4mOsRySOOB35v0bvaJc6p+50DTbWNeX5A2MLiEhTP3vsPrmvk4LRF7CLz2J2TGIM14OoVBw7LARwmv9cz532zHki/c8tlhRzLmOTXh/wL36zFW10DeuReUGmxth7IGNmRMQKV6+miI78jm/KMPpgAdK3vwYF/GcelOFJD2HghMUUCeMbwYnvijLTejuBpwhJMNiHA/NvlEsxJDxqBCoss/Jfe+yCmUFyxovJ+L8oNkTzkmtCNzw3Ra0hiKchGhqK3BIeToV/kVx5DdF081xrEA+qyoM6CVyfJtEoz1zlRRyoo9bJ65Eg6JJd8dj1UCVsDqRY1pIjgzE/Mzsw6AaaCVhaMJL7u7YMVdyKzA6z65Xtvujz0Vo=", "uuid": "ca9e8b7c-f2be-4b6d-a639-f10b4d994d04", "availability_zone": "lt-test-1c", "enterprise_project_id" : "0", "hostname": "ecs-ddd4.novalocal", "launch_index": 0, "instance_type": "s3.medium.2", "meta": { "metering.image_id": "3a64bd37-955e-40cd-ab9e-129db56bc05d", "metering.imagetype": "gold", "metering.resourcespeccode": "s3.medium.2.linux", "admin_pass": "", "metering.cloudServiceType": "hws.service.type.ec2", "image_name": "CentOS 7.6 64bit", "metering.resourcetype": "1", "vpc_id": "3b6c201f-aeb3-4bce-b841-64756e66cb49", "os_bit": "64", "cascaded.instance_extrainfo": "pcibridge:1", "os_type": "Linux", "charging_mode": "0" "__support_agent_list": "hss,ces" }, "region_id": "xxx", "project_id": "6e8b0c94265645f39c5abbe63c4113c6", "name": "ecs-ddd4" } ``` #### User data（OpenStack元数据API） 用于查询弹性云服务器的自定义数据。该值仅在创建弹性云服务器时指定，不支持修改。 - URI /169.254.169.254/openstack/latest/user_data - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/openstack/latest/user_data** Windows操作系统： **Invoke-RestMethod** **http://169.254.169.254/openstack/latest/user_data** ``` #!/bin/bash echo "Hello, the time is now $(date -R)" | tee /root/output.txt ``` ![](https://support.huaweicloud.com/usermanual-ecs/public_sys-resources/note_3.0-zh-cn.png) 如果创建弹性云服务器时未注入自定义数据，此时，该接口的查询结果是404，如[图1]所示。 图1404 Not Found ![](https://support.huaweicloud.com/usermanual-ecs/zh-cn_image_0166755236.png "点击放大") #### Network data（OpenStack元数据API） 查询弹性云服务器的网络信息，支持查询云服务器挂载的全部网卡的信息，包括网卡所在子网的DNS地址、网络带宽、网卡ID、网卡私有IP地址、网卡弹性公网IP地址、网卡的MAC地址。 - URI /openstack/latest/network_data.json - 方法 支持GET请求 - 示例 ![](https://support.huaweicloud.com/usermanual-ecs/public_sys-resources/note_3.0-zh-cn.png) instance_max_bandwidth、instance_min_bandwidth的单位是Mbps，如果取值为-1，说明对带宽大小无限制。 Linux操作系统： **curl http://169.254.169.254/openstack/**latest**/network_data.json** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/openstack/latest/network_data.json \| ConvertTo-Json** ``` { "services": [{ "type": "dns", "address": "xxx.xx.x.x" }, { "type": "dns", "address": "100.125.21.250" }], "qos":{ "instance_min_bandwidth": 100, "instance_max_bandwidth": 500 }, "networks": [{ "network_id": "67dc10ce-441f-4592-9a80-cc709f6436e7", "type": "ipv4_dhcp", "link": "tap68a9272d-71", "id": "network0" }], "links": [{ "vif_id": "68a9272d-7152-4ae7-a138-3ef53af669e7", "public_ipv4": "100.100.xx.xx", "ethernet_mac_address": "fa:16:3e:f7:c1:47", "mtu": null, "local_ipv4": "192.169.10.10", "type": "cascading", "id": "tap68a9272d-71" }] } ``` #### Security Key（OpenStack元数据API） 获取临时的AK、SK。 您如果需要在弹性云服务器获取临时的AK、SK，需要在IAM对弹性云服务器进行云服务委托授权，并在相应的弹性云服务器的详情页面"管理信息 \> 委托"栏目中添加委托。 详细操作，请参见[在ECS上通过委托的临时访问密钥访问其他云服务](https://support.huaweicloud.com/bestpractice-iam/iam_0511.html)。 由于凭证泄露会导致安全风险，需要严格控制委托的配置范围： - 当业务不需要获取临时凭证时，不配置实例委托。 - 当业务有获取临时凭证的诉求时，遵循权限最小化原则，对委托只配置必要的权限。 ![](https://support.huaweicloud.com/usermanual-ecs/public_sys-resources/note_3.0-zh-cn.png) - 临时的AK、SK有效期24个小时。临时的AK、SK过期时间的响应参数为UTC时间格式，北京时间为UTC+8小时。建议您根据业务需要，在过期时间到期前重新获取AK、SK。 - 使用临时AK、SK时，需要在消息的header中增加'X-Security-Token':{securitytoken}。其中，securitytoken就是调用接口返回的值。 - URI /openstack/latest/securitykey - 方法 支持GET请求 - 示例 Linux操作系统： **curl http://169.254.169.254/openstack/**latest**/securitykey** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/openstack/latest/securitykey** #### Instance Action（OpenStack元数据API） 用于查询竞价实例关机提示。 ![](https://support.huaweicloud.com/usermanual-ecs/public_sys-resources/note_3.0-zh-cn.png) 如果您的竞价实例即将被中断，该接口会返回预计关机的时间。 - URI /openstack/latest/spot/instance-action - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/openstack/latest/spot/instance-action** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/openstack/latest/spot/instance-action** ``` {"action":"terminate","timestamp":"2023-06-01 09:15:00"} ``` #### User data（EC2-兼容的API） 用于查询弹性云服务器的自定义。该值仅在创建弹性云服务器时指定，不支持修改。 - URI /169.254.169.254/latest/user-data - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/latest/user-data** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/latest/user-data** ``` #!/bin/bash echo "Hello, the time is now $(date -R)" | tee /root/output.txt ``` #### Hostname（EC2-兼容的API） 用于查询弹性云服务器的主机名称，后面会追加.novalocal后缀。 - URI /169.254.169.254/latest/meta-data/hostname - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/latest/meta-data/hostname** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/latest/meta-data/hostname** ``` vm-test.novalocal ``` #### Instance Type（EC2-兼容的API） 用于查询弹性云服务器的规格名称。 - URI /169.254.169.254/latest/meta-data/instance-type - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/latest/meta-data/instance-type** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/latest/meta-data/instance-type** ``` s3.medium.2 ``` #### Local IPv4（EC2-兼容的API） 用于查询弹性云服务器的固定IP地址。多网卡情况下，只显示主网卡的地址。 - URI /169.254.169.254/latest/meta-data/local-ipv4 - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/latest/meta-data/local-ipv4** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/latest/meta-data/local-ipv4** ``` 192.1.1.2 ``` #### Availability Zone（EC2-兼容的API） 用于查询弹性云服务器的AZ信息。 - URI /169.254.169.254/latest/meta-data/placement/availability-zone - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/latest/meta-data/placement/availability-zone** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/latest/meta-data/placement/availability-zone** ``` az1.dc1 ``` #### Public IPv4（EC2-兼容的API） 用于查询弹性云服务器的弹性公网IP地址。多网卡情况下，只显示主网卡的弹性公网IP地址。 - URI /169.254.169.254/latest/meta-data/public-ipv4 - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/latest/meta-data/public-ipv4** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/latest/meta-data/public-ipv4** ``` 46.1.1.2 ``` #### Public Keys（EC2-兼容的API） 用于查询弹性云服务器的公钥。 - URI /169.254.169.254/latest/meta-data/public-keys/0/openssh-key - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/latest/meta-data/public-keys/0/openssh-key** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/latest/meta-data/public-keys/0/openssh-key** ``` ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDI5Fw5k8Fgzajn1zJwLoV3+wMP+6CyvsSiIc/hioggSnYu/AD0Yqm8vVO0kWlun1rFbdO+QUZKyVr/OPUjQSw4SRh4qsTKf/+eFoWTjplFvd1WCBZzS/WRenxIwR00KkczHSJro763+wYcwKieb4eKRxaQoQvoFgVjLBULXAjH4eKoKTVNtMXAvPP9aMy2SLgsJNtMb9ArfziAiblQynq7UIfLnN3VclzPeiWrqtzjyOp6CPUXnL0lVPTvbLe8sUteBsJZwlL6K4i+Y0lf3ryqnmQgC21yW4Dzu+kwk8FVT2MgWkCwiZd8gQ/+uJzrJFyMfUOBIklOBfuUENIJUhAB Generated-by-Nova ``` #### ECS实例身份文档（华为云元数据类型的API） 用于查询弹性云服务器的实例身份文档。 - URI /169.254.169.254/meta-data/latest/instance-identity/document - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/meta-data/latest/instance-identity/document** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/meta-data/latest/instance-identity/document** ``` {"architecture":"x86_64","availability_zone":"az1","created_at":"2025-06-05 07:20:58.580117+0:00","domain_id":"808000042306xxxxxx","flavor":"c7.large.2","hypervisor":"kvm","id":"d776bea4-b128-4f36-b521-9bf625xxxxxx","image_id":"bfccced4-909b-497a-ba85-efebd85df6a1","private_ipv4":"192.168.1.101","project_id":"c592fc8cad84600ab6d3aa62xxxxxx","region":"region1"} ``` #### ECS实例身份文档签名（华为云元数据类型的API） 用于查询弹性云服务器的实例身份文档签名。 - URI /169.254.169.254/meta-data/latest/instance-identity/signature?audience=xxxxx ![](https://support.huaweicloud.com/usermanual-ecs/public_sys-resources/note_3.0-zh-cn.png) ?audience=xxxxx非必填，具体说明，请参见[验证实例身份文档签名](https://support.huaweicloud.com/usermanual-ecs/ecs_03_2166.html)。 - 方法 支持GET请求。 - 示例 Linux操作系统： **curl http://169.254.169.254/meta-data/latest/instance-identity/signature** Windows操作系统： **Invoke-RestMethod http://169.254.169.254/meta-data/latest/instance-identity/signature** ``` MIILBgYJKoZIhvcNAQcCoIIK9zCCCuMCAQExDzANBg1ghkgBZQMEAgEFADCCAZQGCSqGSIb3DQEHAaCCAYUEggGBeyJhcmNoaXR1Y3R1cmUi0iJ40DZfNjQiLCJhdmFpbGFiaWxpdH1fem9uZSI6ImNuLXudXRodZUzdCByZSIsImNyZMFØZWRfYXQi0iIyMD1LTAZLTA1IDA30jIuOjU4LjUAMDEXNysuMDouMCIsImRvbWFpbI9pZCI6IjgwODAuMDAuNDIzMDYuMDAuMDAiLCJmbGFZ63Ii0iJjNy5sYXIn2S4yIiwiaHIuZXIZaXNvciI6Imt2bSIsImlkIjoiZDc3NmUIYTQtYJEyOC88ZjM2LWI1MJEtOWImYz11MtzBjOWM3Iiwiaw1hZ2UfawQi0iJiMZZjYZUKNCMD1iLTQSNZEtYmEANS11ZMU…………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………… +ra8oU3snPL1miTU5Pt85WXn7dMHXEa7Eh++T5HCIk+jnREx+nXDtD/CdfnJsRLUkHiRIKkhbKMZXYMa6Yo5NIvF99GIpWjJMSdNouGHuBIFEJkPH7i4So3ZsItIzbZFuUP39DYaYf02IESrD4viDC96LBAhØX1IE/oOLUuzu/darNdHDMU617tn+CHOYNBEP+LkCthWKOC+OBDLdmEAZSXAUTXDKOXT86tk1MwØkmbxos+2ufec5gFNLN7iUTahFomsZKA1rIxOØoSuSdrZISiAZat9C3TACiKxDU4tACYzb3R+SuMx7CJNCbeY8XudXeoWCR18ebsHTk6aiMGbpo9T7Xbbve5AuukkufaocR406LhaZBnSNc6jyT9us1faZRFiU35ØUo3b+UØnBDArQFsFGfaCi6MeLEak1YDAabzWCiURGSLihZWTLiaJXKWUnbUULRhGT1m8wloi11Z1E9EZ+9ZbR4FLInsoPXo1hobmtfPCukfJYsnxucUoguCJsCuN9sxZH9L7WeTJo9T ``` #### 相关链接 [Linux操作系统云服务器无法获取元数据怎么办？](https://support.huaweicloud.com/ecs_faq/ecs_faq_1321.html)