audit.yaml 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. AuditLogs:
  2. get:
  3. operationId: listAuditLogs
  4. summary: 分页查询审计日志
  5. parameters:
  6. - $ref: '../components/parameters.yaml#/XRequestId'
  7. - {name: keyword, in: query, schema: {type: string}}
  8. - {name: createdFrom, in: query, schema: {type: string, format: date-time}}
  9. - {name: createdTo, in: query, schema: {type: string, format: date-time}}
  10. - name: userId
  11. in: query
  12. schema: {$ref: '../components/schemas.yaml#/StringId'}
  13. - name: organizationId
  14. in: query
  15. schema: {$ref: '../components/schemas.yaml#/StringId'}
  16. - name: actionType
  17. in: query
  18. schema: {$ref: '../components/schemas.yaml#/AuditAction'}
  19. - name: operationResult
  20. in: query
  21. schema: {$ref: '../components/schemas.yaml#/AuditResult'}
  22. - name: targetType
  23. in: query
  24. schema: {$ref: '../components/schemas.yaml#/AuditTarget'}
  25. - name: targetId
  26. in: query
  27. schema: {$ref: '../components/schemas.yaml#/StringId'}
  28. - {name: page, in: query, schema: {type: integer, minimum: 1, default: 1}}
  29. - name: pageSize
  30. in: query
  31. schema: {type: integer, minimum: 1, maximum: 100, default: 20}
  32. - name: sortDirection
  33. in: query
  34. schema: {type: string, enum: [asc, desc], default: desc}
  35. responses:
  36. '200':
  37. description: 审计日志分页结果
  38. content:
  39. application/json:
  40. schema: {$ref: '../components/schemas.yaml#/AuditLogPageResponse'}
  41. '400': {$ref: '../components/responses.yaml#/InvalidArgument'}
  42. '401': {$ref: '../components/responses.yaml#/AuthenticationError'}
  43. '403': {$ref: '../components/responses.yaml#/Forbidden'}
  44. '500': {$ref: '../components/responses.yaml#/InternalError'}
  45. DocumentStatistics:
  46. get:
  47. operationId: getDocumentStatistics
  48. summary: 查询文档统计概览
  49. parameters:
  50. - $ref: '../components/parameters.yaml#/XRequestId'
  51. responses:
  52. '200':
  53. description: 文档统计概览
  54. content:
  55. application/json:
  56. schema: {$ref: '../components/schemas.yaml#/DocumentStatisticsResponse'}
  57. '400': {$ref: '../components/responses.yaml#/InvalidArgument'}
  58. '401': {$ref: '../components/responses.yaml#/AuthenticationError'}
  59. '403': {$ref: '../components/responses.yaml#/Forbidden'}
  60. '500': {$ref: '../components/responses.yaml#/InternalError'}
  61. AuditTrendStatistics:
  62. get:
  63. operationId: getAuditTrendStatistics
  64. summary: 查询审计趋势
  65. parameters:
  66. - $ref: '../components/parameters.yaml#/XRequestId'
  67. - {name: createdFrom, in: query, schema: {type: string, format: date-time}}
  68. - {name: createdTo, in: query, schema: {type: string, format: date-time}}
  69. - name: granularity
  70. in: query
  71. required: true
  72. schema: {$ref: '../components/schemas.yaml#/AuditGranularity'}
  73. responses:
  74. '200':
  75. description: 审计趋势
  76. content:
  77. application/json:
  78. schema: {$ref: '../components/schemas.yaml#/AuditTrendResponse'}
  79. '400': {$ref: '../components/responses.yaml#/InvalidArgument'}
  80. '401': {$ref: '../components/responses.yaml#/AuthenticationError'}
  81. '403': {$ref: '../components/responses.yaml#/Forbidden'}
  82. '500': {$ref: '../components/responses.yaml#/InternalError'}
  83. AuditActionStatistics:
  84. get:
  85. operationId: getAuditActionStatistics
  86. summary: 查询审计动作分布
  87. parameters:
  88. - $ref: '../components/parameters.yaml#/XRequestId'
  89. - {name: createdFrom, in: query, schema: {type: string, format: date-time}}
  90. - {name: createdTo, in: query, schema: {type: string, format: date-time}}
  91. responses:
  92. '200':
  93. description: 审计动作分布
  94. content:
  95. application/json:
  96. schema: {$ref: '../components/schemas.yaml#/AuditActionStatisticsResponse'}
  97. '400': {$ref: '../components/responses.yaml#/InvalidArgument'}
  98. '401': {$ref: '../components/responses.yaml#/AuthenticationError'}
  99. '403': {$ref: '../components/responses.yaml#/Forbidden'}
  100. '500': {$ref: '../components/responses.yaml#/InternalError'}
  101. AuditUserStatistics:
  102. get:
  103. operationId: getAuditUserStatistics
  104. summary: 查询审计活跃用户
  105. parameters:
  106. - $ref: '../components/parameters.yaml#/XRequestId'
  107. - {name: createdFrom, in: query, schema: {type: string, format: date-time}}
  108. - {name: createdTo, in: query, schema: {type: string, format: date-time}}
  109. - name: limit
  110. in: query
  111. schema: {type: integer, minimum: 1, maximum: 100, default: 10}
  112. responses:
  113. '200':
  114. description: 审计活跃用户
  115. content:
  116. application/json:
  117. schema: {$ref: '../components/schemas.yaml#/AuditUserStatisticsResponse'}
  118. '400': {$ref: '../components/responses.yaml#/InvalidArgument'}
  119. '401': {$ref: '../components/responses.yaml#/AuthenticationError'}
  120. '403': {$ref: '../components/responses.yaml#/Forbidden'}
  121. '500': {$ref: '../components/responses.yaml#/InternalError'}