All Products
Search
Document Center

Managed Service for Prometheus:AddPrometheusGlobalViewByAliClusterIds

Last Updated:Aug 30, 2024

Creates a global aggregation instance in Prometheus Service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
arms:AddPrometheusGlobalViewByAliClusterIdsnone
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
GroupNamestringYes

The name of the global aggregation instance.

zyGlobalView
ProductCodestringNo

The identifier to identify the service if custom dashboards are created for the specified clusters.

adcp
ClusterIdsstringYes

The IDs of clusters. Separate multiple IDs with commas (,).

cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4

Response parameters

ParameterTypeDescriptionExample
object
Dataobject

The struct returned.

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Msgstring

The additional information.

success
Infostring

The Info-level information.

{regionId: the region where the aggregation instance resides. globalViewClusterId: the ID of the aggregation instance. failedClusterIds: the ID of the cluster that failed to be added. A cluster may fail to be added because the specified cluster ID is invalid or the cluster is added across continents.}
RequestIdstring

The request ID. You can use the ID to query logs and troubleshoot issues.

3A0EA2AF-C9B3-555C-B9D5-5DD8F5EF98A9
Codeinteger

Status code. 200 is success, other status codes are exceptions.

200
Messagestring

Returns a hint message for the result.

success

Examples

Sample success responses

JSONformat

{
  "Data": {
    "Success": true,
    "Msg": "success",
    "Info": "{regionId: the region where the aggregation instance resides. globalViewClusterId: the ID of the aggregation instance. failedClusterIds: the ID of the cluster that failed to be added. A cluster may fail to be added because the specified cluster ID is invalid or the cluster is added across continents.}\n"
  },
  "RequestId": "3A0EA2AF-C9B3-555C-B9D5-5DD8F5EF98A9",
  "Code": 200,
  "Message": "success"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-20The response structure of the API has changedView Change Details