本产品（Cms/2024-03-30）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
工作空间
|
API |
标题 |
API概述 |
| PutWorkspace | 创建修改工作空间 | 创建工作空间。 |
| GetWorkspace | 获取工作空间 | 获取工作空间。 |
| ListWorkspaces | 获取工作空间列表 | 获取工作空间列表。 |
| DeleteWorkspace | 删除工作空间 | 删除工作空间。 |
| CreateCloudResource | 创建云资源中心 | 创建云资源中心 |
| GetCloudResource | 获取云资源中心属性 | 查询云资源中心 |
| GetCloudResourceData | 查询云资源中心数据 | 查询云资源中心数据 |
| DeleteCloudResource | 删除云资源中心 | 删除云资源中心 |
| CreateEntityStore | 创建EntityStore | 创建EntityStore相关存储 |
| GetEntityStore | 获取EntityStore | 获取EntityStore相关存储信息 |
| GetEntityStoreData | 查询实体和关系数据 | 查询指定Workspace下的实体和关系数据，返回结果显示某时间区间中的实体数据。 |
| DeleteEntityStore | 删除EntityStore | 删除EntityStore相关存储 |
| CreateUmodel | 创建 Umodel | 创建Umodel配置。 |
| GetUmodel | 获取 Umodel | 获取Umodel配置信息。 |
| UpdateUmodel | 更新 Umodel | 更新Umodel配置信息。 |
| DeleteUmodel | 删除 Umodel | 删除Umodel配置信息。 |
| GetUmodelData | 获取 Umodel Data | 获取相关联的 Umodel 图数据。 |
| UpsertUmodelData | 添加或覆盖Umodel（元素） | 写入 Umodel Elements。 |
| DeleteUmodelData | 删除Umodel Data | 删除 Umodel Elements。 |
| GetUmodelCommonSchemaRef | 获取引用的公共Umodel Schema | 获取引用的公共Umodel Schema。 |
| DeleteUmodelCommonSchemaRef | 删除指定的公共Umodel Schema引用 | 删除引用的公共Umodel Schema。 |
| UpsertUmodelCommonSchemaRef | 引用指定的公共Umodel Schema | 更新引用的公共Umodel Schema。 |
数据接入
|
API |
标题 |
API概述 |
| UpdateIntegrationPolicy | 更新接入中心策略 | 更新指定策略 |
| DeleteIntegrationPolicy | 删除接入中心策略 | 删除接入中心策略 |
| CreateIntegrationPolicy | 创建接入中心策略 | 创建接入中心策略 |
| UpdateAddonRelease | 更新接入组件配置 | 升级接入组件 |
| ListIntegrationPolicyStorageRequirements | 获取接入中心策略的存储要求信息 | 获取接入中心策略的存储要求信息 |
| ListIntegrationPolicyPodMonitors | 查询接入中心策略的PodMonitor资源 | 获取接入中心策略的PodMonitor资源。 |
| ListIntegrationPolicyDashboards | 查询大盘列表 | 查询大盘列表。 |
| ListIntegrationPolicyCustomScrapeJobRules | 获取接入中心策略的自定义服务发现规则 | 获取接入中心策略的自定义服务发现规则。 |
| ListIntegrationPolicies | 查询接入中心策略列表信息 | 查询接入中心策略列表信息 |
| ListAddonReleases | 查看接入组件列表 | addon的release列表 |
| GetIntegrationPolicy | 查询接入中心策略详情 | 查询接入中心策略信息 |
| GetAddonRelease | 查看接入组件信息 | 查看addon release(查看接入状态)。 |
| DeleteAddonRelease | 卸载接入组件 | 删除addon release信息 |
| CreateAddonRelease | 安装接入组件 | 安装接入组件，代表进行一次接入 |
应用监控/用户体验监控
|
API |
标题 |
API概述 |
| GetServiceObservability | 获取应用可观测 | 获取应用可观测实例 |
| DeleteService | 删除应用可观测服务 | 删除应用可观测服务 |
| UpdateService | 更新应用可观测服务 | 更新应用可观测服务 |
| GetService | 查询应用可观测服务 | 查询应用可观测服务 |
| CreateService | 创建应用可观测服务 | 创建应用可观测服务 |
| ListServices | 批量查询应用可观测服务 | 批量查询应用可观测服务 |
Prometheus
|
API |
标题 |
API概述 |
| CreatePrometheusVirtualInstance | 创建Prometheus监控虚拟实例 | 创建Prometheus监控虚拟实例 |
| ListPrometheusVirtualInstances | 获取Prometheus虚拟实例列表 | 获取Prometheus虚拟实例 |
| GetAggTaskGroup | 查询聚合任务组 | 查询聚合任务组详情。 |
| CreateAggTaskGroup | 创建聚合任务组 | 创建聚合任务组。 |
| DeleteAggTaskGroup | 删除聚合任务组 | 删除聚合任务组。 |
| UpdateAggTaskGroupStatus | 更新聚合任务组状态 | 更新聚合任务组状态。 |
| UpdateAggTaskGroup | 更新聚合任务组 | 应用聚合任务组。 |
| ListAggTaskGroups | 查询聚合任务组列表 | 查询聚合任务组列表。 |
| DeletePrometheusInstance | 删除Prometheus实例 | 删除prom实例。 |
| DeletePrometheusView | 删除prometheus视图实例。 | 删除prometheus视图实例。 |
| GetPrometheusInstance | 获取Prometheus实例详细信息 | 查询指定Prometheus实例详情信息。 |
| GetPrometheusView | 查询指定Prometheus视图实例详情。 | 查询指定Prometheus视图实例详情。 |
| ListPrometheusDashboards | 获取Prometheus实例大盘列表 | 获取Prometheus实例大盘列表。 |
| UpdatePrometheusView | 更新Prom视图实例信息 | 更新Prometheus视图实例信息。 |
| UpdatePrometheusInstance | 更新Prometheus实例信息 | 更新Prometheus实例信息。 |
| ListPrometheusViews | 获取Prometheus视图实例列表 | 获取Prometheus视图实例信息列表。 |
| ListPrometheusInstances | 查询 Prometheus 实例列表 | 获取Prometheus实例信息列表。 |
| CreatePrometheusInstance | 创建Prometheus实例 | 创建Prometheus监控实例 |
| CreatePrometheusView | 创建prometheus视图 | 创建prometheus视图 |
告警
|
API |
标题 |
API概述 |
| ListAlertActions | 查询告警行动集成 | 查询告警行动集成 |
| UpdateSubscription | 更新订阅 | 更新订阅 |
| UpdateNotifyStrategy | 更新通知策略 | 更新通知策略 |
控制台内嵌
|
API |
标题 |
API概述 |
| CreateTicket | 创建免登录票据 | 如果您需要将控制台页面免密分享给其他人或者嵌入到第三方系统，可以调用CreateTicket生成票据，然后拼接免密链接。 |
地域
|
API |
标题 |
API概述 |
| DescribeRegions | 查询地域列表 | 查询地域信息列表 |
服务开通
|
API |
标题 |
API概述 |
| GetCmsService | 检查Prometheus服务或商品开通状态 | 检查Prometheus服务或商品开通状态。 |
其他
|
API |
标题 |
API概述 |
| GetPrometheusUserSetting | 获取Prometheus用户配置。 | 查询Prometheus用户配置。 |
| ListIntegrationPolicyServiceMonitors | 获取接入中心策略的ServiceMonitor信息 | 获取接入中心策略的ServiceMonitor信息 |
| UpdatePrometheusUserSetting | 更新Prometheus用户配置。 | 更新Prometheus用户配置信息。 |
该文章对您有帮助吗？