# Alibaba Cloud Application Real-Time Monitoring Service API

> Alibaba Cloud Application Real-Time Monitoring Service API on Apizie: 211 endpoints (Creates or updates a business monitoring job, Suppresses alert notifications. After suppression, no notifications are sent for the alert within the…, Modifies the alert severity level, Modifies the resource group to which a resource belongs, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-arms/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-arms`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/arms
- Page: https://zieapi.vercel.app/api/cloud/aliyun-arms
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-arms/openapi.json

Alibaba Cloud OpenAPI for Application Real-Time Monitoring Service (arms, version 2019-08-08). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates or updates a business monitoring job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/apply-scenario` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| Scenario | string | no | The scenarios. Options: `USER-DEFINED` (default): user-defined. `EDAS-ROLLOUT`: EDAS application publish. `OAM-ROLLOUT`: OAM application… |
| Name | string | yes | The name of the business monitoring job |
| AppId | string | yes | The application ID |
| Sign | string | no | The scenario code. This parameter is not required when you create a business monitoring job, but is required when you update a business… |
| Config | string | yes | The business monitoring configuration in JSON format. For more information about this parameter, see the supplementary description of the… |
| SnTransfer | string | no | Specifies whether the coloring tag is passed through to downstream services. `true` `false` (default) |
| SnStat | string | no | Specifies whether the coloring tag collects traffic statistics. `true` `false` (default) |
| SnDump | string | no | Specifies whether the traces of the coloring tag dump business parameters. `true` `false` (default) |
| SnForce | string | no | Specifies whether the traces of the coloring tag are fully collected. `true` `false` (default) |
| UpdateOption | string | yes | Specifies whether this is an update operation. `true`: Update operation. `false`: Insert operation |

### Suppresses alert notifications. After suppression, no notifications are sent for the alert within the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/block-alarm-notification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AlarmId | integer | yes | The alert ID. To obtain the alert ID, see https://help.aliyun.com/document_detail/2612346.html |
| Timeout | integer | yes | The number of seconds from now during which alert notifications are suppressed. Unit: seconds |
| HandlerId | integer | no | The ID of the handler |

### Modifies the alert severity level
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/change-alarm-severity` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AlarmId | integer | yes | The alert ID. To obtain the alert ID, see https://help.aliyun.com/document_detail/2612346.html |
| Severity | string | yes | The alert severity level. The severity increases from P4, P3, P2, to P1 |
| HandlerId | integer | no | The ID of the handler |

### Modifies the resource group to which a resource belongs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID of the resource |
| ResourceId | string | yes | The ID of the ARMS resource for which you want to change the resource group |
| NewResourceGroupId | string | yes | The ID of the new resource group. You can view available resource groups in the resource group console |
| ResourceType | string | no | The type of the ARMS resource for which you want to modify the resource group |

### Checks the commercial activation status of a product
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/check-commercial-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. Default value: cn-hangzhou |
| Service | string | yes | The sub-product type. Valid values: apm: Application Monitoring rum: Real User Monitoring prometheus: Managed Service for Prometheus… |

### Checks the current service status of a cluster, such as whether the service is activated or whether there is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/check-service-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| SvcCode | string | yes | The Alibaba Cloud service code. The service code for Application Real-Time Monitoring Service (ARMS) Prometheus is prometheus |
| RegionId | string | no | The region ID |

### Claims an alert. This operation is used together with alert escalation policies. When alerts are…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/claim-alarm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AlarmId | integer | yes | The alert ID. To obtain the alert ID, see https://help.aliyun.com/document_detail/2612346.html |
| HandlerId | integer | no | The ID of the handler |

### Closes an alert. Make sure the alert has recovered before closing it. If the alert remains in the triggered…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/close-alarm` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AlarmId | integer | yes | The alert ID. To obtain the alert ID, see https://help.aliyun.com/document_detail/2612346.html |
| Solution | string | no | The alerting Solutions |
| HandlerId | integer | no | The ID of the handler |

### Enables or disables the master switch of the Application Monitoring agent, or queries the status of the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/config-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AppIds | string | yes | The IDs (PIDs) of the applications. Separate multiple PIDs with commas (,) |
| Enable | string | no | Specifies whether to enable or disable the master switch of the agent for one or more applications. After the switch is disabled,… |
| RegionId | string | yes | The region ID |
| Type | string | no | The application type. Currently, only TRACE is supported |

### Creates an alert contact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-alert-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactName | string | no | The name of the alert contact |
| PhoneNum | string | no | The mobile phone number of the contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl |
| Email | string | no | The email address of the contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl |
| DingRobotWebhookUrl | string | no | The webhook URL of the DingTalk chatbot. For more information about how to obtain the URL, see Configure a DingTalk chatbot alert… |
| SystemNoc | string | no | Specifies whether to receive system notifications. Valid values: `true`: Receive system notifications. `false`: Do not receive system… |
| RegionId | string | yes | The region ID. Set the value to `cn-hangzhou` |
| ResourceGroupId | string | no | The resource group ID. You can obtain the ID from the Resource Management console |

### Creates an alert contact group by calling the CreateAlertContactGroup operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-alert-contact-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactGroupName | string | yes | The name of the alert contact group |
| ContactIds | string | no | The IDs of the contacts to include in the alert contact group. Separate multiple contact IDs with spaces. You can call the… |
| RegionId | string | yes | The region ID. Set this parameter to `cn-hangzhou` by default |

### Creates a dispatch policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-dispatch-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| DispatchRule | string | yes | The configuration JSON string of the dispatch conditions. For more information about this parameter, see Additional information about the… |
| RegionId | string | yes | The region ID |

### Creates a custom job for an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-env-custom-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AliyunLang | string | no | The language. Default value: zh. Valid values: zh, en |
| EnvironmentId | string | yes | The environment instance ID |
| CustomJobName | string | yes | The name of the custom job |
| ConfigYaml | string | yes | The YAML configuration string of the custom job |

### Creates a PodMonitor for an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-env-pod-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AliyunLang | string | no | The language environment. Default value: zh. Valid values: zh and en |
| EnvironmentId | string | yes | The environment instance ID |
| DryRun | string | no | Specifies whether to perform a dry run to check whether the format is valid and whether targets can be matched |
| ConfigYaml | string | yes | The YAML configuration string of the PodMonitor |

### Creates a ServiceMonitor for an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-env-service-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AliyunLang | string | no | The locale. Valid values: zh: Chinese. This is the default value. en: English |
| EnvironmentId | string | yes | The environment instance ID |
| DryRun | string | no | Specifies whether to perform a dry run. A dry run checks whether the format is valid and whether targets can be matched |
| ConfigYaml | string | yes | The YAML configuration string of the ServiceMonitor |

### Creates an environment instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AliyunLang | string | no | The language. Default value: zh |
| EnvironmentName | string | yes | The name of the environment |
| EnvironmentType | string | yes | The type of the environment. Valid values: CS: Container Service. ECS: ECS. Cloud: Cloud service |
| EnvironmentSubType | string | yes | The subtype of the environment: CS environments: ACK and One are supported. ECS environments: ECS is supported. Cloud environments: Cloud… |
| BindResourceId | string | yes | The ID of the resource instance bound to the environment, such as a container instance ID or a VPC ID. For Cloud environments, set this… |
| ManagedType | string | no | The managed type. Valid values: none: Unmanaged. This is the default value for ACK clusters. agent: Managed agent, including ksm. This is… |
| FeePackage | string | no | The billing plan. If EnvironmentType is set to CS, you can set this parameter to CS_Basic (default) or CS_Pro. If EnvironmentType is set… |
| PrometheusInstanceId | string | no | The ID of the Prometheus instance bound to the environment. This parameter can be left empty. If it is not provided, call the… |
| GrafanaWorkspaceId | string | no | The ID of the Grafana workspace bound to the environment. If this parameter is left empty, the default shared Grafana workspace is used |
| ResourceGroupId | string | no | The ID of the resource group |
| Tags | string | no | The tags that you want to add to the instance for management (JSON-encoded) |
| InitEnvironment | string | no | Specifies whether to initialize the environment |

### Creates a Managed Service for Grafana workspace instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-grafana-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| GrafanaWorkspaceName | string | yes | The name of the Grafana workspace |
| GrafanaWorkspaceEdition | string | yes | The edition. Valid values: standard: Beta Edition. personal_edition: Developer Edition. experts_edition: Expert Edition. advanced_edition:… |
| Description | string | no | The description of the Grafana workspace |
| GrafanaVersion | string | yes | The Grafana version |
| Password | string | no | The password of the instance. The password must be 8 to 30 characters in length and must contain at least three of the following character… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal. Valid values: true: Auto-renewal is enabled. false: Auto-renewal is disabled. Default value: true |
| PricingCycle | string | no | The billing cycle of the subscription. Valid values: Month (default): billed on a monthly basis. Year: billed on a yearly basis |
| Duration | string | no | The subscription duration of the instance. Valid values: If PricingCycle is set to Month, valid values are 1 to 9. If PricingCycle is set… |
| AccountNumber | string | no | The number of accounts. Value description: If GrafanaWorkspaceEdition is set to standard, this parameter does not take effect. If… |
| CustomAccountNumber | string | no | The number of additional custom accounts. Value description: If GrafanaWorkspaceEdition is set to standard, this parameter does not take… |
| AliyunLang | string | no | The language. Default value: zh. Valid values: zh en |
| ResourceGroupId | string | no | The resource group ID of the Prometheus instance |
| Tags | string | no | The tags (JSON-encoded) |

### Creates an account in a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-grafana-workspace-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| GrafanaWorkspaceId | string | yes | The workspace ID |
| AliyunUid | string | yes | The UID of the authorized Alibaba Cloud account |
| AccountPassword | string | no | The password |
| AccountNotes | string | no | The remarks |
| OrgId | integer | yes | The ID of the organization to which the user belongs |
| Role | string | yes | The role. Valid values: admin, editor, and viewer |
| AliyunLang | string | no | The language. Default value: zh. Valid values: zh: Chinese en: English |

### Creates an alert integration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| IntegrationName | string | yes | The integration name |
| IntegrationProductType | string | yes | The integration product type. Valid values: CLOUD_MONITOR: CloudMonitor LOG_SERVICE: Simple Log Service |
| Description | string | no | The description of the integration |
| AutoRecover | string | no | Specifies whether alert events are automatically recovered. Valid values: true (default) false |
| RecoverTime | integer | no | The automatic recovery time for alert events. Default value: 300. Unit: seconds |
| RegionId | string | no | The region ID |

### Creates or updates an alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-or-update-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AlertId | integer | no | The alert rule ID. If this parameter is left empty, a new alert rule is created. If this parameter is specified, the specified alert rule… |
| AlertName | string | yes | The name of the alert rule |
| RegionId | string | yes | The region ID |
| AlertType | string | yes | The type of the alert rule. Valid values: APPLICATION_MONITORING_ALERT_RULE: Application Monitoring alert rule.… |
| AlertStatus | string | no | The running status of the alert rule. Valid values: RUNNING (default): Started. STOPPED: Stopped |
| NotifyStrategy | string | no | The notification policy. Valid values: null: No notification policy is specified. After the alert rule is created, you can create a… |
| Pids | string | no | The PIDs of applications associated with the Application Monitoring or Browser Monitoring alert rule |
| AutoAddNewApplication | string | no | Specifies whether to enable the feature that automatically appends newly created applications to this alert rule for Application… |
| MetricsType | string | no | The alert metric type of the Application Monitoring or Browser Monitoring alert rule. For more information, see the table below |
| Filters | string | no | The filter conditions of the Application Monitoring or Browser Monitoring alert rule. The format is as follows: ``` "DimFilters": [ {… |
| AlertRuleContent | string | no | The alert rule content for Application Monitoring or Browser Monitoring. The AlertRuleContent template is as follows. For the description… |
| AlertCheckType | string | no | The alerting check type of the Managed Service for Prometheus monitoring alert rule. Valid values: STATIC: Static threshold type. When you… |
| ClusterId | string | no | The cluster ID of the Managed Service for Prometheus alert rule |
| AlertGroup | integer | no | The alert group ID of the Managed Service for Prometheus alert rule. Valid values: -1: custom PromQL 1: Kubernetes load 15: Kubernetes node |
| PromQL | string | no | The PromQL statement of the Managed Service for Prometheus alert rule |
| Duration | integer | no | The duration of the Managed Service for Prometheus alert rule, in minutes. Valid values: 0 to 1440 |
| Level | string | no | The severity level of the Managed Service for Prometheus alert rule. Valid values: P1: Used for critical issues that affect the… |
| Message | string | no | The alert message content of the Managed Service for Prometheus alert rule |
| Labels | string | no | The labels of the Managed Service for Prometheus alert rule |
| Annotations | string | no | The annotations of the Managed Service for Prometheus alert rule |
| MetricsKey | string | no | The alert metric. When you create a Managed Service for Prometheus alert rule and AlertCheckType is set to STATIC, MetricsKey is required.… |
| Tags | string | no | The alert rule tags (Alibaba Cloud unified tags) (JSON-encoded) |
| MarkTags | string | no | The application tags. Used for Application Monitoring alert rules to filter applications associated with the alert rule (JSON-encoded) |
| DataConfig | string | no | The data configuration. The dataRevision field specifies the data repair method when no data is available for the metric. Valid values: 0:… |
| Notice | string | no | The effective period and notification time. Used for compatible with legacy rules |
| AlertPiplines | string | no | The alert notification channel configuration. Used for compatibility with legacy rules |
| NotifyMode | string | no | The notification mode. Normal mode or simplified mode. Valid values: DIRECTED_MODE NORMAL_MODE |
| Product | string | no | Passed in when creating a Managed Service for Prometheus alert rule. The backend verifies whether the product exists. Used to filter… |
| AutoAddTargetConfig | string | no | The automatic application append configuration for Application Monitoring alert rules. autoAddMatchType: The matching method: regular… |
| CheckCycle | integer | no | The alert check cycle for Managed Service for Prometheus |
| aliyunLang | string | no | The aliyunLang |

### Creates or updates an alert contact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-or-update-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactId | integer | no | The ID of the alert contact. If you leave this parameter empty, a new alert contact is created. If you specify this parameter, the… |
| ContactName | string | yes | The name of the alert contact |
| Phone | string | no | The phone number of the alert contact. You must specify at least one of the Phone and Email parameters. Each phone number or email address… |
| Email | string | no | The email address of the alert contact. You must specify at least one of the Phone and Email parameters. Each phone number or email… |
| ReissueSendNotice | integer | no | The reissue type when a phone notification fails. 0: Do not reissue. 1: Redial once. 2: Send an SMS notification. 3 (default): Use the… |
| IsEmailVerify | string | no | Indicates whether the email address is verified |
| DingRobotUrl | string | no | The DingTalk webhook URL |
| ResourceGroupId | string | no | The resource group ID |
| CorpUserId | string | no | The identifier of the alert contact within the enterprise organization. This parameter is used for the @ feature in third-party instant… |

### Creates or updates an alert contact group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-or-update-contact-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactGroupId | integer | no | The ID of the alert contact group. If this parameter is left empty, a new contact group is created. If this parameter is specified, the… |
| ContactGroupName | string | yes | The name of the alert contact group |
| ContactIds | string | no | The IDs of the contacts to add to the contact group. Separate multiple contact IDs with commas (,) |

### Creates or updates an EventBridge notification integration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-or-update-event-bridge-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | integer | no | The notification integration ID. If this parameter is left empty, a new notification integration is created. If this parameter is… |
| Name | string | yes | The name of the EventBridge notification integration |
| Description | string | no | The description of the notification integration |
| Endpoint | string | no | The public endpoint of EventBridge |
| AccessKey | string | no | EventBridge AccessKey ID |
| AccessSecret | string | no | EventBridge AccessKey Secret |
| EventBusName | string | no | The name of the event bus |
| Source | string | no | The event source |
| EventBusRegionId | string | no | The region ID of the event bus |

### Creates or updates an IM robot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-or-update-imrobot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RobotId | integer | no | The IM robot ID. If you leave this parameter empty, a new IM robot is created. If you specify this parameter, the specified IM robot is… |
| RobotName | string | yes | The name of the IM robot |
| Type | string | yes | The type of the IM robot. Valid values: `dingding`: DingTalk chatbot. `wechat`: WeCom chatbot. `feishu`: Lark chatbot |
| RobotAddress | string | yes | The webhook URL of the IM robot |
| DailyNoc | string | no | Specifies whether to send daily statistics information. `false` (default): Does not send statistics information. `true`: Sends statistics… |
| DailyNocTime | string | no | The points in time at which daily statistics information is sent. Separate multiple points in time with commas (,). The time format is… |
| DingSignKey | string | no | The DingTalk signing key. If a key is configured, DingTalk authentication is performed by using the signing method. If no key is… |
| Token | string | no | The token required to enable the Outgoing mechanism |
| EnableOutgoing | string | no | Specifies whether to enable the Outgoing mechanism |
| CardTemplate | string | no | The alert card template configuration. For the description of each parameter in the template, see the supplementary description below |

### Creates or updates a notification policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-or-update-notification-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | integer | no | The notification policy ID. If you leave this parameter empty, a new notification policy is created. If you specify this parameter, the… |
| Name | string | yes | The Policy Name |
| MatchingRules | string | no | The rules for matching alert events. Format: ``` [ { "matchingConditions": [ { "value": "test", // The value of the alert event matching… |
| SendRecoverMessage | string | no | Specifies whether the alert status is automatically changed to resolved when all events under the alert are recovered. When the alert is… |
| GroupRule | string | no | The event grouping settings. If you leave this parameter empty (default), all alerts are grouped by `alertname` and sent to the handler.… |
| NotifyRule | string | yes | The notification rule settings. Format: ``` { "notifyStartTime":"00:00", // The start time of the notification period.… |
| NotifyTemplate | string | no | The notification template. For a sample template, refer to the description below the table |
| EscalationPolicyId | integer | no | The ID of the alert escalation policy |
| Repeat | string | no | Specifies whether to send repeated notifications for alerts that remain unresolved for an extended period. `true` (default): If set to… |
| RepeatInterval | integer | no | The interval for repeated notifications. Unit: seconds |
| IntegrationId | integer | no | The integration ID of the ticket system to which alerts are pushed |
| RegionId | string | no | The region ID |
| DirectedMode | string | no | Specifies whether to enable simplified mode |
| State | string | no | Specifies whether the notification policy is enabled. Valid values: enable: enabled. disable: disabled |

### Creates or modifies a silence policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-or-update-silence-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | integer | no | The silence policy ID. If this parameter is left empty, a new silence policy is created. If this parameter is specified, the specified… |
| Name | string | yes | The Policy Name of the silence policy |
| MatchingRules | string | no | The dispatch rules. The format is as follows: ``` [ { "matchingConditions": [ { "value": "test", // The value of the dispatch rule… |
| RegionId | string | no | The region ID |
| State | string | no | Specifies whether the silence policy is enabled. Valid values: enable: Enabled. disable: Disabled |
| EffectiveTimeType | string | no | The effective period type of the silence policy. Valid values: PERMANENT: permanently effective. CUSTOM_TIME: effective during a custom… |
| TimePeriod | string | no | The cycle period. This parameter is required when the effective time type is CYCLE_EFFECT (cyclically effective). Valid values: DAY: daily… |
| TimeSlots | string | no | The effective time period of the notification policy. When the effective time type is CUSTOM_TIME (custom time period), the input format… |

### Creates or updates a webhook alert contact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-or-update-webhook-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| WebhookId | integer | no | The ID of the webhook alert contact. If this parameter is left empty, a new webhook alert contact is created. If this parameter is… |
| WebhookName | string | yes | The name of the webhook alert contact |
| Method | string | yes | The HTTP request method. Valid values: Post Get |
| Url | string | yes | The request URL for the specified Method |
| BizHeaders | string | no | The HTTP request headers |
| BizParams | string | no | The HTTP request parameters |
| Body | string | no | The notification template that is sent when an alert is triggered. This parameter is required when Method is set to Post. You can use the… |
| RecoverBody | string | no | The notification template that is sent when an alert is resolved. This parameter is required when Method is set to Post. You can use the… |

### Creates an alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-prometheus-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AlertName | string | yes | The name of the alert rule |
| ClusterId | string | yes | The cluster ID |
| Type | string | no | The type of the alert rule. Valid values: 99: custom alert 101: Prometheus alert |
| NotifyType | string | no | The notification type. Valid values: `ALERT_MANAGER` (default): sends notifications through the alert operations center. `DISPATCH_RULE`:… |
| DispatchRuleId | integer | no | The ID of the notification policy. This parameter is required when NotifyType is set to `DISPATCH_RULE` |
| Expression | string | yes | The alert expression, which must be a PromQL statement |
| Duration | string | yes | The duration. Valid values: 1m to 1440m. Unit: minutes |
| Message | string | yes | The alert message. You can reference labels in the {{$labels.xxx}} format |
| Labels | string | no | The label JSON string. You must set the Name and Value of the labels |
| Annotations | string | no | The annotation JSON string. You must set the Name and Value of the annotations |
| Tags | string | no | The tags (JSON-encoded) |

### Creates a Prometheus instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-prometheus-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ClusterType | string | yes | The cluster type. Valid values: remote-write: Prometheus for Remote Write ecs (no longer supported): Prometheus for ECS global-view:… |
| VpcId | string | no | The ID of the virtual private cloud (VPC). This parameter is required when ClusterType is set to ecs or aliyun-cs for a managed ACK cluster |
| VSwitchId | string | no | The ID of the vSwitch. This parameter is required when ClusterType is set to ecs or aliyun-cs for a managed ACK cluster |
| SecurityGroupId | string | no | The ID of the VPC Network Security group. This parameter is required when ClusterType is set to ecs or aliyun-cs for a managed ACK cluster |
| ClusterId | string | no | The ID of the Container Service cluster. This parameter is required when ClusterType is set to aliyun-cs |
| ClusterName | string | no | The name of the cluster. This parameter is required when ClusterType is set to remote-write, ecs, or global-view. If ClusterType is set to… |
| SubClustersJson | string | no | The JSON string of the sub-instances for a GlobalView instance |
| AllSubClustersSuccess | string | no | Specifies whether all sub-instances must be validated successfully before creating a GlobalView instance. Default value: false, which… |
| GrafanaInstanceId | string | no | The ID of the bound Grafana workspace. If you use the shared Grafana edition, set the value to free |
| ResourceGroupId | string | no | The ID of the resource group |
| Tags | string | no | The custom tags (JSON-encoded) |
| Duration | integer | no | The data storage duration in days |
| ArchiveDuration | integer | no | The number of days to automatically archive data after the storage period expires. Valid values: 60, 90, 180, and 365. A value of 0… |
| PaymentType | string | no | The Billable methods. Valid values: POSTPAY: Pay-as-you-go based on the number of reported metrics. POSTPAY_GB: Pay-as-you-go based on the… |

### Creates a Browser Monitoring job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-retcode-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RetcodeAppName | string | yes | The name of the Browser Monitoring application |
| RetcodeAppType | string | yes | The type of the Browser Monitoring application. Valid values: `web`: web page `weex`: Weex page `mini_dd`: DingTalk mini program… |
| RegionId | string | yes | The region ID |
| ResourceGroupId | string | no | The resource group ID. You can obtain the ID from the Resource Management console |
| Tags | string | no | The tags (JSON-encoded) |

### Creates a RUM application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-rum-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AppName | string | yes | The application name |
| SiteType | string | yes | The application type. Valid values: web: Web & H5 miniapp: mini program ios: iOS android: Android |
| Source | string | no | The source. This is a reserved field |
| AppGroup | string | no | The application group |
| Description | string | no | The description of the application |
| ResourceGroupId | string | no | The resource group ID |
| Tag | string | no | The list of tags. A maximum of 20 tags can be specified (JSON-encoded) |
| PackageName | string | no | The Android application package name. This parameter is required when you create an Android application |
| RegionId | string | yes | The region ID |
| NickName | string | no | The application nickname |
| RealRegionId | string | no | The region to which the application is actually connected. This parameter is used only in the Shanghai Finance Cloud scenario |
| Language | string | no | The client language |

### Uploads SourceMap files, symbol table files, and other related files
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-rum-upload-file-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | no | The application ID |
| VersionId | string | no | The file version number |
| Uuid | string | no | The unique ID of the file |
| FileName | string | yes | The file name |
| ContentType | string | no | The file type. Valid values: `"application/zip"`, `"text/plain"`, or an empty string |
| AppName | string | no | The application name |
| SourcemapType | string | no | The file type. Valid values: source-map: SourceMap file. mapping: Android symbol table file. dsym: iOS dSYM file |
| RegionId | string | yes | The region ID |
| Workspace | string | no | The Workspace |
| ServiceId | string | no | The ServiceId |

### Creates or updates a Synthetic Monitoring scheduled task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-synthetic-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| TaskName | string | yes | The task name. To update an existing Synthetic Monitoring task, specify the name of the existing task and set the UpdateTask parameter to… |
| Url | string | yes | The monitoring URL |
| MonitorList | string | yes | The list of monitoring nodes (JSON-encoded) |
| TaskType | integer | yes | The task type. Valid values: 3: Web performance - IE 34: Web performance - Chrome 0: Network quality 40: File download 7: API performance |
| IntervalTime | string | yes | The monitoring frequency, in minutes. Valid values: 1 5 10 15 20 30 60 120 180 240 360 480 720 1440 |
| IntervalType | string | yes | The monitoring cycle type. Valid values: 0: Daily. 1: Custom extended frequency |
| ExtendInterval | string | no | The custom extended frequency (JSON-encoded) |
| IpType | integer | yes | The IP type. Valid values: 0: Automatic. 1: IPv4. 2: IPv6 |
| Net | string | no | The network task (JSON-encoded) |
| CommonParam | string | no | The common parameters (JSON-encoded) |
| Navigation | string | no | The browsing task monitoring settings (JSON-encoded) |
| Download | string | no | The file download task (JSON-encoded) |
| Protocol | string | no | The API performance task (JSON-encoded) |
| UpdateTask | string | no | Specifies whether to update an existing Synthetic Monitoring node. true: Update the node. false: Create task |

### Creates a scheduled Synthetic Monitoring task (new version)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-timing-synthetic-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| Name | string | yes | The name of the monitoring task. The name must be unique |
| TaskType | integer | yes | The task type. Valid values: 1: ICMP 2: TCP 3: DNS 4: HTTP 5: website speed test 6: file download |
| MonitorConf | string | yes | The monitoring configuration (JSON-encoded) |
| MonitorCategory | integer | yes | The monitoring point type. 1: PC. 2: Mobile |
| Monitors | string | yes | The list of monitoring points (JSON-encoded) |
| Frequency | string | yes | The monitoring frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h |
| CustomPeriod | string | no | The custom period (JSON-encoded) |
| CommonSetting | string | no | The common settings (JSON-encoded) |
| AvailableAssertions | string | no | The list of assertions (JSON-encoded) |
| ResourceGroupId | string | no | The resource group ID. This parameter is optional |
| Tags | string | no | The list of tags (JSON-encoded) |

### Creates a Webhook alert contact by calling the CreateWebhook operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/create-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactName | string | yes | The custom contact name |
| Method | string | yes | The HTTP request method. `Get` `Post` |
| Url | string | yes | The request URL for the specified Method |
| HttpParams | string | no | The HTTP request parameters |
| HttpHeaders | string | no | The HTTP request headers |
| RegionId | string | yes | The region ID |
| Body | string | yes | The notification template sent when an alert is triggered. This parameter is required when Method is set to Post. You can use the $content… |
| RecoverBody | string | no | The notification template sent when an alert is resolved. This parameter is required when Method is set to Post. You can use the $content… |

### Disables the authentication token
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/del-auth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ClusterId | string | no | The cluster ID |

### Deletes AddonRelease data by AddonRelease name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-addon-release` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ReleaseName | string | yes | The name of the AddonRelease |
| RegionId | string | no | The region ID |
| EnvironmentId | string | yes | The environment ID |
| AddonName | string | no | The name of the Addon. If AddonName is specified, the ReleaseName parameter is ignored, and all AddonReleases belonging to the same Addon… |

### Deletes an alert contact by calling the DeleteAlertContact operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-alert-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Default value: `cn-hangzhou` |
| ContactId | integer | yes | The ID of the alert contact to be deleted. You can call the SearchAlertContact operation to query contact IDs. For more information, see… |

### Deletes an alert contact group by calling the DeleteAlertContactGroup operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-alert-contact-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Default value: `cn-hangzhou` |
| ContactGroupId | integer | yes | The ID of the contact group to delete. You can call the SearchAlertContactGroup operation to query contact group IDs. For more… |

### Deletes an alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AlertId | integer | yes | The alert rule ID. To obtain the alert rule ID, see https://help.aliyun.com/document_detail/2612348.html |

### Deletes alert rules by calling the DeleteAlertRules operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-alert-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AlertIds | string | yes | The list of alert rule IDs to delete. The value is in the JSONArray format, for example, `[123, 234]`. You can call the SearchAlertRules… |
| RegionId | string | yes | The region ID. Default value: `cn-hangzhou` |

### Batch deletes applications based on a list of Application Monitoring PIDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-app-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| Pids | string | no | The list of Application Real-Time Monitoring Service (ARMS) Application Monitoring instance IDs (PIDs) (JSON-encoded) |

### Deletes an alert contact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactId | integer | yes | The alert contact ID |

### Deletes an alert contact group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-contact-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactGroupId | integer | yes | The ID of the alert contact group |

### Deletes an alert notification policy with a specified ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-dispatch-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the notification policy |
| RegionId | string | yes | The region ID |

### Deletes a custom job in an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-env-custom-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The environment instance ID |
| CustomJobName | string | yes | The name of the custom job |

### Deletes an environment PodMonitor
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-env-pod-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The environment instance ID |
| Namespace | string | yes | The namespace where the PodMonitor resides |
| PodMonitorName | string | yes | The name of the PodMonitor |

### Deletes a ServiceMonitor from an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-env-service-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The environment instance ID |
| Namespace | string | yes | The namespace in which the ServiceMonitor resides |
| ServiceMonitorName | string | yes | The name of the ServiceMonitor |

### Deletes an environment instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The environment instance ID |
| DeletePromInstance | string | no | Specifies whether to cascade delete the Prometheus instance |

### Deletes a feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-environment-feature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| EnvironmentId | string | yes | The environment ID |
| RegionId | string | no | The region ID. Valid values: cn-beijing and cn-hangzhou |
| FeatureName | string | yes | The name of the feature. Valid values: app-agent-pilot, metric-agent, ebpf-agent, and service-check |

### Deletes an EventBridge notification integration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-event-bridge-integration` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | integer | yes | Required. The ID of the EventBridge notification integration. You can call the ListEventBridgeIntegrations operation to query the ID |

### Deletes a Managed Service for Grafana workspace instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-grafana-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Default value: cn-hangzhou |
| GrafanaWorkspaceId | string | yes | The ID of the Managed Service for Grafana workspace |

### Deletes an account from a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-grafana-workspace-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| GrafanaWorkspaceId | string | yes | The workspace ID |
| AccountId | integer | yes | The account ID |

### Deletes the role of an account in a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-grafana-workspace-account-role` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| GrafanaWorkspaceId | string | yes | The workspace ID |
| AccountId | integer | yes | The account ID |
| OrgId | integer | yes | The organization ID |

### Deletes an IM chatbot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-imrobot` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RobotId | integer | yes | The ID of the IM chatbot |

### Deletes a specified alert integration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-integrations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| IntegrationId | integer | yes | The alert integration ID |

### Deletes a notification policy by notification policy ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-notification-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | integer | yes | The notification policy ID. To obtain the notification policy ID, call https://help.aliyun.com/document_detail/2612375.html |

### Deletes a Prometheus alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-prometheus-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AlertId | integer | yes | The ID of the alerting rule. You can view the alerting rule ID in the response data of the ListPrometheusAlertRules API operation |
| ClusterId | string | no | The cluster ID of the Prometheus alert rule |

### Deletes a Browser Monitoring job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-retcode-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AppId | string | no | The application ID. You can query this value by calling the GetRetcodeAppByPid operation |
| RegionId | string | yes | The region ID |
| AppName | string | no | The name of the Browser Monitoring application |
| Pid | string | yes | The identifier of the Browser Monitoring application |

### Deletes a RUM application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-rum-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AppId | string | yes | The application ID |
| AppGroup | string | no | The application group |
| RegionId | string | yes | The region ID |
| RealRegionId | string | no | The region where the application is actually connected. This parameter is used only in the China (Shanghai) Finance Cloud scenario |

### Deletes files such as symbol tables and SourceMap files
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-rum-upload-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | no | The application ID |
| VersionId | string | no | The file version number |
| Uuid | string | no | The unique ID of the file |
| FileName | string | no | The file name, including the file name extension |
| RegionId | string | yes | The region ID |
| BatchItems | string | no | The batch deletion parameter in JSON array format. Leave this parameter empty if you want to delete a single file. If you want to delete… |
| Workspace | string | no | The Workspace |
| ServiceId | string | no | The ServiceId |

### Deletes a Business Monitoring task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-scenario` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ScenarioId | integer | yes | The Business Monitoring ID. You can obtain this ID by calling the ListScenario operation |
| RegionId | string | no | The region ID |

### Deletes a silence policy by silence policy ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-silence-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | integer | yes | The silence policy ID. To obtain the silence policy ID, see https://help.aliyun.com/document_detail/2612383.html |

### Deletes SourceMap files uploaded in Browser Monitoring
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-source-map` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| Pid | string | yes | The application ID. In the ARMS console, go to Browser Monitoring > Browser Monitoring and click the target application name. The URL in… |
| FidList | string | yes | The list of SourceMap IDs (JSON-encoded) |

### Deletes a Synthetic Monitoring scheduled task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-synthetic-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Default value: cn-hangzhou |
| TaskIds | string | yes | The list of task IDs (JSON-encoded) |

### Deletes a scheduled Synthetic Monitoring task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-timing-synthetic-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| TaskId | string | no | The Synthetic Monitoring task ID |
| ResourceGroupId | string | no | The resource group ID |

### Deletes an application by the specified ID or type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-trace-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AppId | string | yes | The ID of the application to delete. You can call the SearchTraceAppByName operation to obtain the ID |
| RegionId | string | yes | The region ID |
| Type | string | yes | The type of the application to delete. You can call the SearchTraceAppByName operation to obtain the type. For more information, see… |
| Pid | string | yes | The application ID. In the Application Real-Time Monitoring Service (ARMS) console, choose Application Monitoring > Applications and click… |
| DeleteReason | string | no | The reason for deletion (JSON-encoded) |

### Deletes a webhook alert contact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/delete-webhook-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| WebhookId | integer | yes | The ID of the webhook alert contact |

### Queries the metric details of a specified add-on
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-addon-metrics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Name | string | yes | The name of the add-on |
| AddonVersion | string | no | The version of the add-on |
| AliyunLang | string | no | The language environment. Default value: zh. Valid values: zh, en |
| EnvironmentType | string | no | The environment |
| RegionId | string | no | The region ID |

### Queries the details of an AddonRelease by name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-addon-release` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ReleaseName | string | yes | The name of the AddonRelease |
| RegionId | string | no | The region ID |
| EnvironmentId | string | yes | The environment ID |

### Queries alert contact group information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-contact-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactGroupName | string | no | The name of the alert contact group |
| Page | integer | yes | The page number of the query |
| Size | integer | yes | The number of contact groups displayed per page |
| IsDetail | string | no | Specifies whether the returned contact group information includes all contacts. `fasle` (default): All contacts are not returned. `true`:… |
| GroupIds | string | no | The ID of the contact group |
| RegionId | string | no | The region ID |

### Queries the list of alert contacts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ContactName | string | no | The name of the alert contact |
| Phone | string | no | The phone number of the alert contact |
| Email | string | no | The email address of the alert contact |
| Page | integer | yes | The page number of the query |
| Size | integer | yes | The number of contacts displayed per page |
| ContactIds | string | no | The IDs of the contacts to query. Separate multiple contact IDs with spaces |
| Verbose | string | no | Specifies whether to return verbose information |
| RegionId | string | no | The region ID |

### Queries the information about a dispatch policy by calling the DescribeDispatchRule operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-dispatch-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | string | yes | The ID of the dispatch policy |
| RegionId | string | yes | The region ID |

### Queries the details of a custom job in an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-env-custom-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The instance ID of the environment |
| CustomJobName | string | yes | The name of the custom job |
| EncryptYaml | string | no | Specifies whether to return the encrypted YAML string |

### Queries the list of deprecated metrics for a specified environment instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-env-drop-metrics-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The environment ID |

### Queries the details of a PodMonitor in an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-env-pod-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The environment instance ID |
| Namespace | string | yes | The namespace where the PodMonitor resides |
| PodMonitorName | string | yes | The name of the PodMonitor |

### Queries the details of a ServiceMonitor in an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-env-service-monitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The environment instance ID |
| Namespace | string | yes | The namespace of the ServiceMonitor |
| ServiceMonitorName | string | yes | The name of the ServiceMonitor |

### Queries the details of an environment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| EnvironmentId | string | yes | The environment instance ID |

### Queries the details of a feature
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-environment-feature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| EnvironmentId | string | yes | The environment ID |
| RegionId | string | no | The region ID |
| FeatureName | string | yes | The name of the feature |
| AliyunLang | string | no | The language. Valid values: en and zh |

### Queries a list of IM robots
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-imrobots` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RobotName | string | no | The name of the IM robot |
| Page | integer | yes | The page number of the page to return |
| Size | integer | yes | The number of IM robots to return on each page |
| RobotIds | string | no | The list of robot IDs |

### Queries a Prometheus alert rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-prometheus-alert-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AlertId | integer | yes | The alerting rule ID. You can view this value in the response data of the ListPrometheusAlertRules API operation |
| ClusterId | string | no | The Prometheus instance ID |

### Lists LicenseKeys
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-trace-license-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |

### Queries the list of webhook alert contacts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/describe-webhook-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| WebhookName | string | no | The name of the webhook alert contact |
| Page | integer | yes | The page number to query |
| Size | integer | yes | The number of webhook alert contacts to display per page |
| ContactIds | string | no | The contact ID |

### Performs the corresponding action based on the module type specified by the parameters
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/do-insights-action` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Module | string | yes | The module type. QueryTopo The topology query feature. A topology consists of edges and nodes. Each edge has a corresponding type, each… |
| Data | string | yes | The query parameters. Different module types correspond to different query parameters. QueryTopo ``` { "regionId": string, # The region… |
| RegionId | string | no | The region ID |

### Retrieves the download URL for the probe
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-agent-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |

### Retrieves the download URL of a probe
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-agent-download-url-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AgentType | string | yes | The type of agent to retrieve. Valid values: JavaAgent Instgo |
| OsType | string | no | The operating system type of the agent working environment. This parameter is valid and required only when AgentType is set to Instgo.… |
| ArchType | string | no | The architecture type of the agent working environment. This parameter is valid and required only when AgentType is set to Instgo. Valid… |

### Queries alert rules that have been created
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-alert-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AlertIds | string | no | The list of alert rule IDs. An alert rule ID uniquely identifies an alert rule and is not duplicated. If you do not specify this… |
| AlertNames | string | no | The list of alert rule names. Duplicate names are not allowed when you create alert rules of the new version. However, existing alert… |
| RegionId | string | yes | The region ID |
| AlertType | string | no | The alert rule type. This parameter is required for alert rules of the new version. APPLICATION_MONITORING_ALERT_RULE: Application… |
| AlertStatus | string | no | The running status of the alert rule. RUNNING: running STOPPED: stopped PAUSED: paused The PAUSED status indicates that the alert rule is… |
| ClusterId | string | no | The cluster ID of the Managed Service for Prometheus alert rule |
| ProductCode | string | no | This parameter is not required |
| Page | integer | yes | The page number of the alert rules to query |
| Size | integer | yes | The number of alert rules per page |
| Tags | string | no | The list of tags (JSON-encoded) |
| BizRegionId | string | no | The region ID where the rule resides |

### Queries the request count, error count, and average response time of each API in an application by page. You…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-app-api-by-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| StartTime | integer | no | The start time of the query. This value is a timestamp in milliseconds |
| EndTime | integer | no | The end time of the query. This value is a timestamp in milliseconds |
| CurrentPage | integer | no | The page number of the query results |
| PageSize | integer | no | This parameter is no longer supported. The number of items per page in the query results. Default value: 10 |
| IntervalMills | integer | no | The time interval of data slices, in milliseconds. Minimum value: 60000. Maximum value: 2147483647 |
| PId | string | yes | The application ID. In the Application Real-Time Monitoring Service (ARMS) console, choose Application Monitoring > Application List and… |

### Retrieves the JVM configuration information of each instance of an application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-app-jvmconfig` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| Pid | string | no | The application ID. On the Application Monitoring > Application List page in the ARMS console, click the target application name. The URL… |
| StartTime | integer | no | The start time of the query. This value is a timestamp in milliseconds |
| EndTime | integer | no | The end time of the query. This value is a timestamp in milliseconds |

### Retrieves the authentication token for public network read and write access
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-auth-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ClusterId | string | yes | The ID of the Kubernetes cluster in Container Service for Kubernetes |
| RegionId | string | yes | The region ID |

### Queries whether the current account has activated the commercial edition of the specified service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-commercial-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. Example: cn-hangzhou |
| CommodityCode | string | yes | The commodity code. Valid values: arms_app_post arms_web_post arms_promethues_public_cn prometheus_pay_public_cn xtrace… |

### Queries information about a specified Grafana workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-grafana-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID. Default value: cn-hangzhou |
| GrafanaWorkspaceId | string | yes | The workspace ID |
| AliyunLang | string | no | The language. Default value: zh (Chinese). Set the value to en for English |

### Retrieves the details of multiple traces
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-multiple-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| TraceIDs | string | yes | The list of trace IDs (JSON-encoded) |
| StartTime | integer | yes | The timestamp of the trace start time, in milliseconds |
| EndTime | integer | yes | The timestamp of the trace end time, in milliseconds |
| PageNumber | integer | no | The page number, starting from 1 |
| PageSize | integer | no | The number of entries per page. Maximum value: 1000 |

### Queries the details of an on-call schedule policy by calling the GetOnCallSchedulesDetail operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-on-call-schedules-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Id | integer | yes | The ID of the on-call schedule policy |
| StartTime | string | no | The start time of the on-call period, in the `yyyy-MM-dd` format |
| EndTime | string | no | The end time of the on-call period, in the `yyyy-MM-dd` format |

### Retrieves the token required to integrate with ARMS Prometheus monitoring
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-prometheus-api-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |

### Adds an aggregation instance for ARMS Prometheus monitoring and retrieves the detailed data source…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-prometheus-global-view` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| GlobalViewClusterId | string | yes | The aggregation instance ID |

### Retrieves the information about a specified Prometheus instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-prometheus-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| ClusterId | string | yes | The Prometheus instance ID |

### Returns a Browser Monitoring application object based on the application PID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-retcode-app-by-pid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | yes | The application PID. In the ARMS console, choose Browser Monitoring > Application List and click the target application name. The URL in… |
| RegionId | string | no | The region ID |
| Tags | string | no | The tag key-value pairs. This parameter is required if you do not specify the ResourceIds parameter. Description of the values: key: the… |

### Queries Browser Monitoring data by using a Simple Log Service (SLS) query statement
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-retcode-data-by-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | yes | The application ID. In the ARMS console, choose Browser Monitoring > Browser Monitoring List and click the target application name. The… |
| Query | string | yes | The query statement that conforms to the SLS Logstore query syntax |
| From | integer | yes | The beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since… |
| To | integer | yes | The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1,… |
| RegionId | string | yes | The region ID |

### Retrieves the Simple Log Service (SLS) Project and Logstore associated with a Browser Monitoring application…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-retcode-logstore` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | yes | The application ID. In the Application Real-Time Monitoring Service (ARMS) console, choose Browser Monitoring > Application List and click… |
| RegionId | string | no | The region ID |

### Retrieves the sharing URL of a Browser Monitoring site
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-retcode-share-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | yes | The application PID. In the Application Real-Time Monitoring Service (ARMS) console, go to Browser Monitoring > Browser List and click the… |

### Retrieves information about a single Browser Monitoring application
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-rum-app-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | yes | The application ID |
| AppGroup | string | no | The application group |
| RegionId | string | yes | The region ID |

### Retrieves the list of Real User Monitoring (RUM) applications
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-rum-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AppId | string | no | The application ID |
| AppGroup | string | no | The application group |
| AppName | string | no | The application name. Only a single name can be specified |
| AppType | string | no | The application type. Valid values: web, miniapp, android, ios, Windows, macOS, and harmonyos |
| ResourceGroupId | string | no | The resource group ID |
| Tags | string | no | The tags (JSON-encoded) |
| RegionId | string | yes | The region ID |

### Retrieves Real User Monitoring data by page
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-rum-data-for-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Query | string | yes | The query statement that conforms to the Simple Log Service Logstore query syntax. You can refer to the parameters passed by this… |
| Pid | string | no | The application ID |
| AppGroup | string | no | The application group |
| StartTime | integer | yes | The timestamp of the query start time. Unit: seconds |
| EndTime | integer | yes | The timestamp of the query end time. Unit: seconds |
| PageSize | integer | no | The number of records per page |
| CurrentPage | integer | no | The current page number of the paginated query |
| RegionId | string | yes | The region ID |

### Retrieves Real User Monitoring (RUM) exception stack information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-rum-exception-stack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | no | The application ID |
| ExceptionStack | string | no | The error stack information in JSON list format. Each list element contains three fields: call_stack.info, call_stack.thread.name, and… |
| ExceptionBinaryImages | string | no | The binary images, which represent all executable files loaded into the process address space at the time of the crash |
| ExceptionThreadId | string | no | The exception thread ID |
| RegionId | string | no | The region ID |
| SourcemapType | string | no | The parsing type. Valid values: js: JS error parsing. sym: PC parsing. har: HarmonyOS parsing. dSYM: iOS parsing. so: Android parsing |
| ExtraInfo | string | no | The additional system symbol table information for iOS parsing. This parameter is optional |
| Workspace | string | no | The Workspace |
| ServiceId | string | no | The ServiceId |

### Retrieves OCU usage data for Real User Monitoring (RUM)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-rum-ocu-statistic-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| StartTime | integer | yes | The start time as a UNIX timestamp, in milliseconds |
| EndTime | integer | yes | The end time as a UNIX timestamp, in milliseconds |
| QueryType | string | no | The query type. Valid values: INSTANT: non-time-series data. TIME_SERIES: time-series data |
| Filter | string | no | The filter conditions. Three filter conditions are supported: Application name: pid (Note: The application name is displayed, but the… |
| Group | string | no | The grouping fields. Valid values: siteType: groups and calculates total OCU by application type. dataType: groups and calculates total… |
| Page | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |
| RegionId | string | no | The region ID |

### Retrieves Real User Monitoring (RUM) related files, including symbol tables and SourceMap files
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-rum-upload-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| AppType | string | no | The file type. Valid values: source-map: a SourceMap file. mapping: an Android symbol table file. dsym: an iOS dSYM file |
| Pid | string | no | The application ID |
| RegionId | string | yes | The region ID |
| VersionId | string | no | The file version number. If this parameter is not specified, files of all versions are returned by default |
| PageSize | integer | no | The PageSize |
| NextToken | string | no | The NextToken |
| FileName | string | no | The FileName |
| Workspace | string | no | The Workspace |
| ServiceId | string | no | The ServiceId |

### Retrieves the details of a SourceMap file uploaded in Browser Monitoring
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-source-map-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| ID | string | yes | The ID of the SourceMap. Format: `pid/sourcemap file version/sourcemap file name` |
| Keyword | string | no | The keyword in the file name. The keyword is used to filter query results |
| OrderField | string | no | The field used for sorting. Valid values: version: sorts by version. uploadTime: sorts by upload time |
| AscendingSequence | string | no | Specifies whether to sort in ascending order. Valid values: true: Ascending order. false: Descending order |
| RegionId | string | no | The region ID |
| Edition | string | no | The version of the SourceMap |

### Retrieves the method stack information of a trace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-stack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| TraceID | string | yes | The trace ID. You can obtain this value on the Trace Analysis page in the ARMS console |
| RegionId | string | yes | The region ID |
| RpcID | string | yes | The RPC ID. You can obtain this value by calling the GetTrace operation |
| Pid | string | no | The application ID. In the ARMS console, choose Application Monitoring > Applications. On the page that appears, click the name of the… |
| StartTime | integer | no | The start timestamp of the method call, in ms |
| EndTime | integer | no | The end timestamp of the method call, in ms |
| SpanID | string | no | The span ID of the trace. You can obtain this value on the Trace Analysis page in the ARMS console |

### Retrieves monitoring nodes for Synthetic Monitoring
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-synthetic-monitors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| Filter | string | yes | The query conditions (JSON-encoded) |

### Retrieves the details of a scheduled Synthetic Monitoring task by task ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-synthetic-task-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. Default value: cn-hangzhou |
| TaskId | string | yes | The Synthetic Monitoring task ID |

### Retrieves the list of Synthetic Monitoring scheduled tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-synthetic-task-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID. Default value: cn-hangzhou |
| TaskType | string | no | The task type. Valid values: 3: Web performance - IE 34: Web performance - Chrome 0: Network quality 40: File download 7: API performance |
| Url | string | no | The URL to be monitored |
| TaskName | string | no | The task name |
| TaskStatus | string | no | The task status. Valid values: 0: Stopped. 1: Started. 9: Ended |
| PageNum | integer | no | The page number for paging |
| PageSize | integer | no | The number of items per page in the query results |
| Order | string | no | The field used for sorting |
| Direction | string | no | The sort direction. Valid values: asc: ascending order desc: descending order |

### Retrieves probe point information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-synthetic-task-monitors` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |

### Retrieves the details of a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-timing-synthetic-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | no | The region ID |
| TaskId | string | no | The Synthetic Monitoring task ID |

### Accelerates the retrieval of trace details
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-trace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| TraceID | string | yes | The trace ID. You can obtain the trace ID on the Trace Query page or the API Snapshot page in the Application Real-Time Monitoring Service… |
| RegionId | string | yes | The region ID |
| StartTime | integer | no | The start time. This value is a timestamp in milliseconds. If the length of TraceID is 30, this parameter is optional. If the length of… |
| EndTime | integer | no | The end time. This value is a timestamp in milliseconds. If the length of TraceID is 30, this parameter is optional. If the length of… |
| PageNumber | integer | no | The page number of the page to return |
| PageSize | integer | no | The number of entries per page. Maximum value: 100 |

### Retrieves the details of an Application Monitoring job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-trace-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | yes | The application ID. On the Application Monitoring > Application List page in the Application Real-Time Monitoring Service (ARMS) console,… |
| RegionId | string | yes | The region ID |
| Tags | string | no | The tags (JSON-encoded) |

### Queries all custom settings (such as trace sampling settings and agent switches) of an application in…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/get-trace-app-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| Pid | string | yes | The application ID. You can obtain the Pid by using one of the following methods: API:… |

### Proxies HTTP API requests for a specified Grafana workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/grafana-workspace-http-api-proxy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| GrafanaWorkspaceId | string | yes | The workspace ID |
| OrgId | integer | no | The organization ID. Default value: 1 |
| BodyStr | string | no | The message body content |

### Calls the ImportAppAlertRules operation to create application alert rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/import-app-alert-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| TemplateAlertId | string | no | The alert template ID. You must specify at least one of TemplateAlertId and TemplageAlertConfig. If both parameters are specified,… |
| Pids | string | yes | The Application Real-Time Monitoring Service (ARMS) application IDs (PIDs) associated with the common alert rules. The value is in the… |
| RegionId | string | yes | The region ID of the application associated with the application alert rule |
| ContactGroupIds | string | no | The IDs of the alert contact groups. The value is in the JSONArray format |
| IsAutoStart | string | no | Specifies whether to automatically enable the alert rule after it is created. Default value: `false`. `true`: automatically enables the… |
| TemplageAlertConfig | string | no | The configuration JSON string of the ARMS alert rule. You must specify at least one of TemplateAlertId and TemplageAlertConfig. If both… |
| Tags | string | no | The list of tags (JSON-encoded) |

### Initializes an environment instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/init-environment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://arms.ap-southeast-1.aliyuncs.com |
| RegionId | string | yes | The region ID |
| AliyunLang | string | no | The locale. Valid values: zh: Chinese. This is the default value. en: English |
| EnvironmentId | string | yes | The environment instance ID |
| ManagedType | string | no | The management type. Valid values: none: Unmanaged. This is the default value for ACK clusters. agent: Managed agent (including KSM). This… |
| CreateAuthToken | string | no | Specifies whether to create a token to improve data read security |

…and 91 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-arms/apply-scenario" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Application Real-Time Monitoring Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-arms/apply-scenario with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Application Real-Time Monitoring Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Application Real-Time Monitoring Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Application Real-Time Monitoring Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-arms.

### What is the status of the Alibaba Cloud Application Real-Time Monitoring Service API?
Needs your own provider key (bring your own key)