機能の概要
このAPIは、過去のイベント情報を照会するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
GET /api/v2/operationEvents
リクエストパラメータ
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| resourceIdOrName | string | いいえ | リソースIDまたはリソース名 | ob6******** |
| callerUids | array | いいえ | 呼び出し元uidのリスト | ["200006001454"] |
| eventTypes | array | いいえ | ["INSTANCE_MANAGEMENT"] | |
| eventOperations | array | いいえ | イベント操作のリスト | ["DeleteInstance"] |
| startTime | string | いいえ | 開始時間、UTC文字列 | 2024-12-20T09:29:57Z |
| endTime | string | いいえ | 終了時間、UTC文字列 | 2025-03-20T09:29:57Z |
| eventStatus | string | いいえ | イベントの状態 | SUCCESS |
| sortField | string | いいえ | ソートフィールド | FINISHED_TIME |
| sortOrder | string | いいえ | ソート規則 | DESCEND |
| pageNumber | int | いいえ | ページネーションのインデックス | 1 |
| pageSize | int | いいえ | ページネーションのサイズ | 10 |
| queryKey | string | いいえ | クエリ条件 | ob6******** |
| uid | string | いいえ | プライマリアカウントID、プロジェクト所有者ID | 200006001454 |
戻り結果
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | リクエストの実行結果 | ||
| datalist | リクエストの実行結果 | ||
| resourceType | enum | リソースタイプ:
|
CLUSTER |
| currentLanguageResourceType | string | 現在の言語におけるリソースタイプ | クラスタ |
| resourceId | string | リソースID | ******** |
| instanceId | string | インスタンスID。リソースタイプがテナントの場合、該当するテナントのインスタンスIDを返します。 | ******** |
| clusterRole | enum | クラスタロール。リソースタイプがクラスタの場合に表示されます。
|
NORMA |
| isExist | boolean | リソースが存在するかどうか:
|
false |
| resourceName | string | リソース名 | ******** |
| eventType | string | イベントタイプ | INSTANCE_MANAGEMENT |
| currentLanguageEventType | string | 現在の言語におけるイベントタイプの説明 | インスタンス管理 |
| eventDescription | string | イベント操作 | DeleteInstance |
| currentLanguageEventDescription | string | 現在の言語におけるイベント操作の説明 | インスタンスの削除 |
| eventSource | enum | イベントの出所:
|
SYSTEM |
| eventStatus | enum | イベントの状態:
|
SUCCESS |
| resultCode | int | 結果コード | 0 |
| resultMessage | string | 結果情報 | |
| uid | string | プライマリアカウントID | ******** |
| callerUid | string | 呼び出し元ID | 200006001454 |
| phoneNumber | string | 携帯電話番号またはメールアドレス | obc***@oceanbase.com |
| projectMemberName | string | プロジェクトメンバー名 | obc***@oceanbase.com |
| requestId | string | リクエストID | _** |
| params | string | リクエストパラメータ | |
| gmtCreate | long | 作成日時(GMT) | ******** |
| gmtModified | long | 変更日時(GMT) | ******** |
| createTime | string | 作成日時 | 2025-03-20T02:58:49Z |
| finishedTime | string | 完了日時 | 2025-03-20T02:58:49Z |
| projectId | string | プロジェクトID | ******** |
| requestId | string | リクエストID | 71f8acbe-e009-4a88-b417-8cbaf1b8ac3d |
| success | boolean | リクエストの実行状況 | true |
例
リクエスト例
curl --digest -u 'ak:sk' \
--request GET \
--url https://api-cloud.oceanbase.com/api/v2/operationEvents
-H 'X-Ob-Project-Id: <プロジェクトID>'
-G -d 'startTime=xx' -d 'endTime=xxx'
レスポンス例
JSON形式
{
"data":{
"dataList":[
{
"callerUid":"200006001454",
"clusterRole":"NORMAL",
"createTime":"2025-03-20T02:58:49Z",
"currentLanguageEventDescription":"インスタンスの削除",
"currentLanguageEventType":"インスタンス管理",
"currentLanguageResourceType":"クラスタ",
"eventDescription":"DeleteInstance",
"eventSource":"SYSTEM",
"eventStatus":"SUCCESS",
"eventType":"INSTANCE_MANAGEMENT",
"finishedTime":"2025-03-20T02:58:49Z",
"gmtCreate":*********,
"gmtModified":*********,
"isExist":false,
"params":"",
"phoneNumber":"obc***@oceanbase.com",
"projectId":"*************",
"projectMemberName":"obc***@oceanbase.com",
"requestId":"*******_*********",
"resourceId":"**********",
"resourceName":"**********",
"resourceType":"CLUSTER",
"resultCode":0,
"resultMessage":"",
"uid":"*********"
}
],
"total":275
},
"requestId":"71f8acbe-e009-4a88-b417-8cbaf1b8ac3d",
"success":true
}