メタデータサービスから返されたデータの概要
メタデータサービスを使用して、インスタンス、SSHキー、およびプレースメントグループに関する情報にアクセスします。 以下の要約には、URIパスとメタデータキーが含まれており、メタデータを説明しています。
各メタデータタイプに対するAPIの応答は、メタデータのキーと値のペアを含むJSON形式で返されます。
インスタンスのメタデータの要約
インスタンスについて返されるメタデータのタイプについては、表 1 の情報を参照して確認してください。 すべてのメタデータにアクセスするには、 インスタンスからメタデータを取得するを 参照してください。
| インスタンスの URI パス | メタデータ・キー | メタデータの説明 |
|---|---|---|
/instance |
availability_policy |
この仮想サーバー・インスタンスの可用性ポリシー。 |
/instance |
bandwidth |
仮想サーバーインスタンスのネットワークインターフェースおよび Block Storage ボリューム間で共有される、メガビット/秒単位の総帯域幅。 |
/instance |
boot_volume_attachment |
ボリューム名、CRN、ID が含まれるブート・ボリューム接続。 |
/instance |
catalog_offering |
この情報は、仮想サーバーインスタンスがプライベートカタログ内のカスタムイメージでプロビジョニングされた場合に表示されます。 |
/instance |
created_at |
仮想サーバー・インスタンスが作成された日時。 |
/instance |
crn |
この仮想サーバー・インスタンスのクラウド・リソース名。 |
/instance |
dedicated_host |
CRN、削除されたホスト、ID、名前、resource_type を含む、専用ホストのリファレンスの集まり。 |
/instance |
disks |
インスタンスのディスクのリスト。 |
/instance |
gpu |
仮想サーバー・インスタンスの GPU 構成 |
/instance |
id |
この仮想サーバー・インスタンスの固有 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 |
1 次ネットワーク・インターフェースを含む、仮想サーバー・インスタンスのネットワーク・インターフェースのリスト。 |
/instance |
placement_target |
仮想サーバー・インスタンスの配置制限。 |
/instance |
primary_network_interface |
インスタンスの 1 次ネットワーク・インターフェース。 |
/instance |
profile |
この仮想サーバー・インスタンス・プロファイルのグローバルで固有の名前。 bx2-2x8 (平衡型プロファイル) など。 |
/instance |
software_attachments |
仮想サーバーインスタンスのソフトウェアアタッチメントの一覧。 |
/instance |
startable |
仮想サーバー・インスタンスの状態が開始要求を許可するかどうかを示します。 |
/instance |
status |
インスタンスの状況: 削除中、失敗、一時停止、一時停止中、保留中、再始動中、再開中、実行中、開始中、停止、または停止中。 |
/instance |
status_reasons |
現在の状況の理由。 |
/instance |
total_network_bandwidth |
インスタンス・ネットワーク・インターフェースに排他的に割り振られる帯域幅の量 (メガビット/秒)。 |
/instance |
total_volume_bandwidth |
インスタンスのブロック・ストレージ・ボリュームに排他的に割り振られる帯域幅の量 (メガビット/秒)。 この値を大きくすると、total_network_bandwidth がそれに応じて減少します。 |
/instance |
vcpu |
count および architecture プロパティを含む構造体を通じて割り当てられる VCPU の数。 |
/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 エンコードで返される、初期設定時の管理者パスワード。 |
/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 |
ネットワーク・インターフェースの固有 ID。 |
/instance/network_interfaces/{id} |
name |
ネットワーク・インターフェースのユーザー定義名。 |
/instance/network_interfaces/{id} |
port_speed |
ネットワーク・インターフェース・ポート速度 (Mbps)。 |
/instance/network_interfaces/{id} |
primary_ipv4_address |
1 次 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 |
0個以上のソフトウェアアタッチメントオブジェクトの配列。 |
/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 |
0個以上のオブジェクトからなる配列。各オブジェクトは、仮想サーバーインスタンスにインストールされ、ライセンスが適用されたソフトウェアプログラムまたは機能を表します。 |
/instance/software_attachments/{id} |
entitlement.licensed_software[].sku |
ソフトウェアプランに関連付けられ、仮想サーバーインスタンス上で実行されている、ライセンス対象のソフトウェアプログラムまたは機能の1つの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 |
ボリューム接続の固有 ID。 |
/instance/volume_attachments/{id} |
name |
ボリューム接続のユーザー定義名。 |
/instance/volume_attachments/{id} |
status |
ボリューム接続の状況 (接続済み、接続中、削除中、または切り離し中)。 |
/instance/volume_attachments/{id} |
type |
ボリューム接続、ブート、またはデータのタイプ。 |
/instance/volume_attachments/{id} |
volume |
CRN、ID、名前、および (ボリュームが削除されている場合は) deleted 値を含む、接続されているボリューム。 |
SSH 鍵のメタデータの要約
SSH 鍵について返されるメタデータのタイプについては、表 2 の情報を参照して確認してください。
| SSH 鍵の URI パス | メタデータ・キー | メタデータの説明 |
|---|---|---|
/keys |
keys |
鍵のコレクション。 詳細は、keys/{id}を参照してください。 |
/keys/{id} |
created_at |
鍵が作成された日時。 |
/keys/{id} |
crn |
キーのクラウドリソース名。 |
/keys/{id} |
fingerprint |
キーのフィンガープリント。 値は、base64 エンコードで、先頭にハッシュ・アルゴリズム (常に SHA256) を付けて返されます。 |
/keys/{id} |
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 エンドポイントは、0個以上のソフトウェアアタッチメントオブジェクトの配列を返します。 各オブジェクトは、ソフトウェアプランに対応する、リソースコントローラに登録されたソフトウェアインスタンスを表します。
| ソフトウェアの添付ファイルの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 |
0個以上のオブジェクトからなる配列。各オブジェクトは、仮想サーバーインスタンスにインストールされ、ライセンスが適用されたソフトウェアプログラムまたは機能を表します。 |
/instance/software_attachments/{id} |
entitlement.licensed_software[].sku |
ソフトウェアプランに関連付けられ、仮想サーバーインスタンス上で実行されている、ライセンス対象のソフトウェアプログラムまたは機能の1つのSKU(在庫管理単位)。 それはソフトウェアのベンダーにとって意義深いことです。 |
/instance/software_attachments/{id} |
entitlement.licensed_software[].key (オプション) |
ソフトウェア利用権のライセンスキー。 記載がない場合は、まだライセンスを取得していないことを意味します。 |
/instance/software_attachments/{id} |
lifecycle_state |
ソフトウェア添付ファイルのライフサイクル状態。 「stable」と表示されていれば、ソフトウェアインスタンスは正常に作成されています。 |
/instance/software_attachments/{id} |
lifecycle_reasons[] |
現在の lifecycle_state の理由。 |
/instance/software_attachments/{id} |
resource_type |
リソースタイプは、 instance_software_attachment に設定されています。 |
/instance/software_attachments/{id} |
created_at |
このソフトウェアの添付ファイルが作成された日時。 |