API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(ARMS/2019-08-08)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

可观测可视化 Grafana 版

API

标题

API概述

ListGrafanaWorkspace 获取Grafana工作区列表 获取地域内Grafana工作区列表。
GetGrafanaWorkspace 查询Grafana工作区信息 查询指定Grafana工作区信息。
CreateGrafanaWorkspace 创建Grafana工作区 创建可观测可视化 Grafana 版工作区实例。
UpdateGrafanaWorkspace 更新Grafana工作区 更新指定Grafana工作区信息。
UpdateGrafanaWorkspaceVersion 更新Grafana工作区版本 更新Grafana工作区版本。
DeleteGrafanaWorkspace 删除Grafana工作区 删除可观测可视化 Grafana 版工作区实例。
GrafanaWorkspaceHttpApiProxy Grafana代理API 代理指定工作区的HTTP API 接口
ListGrafanaWorkspaceAccount 工作区账号列表 获取指定工作区下的阿里云账号列表
CreateGrafanaWorkspaceAccount 创建工作区账号 指定工作区下创建账号
DeleteGrafanaWorkspaceAccount 删除工作区账号 删除指定工作区下账号
DeleteGrafanaWorkspaceAccountRole 删除工作区账号的权限 删除指定工作区下账号的角色
UpdateGrafanaWorkspaceAccountRole 新增/修改工作区账号的权限 修改指定工作区下账号的角色

访问控制

API

标题

API概述

OpenArmsServiceSecondVersion 开通ARMS 开通ARMS下指定子产品的后付费功能。
OpenXtraceDefaultSLR 开通可观测链路 OpenTelemetry 版服务关联角色 开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace。
OpenArmsDefaultSLR 开通ARMS服务关联角色 开通ARMS服务关联角色AliyunServiceRoleForARMS。
ChangeResourceGroup ARMS资源转组 修改资源所属资源组。
TagResources 创建标签资源关系 用于给ARMS资源实例打标签。
UntagResources 删除标签资源关系 用于删除ARMS资源实例标签。