describe-instance-health

Description

指定したロードバランサーに設定されている、サーバーのヘルスチェック結果を取得します。ヘルスチェックは、API「ConfigureHealthCheck」で設定します。

ロードバランサーを指定するためには、ロードバランサー名が必要です。

またサーバーを指定するためには、サーバー名が必要です。自分が所有していないサーバーを指定する場合は、「ニフクラID.サーバー名」の形式で指定する必要があります。サーバーを指定しない場合は、指定したロードバランサーに設定されているすべてのサーバーを対象として、ヘルスチェック結果を取得します。

See also: NIFCLOUD API Documentation

Synopsis

  describe-instance-health
--instance-port <value>
[--instances <value>]
--load-balancer-name <value>
--load-balancer-port <value>
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--instance-port (integer)

--instances (list) (structure)

InstanceId -> (string)

Shorthand Syntax:

InstanceId=string ...

JSON Syntax:

[
  {
    "InstanceId": "string"
  }
  ...
]

--load-balancer-name (string)

--load-balancer-port (integer)

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json

  • text

  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on

  • off

  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

DescribeInstanceHealthResult -> (structure)

InstanceStates -> (list)

(structure)

Description -> (string)

InstanceId -> (string)

InstanceUniqueId -> (string)

ReasonCode -> (string)

State -> (string)

ResponseMetadata -> (structure)

RequestId -> (string)