华为云用户手册

  • URI GET /v1/{project_id}/service/statistic/apps-top-n 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY top_num 是 Integer 前几名 order_by 是 String 排序条件 枚举值: CALL_NUM SUC CES S_NUM FAIL_NUM LEGAL_NUM ILLEGAL_NUM COST_TIME_AVG SUCCESS_COST_TIME_AVG FAIL_COST_TIME_AVG SUCCESS_RATE FAIL_RATE LEGAL_RATE ILLEGAL_RATE
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 [数组元素] Array of CategoryDetailVO objects 自定义项列表 表5 CategoryDetailVO 参数 参数类型 描述 id Long 目录ID,根目录的ID为0 name String 名称 type String 类型 built_in:系统内置 user-defined: 用户自定义 pid String 父目录ID sub_categories Array of SubCategoryDetailVO objects 子目录 表6 SubCategoryDetailVO 参数 参数类型 描述 id Long 目录ID,根目录的ID为0 name String 名称 type String 类型 built_in:系统内置 user-defined: 用户自定义 pid String 父目录ID sub_categories Object 子目录 状态码: 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DQC.0000,请求处理成功 error_msg String 错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码,如DQC.0000,请求处理成功 error_msg String 错误信息
  • 响应示例 状态码: 200 Success [ { "name" : "全部", "id" : 0, "type" : "built_in", "pid" : "-1", "sub_categories" : [ { "name" : "qwe", "id" : 1012384968858652700, "type" : "user-defined", "pid" : "0", "sub_categories" : [ ] } ]} ]
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 apply_num Integer 申请量 call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/service/statistic/apps-overview 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY
  • 响应示例 状态码: 200 查询app 统计数据详情成功 { "id" : "3423634676234236674", "name" : "统计对象名称", "call_num" : 0, "success_num" : 0, "fail_num" : 0, "legal_num" : 0, "illegal_num" : 0, "cost_time_avg" : 0, "success_cost_time_avg" : 0, "fail_cost_time_avg" : 0, "success_rate" : 0, "fail_rate" : 0, "legal_rate" : 0, "illegal_rate" : 0}
  • URI GET /v1/{project_id}/service/statistic/apps-detail/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID app_id 是 String app编号 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 统计对象编号 name String 统计对象名称 call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) cost_time_avg Number 请求平均时长 success_cost_time_avg Number 成功请求平均时长 fail_cost_time_avg Number 失败请求平均时长 success_rate Number 成功率 fail_rate Number 失败率 legal_rate Number 合法率 illegal_rate Number 非法率 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 dashboards Array of StatisticForDashboard objects 统计信息仪表板 表5 StatisticForDashboard 参数 参数类型 描述 log_time Integer 统计时间点(13位时间戳) call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) cost_time_avg Number 请求平均时长 success_cost_time_avg Number 成功请求平均时长 fail_cost_time_avg Number 失败请求平均时长 success_rate Number 成功率 fail_rate Number 失败率 legal_rate Number 合法率 illegal_rate Number 非法率 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/service/statistic/apps-dashboards 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY limit 否 Integer limit offset 否 Integer offset
  • 响应示例 状态码: 200 查询app 仪表板数据详情成功 { "dashboards" : [ { "log_time" : 1629403200000, "call_num" : 0, "success_num" : 0, "fail_num" : 0, "legal_num" : 0, "illegal_num" : 0, "cost_time_avg" : 0, "success_cost_time_avg" : 0, "fail_cost_time_avg" : 0, "success_rate" : 0, "fail_rate" : 0, "legal_rate" : 0, "illegal_rate" : 0 } ]}
  • 响应示例 状态码: 200 查询api 服务调用topN成功 { "statistics" : [ { "id" : "3423634676234236674", "name" : "统计对象名称", "call_num" : 0, "success_num" : 0, "fail_num" : 0, "legal_num" : 0, "illegal_num" : 0, "cost_time_avg" : 0, "success_cost_time_avg" : 0, "fail_cost_time_avg" : 0, "success_rate" : 0, "fail_rate" : 0, "legal_rate" : 0, "illegal_rate" : 0 } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 statistics Array of StatisticForDetail objects 统计信息详情列表 表5 StatisticForDetail 参数 参数类型 描述 id String 统计对象编号 name String 统计对象名称 call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) cost_time_avg Number 请求平均时长 success_cost_time_avg Number 成功请求平均时长 fail_cost_time_avg Number 失败请求平均时长 success_rate Number 成功率 fail_rate Number 失败率 legal_rate Number 合法率 illegal_rate Number 非法率 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/service/statistic/apis-top-n 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 集群编号 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY top_num 是 Integer 前几名 order_by 是 String 排序条件 枚举值: CALL_NUM SUCCESS_NUM FAIL_NUM LEGAL_NUM ILLEGAL_NUM COST_TIME_AVG SUCCESS_COST_TIME_AVG FAIL_COST_TIME_AVG SUCCESS_RATE FAIL_RATE LEGAL_RATE ILLEGAL_RATE
  • 响应示例 状态码: 200 查询api 统计数据详情成功 { "id" : "3423634676234236674", "name" : "统计对象名称", "call_num" : 0, "success_num" : 0, "fail_num" : 0, "legal_num" : 0, "illegal_num" : 0, "cost_time_avg" : 0, "success_cost_time_avg" : 0, "fail_cost_time_avg" : 0, "success_rate" : 0, "fail_rate" : 0, "legal_rate" : 0, "illegal_rate" : 0}
  • URI GET /v1/{project_id}/service/statistic/apis-detail/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID api_id 是 String api编号 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 集群编号 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 统计对象编号 name String 统计对象名称 call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) cost_time_avg Number 请求平均时长 success_cost_time_avg Number 成功请求平均时长 fail_cost_time_avg Number 失败请求平均时长 success_rate Number 成功率 fail_rate Number 失败率 legal_rate Number 合法率 illegal_rate Number 非法率 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 publish_num Integer 已发布API量 developing_num Integer 开发中API量 apply_num Integer 申请量 call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/service/statistic/apis-overview 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY
  • 响应示例 状态码: 200 查询api 仪表板数据详情成功 { "dashboards" : [ { "log_time" : 1629403200000, "call_num" : 0, "success_num" : 0, "fail_num" : 0, "legal_num" : 0, "illegal_num" : 0, "cost_time_avg" : 0, "success_cost_time_avg" : 0, "fail_cost_time_avg" : 0, "success_rate" : 0, "fail_rate" : 0, "legal_rate" : 0, "illegal_rate" : 0 } ]}
  • URI GET /v1/{project_id}/service/statistic/apis-dashboards 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 集群编号 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY limit 否 Integer limit offset 否 Integer offset
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 dashboards Array of StatisticForDashboard objects 统计信息仪表板 表5 StatisticForDashboard 参数 参数类型 描述 log_time Integer 统计时间点(13位时间戳) call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) cost_time_avg Number 请求平均时长 success_cost_time_avg Number 成功请求平均时长 fail_cost_time_avg Number 失败请求平均时长 success_rate Number 成功率 fail_rate Number 失败率 legal_rate Number 合法率 illegal_rate Number 非法率 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 200 查询指定api 仪表板数据详情成功 { "dashboards" : [ { "log_time" : 1629403200000, "call_num" : 0, "success_num" : 0, "fail_num" : 0, "legal_num" : 0, "illegal_num" : 0, "cost_time_avg" : 0, "success_cost_time_avg" : 0, "fail_cost_time_avg" : 0, "success_rate" : 0, "fail_rate" : 0, "legal_rate" : 0, "illegal_rate" : 0 } ]}
  • URI GET /v1/{project_id}/service/statistic/apis-dashboards/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID api_id 是 String api编号 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 集群编号 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 dashboards Array of StatisticForDashboard objects 统计信息仪表板 表5 StatisticForDashboard 参数 参数类型 描述 log_time Integer 统计时间点(13位时间戳) call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) cost_time_avg Number 请求平均时长 success_cost_time_avg Number 成功请求平均时长 fail_cost_time_avg Number 失败请求平均时长 success_rate Number 成功率 fail_rate Number 失败率 legal_rate Number 合法率 illegal_rate Number 非法率 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 statistics Array of StatisticForCallDetail objects 调用信息列表 表5 StatisticForCallDetail 参数 参数类型 描述 id String 统计对象编号 name String 统计对象名称 call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • URI GET /v1/{project_id}/service/statistic/apis-top-n/{api_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID api_id 是 String api编号 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 集群编号 start_time 是 Long 开始时间(13位时间戳) end_time 是 Long 结束时间(13位时间戳) time_unit 是 String 时间单位 枚举值: HOUR DAY top_num 是 Integer 前几名 order_by 是 String 排序条件 枚举值: CALL_NUM SUCCESS_NUM FAIL_NUM LEGAL_NUM ILLEGAL_NUM COST_TIME_AVG SUCCESS_COST_TIME_AVG FAIL_COST_TIME_AVG SUCCESS_RATE FAIL_RATE LEGAL_RATE ILLEGAL_RATE
  • 响应示例 状态码: 200 查询指定api 应用调用topN成功 { "statistics" : [ { "id" : "3423634676234236674", "name" : "统计对象名称", "call_num" : 0, "success_num" : 0, "fail_num" : 0, "legal_num" : 0, "illegal_num" : 0 } ]}
  • 响应 响应样例 { "id": "908489209a320df61607355c57c82882", "name": "app_test_001", "description": "This is the app's description.", "app_key": "fbbf9462bb434cb4a13ee7d2bb70c418", "app_secret": "c1245f01937442e098ffa6ff134cb3dc", "register_time": 1578284788000, "update_time": 1578284788000, "create_user": "create_user", "update_user": "update_user", "app_type": "APP"} 响应参数说明 参数名 参数类型 说明 id String 应用编号 name String 应用名称 description String 应用描述 app_key String 应用key app_secret String 应用secret register_time Long 注册时间。13位时间戳。 update_time Long 最近更新时间。13位时间戳。 create_user String 创建者 update_user String 最近更新者 app_type String 应用类型 IAM :iam认证 APP:app认证 APIG:API网关共享版(存量数据) APIGW:API网关专享版(存量数据) DLM:无网关(存量数据) ROMA_APIC:ROMA-APIC网关(存量数据)
  • 响应 响应样例 { "id": "908489209a320df61607355c57c82882", "name": "app_test_001", "description": "This is the app's description.", "app_key": "fbbf9462bb434cb4a13ee7d2bb70c418", "app_secret": "c1245f01937442e098ffa6ff134cb3dc", "register_time": 1578284788000, "update_time": 1578284788000, "create_user": "create_user", "update_user": "update_user", "app_type": "APP"} 响应参数说明 参数名 参数类型 说明 id String 应用编号 name String 应用名称 description String 应用描述 app_key String 应用key app_secret String 应用secret register_time Long 注册时间。13位时间戳。 update_time Long 最近更新时间。13位时间戳。 create_user String 创建者 update_user String 最近更新者 app_type String 应用类型 IAM:iam认证 APP:app认证 APIG:API网关共享版(存量数据) APIGW:API网关专享版(存量数据) DLM:无网关(存量数据) ROMA_APIC:ROMA-APIC网关(存量数据)
共100000条