华为云用户手册

  • 请求示例 使用阿里云A方式进行https CDN方式迁移,开启按时段限速,限速值为50MB/S,将对象列表object_list_file.txt中的对象列表执行迁移,并开启迁移结果通知。 POST https://{endpoint}/v2/{project_id}/tasks { "task_type" : "list", "src_node" : { "cloud_type" : "HuaweiCloud", "region" : "cn-north-1", "bucket" : "src_bucket", "ak" : "src_ak", "sk" : "src_sk", "list_file" : { "obs_bucket" : "list_file_bucket", "list_file_key" : "object_list_file.txt" } }, "dst_node" : { "region" : "cn-north-1", "ak" : "dst_ak", "sk" : "dst_sk", "bucket" : "dst_bucket" }, "enable_kms" : false, "enable_failed_object_recording" : true, "description" : "xxx", "migrate_since" : 123456789, "bandwidth_policy" : [ { "start" : "00:00", "end" : "23:59", "max_bandwidth" : 50000000 } ], "source_cdn" : { "protocol" : "https", "domain" : "xxx.xxx.xxx", "authentication_type" : "ALIYUN_OSS_A", "authentication_key" : "xxx" }, "smn_config" : { "topic_urn" : "urn:smn:region:4cf2090802d94440b4cdd72ef26857b2: OMS ", "trigger_conditions" : [ "SUC CES S", "FAILURE" ], "language" : "en-us" } } 使用阿里云A方式进行https CDN方式迁移,开启按时段限速,限速值为50MB/S,将对象文件/前缀["file1.xxx", "file2.xxx", "path1/"]进行迁移,并开启迁移结果通知 POST https://{endpoint}/v2/{project_id}/tasks { "task_type" : "object", "src_node" : { "cloud_type" : "HuaweiCloud", "region" : "cn-north-1", "bucket" : "src_bucket", "ak" : "src_ak", "sk" : "src_sk", "object_key" : [ "file1.xxx", "file2.xxx", "path1/" ] }, "dst_node" : { "region" : "cn-north-1", "ak" : "dst_ak", "sk" : "dst_sk", "bucket" : "dst_bucket" }, "enable_kms" : false, "enable_failed_object_recording" : true, "description" : "xxx", "migrate_since" : 123456789, "bandwidth_policy" : [ { "start" : "00:00", "end" : "23:59", "max_bandwidth" : 50000000 } ], "source_cdn" : { "protocol" : "https", "domain" : "xxx.xxx.xxx", "authentication_type" : "ALIYUN_OSS_A", "authentication_key" : "xxx" }, "smn_config" : { "topic_urn" : "urn:smn:region:4cf2090802d94440b4cdd72ef26857b2:OMS", "trigger_conditions" : [ "SUCCESS", "FAILURE" ], "language" : "en-us" } } 创建URL列表迁移任务,将object_list_file.txt中的URL列表执行迁移。 POST https://{endpoint}/v2/{project_id}/tasks { "task_type" : "url_list", "src_node" : { "cloud_type" : "URLSource", "list_file" : { "obs_bucket" : "list_file_bucket", "list_file_key" : "object_list_file.txt" } }, "dst_node" : { "region" : "cn-north-1", "ak" : "dst_ak", "sk" : "dst_sk", "bucket" : "dst_bucket" }, "enable_kms" : false, "enable_failed_object_recording" : true, "description" : "xxx" } 创建前缀迁移任务,将[ "abc", "123", "prefix3", "path/prefix4" ]为前缀的对象文件进行迁移。 POST https://{endpoint}/v2/{project_id}/tasks { "task_type" : "prefix", "src_node" : { "cloud_type" : "HuaweiCloud", "region" : "cn-north-1", "bucket" : "src_bucket", "ak" : "src_ak", "sk" : "src_sk", "object_key" : [ "abc", "123", "prefix3", "path/prefix4" ] }, "dst_node" : { "region" : "cn-north-1", "ak" : "dst_ak", "sk" : "dst_sk", "bucket" : "dst_bucket" }, "enable_kms" : false, "enable_failed_object_recording" : true, "description" : "xxx" }
  • 请求示例 创建阿里云北京api-auto-test1桶到华为云北京4的oms-sonar-north桶的同步任务 POST https://v2/{project_id}/sync-tasks { "src_cloud_type" : "Aliyun", "src_region" : "cn-beijing", "src_bucket" : "api-auto-test1", "src_ak" : "src_ak", "src_sk" : "src_sk", "dst_ak" : "dst_ak", "dst_sk" : "dst_sk", "dst_region" : "cn-north-4", "dst_bucket" : "oms-sonar-north", "description" : "XXXX", "enable_kms" : false, "enable_restore" : false, "enable_metadata_migration" : false }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String API认证鉴权的Token认证方式。推荐使用Authorization签名认证方式,具体请参考API认证鉴权 最小长度:1 最大长度:16384 表3 请求Body参数 参数 是否必选 参数类型 描述 object_keys 是 Array of strings 待同步对象的列表,其中待同步对象最大数量为10,列表中object_key为URL编码处理后的结果 最小长度:1 最大长度:16384 数组长度:1 - 100
  • 请求示例 对子任务31e9b7e6-6ffb-452f-9842-6ce354d99d75创建同步事件,对 [ "test%2F001.txt", "test%2F002.txt" ] 进行同步 /v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events { "object_keys" : [ "test%2F001.txt", "test%2F002.txt" ] } 对子任务31e9b7e6-6ffb-452f-9842-6ce354d99d75创建同步事件,对 [ "test%2B001.txt"] 进行同步 /v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events { "object_keys" : [ "test%2B001.txt" ] } 对子任务31e9b7e6-6ffb-452f-9842-6ce354d99d75创建同步事件,对 [ "test+001.txt" ] 进行同步 /v2/f697f813-554a-4f05-bac8-82a183b20878/sync-tasks/31e9b7e6-6ffb-452f-9842-6ce354d99d75/events { "object_keys" : [ "test+001.txt" ] }
  • 响应参数 状态码:400 表4 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 error_code String 错误码。 状态码:404 表5 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 error_code String 错误码。 状态码:503 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息。 error_code String 错误码。
  • 请求示例 检查xxxx的前缀是否在xxx桶中存在 POST https://{endpoint}/v2/{project_id}/objectstorage/buckets/prefix { "cloud_type" : "HuaweiCloud", "ak" : "xxxxak", "sk" : "xxxxsk", "app_id" : "apptest123", "bucket_name" : "xxx", "file_name" : "xxxx", "data_center" : "cn-north-x", "security_token" : "string" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token认证,需要确认Token中包含的Project ID与请求URI中修改资源的Project ID匹配。 最小长度:1 最大长度:16384 表3 请求Body参数 参数 是否必选 参数类型 描述 cloud_type 是 String 云类型 AWS:亚马逊 Aliyun:阿里云 Qiniu:七牛云 QingCloud:青云 Tencent:腾讯云 Baidu:百度云 KingsoftCloud:金山云 Azure:微软云 UCloud:优刻得 HuaweiCloud:华为云 Google: 谷歌云 URLSource:URL HEC:HEC 缺省值:Aliyun 最小长度:0 最大长度:100 ak 否 String 源端桶的AK(最大长度100个字符),task_type为非url_list时,本参数为必选。 最小长度:0 最大长度:100 sk 否 String 源端桶的SK(最大长度100个字符),task_type为非url_list时,本参数为必选。 最小长度:0 最大长度:100 json_auth_file 否 String 用于谷歌云Cloud Storage鉴权 最小长度:0 最大长度:65535 app_id 否 String 当源端为腾讯云时,会返回此参数。 最小长度:0 最大长度:255 bucket_name 是 String 桶名 最小长度:0 最大长度:100 file_name 是 String 前缀名称 最小长度:0 最大长度:1024 data_center 是 String 数据中心,区域 最小长度:0 最大长度:100 security_token 否 String 安全令牌 最小长度:0 最大长度:16384
  • 请求示例 将group_id为xxxxxxxx的任务的限速时段设置为00:01-23:59,限速值设置为50000000Byte/s /v2/{project_id}/tasks/batch-update { "group_id" : "xxxxxxxx", "bandwidth_policy" : [ { "start" : "00:01", "end" : "23:59", "max_bandwidth" : 50000000 } ] } 将id为111,222的任务的限速时段设置为00:01-23:59,限速值设置为50000000Byte/s /v2/{project_id}/tasks/batch-update { "ids" : [ 111, 222 ], "bandwidth_policy" : [ { "start" : "00:01", "end" : "23:59", "max_bandwidth" : 50000000 } ] }
  • 方案架构 该解决方案支持一键式部署 函数工作流 对象存储服务 ,快速搭建文件解压环境。 图1 方案架构图 该解决方案会部署如下资源: 在对象存储服务(OBS)上创建一个源桶,企业业务系统将文件压缩后上传至此桶; 在对象存储服务(OBS)上创建一个目标桶,企业业务系统从该桶中获取解压后的文件; 在函数工作流服务(FunctionGraph)上创建一个Python语言的解压函数,当有压缩包上传到OBS服务上的源桶时,自动触发该函数解压文件并保存到目标桶。 在 统一身份认证 服务(IAM)上创建一个委托,用于授权函数计算服务(FunctionGraph)操作账号Region内OBS服务上的源和目标桶。
  • 名词解释 基本概念、云服务简介、专有名词解释: 对象存储服务OBS:对象存储服务(Object Storage Service,OBS)是一个基于对象的海量存储服务,为客户提供海量、安全、高可靠、低成本的数据存储能力。 函数工作流FunctionGraph:FunctionGraph是一项基于事件驱动的函数托管计算服务。使用FunctionGraph函数,只需编写业务函数代码并设置运行的条件,无需配置和管理服务器等基础设施,函数以弹性、免运维、高可靠的方式运行。此外,按函数实际执行资源计费,不执行不产生费用。 统一身份认证服务 IAM:是华为云提供权限管理、访问控制和身份认证的基础服务,您可以使用IAM创建和管理用户、用户组,通过授权来允许或拒绝对云服务和资源的访问,通过设置安全策略提高账号和资源的安全性,同时IAM为您提供多种安全的访问凭证。
  • 快速部署 本章节主要指导用户如何自动化部署“在线解压”解决方案。 表1 参数说明 参数名称 类型 是否可选 参数解释 默认值 compressed_files_bucket_name string 必填 OBS桶名称,全局唯一,用于上传压缩文件。取值范围:3~63个字符,支持小写字母、数字、中划线(-)、英文句号(.)。 compressed-files-bucket-demo decompressed_files_bucket_name string 必填 OBS桶名称,全局唯一,用于存放解压缩后的文件。取值范围:3~63个字符,支持小写字母、数字、中划线(-)、英文句号(.)。 decompressed-files-bucket-demo 登录华为云解决方案实践,选择"无服务器文件解压",跳转至该解决方案一键部署界面,单击一键部署,进入选择模板界面。 图1 解决方案实践 在选择模板界面中,单击“下一步”。 图2 选择模板 在配置参数界面中,参考表1完成自定义参数填写,单击“下一步”。 图3 配置参数 在资源设置界面中,在权限委托下拉框中选择“rf_admin_trust”委托,单击“下一步”。 图4 资源栈设置 在配置确认界面中,单击“创建执行计划”。 图5 配置确认 在弹出的创建执行计划框中,自定义填写执行计划名称,单击“确定”。 图6 创建执行计划 单击“部署”,并且在弹出的执行计划确认框中单击“执行”。 图7 执行计划 图8 执行计划确认 待“事件”中出现“Apply required resource success”,表示该解决方案已经部署完成。 图9 部署完成 父主题: 实施步骤
  • 创建rf_admin_trust委托 进入华为云官网,打开控制台管理界面,鼠标移动至个人账号处,打开“统一身份认证”菜单 图1 控制台管理界面 统一身份认证菜单 进入“委托”菜单,搜索“rf_admin_trust”委托 图2 委托列表 如果委托存在,则不用执行接下来的创建委托的步骤 如果委托不存在时执行接下来的步骤创建委托 单击步骤2界面中的“创建委托”按钮,在委托名称中输入“rf_admin_trust”,委托类型选择“云服务”,选择“ RFS ”,单击“下一步”。 图3 创建委托 在搜索框中输入”Tenant Administrator”权限,并勾选搜索结果 图4 选择策略 选择“所有资源”,并单击下一步完成配置 图5 设置最小授权范围 “委托”列表中出现“rf_admin_trust”委托则创建成功 图6 委托列表
  • 给rf_admin_trust委托添加IAM Agency Management FullAcces策略 打开“统一身份认证”菜单 图11 统一身份认证菜单 进入“委托”菜单,选择rf_admin_trust委托 图12 委托列表 进入“授权记录”菜单,单击“授权”按钮 图13 授权记录 在搜索框输入IAM Agency Management FullAcces,勾选过滤出来的记录,单击下一步,并确认完成权限的配置 图14 配置IAM Agency Management FullAcces策略 配置好后的情况:rf_admin_trust委托拥有Tenant Administrator和IAM Agency Management FullAccess权限 图15 授权记录列表
  • 资源和成本规划 该解决方案主要部署如下资源,以下花费仅供参考,具体请参考华为云官网价格详情,实际收费以账单为准: 表1 资源和成本规划 华为云服务 计费说明 每月花费(调用1000次) 对象存储服务 OBS 区域:华北-北京四 存储空间:数据存储(多AZ存储) 默认存储类别:标准存储 桶策略:私有 请求费用:0.0100元/万次 存储空间:0.1390元/GB/月 流量费用: 内/公网流入流量(数据上传到OBS) 0元 内网流出流量 0元 预计每月新增1GB数据量,花费0.1490元。 该方案存储费用消耗较低,详细请参考每月账单 函数工作流 FunctionGraph 区域:华北-北京四 产品:函数 请求次数: 0-100万次: 0元/100万次 100万次以上 : 1.33元/100万次 计量时间: 0-400,000 GB/秒: 0元/GB-秒 400,000 GB/秒以上 :0.00011108元/GB-秒 0元 总计: - 约0.1490元
  • 给rf_admin_trust委托添加IAM Agency Management FullAcces策略 打开“统一身份认证”菜单 图12 统一身份认证菜单 进入“委托”菜单,选择rf_admin_trust委托 图13 委托列表 进入“授权记录”菜单,单击“授权”按钮 图14 授权记录 在搜索框输入IAM Agency Management FullAcces,勾选过滤出来的记录,单击下一步,并确认完成权限的配置 图15 配置IAM Agency Management FullAcces策略 配置好后的情况:rf_admin_trust委托拥有Tenant Administrator和IAM Agency Management FullAccess权限 图16 授权记录列表
  • 创建rf_admin_trust委托 进入华为云官网,打开控制台管理界面,鼠标移动至个人账号处,打开“统一身份认证”菜单。 图1 控制台管理界面 图2 统一身份认证菜单 进入“委托”菜单,搜索“rf_admin_trust”委托。 图3 委托列表 如果委托存在,则不用执行接下来的创建委托的步骤 如果委托不存在时执行接下来的步骤创建委托 单击步骤2界面中的“创建委托”按钮,在委托名称中输入“rf_admin_trust”,委托类型选择“云服务”,选择“RFS”,单击“下一步”。 图4 创建委托 在搜索框中输入“Tenant Administrator”权限,并勾选搜索结果。 图5 选择策略 选择“所有资源”,并单击下一步完成配置。 图6 设置授权范围 “委托”列表中出现“rf_admin_trust”委托则创建成功。 图7 委托列表
  • 给rf_admin_trust委托添加IAM Agency Management FullAcces策略 打开“统一身份认证”菜单 图12 统一身份认证菜单 进入“委托”菜单,选择rf_admin_trust委托 图13 委托列表 进入“授权记录”菜单,单击“授权”按钮 图14 授权记录 在搜索框输入IAM Agency Management FullAcces,勾选过滤出来的记录,单击下一步,并确认完成权限的配置 图15 配置IAM Agency Management FullAcces策略 配置好后的情况:rf_admin_trust委托拥有Tenant Administrator和IAM Agency Management FullAccess权限 图16 授权记录列表
  • 创建rf_admin_trust委托 进入华为云官网,打开控制台管理界面,鼠标移动至个人账号处,打开“统一身份认证”菜单。 图1 控制台管理界面 图2 统一身份认证菜单 进入“委托”菜单,搜索“rf_admin_trust”委托。 图3 委托列表 如果委托存在,则不用执行接下来的创建委托的步骤 如果委托不存在时执行接下来的步骤创建委托 单击步骤2界面中的“创建委托”按钮,在委托名称中输入“rf_admin_trust”,委托类型选择“云服务”,选择“RFS”,单击“下一步”。 图4 创建委托 在搜索框中输入“Tenant Administrator”权限,并勾选搜索结果。 图5 选择策略 选择“所有资源”,并单击下一步完成配置。 图6 设置授权范围 “委托”列表中出现“rf_admin_trust”委托则创建成功。 图7 委托列表
  • 响应示例 状态码: 200 OK,请求响应成功。 { "node_list" : [ { "node_id" : 11, "node_name" : "apm-pu-task:xxx-roma-2", "hint" : null } ], "line_list" : [ { "start_node_id" : null, "end_node_id" : 11, "span_id" : "1", "client_info" : null, "server_info" : { "start_time" : 1666684411910, "time_used" : 1, "argument" : "(GET)(/apm2/health/v1/health-check)(200)", "event_id" : "1" }, "hint" : "(1)((GET)(/apm2/health/v1/health-check)(200))", "id" : "1+1" } ], "global_trace_id" : null }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 global_trace_id String 全局traceId。 line_list Array of TraceTopologyLine objects 组件之间调用指向线列表。 node_list Array of TraceTopologyNode objects 组件节点列表。 表4 TraceTopologyLine 参数 参数类型 描述 start_node_id Long 开始节点id。 end_node_id Long 结束节点id。 span_id String 调用跨度id。 client_info TraceTopologyLineInfo object 客户端看到的信息。 server_info TraceTopologyLineInfo object 服务端信息。 id String id。 hint String 获取一条线的提示信息。 表5 TraceTopologyLineInfo 参数 参数类型 描述 start_time Long 开始时间。 time_used Long 耗时。 argument String 参数信息,比如调用的url信息等。 event_id String event的id。 表6 TraceTopologyNode 参数 参数类型 描述 node_id Long 节点id。 node_name String 节点名称。 hint String 节点提示字段。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 topology_tree TopologyTree object 拓扑树信息。 表4 TopologyTree 参数 参数类型 描述 tree Array of TreeNode objects 拓扑树节点。 表5 TreeNode 参数 参数类型 描述 id String 拓扑树节点id。 parent String 拓扑树节点的父节点。 real_id Long 拓扑树节点的实际id。 name String 拓扑树节点名称。 display_name String 拓扑树节点展示名称。 app_name String 组件名称。 app_id Long 组件id。 is_admin Boolean 是否是管理节点。 is_root Boolean 是否是根节点。 business_id Long 应用id。 node_type String 节点类型。 枚举值: BUSINESS SUB_BUSINESS APPLICATION ENVIRONMENT region String 区域。 is_default Boolean 是否是默认的节点。
  • 响应示例 状态码: 200 OK,请求响应成功。 { "topology_tree" : { "tree" : [ { "id" : "162-55-11", "parent" : "162-55", "real_id" : 11, "name" : "apm-pu-task", "display_name" : "apm-pu-task", "app_name" : null, "app_id" : null, "is_admin" : false, "is_root" : false, "business_id" : 162, "node_type" : "APPLICATION", "is_default" : false, "region" : null }, { "id" : "162-55", "parent" : "162", "real_id" : 55, "name" : "App", "display_name" : "App", "app_name" : null, "app_id" : null, "is_admin" : false, "is_root" : false, "business_id" : 162, "node_type" : "SUB_BUSINESS", "is_default" : false, "region" : null }, { "id" : "162", "parent" : null, "real_id" : 162, "name" : "LubanApm", "display_name" : "LubanApm", "app_name" : null, "app_id" : null, "is_admin" : false, "is_root" : true, "business_id" : 162, "node_type" : "BUSINESS", "is_default" : false, "region" : null }, { "id" : "162-55-11-11", "parent" : "162-55-11", "real_id" : 11, "name" : "xxx-roma-2", "display_name" : "xxx-roma-2", "app_name" : "apm-pu-task", "app_id" : 11, "is_admin" : false, "is_root" : false, "business_id" : 162, "node_type" : "ENVIRONMENT", "is_default" : false, "region" : "xxx-roma-2" } ] } }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 表2 请求Body参数 参数 是否必选 参数类型 描述 from 是 Long 开始时间,比如1704271204595 to 是 Long 结束时间, 比如1704275169491 type 是 String 数据类型, CPU 或者 LATENCY instance_id 是 Long 实例id api 是 String api的url,比如: GET_/user/{id} region 是 String 实例所在区域
  • 请求示例 POST: /v1/apm2/openapi/view/profiling/flame-line-tree { "from": 1704271204595, "to": 1704275169491, "type": "LATENCY", "instance_id": -6870732446083119805, "api" : "GET_/user/{id}", "region":"cn-north-7" }
  • 响应示例 状态码: 200 OK,请求响应成功。 { "data":[ 100, 1000, null, [ [ 700, 700, 0, 30, // 行号 [] ], [ 200, 200, 1, 40, // 行号 [] ] ] ], "methods":[ [ 2, // method id "com.huawei.foo", "SampleService", "doService", "int,long,String", true, // 是否为用户方法 false // 是否为native方法 ], [ 3, "com.huawei.bar", "SampleRemoteCall", "sampleCallRemoteProcess", "float,int", true, // 是否为用户方法 false // 是否为native方法 ] ]}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 data Array of strings 火焰图的数据是个二维数组。 data[0][0]: self time,方法自己消耗的cpu毫秒时间,不包括方法内部调用其他方法的时间。 data[0][1]: total time, 方法消耗的cpu毫秒时间,包括方法内部调用其他方法的时间。 data[0][2]: 方法的index,对应methods中的数组下标。 data[0][3]: 行号 data[0][4]: 方法的子节点,就是方法中调用的其他方法。 methods Array of strings 调用栈上的方法信息是个二维数组。 method[0][0]: 方法的唯一id。 method[0][1]: 方法的package包名。 method[0][2]: 方法的class name 类名。 method[0][3]: 方法名。 method[0][4]: 方法的参数列表。 method[0][5]: 方法是否为用户的方法。 method[0][6]: 方法是否为native方法。
  • 修订记录 发布日期 修订记录 2025-02-06 新增接口WebMonitor。 2024-12-18 GET /v1/apm2/openapi/region/get-all-supported-region返回值删除字段:project_id、status。 POST /v1/apm2/openapi/view/mainview/get-env-instance-list返回值删除字段:business_name、business_id、app_name、env_id、last_modify_user_id、last_modify_user_name。 GET /v1/apm2/openapi/cmdb/apps/get-apps返回值删除字段:gmt_create、gmt_modify、inner_domain_id。 DELETE /v1/apm2/access-keys/{ak}返回值删除字段:sk。 2024-08-16 新增接口“前端监控上传sourcemap文件”。 2024-04-30 新增接口TRACING。 2024-03-04 新增接口PROFILING。 2024-01-17 新增接口获取一个监控项的详情。 2023-08-30 新增状态码以及相关描述,“400 Bad Request,语义或参数有误。” 2023-08-08 接口请求实例描述优化。 2022-12-30 新增以下接口: 查询应用下所有探针 更改实例的采集状态 删除agent 根据组件id删除指定的组件 查询单个应用的详情 查询子应用详情 查询告警列表 查询告警消息列表 查询应用全局拓扑图 查询组件环境拓扑图 查询URL跟踪配置列表 查询URL跟踪Region环境列表 查询URL跟踪视图列表 查询URL跟踪视图详情 2022-11-10 新增23个API接口: 对指定区域下的组件和环境及其探针情况进行搜索 保存监控项 查询监控项列表 查询开通的region 查询所有的支持的region 获取应用树 查询环境标签 获取组件列表 获取组件下的环境列表 查询监控项配置信息 调用链拓扑图 获取event的详情 查询span数据 获取一个trace的所有调用链数据 获取趋势图 获取汇总表格数据 获取原始数据表格 获取原始数据详情 获取实例信息列表 获取监控项信息 创建aksk 查询租户的aksk 删除aksk 2021-12-10 新增以下接口: 查询master地址 获取ak/sk 2021-11-26 第一次正式发布。
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 从IAM服务获取的用户Token。 x-business-id 是 Long 应用id。 表2 请求Body参数 参数 是否必选 参数类型 描述 instance_list 是 Array of integers 实例列表。 region 是 String region英文名称。 business_id 是 Long 应用id。
  • 响应示例 状态码: 200 OK,请求响应成功。 { "title" : "Url", "collector_name" : "Url", "view_row_list" : [ { "view_list" : [ { "latest" : null, "span" : true, "collector_name" : "Url", "metric_set" : "url", "title" : "接口维度汇总", "table_direction" : null, "group_by" : "url,method", "filter" : "", "field_item_list" : [ { "trace" : null, "function" : "SUM(invokeCount)", "as" : "调用次数", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "SUM(totalTime)/SUM(invokeCount)", "as" : "平均响应时间(ms)", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "SUM(errorCount)", "as" : "错误数", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "MAX(concurrentMax)", "as" : "最大并发", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "MAX(maxTime)", "as" : "最慢调用(ms)", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "SUM(range1)", "as" : "0ms-10ms", "default_value" : null, "precision" : null, "unit" : null, "visible" : false }, { "trace" : null, "function" : "SUM(range2)", "as" : "10ms-100ms", "default_value" : null, "precision" : null, "unit" : null, "visible" : false }, { "trace" : null, "function" : "SUM(range3)", "as" : "100ms-500ms", "default_value" : null, "precision" : null, "unit" : null, "visible" : false }, { "trace" : null, "function" : "SUM(range4)", "as" : "500ms-1s", "default_value" : null, "precision" : null, "unit" : null, "visible" : false }, { "trace" : null, "function" : "SUM(range5)", "as" : "1s-10s", "default_value" : null, "precision" : null, "unit" : null, "visible" : false }, { "trace" : null, "function" : "SUM(range6)", "as" : "10s-n", "default_value" : null, "precision" : null, "unit" : null, "visible" : false } ], "span_field" : "source", "order_by" : null, "view_type" : "sumtable" } ], "title" : "" }, { "view_list" : [ { "latest" : null, "span" : true, "collector_name" : "Url", "metric_set" : "statuscode", "title" : "状态码维度汇总", "table_direction" : null, "group_by" : "code", "filter" : "", "field_item_list" : [ { "trace" : null, "function" : "SUM(count)", "as" : "个数", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "LAST(url)", "as" : "最近url", "default_value" : null, "precision" : null, "unit" : null, "visible" : true } ], "span_field" : "code", "order_by" : null, "view_type" : "sumtable" } ], "title" : "" }, { "view_list" : [ { "latest" : null, "span" : null, "collector_name" : "Url", "metric_set" : "user", "title" : "集群维度汇总", "table_direction" : null, "group_by" : "clusterId", "filter" : "", "field_item_list" : [ { "trace" : null, "function" : "SUM(invokeCount)", "as" : "调用次数", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "SUM(totalTime)/SUM(invokeCount)", "as" : "平均响应时间(ms)", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "SUM(errorCount)", "as" : "错误数", "default_value" : null, "precision" : null, "unit" : null, "visible" : true } ], "span_field" : null, "order_by" : null, "view_type" : "sumtable" } ], "title" : "" }, { "view_list" : [ { "latest" : null, "span" : null, "collector_name" : "Url", "metric_set" : "total", "title" : "总览", "table_direction" : null, "group_by" : "", "filter" : "", "field_item_list" : [ { "trace" : null, "function" : "SUM(invokeCount)", "as" : "总请求数", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "SUM(totalTime)/SUM(invokeCount)", "as" : "平均响应时间(ms)", "default_value" : null, "precision" : null, "unit" : null, "visible" : true }, { "trace" : null, "function" : "SUM(errorCount)", "as" : "错误次数", "default_value" : null, "precision" : null, "unit" : null, "visible" : true } ], "span_field" : null, "order_by" : null, "view_type" : "trend" } ], "title" : "" } ], "style" : "tab" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 title String 标题。 collector_name String 采集器名称。 view_row_list Array of ViewRow objects 视图的列表,内部每个List代表的是一行图表。 style String 类型。 表4 ViewRow 参数 参数类型 描述 view_list Array of ViewBase objects 视图行,包含多个视图,展示的时候根据实际的长度适配。 title String 标题。 表5 ViewBase 参数 参数类型 描述 collector_name String 采集器名称。 metric_set String 视图对应的指标集的名称。 title String 图标所需展示的标题。 table_direction String 表格的方向,H:默认,表头横向,V:表头纵向。 枚举值: H V group_by String 分组规则。 filter String 过滤列表模型。 field_item_list Array of FieldItem objects 所需展示的字段列表模型。 span Boolean span信息。 span_field String span字段属性。 order_by String 排序规则。 latest Boolean 是否只展示最近一笔数据。 view_type String 视图类型。 枚举值: trend sumtable rawtable 表6 FieldItem 参数 参数类型 描述 function String 表达式。 as String 作为。 default_value String 默认值。 trace Boolean 是否是trace。 precision Integer 百分比。 unit String 单位。 visible Boolean 是否可见。
共100000条