Class Gs2WatchClient
-
GS2\Core\AbstractGs2Client
-
GS2\Watch\Gs2WatchClient
Methods summary
public
|
#
__construct( string $region, GS2\Core\Gs2Credentials $credentials, array $options = [] )
コンストラクタ
Parameters
- $region
- リージョン名
- $credentials
- 認証情報
- $options
- オプション
|
public
array
|
#
describeAlerm( string $pageToken = NULL, integer $limit = NULL )
アラームリストを取得
Parameters
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- alermId => アラームID
- ownerId => オーナーID
- name => アラーム名
- description => 説明文
- service => 監視対象サービス
- serviceId => 監視対象サービスID
- operation => 監視対象オペレーション
- expression => 演算子
- threshold => 閾値
- notificationId => 通知ID
- createAt => 作成日時
- updateAt => 更新日時
- status => ステータス
- lastStatusChangeAt => 最終ステータス更新日時
- nextPageToken => 次ページトークン
|
public
array
|
#
createAlerm( array $request )
アラームを作成
Parameters
- $request
- name => アラーム名
- description => 説明文
- service => 監視対象サービス
- serviceId => 監視対象サービスID
- operation => 監視対象オペレーション
- expression => 演算子(>=, >, <, <=)
- threshold => 閾値
- notificationId => 通知ID
Returns
array
- item
- alermId => アラームID
- ownerId => オーナーID
- name => アラーム名
- description => 説明文
- service => 監視対象サービス
- serviceId => 監視対象サービスID
- operation => 監視対象オペレーション
- expression => 演算子
- threshold => 閾値
- notificationId => 通知ID
- createAt => 作成日時
- updateAt => 更新日時
- status => ステータス
- lastStatusChangeAt => 最終ステータス更新日時
|
public
array
|
#
getAlerm( array $request )
アラームを取得
Parameters
Returns
array
- item
- alermId => アラームID
- ownerId => オーナーID
- name => アラーム名
- description => 説明文
- service => 監視対象サービス
- serviceId => 監視対象サービスID
- operation => 監視対象オペレーション
- expression => 演算子
- threshold => 閾値
- notificationId => 通知ID
- createAt => 作成日時
- updateAt => 更新日時
- status => ステータス
- lastStatusChangeAt => 最終ステータス更新日時
|
public
array
|
#
updateAlerm( array $request )
アラームを更新
Parameters
- $request
- alermName => アラーム名
- description => 説明文
- expression => 演算子(>=, >, <, <=)
- threshold => 閾値
- notificationId => 通知ID
Returns
array
- item
- alermId => アラームID
- ownerId => オーナーID
- name => アラーム名
- description => 説明文
- service => 監視対象サービス
- serviceId => 監視対象サービスID
- operation => 監視対象オペレーション
- expression => 演算子
- threshold => 閾値
- notificationId => 通知ID
- createAt => 作成日時
- updateAt => 更新日時
- status => ステータス
- lastStatusChangeAt => 最終ステータス更新日時
|
public
|
|
public
array
|
#
describeAlermEvent( array $request, string $pageToken = NULL, integer $limit = NULL )
アラームイベントリストを取得
過去にアラームが発生した履歴などを確認できます。
アラームイベントリストを取得
過去にアラームが発生した履歴などを確認できます。
Parameters
- $request
- $pageToken
- ページトークン
- $limit
- 取得件数
Returns
array
- items
- array
- eventId => アラームイベントID
- alermId => アラームID
- type => イベントの種類
- eventAt => イベント発生日時
- nextPageToken => 次ページトークン
|
public
array
|
#
describeService( )
サービス名リストを取得
アラームを設定する際に指定できるサービスの一覧を取得できます。
サービス名リストを取得
アラームを設定する際に指定できるサービスの一覧を取得できます。
Returns
array サービス名リスト
|
public
array
|
#
describeOperation( array $request )
オペレーション名リストを取得
アラームを設定する際に指定できるオペレーションの一覧を取得できます。
オペレーション名リストを取得
アラームを設定する際に指定できるオペレーションの一覧を取得できます。
Parameters
Returns
array オペレーション名リスト
|
public
array
|
#
getMetric( array $request )
メトリクスを取得
過去のサービスの利用状況を取得します。
メトリクスを取得
過去のサービスの利用状況を取得します。
Parameters
- $request
- serviceId => サービスID
- operation => オペレーション名
- begin => メトリクス取得開始日時(unixepoch)
- end => メトリクス取得終了日時(unixepoch)
- allowLongTerm => 7日以上の期間のデータを取得することを許可するか(OPTIONAL)
- serviceId => サービスID
Returns
array
- items
- array
- timestamp => タイムスタンプ(YYYY-MM-DD HH:mm:SS)
- value => 値
|