元数据服务返回的数据摘要
使用元数据服务访问有关实例、SSH 密钥和安置组的信息。 以下摘要包含URI路径和元数据键,并描述了元数据。
每种元数据类型的 API 响应都以 JSON 格式提供,其中包含元数据“键/值”对。
实例的元数据摘要
使用表 1 中的信息来了解针对实例返回的元数据类型。 要访问所有元数据,请参阅 从实例检索元数据。
| 实例 URI 路径 | 元数据键 | 元数据的描述 |
|---|---|---|
/instance |
availability_policy |
此虚拟服务器实例的可用性策略。 |
/instance |
bandwidth |
虚拟服务器实例的网络接口和 Block Storage 卷之间共享的总带宽(单位:兆比特每秒)。 |
/instance |
boot_volume_attachment |
引导卷连接,具有卷名,CRN 和标识。 |
/instance |
catalog_offering |
此信息会在虚拟服务器实例使用私有目录中的自定义映像进行配置时显示。 |
/instance |
created_at |
虚拟服务器实例的创建日期和时间。 |
/instance |
crn |
此虚拟服务器实例的云资源名称。 |
/instance |
dedicated_host |
专用主机引用的集合,包括 CRN,已删除的主机,标识,名称和 resource_type。 |
/instance |
disks |
实例磁盘的列表。 |
/instance |
gpu |
虚拟服务器实例 GPU 配置 |
/instance |
id |
此虚拟服务器实例的唯一标识。 |
/instance |
image |
从中供应虚拟服务器实例的映像。 例如,Debian Linux 库存映像。 |
/instance |
lifecycle_reasons |
当前 lifecycle_state 的原因。 |
/instance |
lifecycle_state |
虚拟服务器实例的生命周期状态。 |
/instance |
memory |
内存量; 截断为整千兆字节。 |
/instance |
metadata_service |
指示元数据服务端点是否可用于虚拟服务器实例。 ("已启用" 状态为 true 或 false。) |
/instance |
name |
此虚拟服务器实例的用户定义的名称 (和缺省系统主机名)。 |
/instance |
network_interfaces |
虚拟服务器实例的网络接口 (包括主网络接口) 的列表。 |
/instance |
placement_target |
虚拟服务器实例的部署限制。 |
/instance |
primary_network_interface |
实例的主网络接口。 |
/instance |
profile |
此虚拟服务器实例概要文件的全局唯一名称。 例如,bx2-2x8,均衡概要文件。 |
/instance |
software_attachments |
虚拟服务器实例的软件附件列表。 |
/instance |
startable |
指示虚拟服务器实例的状态是否允许启动请求。 |
/instance |
status |
实例的状态: 正在删除,失败,已暂停,正在暂停,暂挂,正在重新启动,正在恢复,正在运行,正在启动,已停止或正在停止。 |
/instance |
status_reasons |
当前状态的原因。 |
/instance |
total_network_bandwidth |
专门分配给实例网络接口的带宽,单位为兆比特每秒。 |
/instance |
total_volume_bandwidth |
专门分配给该实例的 Block Storage 卷的带宽,单位为兆比特每秒。 增大此值将导致相应的 total_network_bandwidth 减少。 |
/instance |
vcpu |
通过包含计数和架构属性的结构分配的虚拟CPU数量。 |
/instance |
volume_attachments |
虚拟服务器实例的卷连接的列表。 |
/instance |
boot_volume_attachment |
实例的引导卷连接。 |
/instance |
volume_bandwidth_qos_mode |
此虚拟服务器实例的卷带宽 QoS 模式。 或集中或加权。 |
/instance |
vpc |
虚拟服务器实例所在的 VPC。 |
/instance |
zone |
区域的全局唯一名称。 |
/instance/initialization |
default_trusted_profile |
创建虚拟服务器实例时指定的缺省可信概要文件配置。 |
/instance/initialization |
keys |
对实例初始化时使用的公用 SSH 密钥的引用列表。 |
/instance/initialization |
password |
初始化时的管理员密码,使用加密 encryption_key,并返回 Base64-encoded。 |
/instance/initialization |
user_data |
设置新的虚拟服务器实例时可用的用户数据。 |
/instance/network_interfaces |
network_interfaces |
网络接口的列表。 详情请参阅 /instance/network_interfaces/ {id}。 |
/instance/network_interfaces/{id} |
allow_ip_spoofing |
指示此接口上是否允许源 IP 电子欺骗。 如果为 false,那么在此接口上阻止源 IP 电子欺骗。 如果为 true,那么在此接口上允许源 IP 电子欺骗。 |
/instance/network_interfaces/{id} |
created_at |
网络接口的创建日期和时间。 |
/instance/network_interfaces/{id} |
floating_ips |
对与网络接口关联的浮动 IP 地址的引用数组。 |
/instance/network_interfaces/{id} |
id |
网络接口的唯一标识。 |
/instance/network_interfaces/{id} |
name |
网络接口的用户自定义名称。 |
/instance/network_interfaces/{id} |
port_speed |
网络接口端口速度 (以 Mbps 为单位)。 |
/instance/network_interfaces/{id} |
primary_ipv4_address |
IPv4 的主要地址。 |
/instance/network_interfaces/{id} |
resource_type |
资源类型。 |
/instance/network_interfaces/{id} |
security_groups |
安全组列表。 |
/instance/network_interfaces/{id} |
status |
网络接口的状态。 |
/instance/network_interfaces/{id} |
subnet |
与该实例关联的子网。 |
/instance/network_interfaces/{id} |
type |
与实例相关的此网络接口的类型。 |
/instance/software_attachments |
software_attachments |
一个包含零个或多个软件附件对象的数组。 |
/instance/software_attachments/{id} |
id |
此软件附件的唯一标识符(UUID)。 |
/instance/software_attachments/{id} |
name |
该软件附件的名称。 该名称在与该虚拟服务器实例关联的软件附件集合中是唯一的。 |
/instance/software_attachments/{id} |
href |
该软件附件的 URL。 |
/instance/software_attachments/{id} |
catalog_offering |
一个包含代表该软件的目录产品版本 CRN 及相关软件计划 CRN 的对象。 |
/instance/software_attachments/{id} |
offering_instance |
一个表示从软件方案实例化而来的软件产品实例的对象。 包含该软件产品实例的CRN。 |
/instance/software_attachments/{id} |
entitlement |
一个表示软件产品实例许可权限的对象。 在成功调用许可证管理器获取授权后,该属性将动态填充。 |
/instance/software_attachments/{id} |
entitlement.licensed_software |
一个包含零个或多个对象的数组,每个对象代表虚拟服务器实例中已安装且已授权的软件程序或功能。 |
/instance/software_attachments/{id} |
entitlement.licensed_software[].sku |
与软件计划相关、并在虚拟服务器实例上运行的某款可授权软件程序或功能的 SKU(库存单位)。 |
/instance/software_attachments/{id} |
entitlement.licensed_software[].key |
该软件授权的许可证密钥。 该属性的值可能会随时间变化。 |
/instance/software_attachments/{id} |
lifecycle_state |
软件附件的生命周期状态,用于指示该附件是否已完成且可供使用。 |
/instance/software_attachments/{id} |
lifecycle_reasons |
导致当前生命周期状态的一系列原因。 |
/instance/software_attachments/{id} |
resource_type |
资源类型。 将其设置为 instance_software_attachment。 |
/instance/software_attachments/{id} |
created_at |
此软件附件的创建日期和时间。 |
/instance/volume_attachments/{id} |
bandwidth |
该卷连接到此实例时的最大带宽(单位:兆比特每秒)。 根据实例的配置不同,该值可能小于卷带宽。 |
/instance/volume_attachments/{id} |
created_at |
该卷被挂载的日期和时间。 |
/instance/volume_attachments/{id} |
delete_volume_on_instance_delete |
如果设置为 true,那么在删除实例时,也会删除该卷。 |
/instance/volume_attachments/{id} |
device |
有关如何向实例操作系统公开卷的信息。 |
/instance/volume_attachments/{id} |
id |
卷连接的唯一标识。 |
/instance/volume_attachments/{id} |
name |
卷连接的用户定义的名称。 |
/instance/volume_attachments/{id} |
status |
卷连接的状态: 已连接,正在连接,正在删除或正在拆离。 |
/instance/volume_attachments/{id} |
type |
卷连接,引导或数据的类型。 |
/instance/volume_attachments/{id} |
volume |
删除卷时连接的卷,其中包含 CRN,标识,名称和 deleted 值。 |
SSH 密钥的元数据摘要
使用表 2 中的信息来了解针对 SSH 密钥返回的元数据类型。
| SSH 密钥 URI 路径 | 元数据键 | 元数据的描述 |
|---|---|---|
/keys |
keys |
密钥的集合。 请参阅 keys/{id} 以了解详细信息。 |
/keys/{id} |
created_at |
密钥的创建日期和时间。 |
/keys/{id} |
crn |
密钥的云资源名称。 |
/keys/{id} |
fingerprint |
密钥的指纹。 该值以哈希算法(始终为 SHA256 )为前缀返回 Base64-encoded。 |
/keys/{id} |
id |
该密钥的唯一标识符。 |
/keys/{id} |
length |
密钥的长度 (以位计)。 |
/keys/{id} |
name |
密钥的用户定义的唯一名称。 如果未指定,那么名称是随机选择的单词的连字符列表 (例如,elderly-mountain-troop-opponent)。 |
/keys/{id} |
public_key |
公用 SSH 密钥。 |
/keys/{id} |
type |
该密钥所使用的加密系统。 |
布置组的元数据摘要
使用表 3 中的信息来了解为放置组返回的元数据类型。
| 布置组 URI 路径 | 元数据键 | 元数据的描述 |
|---|---|---|
/placement_groups |
placement_groups |
布置组的集合。 请参阅 placement_groups/{id} 以了解详细信息。 |
/placement_groups/{id} |
created_at |
该分组创建的日期和时间。 |
/placement_groups/{id} |
crn |
放置组的云资源名称。 |
/placement_groups/{id} |
id |
该投放组的唯一标识符。 |
/placement_groups/{id} |
lifecycle_state |
放置组的生命周期状态。 |
/placement_groups/{id} |
name |
放置组的用户定义的名称。 |
/placement_groups/{id} |
resource_type |
资源类型。 |
/placement_groups/{id} |
strategy |
该安置组的策略。 |
软件附件元数据摘要
请参考下表中的信息,了解软件附件返回的元数据类型。
/metadata/v1/instance/software_attachments 端点返回一个包含零个或多个软件附件对象的数组。 每个对象代表一个由资源控制器注册的、与某个软件计划相对应的软件实例。
| 软件附件的 URI 路径 | 元数据键 | 元数据的描述 |
|---|---|---|
/instance/software_attachments/{id} |
id |
该软件附件的唯一 UUID。 |
/instance/software_attachments/{id} |
name |
在与虚拟服务器实例关联的软件附件集合中,该名称是唯一的。 该名称默认设置为系统生成的随机值,所有者随后可根据需要进行更新。 请注意,更新虚拟服务器实例软件附件中的名称不会影响所附加的启动卷的名称,也不会影响已从该卷创建的任何快照。 |
/instance/software_attachments/{id} |
href |
该软件附件的 URL。 |
/instance/software_attachments/{id} |
catalog_offering |
一个对象,其值与该实例中同名的对象相同,其中包含代表该软件的目录产品版本 CRN 及相关软件计划 CRN。 |
/instance/software_attachments/{id} |
offering_instance |
一个表示从软件方案实例化而来的软件产品实例的对象。 |
/instance/software_attachments/{id} |
offering_instance.crn |
该软件提供实例 CRN。 |
/instance/software_attachments/{id} |
entitlement(可选) |
一个表示软件产品实例许可权限的对象。 如果未指定,则该软件方案未关联任何许可证。 |
/instance/software_attachments/{id} |
entitlement.licensed_software |
一个包含零个或多个对象的数组,每个对象代表虚拟服务器实例中已安装且已授权的软件程序或功能。 |
/instance/software_attachments/{id} |
entitlement.licensed_software[].sku |
与软件计划相关、并在虚拟服务器实例上运行的某款可授权软件程序或功能的 SKU(库存单位)。 这对软件供应商来说意义重大。 |
/instance/software_attachments/{id} |
entitlement.licensed_software[].key(可选) |
该软件授权的许可证密钥。 如果未显示,则表示尚未获得该许可证。 |
/instance/software_attachments/{id} |
lifecycle_state |
软件附件的生命周期状态。 如果显示“稳定”,则说明软件实例已成功创建。 |
/instance/software_attachments/{id} |
lifecycle_reasons[] |
当前 lifecycle_state 的原因。 |
/instance/software_attachments/{id} |
resource_type |
资源类型,设置为 instance_software_attachment。 |
/instance/software_attachments/{id} |
created_at |
此软件附件的创建日期和时间。 |