機能の概要
このAPIは、現在のプロジェクトで設定されているPrometheus監視連携リストを取得するために使用します。このAPIを呼び出すことで、OB Cloudデータベースインスタンスのテナント(Tenant)に関連付けられたすべてのPrometheus監視設定情報を取得できます。これには、テナント名、監視データストレージ設定(例：ホットストレージ/コールドストレージのサイズ、データ保持期間)、連携状態などが含まれます。これにより、すべてのデータベースインスタンスの監視連携状況を一元的に管理および確認できます。
呼び出しの説明
API制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理を参照してください。
リクエストパス
GET /api/v2/services/ListPrometheusIntegration
リクエストパラメータ
Query
項目 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| requestId | String | はい | リクエストID。追跡に使用されます | dc302d76-66b5-48d8-ab53-a035******** |
Header
項目 |
タイプ |
必須 |
説明 |
例 |
|---|---|---|---|---|
| X-Ob-Project-Id | String | はい | プロジェクトID | hxq3ztx3377nby3v87ry**** |
戻り値
項目 |
タイプ |
説明 |
例 |
|---|---|---|---|
| success | Boolean | 成功かどうか | true |
| errorCode | String | エラーコード | null |
| errorMessage | String | エラーメッセージ | null |
| data | Array | 業務データ(object) | なし |
| cost | Number | 所要時間 | 1 |
| server | String | サーバーアドレス | xxx.xxx.x.xxx:xxxx |
| requestId | String | リクエストID | dc302d76-66b5-48d8-ab53-a035******** |
| totalCount | Number | 合計 | 1 |
| extra | Object | 追加情報(object) | null |
data[]要素フィールド
名前 |
タイプ |
説明 |
サンプル値 |
|---|---|---|---|
| tenantId | String | テナントID | t4louaeei**** |
| status | String | リソースステータス | なし |
| retentionTime | Integer | 保持時間 | なし |
| hotDays | Integer | ホットストレージ日数 | なし |
| serviceType | String | アドレスタイプ | なし |
| hotStorageSize | Integer | ホットストレージサイズ | なし |
| coldStorageSize | Integer | コールドストレージサイズ | なし |
| tenantName | String | テナント名 | xxxxxx |
例
リクエスト例
curl -X GET 'https://api-cloud.oceanbase.com/api/v2/services/ListPrometheusIntegration?requestId={requestId}' \
-H 'X-Ob-Project-Id: {projectId}'
レスポンス例
JSON形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": [
{
"tenantId": "t4louaeei****",
"status": "xxxxxx",
"retentionTime": 1,
"hotDays": 1,
"serviceType": "xxxxxx",
"hotStorageSize": 1,
"coldStorageSize": 1,
"tenantName": "xxxxxx"
}
],
"cost": 1,
"server": "xxx.xxx.x.xxx:xxxx",
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"totalCount": 1,
"extra": null
}