機能の概要
指定されたOB Cloudデータベースインスタンスに対してPrometheus監視の統合を作成します。この操作では、Prometheusの取得ターゲットを設定するための構成ファイルが生成され、返されます。これにより、インスタンスのモニタリングメトリクスをお客様のPrometheus監視システムに接続できます。作成が成功すると、返された構成ファイルの内容を使用して、Prometheusの設定を更新できます。
呼び出しの説明
インターフェース制約
呼び出し元はマルチクラウドAPIにアクセスするためのキーを保有している必要があります。AccessKey IDとAccessKey Secretの取得方法の詳細については、アクセスキーの管理をご参照ください。
リクエストパス
POST /api/v2/services/CreatePrometheusIntegration
リクエストパラメータ
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 | Object | Prometheus Integration Dto | なし |
| data.integrationId | String | Delete Prometheus Integration | xxxxxx |
| data.prometheusConfig | String | Prometheus Config | なし |
| data.createdAt | String | Prometheus Integration Create Time | なし |
| 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 |
例
リクエスト例
curl -X POST \
'https://api.example.com/api/v2/services/CreatePrometheusIntegration?requestId=dc302d76-66b5-48d8-ab53-a035********' \
-H 'X-Ob-Project-Id: hxq3ztx3377nby3v87ry****' \
-H 'Content-Type: application/json' \
-d '{
"instanceId": "obcloud-xxxxxxxx",
"region": "cn-hangzhou"
}'
レスポンス例
JSON 形式
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": {
"integrationId": "xxxxxx",
"prometheusConfig": "xxxxxx",
"createdAt": "xxxxxx"
},
"cost": 1,
"server": "xxx.xxx.x.xxx:xxxx",
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"totalCount": 1,
"extra": null
}