云服务器内容精选

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 datapoints Array of MetricData objects 指标数据列表 表5 MetricData 参数 参数类型 描述 average Integer 聚合周期内指标数据的平均值,仅当请求参数filter字段值为average时支持。 max Integer 聚合周期内指标数据的最大值,仅当请求参数filter字段值为max时支持。 min Integer 聚合周期内指标数据的最小值,仅当请求参数filter字段值为min时支持。 sum Integer 聚合周期内指标数据的求和值,仅当请求参数filter字段值为sum时支持。 variance Integer 聚合周期内指标数据的方差,仅当请求参数filter字段值为variance时支持。 timestamp Long 指标采集时间,UNIX时间戳,单位毫秒。 unit String 指标单位。 状态码: 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 { "datapoints" : [ { "average" : 5, "timestamp" : 1665304920000, "unit" : "Byte" } ] } 状态码: 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" }
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/metric-data 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 dim 是 String 指标维度 inbound_eip:入口公网带宽,仅ELB类型实例支持 outbound_eip:出口公网带宽 枚举值: inbound_eip outbound_eip metric_name 是 String 指标名称 upstream_bandwidth:出网带宽 downstream_bandwidth:入网带宽 upstream_bandwidth_usage:出网带宽使用率 downstream_bandwidth_usage:入网带宽使用率 up_stream:出网流量 down_stream:入网流量 枚举值: upstream_bandwidth downstream_bandwidth upstream_bandwidth_usage downstream_bandwidth_usage up_stream down_stream from 是 String 查询数据起始时间,UNIX时间戳,单位毫秒。 to 是 String 查询数据截止时间UNIX时间戳,单位毫秒。from必须小于to。 period 是 Integer 监控数据粒度。 1:实时数据 300:5分钟粒度 1200:20分钟粒度 3600:1小时粒度 14400:4小时粒度 86400:1天粒度 枚举值: 1 300 1200 3600 14400 86400 filter 是 String 数据聚合方式。 average:聚合周期内指标数据的平均值。 max:聚合周期内指标数据的最大值。 min:聚合周期内指标数据的最小值。 sum:聚合周期内指标数据的求和值。 variance:聚合周期内指标数据的方差。 枚举值: average max min sum variance
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 响应码 msg String 返回消息 start_time Long 开始时间的UTC的时间戳 end_time Long 截止时间的UTC的时间戳 list Array of StatisticsGroup objects 统计指标的数据结构结构体 表5 StatisticsGroup 参数 参数类型 描述 max_latency Integer 最大延时 单位:ms avg_latency Float 平均延时 单位:ms req_count Integer 请求总次数 req_count2xx Integer 2xx响应码总次数 req_count4xx Integer 4xx响应码总次数 req_count5xx Integer 5xx响应码总次数 req_count_error Integer 错误次数 output_throughput Long 下行吞吐量(byte) input_throughput Long 上行吞吐量(byte) current_minute Long API访问的UTC时间戳 group_id String API分组编号 provider String API拥有者 req_time String API请求时间 register_time String 记录时间 状态码: 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 { "code" : "APIG.0000", "start_time" : 1595574540, "end_time" : 1595578080, "list" : [ { "avg_latency" : 4.14, "current_minute" : 1595576640, "group_id" : "d0fc4e40b7d1492cba802f667c7c7226", "input_throughput" : 1071, "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" }, { "avg_latency" : 3.67, "current_minute" : 1595577900, "group_id" : "d0fc4e40b7d1492cba802f667c7c7226", "input_throughput" : 915, "max_latency" : 6, "output_throughput" : 2763, "provider" : "73d69ae0cfcf460190522d06b60f05ad", "register_time" : "2020-07-24 16:05:12", "req_count" : 6, "req_count2xx" : 3, "req_count4xx" : 0, "req_count5xx" : 3, "req_count_error" : 3, "req_time" : "2020-07-24 16:05:00" } ] } 状态码: 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:group_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.3001", "error_msg" : "API group d0fc4e40b7d1492cba802f667c7c7226 does not exist" } 状态码: 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }
  • URI GET /v2/{project_id}/apigw/instances/{instance_id}/statistics/group/latest 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 group_id 是 String API分组的编号
  • 响应示例 状态码: 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 错误描述
  • 功能介绍 根据API的id和最近的一段时间查询API被调用的次数,统计周期为1分钟、小时、天。 查询范围一小时以内,一分钟一个样本,其样本值为一分钟内的累计值,服务器返回服务器的时间的上一分钟到往前推N分钟的数据; 查询范围一天以内,返回一小时一个样本,其样本值为一小时内的累计值,服务器会返回最近时长横跨统计周期的数据,比如时长为大于2小时,且小于3小时,那么会查询最近3个小时的数据; 查询超过一天以上,返回一天为一个样本,其样本值为一天内的累计值,服务器会返回最近时长横跨统计周期的数据。 为了安全起见,在服务器上使用curl命令调用接口查询信息后,需要清理历史操作记录,包括但不限于“~/.bash_history”、“/var/log/messages”(如有)。
  • 响应消息 表3 参数说明 参数 类型 说明 操作类型 code String 响应码 R msg String 返回消息 R start_time Long 开始时间的UTC的时间戳 R end_time Long 截止时间的UTC的时间戳 R list 结构体数据类型 统计指标的数据结构结构体 R 表4 参数说明 参数 类型 说明 操作类型 cycle String 统计周期(预留) R api_id String API的id R current_minute Long API访问的UTC时间戳 R group_id String API的分组ID R provider String API拥有者 R req_count Integer 请求总次数 R max_latency Integer 最大延时 R avg_latency Double 平均耗时 R max_backend_latency Integer 最大后端延时 R avg_backend_latency Double 平均后端延时 R max_inner_latency Integer 最大网关内部延时 R avg_inner_latency Double 平均网关内部延时 R output_throughput Integer 下行吞吐量(byte) R input_throughput Integer 上行吞吐量(byte) R req_count4xx Integer 4xx响应码总次数 R req_count5xx Integer 5xx响应码总次数 R req_count2xx Integer 2xx响应码总次数 R req_count_error Integer 错误次数 R register_time String 记录时间(yyy-MM-dd HH:mm:ss) R req_time String API请求时间(yyy-MM-dd HH:mm:ss) R status Integer 状态-预留 R 响应消息样例: { "code":"APIG.0000", "msg":"", "start_time":1524735000, "end_time":1524735000, "list":[ { "api_id":"ae12b59fef2e4c6b8e01d44e98b738c0", "current_minute":1524735000, "group_id":"26463e4b2445415eabb55b2414012989", "provider":"d4ef919b31bd43d3927c5d46c71b68c4", "req_count":45, "max_latency":59, "avg_latency":2.53, "max_backend_latency":0, "avg_backend_latency":0, "max_inner_latency":59, "avg_inner_latency":2.53, "output_throughput":31815, "input_throughput":334474, "req_count4xx":0, "req_count5xx":0, "req_count2xx":45, "req_count_error":0, "register_time":"2018-04-26 17:30:48", "req_time":"2018-04-26 17:30:00", "status":1 } ]}