Overview
This API is used to delete a configured Prometheus monitoring integration. You can call this API when you no longer need to monitor an OceanBase Cloud database instance or when you need to clean up old monitoring configurations. After the operation succeeds, the system stops collecting monitoring metrics for that database instance from the specified Prometheus data source.
API details
Constraints
The caller must have an AccessKey for accessing the multi-cloud API. For information about how to obtain the AccessKey ID and AccessKey secret, see Manage AccessKeys.
Request path
POST /api/v2/services/DeletePrometheusIntegration
Request parameters
Query
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| requestId | String | Yes | Request ID, used for tracking | dc302d76-66b5-48d8-ab53-a035******** |
Header
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| X-Ob-Project-Id | String | Yes | Project ID | hxq3ztx3377nby3v87ry**** |
Body
Name |
Type |
Required |
Description |
Example value |
|---|---|---|---|---|
| integrationId | String | Yes | Delete Prometheus Integration | xxxxxx |
Response parameters
Name |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Success | true |
| errorCode | String | Error Code | null |
| errorMessage | String | Error message | null |
| data | Boolean | Business data (object) | None |
| cost | Number | Time consumed | 1 |
| server | String | Server Address | xxx.xxx.x.xxx:xxxx |
| requestId | String | Request ID | dc302d76-66b5-48d8-ab53-a035******** |
| totalCount | Number | Total | 1 |
| extra | Object | Additional Information (object) | null |
Examples
Request example
curl -X POST \
'https://api.example.com/api/v2/services/DeletePrometheusIntegration?requestId=dc302d76-66b5-48d8-ab53-a035********' \
-H 'X-Ob-Project-Id: hxq3ztx3377nby3v87ry****' \
-H 'Content-Type: application/json' \
-d '{
"integrationId": "xxxxxx"
}'
Response example
JSON format
{
"success": true,
"errorCode": null,
"errorMessage": null,
"data": true,
"cost": 1,
"server": "xxx.xxx.x.xxx:xxxx",
"requestId": "dc302d76-66b5-48d8-ab53-a035********",
"totalCount": 1,
"extra": null
}