ip-entries.yaml 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. IpEntries:
  2. get:
  3. operationId: listIpEntries
  4. summary: 分页查询IP条目(模糊匹配ipValue与remark)
  5. parameters:
  6. - $ref: '../components/parameters.yaml#/XRequestId'
  7. - name: keyword
  8. in: query
  9. schema:
  10. type: string
  11. - name: page
  12. in: query
  13. schema:
  14. type: integer
  15. minimum: 1
  16. default: 1
  17. - name: pageSize
  18. in: query
  19. schema:
  20. type: integer
  21. minimum: 1
  22. maximum: 100
  23. default: 20
  24. responses:
  25. '200':
  26. description: IP条目分页结果
  27. content:
  28. application/json:
  29. schema:
  30. $ref: '../components/schemas.yaml#/IpEntryPageResponse'
  31. '400':
  32. $ref: '../components/responses.yaml#/InvalidArgument'
  33. '401':
  34. $ref: '../components/responses.yaml#/AuthenticationError'
  35. '403':
  36. $ref: '../components/responses.yaml#/Forbidden'
  37. '500':
  38. $ref: '../components/responses.yaml#/InternalError'
  39. post:
  40. operationId: createIpEntry
  41. summary: 新建IP条目(精确IP或CIDR网段,规范化存储)
  42. parameters:
  43. - $ref: '../components/parameters.yaml#/XRequestId'
  44. requestBody:
  45. required: true
  46. content:
  47. application/json:
  48. schema:
  49. $ref: '../components/schemas.yaml#/CreateIpEntryRequest'
  50. responses:
  51. '201':
  52. description: 创建成功
  53. content:
  54. application/json:
  55. schema:
  56. $ref: '../components/schemas.yaml#/IpEntryResponse'
  57. '400':
  58. $ref: '../components/responses.yaml#/InvalidArgument'
  59. '401':
  60. $ref: '../components/responses.yaml#/AuthenticationError'
  61. '403':
  62. $ref: '../components/responses.yaml#/Forbidden'
  63. '409':
  64. $ref: '../components/responses.yaml#/Conflict'
  65. '500':
  66. $ref: '../components/responses.yaml#/InternalError'
  67. IpEntry:
  68. parameters:
  69. - name: id
  70. in: path
  71. required: true
  72. schema:
  73. $ref: '../components/schemas.yaml#/StringId'
  74. put:
  75. operationId: updateIpEntry
  76. summary: 编辑IP条目(乐观锁)
  77. requestBody:
  78. required: true
  79. content:
  80. application/json:
  81. schema:
  82. $ref: '../components/schemas.yaml#/UpdateIpEntryRequest'
  83. responses:
  84. '200':
  85. description: 编辑成功
  86. content:
  87. application/json:
  88. schema:
  89. $ref: '../components/schemas.yaml#/IpEntryResponse'
  90. '400':
  91. $ref: '../components/responses.yaml#/InvalidArgument'
  92. '401':
  93. $ref: '../components/responses.yaml#/AuthenticationError'
  94. '403':
  95. $ref: '../components/responses.yaml#/Forbidden'
  96. '404':
  97. $ref: '../components/responses.yaml#/NotFound'
  98. '409':
  99. $ref: '../components/responses.yaml#/Conflict'
  100. '500':
  101. $ref: '../components/responses.yaml#/InternalError'
  102. delete:
  103. operationId: deleteIpEntry
  104. summary: 逻辑删除IP条目(被部门分配引用时拒绝)
  105. parameters:
  106. - name: rowVersion
  107. in: query
  108. required: true
  109. schema: {type: integer, minimum: 0}
  110. responses:
  111. '200':
  112. description: 删除成功
  113. content:
  114. application/json:
  115. schema:
  116. $ref: '../components/schemas.yaml#/DeleteIpEntryResponse'
  117. '400':
  118. $ref: '../components/responses.yaml#/InvalidArgument'
  119. '401':
  120. $ref: '../components/responses.yaml#/AuthenticationError'
  121. '403':
  122. $ref: '../components/responses.yaml#/Forbidden'
  123. '404':
  124. $ref: '../components/responses.yaml#/NotFound'
  125. '409':
  126. $ref: '../components/responses.yaml#/Conflict'
  127. '500':
  128. $ref: '../components/responses.yaml#/InternalError'