任务类型对应表 表2 任务类型和任务名称对应表 任务类型 任务名称 100 点查询 101 创建点 102 删除点 103 修改点属性 104 添加点Label 105 删除点Label 200 边查询 201 创建边 202 删除边 203 修改边属性 300 查询Schema详情 301 添加Label 302 修改Label 303 查询Label 304 修改属性 400 查询图详情 401 清空图 402 在线增量导入图 403 创建图 405 删除图 406 导出图 407 filtered_khop 408 查询路径详情 409 离线增量导入图 500 创建备份 501 从备份恢复图 601 创建索引 602 查询索引 603 更新索引 604 删除索引 700 运行算法

监控指标 表1 云专线支持的监控指标 指标ID 指标名称 指标含义 取值范围 测量对象 监控周期 network_incoming_bits_rate 网络流入带宽 云专线连接侧入站数据的比特率。 单位：bit/s ≥ 0 bits/s 物理连接和历史物理连接 1分钟 network_outgoing_bits_rate 网络流出带宽 云专线连接侧出站数据的比特率。 单位：bit/s ≥ 0 bits/s 物理连接和历史物理连接 1分钟 network_incoming_bytes 网络流入流量 云专线连接侧入站数据的字节数。 单位：byte ≥ 0 bytes 物理连接和历史物理连接 1分钟 network_outgoing_bytes 网络流出流量 云专线连接侧出站数据的字节数。 单位：byte ≥ 0 bytes 物理连接和历史物理连接 1分钟 network_incoming_packets_rate 网络流入包速率 云专线连接侧入站数据包速率。 单位：Packet/s ≥ 0 packets/s 物理连接和历史物理连接 1分钟 network_outgoing_packets_rate 网络流出包速率 云专线连接侧出站数据包速率。 单位：Packet/s ≥ 0 packets/s 物理连接和历史物理连接 1分钟 network_incoming_packets 网络流入包量 云专线连接侧入站数据包数。 单位：Packet ≥ 0 packets 物理连接和历史物理连接 1分钟 network_outgoing_packets 网络流出包量 云专线连接侧出站数据包数。 单位：Packet ≥ 0 packets 物理连接和历史物理连接 1分钟 network_status 端口状态 云专线物理连接的端口状态。 0-DOWN 1-UP 物理连接和历史物理连接 1分钟 bgp_receive_route_num_v4 接收到的IPV4路由条目数 虚拟接口通过BGP协议学习到的IPV4的路由条目数。 ≥0 个 虚拟接口 1分钟 bgp_receive_route_num_v6 接收到的IPV6路由条目数 虚拟接口通过BGP协议学习到的IPV6的路由条目数。 ≥0 个 虚拟接口 1分钟 bgp_peer_status_v4 IPv4 BGP PEER状态 IPv4 BGP PEER状态 0-DOWN 1-ACTIVE 虚拟接口 1分钟 bgp_peer_status_v6 IPv6 BGP PEER状态 IPv6 BGP PEER状态 0-DOWN 1-ACTIVE 虚拟接口 1分钟

GaussDB 实例的哪些监控指标需要重点关注 对于GaussDB实例，需要关注的监控指标有：CPU利用率、内存利用率、磁盘空间利用率。 可以根据实际应用场景配置告警提示，当收到告警，可采取相应措施消除告警。 配置示例： 如果在某段时间内（如5min），CPU的利用率出现多次（如3次）不低于某特定值（如90%）的情况，则发出相应Cloud Eye告警。 如果在某段时间内（如5min），内存的利用率出现多次（如4次）不低于某特定值（如90%）的情况，则发出相应Cloud Eye告警。 如果在某段时间内（如5min），磁盘的使用率出现多次（如5次）不低于某特定值（如85%）的情况，则发出相应Cloud Eye告警。 Cloud Eye告警详细配置方法，请参见《 云监控 用户指南》中“创建告警规则”。 采取措施： 收到与CPU利用率、内存利用率有关的告警，通过实例规格变更分别增大CPU、内存。 请参见规格变更。 收到与磁盘空间利用率有关的告警，通过磁盘空间扩容增大磁盘空间。 请参见扩容磁盘。 父主题： 数据库监控

响应示例 状态码： 200 OK { "code" : "APIG.0000", "start_time" : 1595573280, "end_time" : 1595576820, "list" : [ { "api_id" : "39bce6d25a3f470e8cf7b2c97174f7d9", "avg_backend_latency" : 2.71, "avg_inner_latency" : 1.57, "avg_latency" : 4.14, "current_minute" : 1595576640, "cycle" : "MINUTE", "group_id" : "d0fc4e40b7d1492cba802f667c7c7226", "input_throughput" : 1071, "max_backend_latency" : 6, "max_inner_latency" : 8, "max_latency" : 14, "output_throughput" : 3790, "provider" : "73d69ae0cfcf460190522d06b60f05ad", "register_time" : "2020-07-24 15:44:56", "req_count" : 7, "req_count2xx" : 0, "req_count4xx" : 6, "req_count5xx" : 1, "req_count_error" : 7, "req_time" : "2020-07-24 15:44:00", "status" : 1 } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:api_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3002", "error_msg" : "API 39bce6d25a3f470e8cf7b2c97174f7d9 does not exist" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 code String 响应码 start_time Long 开始时间的UTC的时间戳 end_time Long 截止时间的UTC的时间戳 list Array of StatisticsAPI objects 统计指标的数据结构结构体 表5 StatisticsAPI 参数 参数类型 描述 max_latency Integer 最大延时 avg_latency Float 平均延时 req_count Integer 请求总次数 req_count2xx Integer 2xx响应码总次数 req_count4xx Integer 4xx响应码总次数 req_count5xx Integer 5xx响应码总次数 req_count_error Integer 错误次数 max_inner_latency Integer 最大网关内部延时 avg_inner_latency Float 平均网关内部延时 max_backend_latency Integer 最大后端延时 avg_backend_latency Float 平均后端延时 output_throughput Long 下行吞吐量（byte） input_throughput Long 上行吞吐量（byte） current_minute Long API访问的UTC时间戳 cycle String 查询统计周期 api_id String API编号 group_id String API分组编号 provider String API拥有者 req_time String API请求时间 register_time String 记录时间 status Integer 状态值： 1：调度中，未上报 CES 2：已经成功上报CES 预留字段，暂不支持 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "total" : 99999, "size" : 99999, "entities" : [ { "id" : "id123456789", "start_time" : 1603243428000, "dispatch_time" : 1603243428000, "end_time" : 1603243428000, "execute_status" : "RUNNING", "position" : "READER", "position_status" : "NORMAL", "status" : 504, "dirty_data_count" : 0, "data_count" : 100, "data_size" : 1000, "data_size_unit" : "B", "spend_time" : 5000, "read_spend_time" : 5000, "write_spend_time" : 5000, "remarks" : "Task execute success", "detail_logs" : [ { "id" : "id123456789", "status" : 500, "position" : "READER", "position_status" : "NORMAL", "stage" : "adapter", "dirty_data_count" : 0, "data_count" : 100, "data_size" : 1000, "data_size_unit" : "B", "spend_time" : 5000, "remarks" : "task start successfully.", "step_begin_time" : 1603243428000, "step_end_time" : 1603243428000 } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数。 最小值：1 最大值：99999 size Integer 当前页日志数量。 最小值：1 最大值：99999 entities Array of TaskMonitorLog objects 任务监控日志当前页元素。 数组长度：1 - 9999 表5 TaskMonitorLog 参数 参数类型 描述 id String 单次任务执行的跟踪ID。 最小长度：10 最大长度：40 start_time Integer 本次执行启动时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：9999999999999 dispatch_time Integer 计划执行时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：9999999999999 end_time Integer 写入结束时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：9999999999999 execute_status String 任务本次执行状态： UNSTARTED(未启动) WAITING(等待调度中) RUNNING(执行中) SUCCESS(执行成功) CANCELLED(任务取消) ERROR(执行异常) 最小长度：3 最大长度：10 position String 标识本次任务执行到哪一个阶段： ADAPTER(任务处于初始化阶段) READER(任务正在执行Reader读操作) WRITER(任务正在执行Writer写操作) 最小长度：3 最大长度：10 position_status String 任务本次执行当前阶段的状态： NORMAL(正在运行) NODE_END(本节点正常结束) RUNTIME_CANCEL(任务被取消) TASK_END(本任务正常结束) RUNTIME_ERR(运行时异常) INTERNAL_ERR(内部程序异常) 最小长度：3 最大长度：20 status Integer 本次任务执行详细状态，状态码划分规则：reader端 100 ~ 499，writer端 500 ~ 899，其他900 ~ ： 16(被强制取消) 99(任务开始) 100(Reader 任务开始) 101(Reader 任务结束) 102(正在读取数据) 103(读端数据源端异常) 104(读取数据结束) 105(读取数据为0) 106(读任务强制取消) 107(在reader plugin中，任务发生了中断) 108(读任务恢复运行) 500(Writer 任务开始) 501(Writer 任务结束) 502(正在数据写入) 503(目标端异常) 504(数据写入结束) 505(写任务强制取消) 506(在writer plugin中，任务发生了中断) 507(写任务恢复运行) 900(接收到调度请求) 901(任务运行结束) 902(任务已运行结束，正在进行数据完整性校验) 903(输出数据完整性校验结果) 904(经过数据完整性校验，发现有数据缺失，正在进行数据补偿) 905(输出数据补偿结果) 906(读取任务正在排队中（平台资源）) 907(读取任务被拒绝执行，因为上一次调度还没有结束) 908(写入任务正在排队中（平台资源）) 909(写入任务被拒绝执行，因为上一次调度还没有结束) 911(读取任务没有被正常开启，请检查网络是否通畅，参数是否正确) 912(写入任务没有被正常开启，请检查网络是否通畅，参数是否正确) 913(任务调度请求失败) 914(任务被拒绝执行，因为上一次调度还没有结束) 915(任务不正常运行) 916(任务日志上报异常) 最小值：1 最大值：1000 dirty_data_count Integer 异常数据条数。 最小值：0 最大值：9999999999999 data_count Integer 成功数据条数。 最小值：0 最大值：9999999999999 data_size Number 成功数据大小，浮点数类型。 最小值：0 最大值：9999999999999 data_size_unit String 成功数据大小的计量单位。 最小长度：1 最大长度：2 spend_time Integer 执行时长，单位：ms。 最小值：0 最大值：9999999999999 read_spend_time Integer 读取执行时长，单位：ms，只有在定时任务时存在该属性。 最小值：0 最大值：9999999999999 write_spend_time Integer 写入执行时长，单位：ms。 最小值：0 最大值：9999999999999 remarks String 本次执行结果简要信息。 最小长度：0 最大长度：1000 detail_logs Array of TaskMonitorDetailLog objects 本次执行详细轨迹信息。 数组长度：1 - 9999 表6 TaskMonitorDetailLog 参数 参数类型 描述 id String 任务每次执行步骤产生的唯一ID。 最小长度：10 最大长度：40 status Integer 本次任务执行详细状态，状态码划分规则：reader端 100 ~ 499，writer端 500 ~ 899，其他900 ~ ： 16(被强制取消) 99(任务开始) 100(Reader 任务开始) 101(Reader 任务结束) 102(正在读取数据) 103(读端数据源端异常) 104(读取数据结束) 105(读取数据为0) 106(读任务强制取消) 107(在reader plugin中，任务发生了中断) 108(读任务恢复运行) 500(Writer 任务开始) 501(Writer 任务结束) 502(正在数据写入) 503(目标端异常) 504(数据写入结束) 505(写任务强制取消) 506(在writer plugin中，任务发生了中断) 507(写任务恢复运行) 900(接收到调度请求) 901(任务运行结束) 902(任务已运行结束，正在进行数据完整性校验) 903(输出数据完整性校验结果) 904(经过数据完整性校验，发现有数据缺失，正在进行数据补偿) 905(输出数据补偿结果) 906(读取任务正在排队中（平台资源）) 907(读取任务被拒绝执行，因为上一次调度还没有结束) 908(写入任务正在排队中（平台资源）) 909(写入任务被拒绝执行，因为上一次调度还没有结束) 911(读取任务没有被正常开启，请检查网络是否通畅，参数是否正确) 912(写入任务没有被正常开启，请检查网络是否通畅，参数是否正确) 913(任务调度请求失败) 914(任务被拒绝执行，因为上一次调度还没有结束) 915(任务不正常运行) 916(任务日志上报异常) 最小值：1 最大值：1000 position String 标识当前步骤属于哪一个阶段： ADAPTER(任务处于初始化阶段) READER(任务正在执行Reader读操作) WRITER(任务正在执行Writer写操作) 最小长度：3 最大长度：10 position_status String 任务当前步骤的状态： NORMAL(正在运行) NODE_END(本节点正常结束) RUNTIME_CANCEL(任务被取消) TASK_END(本任务正常结束) RUNTIME_ERR(运行时异常) INTERNAL_ERR(内部程序异常) 最小长度：3 最大长度：20 stage String 标识当前步骤属于哪一个FDI插件，如adapter、apireader、rdbwriter等。 最小长度：3 最大长度：20 dirty_data_count Integer 异常数据条数。 最小值：0 最大值：9999999999999 data_count Integer 成功数据条数。 最小值：0 最大值：9999999999999 data_size Number 成功数据大小，浮点数类型。 最小值：0 最大值：9999999999999 data_size_unit String 成功数据大小的计量单位。 最小长度：1 最大长度：2 spend_time Integer 执行时长，单位：ms。 最小值：0 最大值：9999999999999 remarks String 执行详细信息。 最小长度：1 最大长度：256 step_begin_time Integer 本次步骤启动时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：9999999999999 step_end_time Integer 本次步骤结束时间，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：9999999999999 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 group_id String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256

请求示例 创建名称为rg_test，且资源分组添加资源方式为TAG的资源分组。 { "group_name" : "rg_test", "enterprise_project_id" : "0", "type" : "TAG", "tags" : [ { "key" : "key1", "value" : "value1" } ], "association_ep_ids" : [ "d61d4705-5658-42f5-8e0c-70eb34d17b02" ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 资源分组的名称，只能为字母、数字、汉字、-、_，最大长度为128 最小长度：1 最大长度：128 正则匹配：^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$ enterprise_project_id 否 String 资源分组归属企业项目ID 正则匹配：^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ type 否 String 资源分组添加资源方式，取值只能为EPS（同步企业项目）,TAG（标签动态匹配）,不传为手动添加 正则匹配：^(EPS|TAG|Manual|COMB)$ tags 否 Array of ResourceGroupTagRelation objects 标签动态匹配时的关联标签,type为TAG时必传 数组长度：1 - 10 association_ep_ids 否 Array of strings 该资源分组内包含的资源来源的企业项目ID，type为EPS时必传 数组长度：1 - 10 表4 ResourceGroupTagRelation 参数 是否必选 参数类型 描述 key 是 String 键 最小长度：1 最大长度：36 value 否 String 值 最小长度：1 最大长度：42

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。默认使用application/json; charset=UTF-8。 缺省值：application/json; charset=UTF-8 最小长度：1 最大长度：64 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：16384

响应示例 状态码： 200 查询成功 { "dimensions" : [ { "name" : "disk", "value" : "2e84018fc8b4484b94e89aae212fe615", "origin_value" : "vda" }, { "name" : "disk", "value" : "6a1b2de69eeb9a037ea23de6b529394d", "origin_value" : "vdc" } ], "count" : 10 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 dimensions Array of AgentDimension objects 维度信息 数组长度：0 - 2147483647 count Integer 维度信息总数 最小值：0 最大值：2147483647 表5 AgentDimension 参数 参数类型 描述 name String 维度名称，枚举类型，类型有： mount_point：挂载点， disk：磁盘， proc：进程， gpu：显卡， raid: RAID控制器 枚举值： mount_point disk proc gpu raid value String 维度值，32位字符串，如：2e84018fc8b4484b94e89aae212fe615 最小长度：32 最大长度：32 origin_value String 实际维度信息，字符串，如：vda。 最小长度：1 最大长度：1024 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：256 error_msg String 错误信息 最小长度：0 最大长度：256 request_id String 请求id 最小长度：0 最大长度：256 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：256 error_msg String 错误信息 最小长度：0 最大长度：256 request_id String 请求id 最小长度：0 最大长度：256 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：0 最大长度：256 error_msg String 错误信息 最小长度：0 最大长度：256 request_id String 请求id 最小长度：0 最大长度：256

URI GET /v2/{project_id}/instances/{instance_id}/agent-dimensions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目编号。 最小长度：1 最大长度：64 instance_id 是 String 资源ID，如：4270ff17-aba3-4138-89fa-820594c39755。 最小长度：36 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 dim_name 是 String 维度名称，枚举类型，类型有： mount_point：挂载点, disk：磁盘, proc：进程, gpu：显卡, raid: RAID控制器, 枚举值： mount_point disk proc gpu raid dim_value 否 String 维度值，32位字符串，如：2e84018fc8b4484b94e89aae212fe615。 最小长度：32 最大长度：32 offset 否 Integer 分页偏移量 最小值：0 最大值：2147483647 缺省值：0 正则匹配：^(0|[1-9][0-9]*)$ limit 否 Integer 分页大小 最小值：1 最大值：1000 缺省值：1000 正则匹配：^([1-9]|[1-9][0-9]|[1-9][0-9][0-9]|1000)$

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 资源分组总数 最小值：0 最大值：1000 resource_groups Array of OneResourceGroupResp objects 资源分组列表 数组长度：0 - 100 表5 OneResourceGroupResp 参数 参数类型 描述 group_name String 资源分组的名称 正则匹配：^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ group_id String 资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 最小长度：2 最大长度：24 create_time String 资源分组的创建时间 enterprise_project_id String 资源分组归属企业项目ID 正则匹配：^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$ type String 资源分组添加资源方式，取值只能为EPS（同步企业项目）,TAG（标签动态匹配）,Manual（手动添加） 枚举值： EPS TAG Manual 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 请求异常内部业务状态码 最小长度：0 最大长度：256 error_msg String 请求异常信息 最小长度：0 最大长度：256 request_id String 请求ID 最小长度：0 最大长度：256