UpdatePrometheusGlobalView-阿里云帮助中心

Updates the data sources of Prometheus instance for GlobalView.

Note

This API has been deprecated with no replacement. While temporary access is maintained, no further updates or bug fixes will be provided. To ensure continued functionality, plan your migration and contact your account manager for support.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

arms:UpdatePrometheusGlobalView

update

*Prometheus

acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region in which the Prometheus instance resides.	cn-shenzhen
GroupName	string	No	The name of the global aggregation instance.	zyGlobalView
MostRegionId	string	No	The region ID of the global aggregation instance.	cn-hangzhou
ClusterId	string	Yes	The ID of the Prometheus instance.	global****
ResourceGroupId	string	No	The ID of the resource group to which the Prometheus instance belongs.	rg-acfmxyexli2****
SubClustersJson	string	Yes	The data sources of the Prometheus instance for GlobalView.	[ { "headers":{ }, "regionId":"cn-hangzhou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c39a1048921e04f*********", "sourceName":"arms-luyao-test", "dataSource":"", "userId":"1672753*******" }, { "headers":{ }, "regionId":"cn-beijing", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c6b6485496d5b40*******", "sourceName":"agent-321-测试", "dataSource":"", "userId":"1672753*******" }, { "headers":{ }, "regionId":"cn-zhangjiakou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c261a4f3200c446*******", "sourceName":"zaifeng-cardinality-01", "dataSource":"", "userId":"1672753*********" } ]
AllSubClustersSuccess	boolean	Yes	To edit a GlobalView aggregated instance, do you require all passed child instances to be verified successfully before creating a GlobalView instance (optional, default to false): true false	true

Response elements

Element	Type	Description	Example
	object
Data	object	The returned struct.
Success	boolean	Indicates whether the request was successful. Valid values: `true` `false`	true
FailedInstances	array<object>	The data sources that failed to be updated.
	object
SourceName	string	The name of the data source.	sourcename-test
SourceType	string	The type of the data source. AlibabaPrometheus MetricStore CustomPrometheus	AlibabaPrometheus
UserId	string	The user ID.	23784673825*******
ClusterId	string	The ID of the Prometheus instance.	cdb65ed2d527345*********
RequestId	string	The ID of the request. You can use the ID to query logs and troubleshoot issues.	E9C9DA3D-10FE-472E-9EEF-2D0A3E41****
Message	string	The error message that is returned if the request failed.	message
Code	integer	The response code. The status code 200 indicates that the request was successful.	200

Examples

Success response

JSON format

{
  "Data": {
    "Success": true,
    "FailedInstances": [
      {
        "SourceName": "sourcename-test",
        "SourceType": "AlibabaPrometheus",
        "UserId": "23784673825*******",
        "ClusterId": "cdb65ed2d527345*********"
      }
    ]
  },
  "RequestId": "E9C9DA3D-10FE-472E-9EEF-2D0A3E41****",
  "Message": "message",
  "Code": 200
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.