Overview
This API is used to query the list of configured Prometheus monitoring integrations in the current project. By calling this API, you can obtain the Prometheus monitoring configuration information for all tenants associated with OceanBase Cloud database instances, including the tenant name, monitoring data storage configuration (such as hot storage/cold storage size and data retention period), and integration status. This helps you centrally manage and view the monitoring integration status of all database instances.
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
GET /api/v2/services/ListPrometheusIntegration
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**** |
Response parameters
Name |
Type |
Description |
Example value |
|---|---|---|---|
| success | Boolean | Success | true |
| errorCode | String | Error Code | null |
| errorMessage | String | Error message | null |
| data | Array | 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 |
data[] Element Fields
Name |
Type |
Description |
Example value |
|---|---|---|---|
| tenantId | String | Tenant ID | t4louaeei**** |
| status | String | Resource Status | None |
| retentionTime | Integer | Retention time | None |
| hotDays | Integer | Hot days | None |
| serviceType | String | Address type | None |
| hotStorageSize | Integer | Hot storage size | None |
| coldStorageSize | Integer | Cold storage size | None |
| tenantName | String | Tenant Name | xxxxxx |
Examples
Request example
curl -X GET 'https://api.example.com/api/v2/services/ListPrometheusIntegration?requestId={requestId}' \
-H 'X-Ob-Project-Id: {projectId}'
Response example
JSON format
{
"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
}