CreateSessions - Amazon DCV セッションマネージャー
パラメータのリクエストレスポンスパラメータ例

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

CreateSessions

指定された詳細で新しい Amazon DCV セッションを作成します。

パラメータのリクエスト

Name

セッションの名前。

タイプ: 文字列

必須: はい

Owner

セッション所有者の名前。これは、ターゲットの Amazon DCV サーバーの既存ユーザーの名前でなければなりません。

タイプ: 文字列

必須: はい

Type

セッションのタイプ。セッションタイプの詳細については、「Amazon DCV 管理者ガイド」の「Amazon DCV セッションの概要」を参照してください。

有効な値: CONSOLE | VIRTUAL

タイプ: 文字列

必須: はい

InitFile

Linux Amazon DCV サーバーの仮想セッションでサポートされています。Windows および Linux Amazon DCV サーバーのコンソールセッションではサポートされません。セッションを作成時に初期化するために実行する Amazon DCV サーバー上のカスタムスクリプトへのパス。このファイルパスは、agent.init_folder エージェント設定パラメータに対して指定された init ディレクトリに関連します。ファイルが指定された init ディレクトリ内にある場合は、ファイル名のみを指定します。ファイルが指定された init ディレクトリ内にない場合は、相対パスを指定します。詳細については、「Amazon DCV セッションマネージャー管理者ガイド」の「エージェント設定ファイル」を参照してください。

タイプ: 文字列

必須: いいえ

MaxConcurrents

同時 Amazon DCV クライアントの最大数。

タイプ: 整数

必須: いいえ

DcvGlEnabled

仮想セッションがハードウェアベースの OpenGL を使用するように設定されているかどうかを示します。仮想セッションでのみサポートされます。このパラメータは Windows Amazon DCV サーバーではサポートされません。

有効な値: true | false

型: ブール値

必須: いいえ

PermissionsFile

アクセス許可ファイルの Base64 エンコードコンテンツ。省略した場合、デフォルトはサーバーのデフォルトです。詳細については、「Amazon DCV 管理者ガイド」の「Amazon DCV 認可の設定」を参照してください。

タイプ: 文字列

必須: いいえ

EnqueueRequest

すぐに受理できない場合に、リクエストをキューに入れるかどうかを示します。

型: ブール値

デフォルト: false

必須: いいえ

AutorunFile

Windows Amazon DCV サーバーのコンソールセッションおよび Linux Amazon DCV サーバーの仮想セッションでサポートされています。Linux Amazon DCV サーバーのコンソールセッションではサポートされません。

セッション内で実行されるホストサーバー上のファイルへのパス。このファイルパスは、agent.autorun_folder エージェント設定パラメータに対して指定された自動実行ディレクトリに関連します。ファイルが指定された autorun ディレクトリ内にある場合は、ファイル名のみを指定します。ファイルが指定された autorun ディレクトリにない場合は、相対パスを指定します。詳細については、「Amazon DCV セッションマネージャー管理者ガイド」の「エージェント設定ファイル」を参照してください

ファイルは、指定された所有者に代わって実行されます。指定された所有者は、サーバーでファイルを実行するためのアクセス許可を持っている必要があります。Windows Amazon DCV サーバーでは、所有者がセッションにログインしたときにファイルが実行されます。Linux Amazon DCV サーバーでは、ファイルはセッションの作成時に実行されます。

タイプ: 文字列

必須: いいえ

AutorunFileArguments

Linux Amazon DCV サーバーの仮想セッションでサポートされています。Windows および Linux Amazon DCV サーバーのコンソールセッションではサポートされません。セッション内での実行時に AutorunFile に渡されるコマンドライン引数。引数は、所定の配列に表示される順序で渡されます。引数の最大許容数および各引数の最大許容長さを設定できます。詳細については、「Amazon DCV セッションマネージャー管理者ガイド」の「ブローカー設定ファイル」を参照してください。

型: 文字列の配列

必須: いいえ

DisableRetryOnFailure

何らかの理由で Amazon DCV ホストで失敗した場合にセッション作成リクエストを再試行するかどうかを示します。セッション再試行メカニズムの作成の詳細については、「Amazon DCV セッションマネージャー管理者ガイド」の「ブローカー設定ファイル」を参照してください。

型: ブール値

デフォルト: false

必須: いいえ

Requirements

セッションを配置するためにサーバーで満たされなければならない要件。この要件にはサーバータグやサーバープロパティが含まれていることがあり、サーバータグとサーバープロパティはいずれも DescribeServers API の呼び出しにより取得されます。

要件の条件式:

  • a != b a と b が等しくない場合は true

  • a = b a と b が等しい場合は true

  • a > b a が b よりも大きい場合は true

  • a >= b a が b 以上である場合は true

  • a < b a が b よりも小さい場合は true

  • a <= b a が b 以下である場合は true

  • a = b a に文字列 b が含まれている場合は true

要件のブール演算子:

  • a and b a と b が true である場合は true

  • a or b a か b が true である場合は true

  • not a a が false である場合は true

タグキーには接頭辞として tag: を付け、サーバープロパティには接頭辞として server: を付ける必要があります。要件式では括弧 () を使用できます。

要件の例:

  • tag:color = 'pink' and (server:Host.Os.Family = 'windows' or tag:color := 'red')

  • "server:Host.Aws.Ec2InstanceType := 't2' and server:Host.CpuInfo.NumberOfCpus >= 2"

"server:Host.Memory.TotalBytes > 1024E6" などの指数表現を使用して数値を指定できます。

サポートされているサーバープロパティは次のとおりです。

  • Id

  • Hostname

  • Version

  • SessionManagerAgentVersion

  • Host.Os.BuildNumber

  • Host.Os.Family

  • Host.Os.KernelVersion

  • Host.Os.Name

  • Host.Os.Version

  • Host.Memory.TotalBytes

  • Host.Memory.UsedBytes

  • Host.Swap.TotalBytes

  • Host.Swap.UsedBytes

  • Host.CpuLoadAverage.OneMinute

  • Host.CpuLoadAverage.FiveMinutes

  • Host.CpuLoadAverage.FifteenMinutes

  • Host.Aws.Ec2InstanceId

  • Host.Aws.Ec2InstanceType

  • Host.Aws.Region

  • Host.Aws.Ec2ImageId

  • Host.CpuInfo.Architecture

  • Host.CpuInfo.ModelName

  • Host.CpuInfo.NumberOfCpus

  • Host.CpuInfo.PhysicalCoresPerCpu

  • Host.CpuInfo.Vendor

タイプ: 文字列

必須: いいえ

StorageRoot

セッションストレージに使用されるフォルダのパスを指定します。Amazon DCV セッションストレージの詳細については、「Amazon DCV 管理者ガイド」の「セッションストレージの有効化」を参照してください。

タイプ: 文字列

必須: いいえ

レスポンスパラメータ

Id

セッションの一意の ID。

Name

セッション名。

Owner

セッション所有者。

Type

セッションのタイプ。

State

セッションの状態。リクエストが正常に完了すると、セッションが CREATING 状態に入ります。

Substate

セッションのサブステート。リクエストが正常に完了すると、サブステートが SESSION_PLACING サブステートに入ります。

例

Python
リクエスト

次の例では、3 つのセッションを作成します。


from swagger_client.models.create_session_request_data import CreateSessionRequestData

def get_sessions_api():
    api_instance = swagger_client.SessionsApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def create_sessions(sessions_to_create):
    create_sessions_request = list()
    for name, owner, session_type, init_file_path, autorun_file, autorun_file_arguments, max_concurrent_clients,\
            dcv_gl_enabled, permissions_file, requirements, storage_root in sessions_to_create:
        a_request = CreateSessionRequestData(
            name=name, owner=owner, type=session_type,
            init_file_path=init_file_path, autorun_file=autorun_file, autorun_file_arguments=autorun_file_arguments, max_concurrent_clients=max_concurrent_clients,
            dcv_gl_enabled=dcv_gl_enabled, permissions_file=permissions_file, requirements=requirements, storage_root=storage_root)
        create_sessions_request.append(a_request)

    api_instance = get_sessions_api()
    print('Create Sessions Request:', create_sessions_request)
    api_response = api_instance.create_sessions(body=create_sessions_request)
    print('Create Sessions Response:', api_response)

def main():
    create_sessions([
    ('session1', 'user1', 'CONSOLE', None, None, None, 1, None, '/dcv/permissions.file', "tag:os = 'windows' and server:Host.Memory.TotalBytes > 1024", "/storage/root"),
    ('session2', 'user1', 'VIRTUAL', None, 'myapp.sh', None, 1, False, None, "tag:os = 'linux'", None),
    ('session3', 'user1', 'VIRTUAL', '/dcv/script.sh', 'myapp.sh', ['argument1', 'argument2'], 1, False, None, "tag:os = 'linux'", None),
])
応答

以下は出力例です。

{
              "RequestId": "e32d0b83-25f7-41e7-8c8b-e89326ecc87f",
    "SuccessfulList": [
    {
            "Id": "78b45deb-1163-46b1-879b-7d8fcbe9d9d6",
            "Name": "session1",
            "Owner": "user1",
            "Type": "CONSOLE",
            "State": "CREATING"
    },
    {
            "Id": " a0c743c4-9ff7-43ce-b13f-0c4d55a268dd",
            "Name": "session2",
            "Owner": "user1",
            "Type": "VIRTUAL",
            "State": "CREATING"
    },
    {
            "Id": " 10311636-df90-4cd1-bcf7-474e9675b7cd",
            "Name": "session3",
            "Owner": "user1",
            "Type": "VIRTUAL",
            "State": "CREATING"
    }
    ],
    "UnsuccessfulList": [
    ]
}