All Products
Search

This Product

    Managed Service for Prometheus:InstallManagedPrometheus

    Document Center

    Managed Service for Prometheus:InstallManagedPrometheus

    Last Updated:May 09, 2024

    Installs a Prometheus agent for serverless Kubernetes (ASK) clusters or Elastic Compute Service (ECS) clusters.

    Operation description

    If you call the operation to monitor an ASK cluster or an ECS instance, a Prometheus agent is installed in the ASK cluster or ECS instance. Make sure that the ASK cluster or ECS instance has no Prometheus agent installed in advance.

    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:InstallManagedPrometheusWrite
    • Prometheus
      acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The region ID.

    		cn-hangzhou
    ClusterIdstringNo

    The ID of the ACK cluster.

    		cc7a37ee31aea4ed1a059eff8034b****
    ResourceGroupIdstringNo

    The ID of the resource group to which the Prometheus instance belongs.

    		rg-acfmxyexli2****
    ClusterNamestringNo

    The name of the ECS instance. If you set the ClusterType parameter to ecs, you must configure this parameter.

    		prd-ecs
    ClusterTypestringYes

    The cluster type.

    Valid values:

    • ecs

    • one

    • ask

    • pro

    		ask
    VpcIdstringYes

    The virtual private cloud (VPC) where the ASK cluster or ECS instance resides.

    		vpc-xxxxxx
    VSwitchIdstringYes

    The vSwitch used by the ASK cluster or ECS instance.

    		vsw-bp1*********
    SecurityGroupIdstringYes

    The security group of the ASK cluster or ECS instance.

    		sg-bp1********
    GrafanaInstanceIdstringNo

    The ID of the Grafana workspace used by the ASK cluster or ECS instance. If you set the value to free or leave the parameter empty, a shared Grafana workspace is used.

    		grafana-bp1*****
    KubeConfigstringNo

    This parameter is not supported.

    		-

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response object.

    RequestIdstring

    The request ID.

    		String 2A0CEDF1-06FE-44AC-8E21-21A5BE65****
    Datastring

    The response content. The status of the Prometheus instance is returned.

    		success
    Successboolean

    Indicates whether the Prometheus instance was created.

    		true
    Messagestring

    The error message returned if the Prometheus instance fails to be created.

    		vpcId is blank
    Codeinteger

    The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.

    		200

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "String\t2A0CEDF1-06FE-44AC-8E21-21A5BE65****",
  "Data": "success",
  "Success": true,
  "Message": "vpcId is blank",
  "Code": 200
}

    Error codes

    HTTP status codeError codeError message
    400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

    Change history

    Change timeSummary of changesOperation
    2024-01-03The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-09-10The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-05-15API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2022-11-28The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2022-11-28The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2022-01-04Add Operationsee changesets