API standartları ve çok dilli hazır SDK'lar
Bu ürünün OpenAPI'si (ARMS/2019-08-08), RPC imzalama yöntemini kullanır. Geliştiriciler için yaygın programlama dillerine yönelik SDK'ları kapsülledik. Geliştiriciler, bu ürünün OpenAPI'sini teknik ayrıntılarla uğraşmadan doğrudan çağırabilmek için SDK'yı indirebilir. Mevcut SDK ihtiyaçlarınızı karşılamıyorsa, kendi imzanızı oluşturmak üzere imzalama mekanizmasını kullanarak entegrasyon yapabilirsiniz. Kendi imzanızı oluşturma sürecinin ayrıntıları oldukça karmaşık olduğundan, bu işlem yaklaşık 5 iş günü sürebilir. Bu nedenle, DingTalk hizmet grubumuza (147535001692) katılmanızı ve uzman rehberliği altında imzalama entegrasyonu gerçekleştirmenizi öneririz.
API'yi kullanmadan önce, istemci araçları (SDK ve CLI gibi) aracılığıyla API'ye etkili bir şekilde erişebilmek için kimlik hesabınızı ve erişim anahtarınızı (AccessKey) hazırlamanız gerekir. Ayrıntılar için bkz. AccessKey Alma.
Özel imzalama senaryoları
İş senaryonuzun özel gereksinimleri varsa ve API'yi kendi imzanızı oluşturarak entegre etmeniz gerekiyorsa, profesyonel rehberlik almak ve verimli bir entegrasyon sağlamak için öncelikle teknik destek ekibimizle (DingTalk hizmet grubu: 147535001692) iletişime geçmenizi öneririz.
Hesap ve güvenlik hazırlığı
Alibaba Cloud hesapları, tüm kaynaklar üzerinde tam yönetici izinlerine sahiptir. Bir AccessKey ele geçirildiğinde, ilişkili tüm kaynaklar yetkisiz erişim riskiyle karşı karşıya kalır. Güvenliği sağlamak için, yalnızca API erişim izinlerine sahip bir RAM kullanıcısı oluşturmanız ve bunun AccessKey'ini yapılandırmanız; ayrıca en az ayrıcalık ilkesine (PoLP) dayalı olarak RAM ilkelerini yapılandırmanız önerilir. Alibaba Cloud hesabını yalnızca Alibaba Cloud hesabı izinlerinin açıkça gerekli olduğu belirli senaryolarda kullanın.
Prometheus için yönetilen hizmet
|
API |
Başlık |
Açıklama |
| DescribeEnvDropMetricsRule | DescribeEnvDropMetricsRule | Queries the metric drop rule for a specified environment instance. |
| UpdateEnvDropMetricsRule | UpdateEnvDropMetricsRule | Updates a discarded metric rule in the environment. |
| AddTagToFlinkCluster | AddTagToFlinkCluster | Attaches the workspace ID and workspace name tags to the Prometheus instance corresponding to a Flink workspace. |
| CreateEnvironment | CreateEnvironment | Creates an environment instance. |
| InitEnvironment | InitEnvironment | Initializes an environment instance. |
| DescribeEnvironment | DescribeEnvironment | Queries the details of an environment. |
| UpdateEnvironment | UpdateEnvironment | Updates the configuration of an environment. |
| ListEnvironments | ListEnvironments | Queries environments. |
| DeleteEnvironment | DeleteEnvironment | Deletes an environment instance. |
| DescribeAddonMetrics | DescribeAddonMetrics | Queries the metric details of a component. |
| InstallEnvironmentFeature | InstallEnvironmentFeature | Installs a feature. |
| DescribeEnvironmentFeature | DescribeEnvironmentFeature | Queries the details of a feature. |
| UpgradeEnvironmentFeature | UpgradeEnvironmentFeature | Updates the feature information of an environment. |
| RestartEnvironmentFeature | RestartEnvironmentFeature | Restarts a feature. |
| ListEnvironmentFeatures | ListEnvironmentFeatures | Queries the features in an environment. |
| DeleteEnvironmentFeature | DeleteEnvironmentFeature | Deletes a feature. |
| CreateEnvCustomJob | CreateEnvCustomJob | Creates a custom job for an environment. |
| UpdateEnvCustomJob | UpdateEnvCustomJob | Updates a custom job for an environment. |
| ListEnvCustomJobs | ListEnvCustomJobs | Queries the custom jobs of an environment. |
| DescribeEnvCustomJob | DescribeEnvCustomJob | Queries the details of a custom job for an environment. |
| DeleteEnvCustomJob | DeleteEnvCustomJob | Deletes a custom job for an environment. |
| CreateEnvPodMonitor | CreateEnvPodMonitor | Creates a PodMonitor for an environment. |
| DescribeEnvPodMonitor | DescribeEnvPodMonitor | Queries the PodMonitor details of an environment. |
| ListEnvPodMonitors | ListEnvPodMonitors | Queries the PodMonitors of an environment. |
| UpdateEnvPodMonitor | UpdateEnvPodMonitor | Updates the PodMonitor of an environment. |
| DeleteEnvPodMonitor | DeleteEnvPodMonitor | Deletes the PodMonitor of an environment. |
| CreateEnvServiceMonitor | CreateEnvServiceMonitor | Creates a ServiceMonitor for an environment. |
| DescribeEnvServiceMonitor | DescribeEnvServiceMonitor | Queries the ServiceMonitor details of an environment. |
| ListEnvServiceMonitors | ListEnvServiceMonitors | Queries the ServiceMonitors of an environment. |
| UpdateEnvServiceMonitor | UpdateEnvServiceMonitor | Updates the ServiceMonitor of an environment. |
| DeleteEnvServiceMonitor | DeleteEnvServiceMonitor | Deletes the ServiceMonitor of an environment. |
| InstallAddon | InstallAddon | Installs an add-on. |
| DescribeAddonRelease | DescribeAddonRelease | Queries the release information of an add-on by name. |
| ListAddons | ListAddons | List of access center products. |
| UpgradeAddonRelease | UpgradeAddonRelease | Updates the release information of an add-on. |
| ListAddonReleases | Query addons installed in an environment | Queries the addons installed in an environment. |
| DeleteAddonRelease | DeleteAddonRelease | Delete AddonRelease data by AddonRelease name. |
| ListEnvironmentDashboards | ListEnvironmentDashboards | Queries information about a dashboard of an environment instance. |
| EnableMetric | EnableMetric | Enables a discarded metric. |
| UpdateMetricDrop | UpdateMetricDrop | Updates the list of discarded metrics. |
| UpdatePrometheusMonitoringStatus | UpdatePrometheusMonitoringStatus | Updates the status of the monitoring configuration of a Prometheus instance. |
| UpdatePrometheusMonitoring | UpdatePrometheusMonitoring | Updates the monitoring configuration of a Prometheus instance. |
| ListPrometheusMonitoring | ListPrometheusMonitoring | Queries the monitoring configuration of a Prometheus instance. |
| GetPrometheusMonitoring | GetPrometheusMonitoring | Queries the monitoring configuration of a Prometheus instance. |
| DeletePrometheusMonitoring | DeletePrometheusMonitoring | Deletes the monitoring configuration of a Prometheus instance. |
| CreatePrometheusMonitoring | CreatePrometheusMonitoring | Creates a monitoring configuration for a Prometheus instance. |
| AppendInstancesToPrometheusGlobalView | AppendInstancesToPrometheusGlobalView | Adds a data source to a global aggregation instance. |
| AddPrometheusInstance | AddPrometheusInstance | Creates a Prometheus instance for Remote Write. |
| AddPrometheusGlobalViewByAliClusterIds | AddPrometheusGlobalViewByAliClusterIds | Adds a global aggregation instance in Managed Service for Prometheus. |
| AddPrometheusGlobalView | Create aggregation instance | Adds an aggregation instance for ARMS Prometheus monitoring. |
| AddAliClusterIdsToPrometheusGlobalView | AddAliClusterIdsToPrometheusGlobalView | Adds a global aggregation instance as a data source in Managed Service for Prometheus. |
| AddRecordingRule | AddRecordingRule | Creates or updates a recording rule. |
| SyncRecordingRules | Batch synchronize aggregation rules of a cluster to other target clusters across all regions | Batch synchronizes the aggregation rules of a cluster to other target clusters across all regions. |
| AddIntegration | AddIntegration | Integrates the dashboard and collection rules of Prometheus Service. |
| GetIntegrationState | GetIntegrationState | Queries the integration state of the dashboards and collection rules of Application Real-Time Monitoring Service (ARMS) Prometheus. |
| DeleteIntegration | DeleteIntegration | Deletes the collection rules for a Container Service for Kubernetes (ACK) cluster. |
| AddGrafana | AddGrafana | Integrates the dashboard of Managed Service for Prometheus. |
| InstallCmsExporter | InstallCmsExporter | Installs the cms-exporter collector. |
| OpenVCluster | OpenVCluster | Activates a virtual cluster. |
| DeletePrometheusGlobalView | DeletePrometheusGlobalView | Deletes a global aggregation instance from Prometheus Service. |
| RemoveAliClusterIdsFromPrometheusGlobalView | RemoveAliClusterIdsFromPrometheusGlobalView | Removes data sources from a global aggregation instance in Managed Service for Prometheus. |
| RemoveSourcesFromPrometheusGlobalView | RemoveSourcesFromPrometheusGlobalView | Removes data sources from a global aggregation instance in Managed Service for Prometheus. You can delete only data sources that are not from Alibaba Cloud. |
| DeleteCmsExporter | Uninstall Prometheus for an Alibaba Cloud service instance | Uninstall Prometheus for an Alibaba Cloud service instance. |
| DelAuthToken | DelAuthToken | Disables an authentication token. |
| DeleteGrafanaResource | DeleteGrafanaResource | Deletes Grafana dashboard resources from a Managed Service for Prometheus instance. |
| UninstallPromCluster | UninstallPromCluster | Releases a Prometheus instance. |
| QueryPromInstallStatus | QueryPromInstallStatus | Queries whether the Prometheus agent is installed on a cluster. |
| ListPrometheusGlobalView | ListPrometheusGlobalView | Creates a global aggregation instance in Prometheus Service and obtains the list of global aggregation instances. |
| GetPrometheusGlobalView | GetPrometheusGlobalView | Queries the information about a global aggregation instance. |
| CheckServiceStatus | CheckServiceStatus | Checks the status of a service in the current cluster, such as whether the service is activated and whether the payment is overdue. |
| GetPrometheusApiToken | GetPrometheusApiToken | Queries the token required for integrating Prometheus Service. |
| GetExploreUrl | Retrieve grafana explore data | Retrieves data using the Explore feature of Grafana. |
| ListDashboards | ListDashboards | Queries the Grafana dashboards of a Container Service for Kubernetes (ACK) cluster. |
| ListClusterFromGrafana | ListClusterFromGrafana | Queries all Grafana dashboards in a specified region. |
| GetRecordingRule | GetRecordingRule | Obtains the recording rule of a cluster. |
| ListCmsInstances | Query the collection status of Alibaba Cloud services | Queries the data collection status of cloud services. |
| ListDashboardsByName | ListDashboardsByName | Uses Loki data sources and other data sources to create a Grafana dashboard in Managed Service for Prometheus. |
| GetAuthToken | GetAuthToken | Obtains an authentication token. When you connect a Container Service for Kubernetes (ACK) cluster to Prometheus Service over the Internet, you must use a token for authentication. |
| GetClusterAllUrl | GetClusterAllUrl | Obtains all the URLs of a cluster, including remote read and write URLs, Pushgateway URLs, and Grafana URLs. |
| GetCloudClusterAllUrl | GetCloudClusterAllUrl | Queries the read and write URLs of a CloudMonitor instance, such as Pushgateway and Grafana URLs. |
| ListPrometheusInstances | ListPrometheusInstances | Obtains all Prometheus instances in a region. |
| InstallManagedPrometheus | Create Managed Prometheus | Create a managed (ASK/ECS) Prometheus instance. |
| UninstallManagedPrometheus | UninstallManagedPrometheus | Uninstalls a managed Prometheus agent for a serverless Kubernetes (ASK) cluster, Distributed Cloud Container Platform for Kubernetes (ACK One) cluster, or Elastic Compute Service (ECS) cluster. |
| GetManagedPrometheusStatus | GetManagedPrometheusStatus | Queries the installation status of a Prometheus agent in a serverless Kubernetes (ASK) cluster or an Elastic Compute Service (ECS) cluster. |
| BindPrometheusGrafanaInstance | BindPrometheusGrafanaInstance | Binds a Grafana workspace to a Prometheus instance. |
| AddPrometheusIntegration | AddPrometheusIntegration | Adds an exporter to a Prometheus instance for Container Service or a Prometheus instance for ECS. |
| UpdatePrometheusIntegration | UpdatePrometheusIntegration | Modifies the configurations of an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS. |
| DeletePrometheusIntegration | DeletePrometheusIntegration | Deletes an exporter from a Prometheus instance for Container Service or a Prometheus instance for ECS. |
| GetPrometheusIntegration | GetPrometheusIntegration | Queries the information about an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS. |
| ListPrometheusIntegration | ListPrometheusIntegration | Queries a list of exporters that are integrated into a Prometheus instance. Only aliyun-cs and ecs instances are supported. |
| GetPrometheusInstance | Retrieve specified prometheus instance information | Retrieves information about a specified Prometheus instance. |
| ListPrometheusInstanceByTagAndResourceGroupId | ListPrometheusInstanceByTagAndResourceGroupId | Queries Prometheus instances by tag and resource group. |
| CreatePrometheusInstance | Create a prometheus instance | Creates a Managed Service for Prometheus instance. |
| UpdatePrometheusInstance | Update prometheus instance information | Updates the information of a Prometheus instance. |
| UpdatePrometheusGlobalView | UpdatePrometheusGlobalView | Updates the data sources of Prometheus instance for GlobalView. |
| ListEnvironmentKubeResources | ListEnvironmentKubeResources | Queries the Kubernetes resources of an environment. |
| ListEnvironmentMetricTargets | ListEnvironmentMetricTargets | Queries the targets of an environment. |
| ListEnvironmentAddons | Query the Addon installed in a specified environment | Lists the add-ons installed in a specified environment. |
| ListEnvironmentAlertRules | ListEnvironmentAlertRules | Queries the alert groups of an environment instance. |
Prometheus uyarı kuralları (eski)
|
API |
Başlık |
Açıklama |
| CreatePrometheusAlertRule | CreatePrometheusAlertRule | Creates an alert rule. |
| DeletePrometheusAlertRule | DeletePrometheusAlertRule | Deletes an alert rule of Prometheus Service. |
| UpdatePrometheusAlertRule | UpdatePrometheusAlertRule | Updates a Prometheus alert rule. |
| DescribePrometheusAlertRule | DescribePrometheusAlertRule | Queries the details about an alert rule for a Prometheus instance. |
| ListPrometheusAlertRules | ListPrometheusAlertRules | Queries the alert rules created for a Prometheus instance. |
| ListPrometheusAlertTemplates | ListPrometheusAlertTemplates | Queries the alert templates of Prometheus Service. |
Erişim denetimi
|
API |
Başlık |
Açıklama |
| OpenArmsServiceSecondVersion | OpenArmsServiceSecondVersion | Activates a specified pay-as-you-go sub-service of Application Real-Time Monitoring Service (ARMS). |
| OpenXtraceDefaultSLR | OpenXtraceDefaultSLR | Activates the service-linked role AliyunServiceRoleForXtrace for Tracing Analysis. |
| OpenArmsDefaultSLR | OpenArmsDefaultSLR | Activates the service-linked role AliyunServiceRoleForARMS for Application Real-Time Monitoring Service (ARMS). |
| ChangeResourceGroup | ChangeResourceGroup | Moves a resource to a specific resource group. |
| TagResources | TagResources | Adds tags to ARMS resources. |
| UntagResources | UntagResources | Removes tags from ARMS resources. |
Faturalandırma
|
API |
Başlık |
Açıklama |
| GetCommercialStatus | GetCommercialStatus | Queries whether the current account has activated the commercial edition of a service. |
| CheckCommercialStatus | Check product commercial activation status | Checks the commercial activation status of a product. |
| QueryCommercialUsage | QueryCommercialUsage | Queries the amount of data written to Application Monitoring, Managed Service for OpenTelemetry, Managed Service for Prometheus, and Real User Monitoring (RUM). |