Standar API dan SDK siap pakai dalam berbagai bahasa
Spesifikasi OpenAPI produk ini (ARMS/2019-08-08) mematuhi standar RPC. Alibaba Cloud menyediakan SDK siap pakai untuk berbagai bahasa pemrograman populer guna mengabstraksi kompleksitas tingkat rendah seperti request signing. Hal ini memungkinkan developer untuk memanggil API menggunakan sintaks khusus tanpa perlu menangani detail HTTP secara langsung.
Signature kustom
Jika SDK tidak mendukung kebutuhan spesifik Anda, seperti signature kustom, Anda harus menandatangani request secara manual menggunakan signature mechanism. Perhatikan bahwa proses penandatanganan manual memerlukan upaya yang signifikan (estimasi 5 hari kerja). Untuk mendapatkan dukungan, bergabunglah dengan grup DingTalk kami (ID: 147535001692).
Sebelum Anda mulai
Akun Alibaba Cloud memiliki hak administratif penuh. Jika pasangan AccessKey dikompromikan, semua resource terkait dapat terekspos terhadap akses tidak sah, sehingga menimbulkan risiko keamanan yang signifikan. Buat Resource Access Management (RAM) user dengan akses khusus API dan gunakan kebijakan RAM untuk menerapkan principle of least privilege (PoLP). Gunakan akun Alibaba Cloud hanya jika benar-benar diperlukan.
Untuk memanggil API secara aman, konfigurasikan hal berikut:
Akun RAM user
Pasangan AccessKey untuk akun tersebut
Layanan Terkelola untuk Prometheus
|
API |
Judul |
Deskripsi |
| DescribeEnvDropMetricsRule | 查询接入环境的废弃指标规则 | 查询指定环境实例的废弃指标列表。 |
| UpdateEnvDropMetricsRule | 更新环境中废弃指标规则 | 更新环境中废弃指标规则。 |
| AddTagToFlinkCluster | Prometheus Flink集群打标 | 主要将用户Flink工作空间对应的Prometheus实例打上工作空间ID、工作空间名称这两个Tag。 |
| CreateEnvironment | 创建环境 | 创建环境实例。 |
| InitEnvironment | 初始化环境实例 | 初始化环境实例。 |
| DescribeEnvironment | 查询环境详情 | 查询环境详情。 |
| UpdateEnvironment | 更新环境信息 | 更新环境信息。 |
| ListEnvironments | 查询环境列表 | 查询环境列表。 |
| DeleteEnvironment | 删除环境 | 删除环境实例。 |
| DescribeAddonMetrics | 查询Addon指标信息 | 查询指定Addon的指标详情。 |
| InstallEnvironmentFeature | 安装Feature | 安装Feature。 |
| DescribeEnvironmentFeature | 查询Feature详情 | 查询Feature详情。 |
| UpgradeEnvironmentFeature | 更新Feature | 更新Feature信息。 |
| RestartEnvironmentFeature | 重启Feature | 重启feature。 |
| ListEnvironmentFeatures | 查询环境中的Feature | 查询环境中的Feature。 |
| DeleteEnvironmentFeature | 删除feature | 删除feature。 |
| CreateEnvCustomJob | 创建环境的自定义Job | 创建环境的自定义Job。 |
| UpdateEnvCustomJob | 更新环境的自定义Job | 更新环境的自定义Job。 |
| ListEnvCustomJobs | 查询环境的自定义Job列表 | 查询环境的自定义Job列表。 |
| DescribeEnvCustomJob | 查询环境CustomJob详情 | 查询环境CustomJob详情。 |
| DeleteEnvCustomJob | 删除环境的自定义Job | 删除环境的自定义job。 |
| CreateEnvPodMonitor | 创建环境的PodMonitor | 创建环境的PodMonitor。 |
| DescribeEnvPodMonitor | 查询环境的PodMonitor详情 | 查询环境的PodMonitor详情。 |
| ListEnvPodMonitors | 查询环境的PodMonitor列表 | 查询环境的PodMonitor列表。 |
| UpdateEnvPodMonitor | 更新环境的PodMonitor | 更新环境的PodMonitor。 |
| DeleteEnvPodMonitor | 删除环境PodMonitor | 删除环境PodMonitor。 |
| CreateEnvServiceMonitor | 创建环境的ServiceMonitor | 创建环境的ServiceMonitor。 |
| DescribeEnvServiceMonitor | 查询环境的ServiceMonitor详情 | 查询环境的ServiceMonitor详情。 |
| ListEnvServiceMonitors | 查询环境的ServiceMonitor列表 | 查询环境的ServiceMonitor列表。 |
| UpdateEnvServiceMonitor | 更新环境的ServiceMonitor | 更新环境的ServiceMonitor。 |
| DeleteEnvServiceMonitor | 删除环境ServiceMonitor | 删除环境ServiceMonitor。 |
| InstallAddon | 安装Addon信息 | 安装Addon信息。 |
| DescribeAddonRelease | 查看AddonRelease详情 | 通过名称查询AddonRelease详情。 |
| ListAddons | 查询addon列表 | 新版接入中心产品列表。 |
| UpgradeAddonRelease | 更新AddonRelease信息 | 更新AddonRelease信息。 |
| ListAddonReleases | 查询环境中安装的Addon | 查询环境中安装的Addon。 |
| DeleteAddonRelease | 删除AddonRelease信息 | 通过AddonRelease名称删除AddonRelease数据。 |
| ListEnvironmentDashboards | 查询环境中的大盘信息 | 查询环境中的大盘信息。 |
| EnableMetric | 启用单个废弃指标 | 启用废弃指标。 |
| UpdateMetricDrop | 更新废弃指标列表 | 更新废弃指标列表。 |
| UpdatePrometheusMonitoringStatus | 更新Prometheus实例监控配置状态 | 更新Prometheus实例监控配置状态。 |
| UpdatePrometheusMonitoring | 更新Prometheus实例监控配置 | 更新Prometheus实例监控配置。 |
| ListPrometheusMonitoring | 查询Prometheus实例监控配置 | 查询Prometheus实例监控配置。 |
| GetPrometheusMonitoring | 查询Prometheus实例指定监控配置 | 查询Prometheus实例指定监控配置。 |
| DeletePrometheusMonitoring | 删除Prometheus实例监控配置 | 删除Prometheus实例监控配置。 |
| CreatePrometheusMonitoring | 创建Prometheus实例的监控配置 | 创建Prometheus实例的监控配置。 |
| AppendInstancesToPrometheusGlobalView | 新增Prometheus实例数据源 | 增加ARMS Prometheus监控聚合实例中的数据源，将数据源添加到Prometheus聚合实例。 |
| AddPrometheusInstance | 创建RemoteWrite类型的Prometheus实例 | 创建RemoteWrite类型Prometheus实例。 |
| AddPrometheusGlobalViewByAliClusterIds | 新增容器聚合实例 | 增加ARMS Prometheus监控的聚合实例。 |
| AddPrometheusGlobalView | 新增聚合实例 | 增加ARMS Prometheus监控的聚合实例。 |
| AddAliClusterIdsToPrometheusGlobalView | 新增聚合实例数据源 | 增加ARMS Prometheus监控聚合实例的数据源。 |
| AddRecordingRule | 创建RecordingRule | 创建或者更新Prometheus监控的RecordingRule规则。 |
| SyncRecordingRules | 将某个集群的聚合规则批量同步到全Region的其他目标集群 | 将某个集群的聚合规则批量同步到全Region的其他目标集群。 |
| AddIntegration | 集成大盘及采集规则 | 集成ARMS Prometheus监控的大盘以及采集规则。 |
| GetIntegrationState | 获取Integration的接入状态 | 来获取Integration的接入状态。 |
| DeleteIntegration | 删除Integration接入的采集规则 | 删除Integration接入的采集规则。 |
| AddGrafana | 集成Prometheus监控大盘 | 集成ARMS Prometheus监控的大盘。 |
| InstallCmsExporter | 安装云服务采集器 | 安装云服务采集器。 |
| OpenVCluster | 开通虚拟集群 | 开通虚拟集群。 |
| DeletePrometheusGlobalView | 删除Prometheus聚合实例 | 删除Prometheus聚合实例。 |
| RemoveAliClusterIdsFromPrometheusGlobalView | 删除聚合实例数据源 | 移除ARMS Prometheus监控聚合实例的某些数据源。 |
| RemoveSourcesFromPrometheusGlobalView | 删除聚合实例非阿里数据源 | 移除ARMS Prometheus监控聚合实例中的数据源，仅支持删除非阿里数据源。 |
| DeleteCmsExporter | 卸载Prometheus for 云服务实例 | 来卸载Prometheus for 云服务实例。 |
| DelAuthToken | 关闭鉴权token | 关闭鉴权token。 |
| DeleteGrafanaResource | 删除集群的大盘资源 | 删除ARMS Prometheus监控集群中的Grafana大盘资源。 |
| UninstallPromCluster | 卸载prometheus集群 | 来卸载ARMS Prometheus集群实例。 |
| QueryPromInstallStatus | 查询集群安装状态 | 来查询ARMS Prometheus集群的安装状态。 |
| ListPrometheusGlobalView | 获取聚合实例列表 | 增加ARMS Prometheus监控的聚合实例，获取聚合实例列表。 |
| GetPrometheusGlobalView | 获取聚合实例的数据源详情 | 增加ARMS Prometheus监控的聚合实例，获取指定聚合实例的详细数据源情况。 |
| CheckServiceStatus | 检查产品开通状态 | 检查集群当前的服务状态，例如是否开通服务，是否欠费等。 |
| GetPrometheusApiToken | 获取Prometheus监控所需Token | 获取集成ARMS Prometheus监控所需的Token。 |
| GetExploreUrl | 获取Grafana的Explore功能 | 获取使用Grafana的Explore功能。 |
| ListDashboards | 获取集群的大盘列表 | 获取集群的Grafana大盘的列表。 |
| ListClusterFromGrafana | 列出指定地域下的所有Grafana大盘 | 列出指定地域下的所有Grafana大盘。 |
| GetRecordingRule | 获取聚合规则 | 获取集群的RecordingRule聚合规则。 |
| ListCmsInstances | 查询云服务采集状态 | 查询云服务采集状态。 |
| ListDashboardsByName | 创建Loki数据源和相关的多数据源大盘 | 来创建与Prometheus关联的Loki数据源和相关的多数据源大盘。 |
| GetAuthToken | 获取公网读写鉴权 | 获取公网读写鉴权Token。 |
| GetClusterAllUrl | 获取集群所有地址 | 获取集群所有地址。包括远程读写地址、 Push Gateway地址、 Grafana地址。 |
| GetCloudClusterAllUrl | 获取云产品各种URL | 获取云监控云产品读写地址，pushgateway，grafana 地址。 |
| ListPrometheusInstances | 获取所有正常实例 | 获取Prometheus的所有正常实例。 |
| InstallManagedPrometheus | 创建托管Prometheus | 创建托管（ASK/ECS）Prometheus。 |
| UninstallManagedPrometheus | 卸载托管Prometheus | 卸载托管（ASK/ECS/ACKoNE）Prometheus。 |
| GetManagedPrometheusStatus | 获取托管版Prometheus安装状态 | 获取托管版（ask、ecs和one）Prometheus实例的安装状态。 |
| BindPrometheusGrafanaInstance | 绑定Prometheus实例使用的Grafana工作区ID | 绑定Prometheus实例使用的Grafana工作区ID。 |
| AddPrometheusIntegration | 增加Prometheus实例的集成中心Exporter实例 | 增加Prometheus实例的集成中心Exporter实例（仅支持aliyun-cs、ecs两种类型的实例）。 |
| UpdatePrometheusIntegration | 更改Prometheus实例集成中心Exporter配置 | 更改Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）集成中心Exporter配置。 |
| DeletePrometheusIntegration | 删除Prometheus实例集成中心Exporter实例 | 删除Prometheus实例集成中心Exporter实例（仅支持aliyun-cs、ecs两种类型的实例）。 |
| GetPrometheusIntegration | 获取Prometheus实例指定集成中心Exporter实例 | 获取Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）指定集成中心Exporter实例。 |
| ListPrometheusIntegration | 查询Prometheus实例集成中心Exporter实例列表 | 查询Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）集成中心Exporter实例列表。 |
| GetPrometheusInstance | 获取指定Prometheus实例信息 | 获取指定Prometheus实例信息。 |
| ListPrometheusInstanceByTagAndResourceGroupId | 根据标签和资源组查询Prometheus实例 | 根据标签和资源组查询Prometheus实例。 |
| CreatePrometheusInstance | 新建Prometheus实例 | 新建Prometheus实例。 |
| UpdatePrometheusInstance | 更新Prometheus实例信息 | 更新Prometheus实例信息。 |
| UpdatePrometheusGlobalView | 更新Prometheus for GlobalView聚合数据源 | 更新Prometheus for GlobalView聚合数据源。 |
| ListEnvironmentKubeResources | 查看环境的K8s资源 | 查看环境的K8s资源。 |
| ListEnvironmentMetricTargets | 查询环境中的Target列表 | 查询环境中的Target列表。 |
| ListEnvironmentAddons | 查询指定环境安装的Addon | 查询指定环境安装的Addon信息。 |
| ListEnvironmentAlertRules | 查询环境中的告警组信息 | 查询环境中的告警组信息。 |
Aturan Peringatan Prometheus (Legacy)
|
API |
Judul |
Deskripsi |
| CreatePrometheusAlertRule | 创建告警规则 | 创建告警规则。 |
| DeletePrometheusAlertRule | 删除告警规则 | 删除Prometheus告警规则。 |
| UpdatePrometheusAlertRule | 更新告警规则 | 调用UpdatePrometheusAlertRule接口更新Prometheus报警规则。 |
| DescribePrometheusAlertRule | 查看告警规则 | 查看Prometheus告警规则。 |
| ListPrometheusAlertRules | 查看告警规则列表 | 查看Prometheus告警规则列表。 |
| ListPrometheusAlertTemplates | 查看告警模板列表 | 调用ListPrometheusAlertTemplates接口查看Prometheus告警模板列表。 |
Kontrol Akses
|
API |
Judul |
Deskripsi |
| OpenArmsServiceSecondVersion | 开通ARMS | 开通ARMS下指定子产品的后付费功能。 |
| OpenXtraceDefaultSLR | 开通可观测链路 OpenTelemetry 版服务关联角色 | 开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace。 |
| OpenArmsDefaultSLR | 开通ARMS服务关联角色 | 开通ARMS服务关联角色AliyunServiceRoleForARMS。 |
| ChangeResourceGroup | ARMS资源转组 | 修改资源所属资源组。 |
| TagResources | 创建标签资源关系 | 用于给ARMS资源实例打标签。 |
| UntagResources | 删除标签资源关系 | 用于删除ARMS资源实例标签。 |
Penagihan
|
API |
Judul |
Deskripsi |
| GetCommercialStatus | 获取商业化状态 | 查看当前账号是否开通对应产品的商业化版本。 |
| CheckCommercialStatus | 检查产品商业化状态 | 检查产品的商业化开通状态。 |
| QueryCommercialUsage | 查询可观测用量数据 | 查询写入量数据，支持应用监控、可观测链路OpenTelemetry版、Prometheus、用户体验监控四大产品用量数据。 |