API标准及多语言预置SDK
本产品（Cms/2024-03-30）的OpenAPI采用ROA签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
数据集
|
API |
标题 |
API概述 |
| ExecuteQuery | 执行 sql、spl 等查询接口 | 执行 sql、spl 等查询接口 |
上下文库
|
API |
标题 |
API概述 |
| CreateContextStore | 创建上下文库 | 创建上下文库 |
| UpdateContextStore | 修改上下文库配置 | 修改上下文库配置 |
| ListContextStores | 查询上下文库列表 | 查询上下文库列表 |
| GetContextStore | 查询上下文库 | 查询上下文库 |
| DeleteContextStore | 删除上下文库 | 删除上下文库 |
| AddContexts | 写入上下文 | 写入上下文 |
| UpdateContext | 修改上下文 | 修改上下文 |
| SearchContext | 搜索上下文 | 搜索上下文。 |
| GetContext | 查询单条上下文 | 查询单条上下文 |
| DeleteContexts | 批量删除上下文 | 批量删除上下文 |
| DeleteContext | 删除上下文 | 删除上下文 |
| CreateContextStoreAPIKey | 创建 API Key | 创建 API Key |
| ListContextStoreAPIKeys | 获取 API Key 列表 | 获取 API Key 列表 |
| DeleteContextStoreAPIKey | 删除 API Key | 删除 API Key |
记忆库
|
API |
标题 |
API概述 |
| UpdateMemoryStore | 修改记忆库 | 修改记忆库。 |
| UpdateMemory | 修改记忆 | 修改记忆 |
| ListMemoryStores | 查询记忆库列表 | 查询记忆库列表。 |
| GetMemoryStore | 查询记忆库 | 查询记忆库。 |
| GetMemoryHistory | 获取记忆历史记录 | 获取记忆历史记录。 |
| GetMemory | 获取单个记忆 | 获取单个记忆。 |
| GetMemories | 获取全部记忆 | 获取全部记忆。 |
| DeleteMemoryStore | 删除记忆库 | 删除记忆库 |
| DeleteMemory | 删除单个记忆 | 删除单个记忆。 |
| DeleteMemories | 批量删除记忆 | 通过过滤属性删除记忆。至少需要设置一个过滤属性，若不设置任何过滤属性，则会返回验证错误提示。 |
| AddMemories | 添加记忆 | 向用户的记忆存储中添加新的事实、消息或元数据。“添加记忆”端点接受原始文本或对话回合，并异步提交它们，以便记忆准备好用于后续的搜索、检索和图查询。 |
| CreateMemoryStore | 创建记忆库 | 创建记忆库 |
工作空间
|
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概述 |
| GetAddon | 获取 Addon 配置详情 | 获取插件详情(Addon)。 |
| GetAddonSchema | 获取Addon的Schema信息 | 插件schema详情(Addon)。 |
| UpdateIntegrationPolicy | 更新接入中心策略 | 更新指定策略 |
| DeleteIntegrationPolicy | 删除接入中心策略 | 删除接入中心策略 |
| CreateIntegrationPolicy | 创建接入中心策略 | 创建接入中心策略 |
| UpdateAddonRelease | 更新接入组件配置 | 升级接入组件 |
| ListIntegrationPolicyStorageRequirements | 获取接入中心策略的存储要求信息 | 获取接入中心策略的存储要求信息 |
| ListIntegrationPolicyPodMonitors | 查询接入中心策略的PodMonitor资源 | 获取接入中心策略的PodMonitor资源。 |
| ListIntegrationPolicyDashboards | 查询大盘列表 | 查询大盘列表。 |
| ListIntegrationPolicyCustomScrapeJobRules | 获取接入中心策略的自定义服务发现规则 | 获取接入中心策略的自定义服务发现规则。 |
| ListIntegrationPolicies | 查询接入中心策略列表信息 | 查询接入中心策略列表信息 |
| GetIntegrationPolicy | 查询接入中心策略详情 | 查询接入中心策略信息 |
| GetAddonRelease | 查看接入组件信息 | 查看addon release(查看接入状态)。 |
| CreateAddonRelease | 安装接入组件 | 安装接入组件，代表进行一次接入 |
| ListIntegrationPolicyServiceMonitors | 获取接入中心策略的ServiceMonitor信息 | 获取接入中心策略的ServiceMonitor信息 |
| ListIntegrationPolicyCollectors | 获取接入中心策略的采集器 | 获取接入中心策略的采集器信息 |
| ListIntegrationPolicyAddons | 获取当前策略安装的Addon列表 | 获取当前策略安装的Addon列表。 |
应用监控/用户体验监控
|
API |
标题 |
API概述 |
| GetServiceObservability | 获取应用可观测 | 获取应用可观测实例 |
| DeleteService | 删除应用可观测服务 | 删除应用可观测服务 |
| UpdateService | 更新应用可观测服务 | 更新应用可观测服务 |
| GetService | 查询应用可观测服务 | 查询应用可观测服务 |
| CreateService | 创建应用可观测服务 | 创建应用可观测服务 |
| ListServices | 批量查询应用可观测服务 | 批量查询应用可观测服务 |
Prometheus
|
API |
标题 |
API概述 |
| CreatePrometheusInstance | 创建Prometheus实例 | 创建Prometheus监控实例 |
| GetPrometheusInstance | 获取Prometheus实例详细信息 | 查询指定Prometheus实例详情信息。 |
| ListPrometheusInstances | 查询 Prometheus 实例列表 | 获取Prometheus实例信息列表。 |
| UpdatePrometheusInstance | 更新Prometheus实例信息 | 更新Prometheus实例信息。 |
| DeletePrometheusInstance | 删除Prometheus实例 | 删除prom实例。 |
| DeleteDeliveryTask | 删除数据投递任务 | 删除数据投递任务 |
| UpdateDeliveryTask | 更新数据投递任务 | 更新数据投递任务。更新语义为 Patch：未填写的字段保持不变。 |
| ListDeliveryTasks | 获取数据投递任务列表 | 获取数据投递任务列表 |
| GetDeliveryTask | 获取数据投递任务 | 获取数据投递任务详情 |
| CreateDeliveryTask | 创建数据投递任务 | 创建数据投递任务，将指定数据源的指标数据投递至目标存储或消息队列，支持 Prometheus Remote Write、Kafka、MaxCompute 三种投递类型。支持通过标签过滤指定投递的指标范围，以及为投递指标附加自定义标签。 |
| CreatePrometheusVirtualInstance | 创建Prometheus监控虚拟实例 | 创建Prometheus监控虚拟实例 |
| ListPrometheusVirtualInstances | 获取Prometheus虚拟实例列表 | 获取Prometheus虚拟实例。 |
| DeletePrometheusVirtualInstance | 删除 Prometheus 虚拟实例 | 通过虚拟实例 ID 删除 Prometheus 虚拟实例。 |
| GetAggTaskGroup | 查询聚合任务组 | 查询聚合任务组详情。 |
| CreateAggTaskGroup | 创建聚合任务组 | 创建聚合任务组。 |
| DeleteAggTaskGroup | 删除聚合任务组 | 删除聚合任务组。 |
| UpdateAggTaskGroupStatus | 更新聚合任务组状态 | 更新聚合任务组状态。 |
| UpdateAggTaskGroup | 更新聚合任务组 | 应用聚合任务组。 |
| ListAggTaskGroups | 查询聚合任务组列表 | 查询聚合任务组列表。 |
| ListPrometheusDashboards | 获取Prometheus实例大盘列表 | 获取Prometheus实例大盘列表。 |
| DeletePrometheusView | 删除prometheus视图实例。 | 删除prometheus视图实例。 |
| GetPrometheusView | 查询指定Prometheus视图实例详情。 | 查询指定Prometheus视图实例详情。 |
| UpdatePrometheusView | 更新Prom视图实例信息 | 更新Prometheus视图实例信息。 |
| ListPrometheusViews | 获取Prometheus视图实例列表 | 获取Prometheus视图实例信息列表。 |
| CreatePrometheusView | 创建prometheus视图 | 创建prometheus视图 |
告警
|
API |
标题 |
API概述 |
| ListAlertActions | 查询告警行动集成 | 查询告警行动集成 |
| CreateAlertWebhook | 创建报警webhook | 创建Webhook |
| DeleteAlertWebhooks | 删除报警webhook | 删除Webhook |
| ListAlertWebhooks | 查询报警webhook | 查询Webhook |
| UpdateAlertWebhook | 更新报警webhook | 更新Webhook |
| UpdateNotifyStrategy | 更新通知策略 | 更新通知策略 |
控制台内嵌
|
API |
标题 |
API概述 |
| CreateTicket | 创建免登录票据 | 如果您需要将控制台页面免密分享给其他人或者嵌入到第三方系统，可以调用CreateTicket生成票据，然后拼接免密链接。 |
服务开通
|
API |
标题 |
API概述 |
| GetCmsService | 检查Prometheus服务或商品开通状态 | 检查Prometheus服务或商品开通状态。 |
其他
|
API |
标题 |
API概述 |
| CreateBizTrace | 创建业务链路 | 创建业务链路 |
| CreateServiceObservability | 创建应用可观测 | 创建应用可观测，完成接入前置资源准备等； |
| DeleteBizTrace | 删除业务链路 | 删除业务链路 |
| GetAddonCodeTemplate | 获取Addon内代码模版 | 插件schema详情(Addon) |
| GetBizTrace | 查询业务链路 | 查询业务链路 |
| GetIntegrationVersionForCS | 查询容器集群链接的接入中心版本 | 查询容器集群链接的接入中心版本。 |
| GetPrometheusUserSetting | 获取Prometheus用户配置。 | 查询Prometheus用户配置。 |
| ListAlertRobots | 查询告警机器人 | 查询机器人 |
| ListBizTraces | 查询业务链路列表 | 业务链路列表 |
| ListContactGroups | 查询联系组 | 查询联系人组 |
| ListContacts | 查询联系人 | 查询联系人 |
| OpenCmsService | 开通CMS服务 | 开通云监控服务，包括企业云监控、Prometheus服务、SLS日志服务。 |
| UpdateBizTrace | 修改业务链路 | 修改业务链路 |
| UpdatePrometheusUserSetting | 更新Prometheus用户配置。 | 更新Prometheus用户配置信息。 注意：修改settingKey=financeUsageRegion，会将Prometheus用量数据切换到指定region的sls，同时历史用量数据将无法在Prometheus控制台查看。 |
| ChangeResourceGroup | 修改资源组 | 修改资源所属资源组 |
| CreateDataset | 创建数据集 | 创建数据集 |
| CreatePipeline | 创建流水线 | 创建流水线 |
| DeleteAddonRelease | 卸载接入组件 | 删除addon release信息 |
| DeleteDataset | 删除数据集 | 删除数据集 |
| DeletePipeline | 删除流水线 | 删除流水线 |
| DescribeRegions | 查询地域列表 | 查询地域信息列表 |
| GetDataset | 查询数据集 | 查询数据集 |
| GetPipeline | 查询流水线 | 查询流水线 |
| ListAddonReleases | 查看接入组件列表 | addon的release列表 |
| ListAddons | 查询接入组件列表 | 新版接入中心产品列表(分组)。 |
| ListDatasets | 查询数据集列表 | 查询数据集列表 |
| ListPipelines | 查询流水线列表 | 查询流水线列表 |
| ListTagResources | 查询标签列表 | 查标签接口。 |
| ManageAlertRules | 管理告警规则 | 管理告警规则 |
| QueryAlertRules | 查询告警规则 | 查询告警规则 |
| SearchMemories | 搜索记忆 | 根据查询条件和筛选项来搜索记忆。 |
| TagResources | 绑定标签 | 打标签接口 |
| UntagResources | 解绑标签 | 删标签接口 |
| UpdateDataset | 更新数据集 | 更新数据集 |
| UpdatePipeline | 更新流水线 | 更新流水线 |
| UpdateSubscription | 更新订阅 | 更新订阅 |
| DescribeMetricMetaList | 查询云监控开放的监控项详情 | 查询元数据meta |
该文章对您有帮助吗？