仮想サーバー情報取得処理

オペレーション名

仮想サーバー情報取得

機能概要

接続先の全仮想サーバーの情報を取得します。

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

変数の使用については、「変数」を参照してください。

基本設定

項目名	必須/省略可	変数の使用	説明	備考
名前	必須	使用不可	スクリプトキャンバス上での名前を入力します。

必須設定

項目名	必須/省略可	変数の使用	説明	備考
接続先	必須	使用不可	グローバルリソースを選択します。 [追加]: 新規にグローバルリソースを追加します。 [一覧の編集]: 「リソース一覧の編集」画面にて、グローバルリソースの設定を編集することができます。

項目名	必須/省略可	変数の使用	説明	備考
コメント	省略可	使用不可	このアダプタの簡単な説明を記述することができます。説明を記述すると、仕様書に反映させることができます。

スキーマ

入力スキーマ

ありません。

出力スキーマ

<?xml version="1.0"?>
<instances>
  <instance
    instanceId=""
    instanceState=""
    name=""
    displayName=""
    account=""
    cpuNumber=""
    cpuSpeed=""
    cpuUsed=""
    created=""
    domain=""
    domainId=""
    forVirtualNetwork=""
    group=""
    groupId=""
    guestOsId=""
    haenable=""
    hostId=""
    hostName=""
    hypervisor=""
    ipAddress=""
    isoDisplayText=""
    isoId=""
    jobId=""
    jobStatus=""
    memory=""
    networkKbsRead=""
    networkKbsWrite=""
    password=""
    passwordEnabled=""
    rootDeviceId=""
    rootDeviceType=""
    serviceOfferingId=""
    serviceOfferingName=""
    templateDisplayText=""
    templateId=""
    templateName=""
    zoneId=""
    zoneName="">
    <nics>
      <nic
        id=""
        broadcastUri=""
        gateway=""
        ipAddress=""
        isDefault=""
        isolationUri=""
        macAddress=""
        netmask=""
        networkId=""
        trafficType=""
        type=""/>
    </nics>
    <securityGroups>
      <securityGroup
        id=""
        account=""
        description=""
        domain=""
        domainId=""
        jobId=""
        jobStatus=""
        name="">
        <ingressRules>
          <ingressRule
            account=""
            cidr=""
            endPort=""
            icmpCode=""
            icmpType=""
            protocol=""
            ruleId=""
            securityGroupName=""
            startPort=""/>
        </ingressRules>
      </securityGroup>
    </securityGroups>
  </instance>
</instances>

要素名	属性名	説明
instances	-
instance	-	作成している仮想サーバーごとに出現します。
	instanceId	仮想サーバーのidを出力します。
	instanceState	仮想サーバーの状態を出力します。 [Running]:仮想サーバーが起動している状態です。 [Starting]:仮想サーバーが起動処理を行っている状態です。 [Stopped]:仮想サーバーが停止している状態です。 [Stopping]:仮想サーバーが停止処理を行っている状態です。 [Destroyed]:仮想サーバーが削除されている状態です。
	name	仮想サーバーの名前を出力します。
	displayName	仮想サーバーの表示名を出力します。
	account	仮想サーバーに関連付けられたアカウントを出力します。
	cpuNumber	仮想サーバーで実行されているCPUの数を出力します。
	cpuSpeed	仮想サーバーのCPUの速度を出力します。
	cpuUsed	仮想サーバーが使用されているVMのCPU使用量を出力します。
	created	仮想サーバーが作成された日時を出力します。
	domain	仮想サーバーが存在するドメインの名前を出力します。
	domainId	仮想サーバーが存在するドメインのidを出力します。
	forVirtualNetwork	仮想サーバーのサービスオファリングのための仮想ネットワークを出力します。
	group	仮想サーバーのグループ名を出力します。
	groupId	仮想サーバーのグループidを出力します。
	guestOsId	仮想サーバーのOSのidを出力します。
	haenable	高可用性が有効になっているかを出力します。 [true]:有効 [false]:無効
	hostId	仮想サーバーのホストidを出力します。
	hostName	仮想サーバーのホスト名を出力します。
	hypervisor	テンプレートが実行されるハイパーバイザを出力します。
	ipAddress	仮想サーバーのIPアドレスを出力します。
	isoDisplayText	仮想サーバーに接続されているISOの表示テキストを出力します。
	isoId	仮想サーバーに接続されているISOのidを出力します。
	jobId	現在保留中の非同期ジョブIDを出力します。
	jobStatus	現在保留中の非同期ジョブステータスを出力します。
	memory	仮想サーバーに割り当てられたメモリを出力します。
	networkKbsRead	仮想サーバーのVMに着信するネットワークトラフィックを出力します。
	networkKbsWrite	仮想サーバーのホスト上から発信されたネットワークトラフィックを出力します。
	password	仮想サーバーのパスワードが存在する場合出力します。
	passwordEnabled	仮想サーバーのパスワード機能が有効になっているかを出力します。 [true]:有効 [false]:無効
	rootDeviceId	仮想サーバーのルートボリュームのデバイスidを出力します。
	rootDeviceType	仮想サーバーのルートボリュームのデバイスタイプを出力します。
	serviceOfferingId	仮想サーバーのサービスオファリングのidを出力します。
	serviceOfferingName	仮想サーバーのサービスオファリングの名前を出力します。
	templateDisplayText	テンプレートの表示テキストを出力します。
	templateId	仮想サーバーのテンプレートのidを出力します。ISOファイルから作成された場合は-1を出力します。
	templateName	仮想サーバーのテンプレートの名前を出力します。
	zoneId	仮想サーバーが使用しているゾーンのidを出力します。
	zoneName	仮想サーバーが使用しているゾーンの名前を出力します。
nics	-
nic	-	仮想サーバに設定されたNICごとに出力します。
	id	NICのidを出力します。
	broadcastUri	NICのブロードキャストURIを出力します。
	gateway	NICのゲートウェイを出力します。
	ipAddress	NICのIPアドレスを出力します。
	isDefault	デフォルトのNICかどうかを出力します。 [true]:デフォルトであることを表します。 [false]:デフォルトではないことを表します。
	isolationUri	NICの分離URIを出力します。
	macAddress	NICのMACアドレスを出力します。
	netmask	NICのサブネットマスクを出力します。
	networkId	対応するネットワークのidを出力します。
	trafficType	NICのトラフィックタイプを出力します。
	type	NICのタイプを出力します。
securityGroups	-
securityGroup	-	仮想サーバに設定されたsecurityGroupごとに出力します。
	id	securityGroupのidを出力します。
	account	securityGroupを所有しているアカウントを出力します。
	description	securityGroupの説明を出力します。
	domain	securityGroupのドメイン名を出力します。
	domainId	securityGroupのdomainIdを出力します。
	jobId	現在保留中の非同期ジョブIDを出力します。
	jobStatus	現在保留中の非同期ジョブステータスを出力します。
	name	securityGroupの名前を出力します。
ingressRules	-
ingressRule	-	仮想サーバのsecurityGroupに設定されたingressRuleごとに出力します。
	account	ingressRuleを所有するアカウントを出力します。
	cidr	ingressRuleのベースIPアドレスのCIDR表記を出力します。
	endPort	ingressRuleの終了IPを出力します。
	icmpCode	ICMPメッセージ応答のコードを出力します。
	icmpType	ICMPメッセージ応答のタイプを出力します。
	protocol	ingressRuleのプロトコルを出力します。
	ruleId	ingressRuleのidを出力します。
	securityGroupName	securityGroupの名前を出力します。
	startPort	ingressRuleの開始IPを出力します。

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応していません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名	説明	備考
message_category	エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。	デフォルト値はnullです。
message_code	エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。	デフォルト値はnullです。
message_level	エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。	デフォルト値はnullです。
error_type	エラー発生時、発生したエラーの種類が格納されます。	デフォルト値はnullです。エラーの種類は、以下のような形式となります。例:「java.io.FileNotFoundException」 DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_message	エラー発生時、発生したエラーのメッセージが格納されます。	デフォルト値はnullです。 DataSpider Servistaのバージョンにより、格納される内容が変わる可能性があります。
error_trace	エラー発生時、発生したエラーのトレース情報が格納されます。	デフォルト値はnullです。 DataSpider Servistaのバージョンや実行するクライアントアプリケーションにより、格納される内容が変わる可能性があります。

仕様制限

ありません。

主な例外

例外名	原因	対策
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[]	[接続先]が指定されていません。	[接続先]を指定してください。
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>]	[接続先]で選択されたリソース定義が見つかりません。	[接続先]で指定したグローバルリソースを確認してください。
InvalidPropertyConfigurationException <プロパティ名>が設定されていません。	[<プロパティ名>]が設定されていません。	[<プロパティ名>]を設定してください。
InvalidPropertyConfigurationException タイムアウトは0より大きくなければなりません。	[接続先]で指定したグローバルリソースの[タイムアウト]に0以下の数値が入力されています。	[接続先]で指定したグローバルリソースの[タイムアウト]に0より大きい数値を入力してください。
InvalidPropertyConfigurationException タイムアウトには整数または変数を入力してください。	[接続先]で指定したグローバルリソースの[タイムアウト]に数値以外の値が入力されています。	[接続先]で指定したグローバルリソースの[タイムアウト]に数値を入力してください。
NttcomCloudnClientException Code=401, Message=unable to verify user credentials and/or request signature	[接続先]で指定したグローバルリソースの[APIキー]または[秘密鍵]に誤りがあります。	[接続先]で指定したグローバルリソースの設定を確認してください。
NttcomCloudnTimeoutException org.apache.http.conn.ConnectTimeoutException: Connect to <ホスト> timed out	ホストに接続中にタイムアウトが発生しました。	ネットワークの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。
NttcomCloudnTimeoutException java.net.SocketTimeoutException: Read timed out	ホストに接続後、ホストからの応答までにタイムアウトが発生しました。	ホストの状態を確認してください。または、[接続先]で指定したグローバルリソースの[タイムアウト]を確認してください。

注意事項

Cloudnと本アダプタとの通信は、HTTPSを使用します。

Cloudnのトラブル・メンテナンス情報については、サービス提供元の情報を参照してください。

サービスの仕様により、出力スキーマで定義している一部の内容の値が出力されない場合があります。

仮想サーバー情報取得処理

オペレーション名

機能概要

データモデル

プロパティ

基本設定

必須設定

コメント

スキーマ

入力スキーマ

出力スキーマ

Mapperでのスキーマ読み込み

大容量データ処理

PSPでの使用について

使用できるコンポーネント変数

仕様制限

主な例外

注意事項