注意
このAPIは廃止されました。関連情報の照会については、DescribeMetricsData - 監視メトリクスデータの照会をご参照ください。
機能の概要
このAPIは、指定されたOceanBaseテナントのメトリクス情報を照会するために使用されます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法については、詳細はアクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/instances/{instanceId}/tenants/{tenantId}/metrics
リクエストパラメータ
Path
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| instanceId | string | はい | OB CloudクラウドデータベースインスタンスID。 | obcluster-***** |
| tenantId | string | はい | テナントID。 | t4louaeei**** |
Query
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| requestId | string | いいえ | リクエストID。追跡に使用されます。 | dc302d76-66b5-48d8-ab53-a035******** |
Body
名前 |
型 |
必須 |
説明 |
サンプル値 |
|---|---|---|---|---|
| startTime | string | はい | 監視データの開始時間です。この時間はUTC時刻のみをサポートし、形式はYYYY-MM-DDThh:mm:ssZです。 | 2021-06-13T15:40:43Z |
| endTime | string | はい | モニタリングデータの終了時刻です。この時間はUTC時間のみをサポートし、形式はYYYY-MM-DDThh:mm:ssZです。 | 2021-09-13T15:40:43Z |
| metrics | array[string] | はい | 指標名のリストです。 | ["total_sessions_tenant"] |
| tenantIdList | array[string] | いいえ | テナントIDのリストです。 | ["t4tx6u5tc****"] |
| nodeIdList | array[string] | いいえ | ノードIDのリストです。 | ["i-0104c6fb57e6e****"] |
| UID | string | いいえ | ユーザー識別子です。 | - |
| User_ID | string | いいえ | ユーザーIDです。 | - |
| requestId | string | いいえ | リクエストIDです。 | dc302d76-66b5-48d8-ab53-a035******** |
| callerType | string | いいえ | 呼び出し元のタイプです。 | - |
| accessKeyId | string | いいえ | アクセスキーIDです。 | - |
| securityToken | string | いいえ | セキュリティトークンです。 | - |
| callerUid | string | いいえ | 呼び出し元のUIDです。 | - |
| callerBid | string | いいえ | 呼び出し元のBIDです。 | - |
| stsTokenCallerUid | string | いいえ | STSトークン呼び出し元のUIDです。 | - |
| stsTokenCallerBid | string | いいえ | STSトークン呼び出し元のBIDです。 | - |
| acceptLanguage | string | いいえ | 対応言語です。 | - |
| pageNumber | integer | いいえ | ページ番号です。 | 1 |
| pageSize | integer | いいえ | 1ページあたりの件数です。 | 10 |
| mergedCallerBid | string | いいえ | 合併された呼び出し元のBIDです。 | - |
戻り値
名前 |
型 |
説明 |
サンプル値 |
|---|---|---|---|
| data | object | リクエストの戻り結果です。 | - |
| RequestId | string | リクエストIDです。 | EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C |
dataの例
"data":[
{
"nodeId":"ins-122dhae",
"ip":"xx.xxx.xxx.xx",
"metrics":[
{
"total_sessions_tenant":0,
"timestamp":1687640160
},
{
"total_sessions_tenant":1,
"timestamp":1687661700
},
{
"total_sessions_tenant":1,
"timestamp":1687661760
}
]
}
]
例
リクエスト例
curl --digest -u '<Your AK:SK>' \
--request POST \
--url 'https://api-cloud.oceanbase.com/api/v2/instances/{instanceId}/tenants/{tenantId}/metrics?requestId={requestId}' \
-H 'Content-Type: application/json' \
-H 'X-Ob-Project-Id: <Project ID>' \
--data '{"startTime":"2023-06-19T05:32:56Z","endTime":"2023-06-19T06:32:56Z","metrics":["total_sessions_tenant"]}'
説明
- プロジェクトIDはプロジェクトの一意の識別子です。プロジェクト管理を参照して、クラスタのプロジェクトIDを取得できます。
- instanceIdが属するプロジェクトのIDと指定されたプロジェクトIDが一致していることを確認してください。
レスポンス例
JSON形式
{
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"data": [
{
"tenantName": "obmt4tpqx195803k",
"tenantId": "obmt4tpqx195803k",
"obTenantId": "obmt4tpqx195803k",
"metrics": [
{
"total_sessions_tenant": 0,
"timestamp": 1687640160
},
{
"total_sessions_tenant": 1,
"timestamp": 1687661700
},
{
"total_sessions_tenant": 1,
"timestamp": 1687661760
}
]
}
]
}