Query Storage Requirements for Integration Policies via API - CloudMonitor

Lists the storage requirements for an Integration Center policy.

Operation description

When a policy is active, alert notifications are not sent for alerts that occur in the application group.

This topic provides an example of creating a policy named PauseNotify. This policy pauses alert notifications for application group 7301**** from 1622949300000 to 1623208500000 (from 2021-06-06 11:15:00 to 2021-06-09 11:15:00 UTC+8).

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

cms:ListIntegrationPolicyStorageRequirements

none

*IntegrationPolicy

acs:cms:{#regionId}:{#accountId}:integrationpolicy/{#integrationPolicyId}

None

Request syntax

GET /integration-policies/{policyId}/storage-requirements HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
policyId	string	Yes	The ID of the Integration Center policy.	policy-ac38a7cb02d14ff48bc9f97d0a75063e

Request parameters

Parameter	Type	Required	Description	Example
addonName	string	No	The name of the add-on release.	release-1234357
storageType	string	No	The storage type. Valid values: LogStore, Prometheus, TraceStore, EventStore, and EntityStore.	LogStore
addonReleaseName	string	No	The name of the AddonRelease.	kafka-17201012937917

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	0CEC5375-C554-562B-A65F-9A629907C1F0
storageRequirements	array<object>	The list of storage requirements.
	array<object>
apiVersion	string	The version number.	v1
kind	string	The kind of the resource.	Pod
metadata	object	The metadata.
annotations	object	The annotations.
	string	The annotations.	prometheus.io/path
labels	object	The resource labels.
	string	The resource labels.	key=value
name	string	The resource name.	pod-1234567
namespace	string	The namespace.	arms-prom
spec	object	The spec of the resource.
entityId	string	The instance ID. Specify this parameter to query data at the instance level. This parameter depends on data in EntityStore.	es-xxxxx
instance	string	The ID of the Prometheus instance.	i-bp122p85gthbniw8rsu9
instanceName	string	The name of the Prometheus instance.	category_predict
project	string	Optional. The project is determined based on the current environment type.	datagrid_cdm
region	string	The region.	cn-shenzhen
shareScope	string	The scope of storage sharing. Valid values: Environment, Region, Workspace, and Custom.	Region
storageType	string	The storage type of the instance.	Prometheus
systemTags	object	The tags that need to be added to the destination storage. The tags are injected as system tags.
	string	The tags that need to be added to the destination storage. The tags are injected as system tags.	system-key=value
tags	object	The tags that need to be added to the destination storage. The tags are injected as common tags.
	string	The tags that need to be added to the destination storage. The tags are injected as common tags.	key=value
userId	string	The user ID.	12345678
workspace	string	The workspace.	test-api
status	object	The status of the storage requirement.
instanceId	string	The instance ID.	rmq-cn-uqm3ket1t0u
interUrl	string	The internal URL.	http://192.168.xxxxxx
intraUrl	string	The internal URL.	http://100.100.xxxxxx
name	string	The name of the storage requirement.	sr-xxxx
project	string	The project for the storage requirement.	jiuwu_algo
promMetricStore	string	The metric store of Prometheus.	xxxx
region	string	The region.	cn-hangzhou
storageType	string	The storage type of the instance.	Prometheus
workspace	string	The workspace.	default
addonReleaseNames	array	A collection of AddonRelease names.
	string	The name of the AddonRelease.	kafka-17201238912

Examples

Success response

JSON format

{
  "requestId": "0CEC5375-C554-562B-A65F-9A629907C1F0",
  "storageRequirements": [
    {
      "apiVersion": "v1",
      "kind": "Pod",
      "metadata": {
        "annotations": {
          "key": "prometheus.io/path"
        },
        "labels": {
          "key": "key=value"
        },
        "name": "pod-1234567",
        "namespace": "arms-prom"
      },
      "spec": {
        "entityId": "es-xxxxx",
        "instance": "i-bp122p85gthbniw8rsu9",
        "instanceName": "category_predict",
        "project": "datagrid_cdm",
        "region": "cn-shenzhen",
        "shareScope": "Region",
        "storageType": "Prometheus",
        "systemTags": {
          "key": "system-key=value"
        },
        "tags": {
          "key": "key=value"
        },
        "userId": "12345678",
        "workspace": "test-api"
      },
      "status": {
        "instanceId": "rmq-cn-uqm3ket1t0u",
        "interUrl": "http://192.168.xxxxxx",
        "intraUrl": "http://100.100.xxxxxx",
        "name": "sr-xxxx",
        "project": "jiuwu_algo",
        "promMetricStore": "xxxx",
        "region": "cn-hangzhou",
        "storageType": "Prometheus",
        "workspace": "default"
      },
      "addonReleaseNames": [
        "kafka-17201238912"
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.