请用 has_next_page 而不是 total 判断是否还有下一页:has_next_page 不依赖 total,超过 1,000 条后仍然准确。
此页面对您有帮助吗?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Flashduty Docs","description":"Flashduty 官方文档,涵盖 On-call 告警响应、Monitors 监控、RUM 与 AI SRE 的配置指南、集成方式和 API 参考。","colors":{"primary":"#8B5CF6","light":"#8B5CF6","dark":"#8B5CF6"},"logo":{"light":"https://mintcdn.com/flashduty-com/FpfuLufyi4FJe6mQ/logo/saas-logo.svg?fit=max\u0026auto=format\u0026n=FpfuLufyi4FJe6mQ\u0026q=85\u0026s=1656361bf7575f7275615ac9191db061","dark":"https://mintcdn.com/flashduty-com/FpfuLufyi4FJe6mQ/logo/saas-logo-white.svg?fit=max\u0026auto=format\u0026n=FpfuLufyi4FJe6mQ\u0026q=85\u0026s=744bbbd3bb703e9db8183af2ee98f185","href":"https://flashduty.com/"},"favicon":"https://mintcdn.com/flashduty-com/FpfuLufyi4FJe6mQ/logo/saas-favicon.png?fit=max\u0026auto=format\u0026n=FpfuLufyi4FJe6mQ\u0026q=85\u0026s=377e85b5ba71d5351ee7f84b5d70b1e1","navbar":{"links":[{"icon":"code","href":"/zh/openapi/introduction","label":"API Reference"}],"primary":{"type":"button","label":"Console","href":"https://console.flashcat.cloud"}},"seo":{"metatags":{"canonical":"https://docs.flashduty.com"},"organization":{"id":"https://flashduty.com/#organization","name":"Flashduty","legalName":"北京快猫星云科技有限公司","url":"https://flashduty.com/","logo":"https://docs.flashduty.com/logo/saas-logo.svg","sameAs":["https://github.com/flashcatcloud"]},"indexing":"all"},"styling":{"latex":true},"navigation":{"languages":[{"language":"zh","footer":{"socials":{"github":"https://github.com/flashcatcloud"},"links":[{"header":"Flashduty","items":[{"label":"官网","href":"https://www.flashduty.com/zh"},{"label":"定价","href":"https://www.flashduty.com/zh/pricing"},{"label":"集成目录","href":"https://www.flashduty.com/zh/integrations"},{"label":"博客","href":"https://www.flashduty.com/zh/now/blog"}]},{"header":"支持","items":[{"label":"联系我们","href":"https://www.flashduty.com/zh/contact"},{"label":"安全与合规","href":"https://www.flashduty.com/zh/legal/security"},{"label":"服务 SLA","href":"/zh/compliance/service-sla"}]},{"header":"法律","items":[{"label":"服务条款","href":"/zh/compliance/terms-of-service"},{"label":"用户协议","href":"/zh/compliance/user-agreement"},{"label":"隐私政策","href":"/zh/compliance/privacy-policy"},{"label":"退款政策","href":"/zh/compliance/refund-policy"}]}]},"navbar":{"links":[{"icon":"code","href":"/zh/openapi/introduction","label":"API 参考"}],"primary":{"type":"button","label":"控制台","href":"https://console.flashcat.cloud"}},"href":"zh/home"},{"language":"en","footer":{"socials":{"github":"https://github.com/flashcatcloud"},"links":[{"header":"Flashduty","items":[{"label":"Website","href":"https://www.flashduty.com/en"},{"label":"Pricing","href":"https://www.flashduty.com/en/pricing"},{"label":"Integrations","href":"https://www.flashduty.com/en/integrations"},{"label":"Blog","href":"https://www.flashduty.com/en/now/blog"}]},{"header":"Support","items":[{"label":"Contact us","href":"https://www.flashduty.com/en/contact"},{"label":"Security","href":"https://www.flashduty.com/en/legal/security"},{"label":"Service SLA","href":"/en/compliance/service-sla"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"/en/compliance/terms-of-service"},{"label":"User Agreement","href":"/en/compliance/user-agreement"},{"label":"Privacy Policy","href":"/en/compliance/privacy-policy"},{"label":"Refund Policy","href":"/en/compliance/refund-policy"}]}]},"navbar":{"links":[{"icon":"code","href":"/en/openapi/introduction","label":"API Reference"}],"primary":{"type":"button","label":"Console","href":"https://console.flashcat.cloud"}},"href":"en/home"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flashduty-com","hasAudioNarration":false,"actualSubdomain":"flashduty-com","customDomains":["docs.flashduty.com"],"gitSource":{"type":"github","owner":"flashcatcloud","repo":"flashduty-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6affc7d52bab8c36268d629d","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"en","tag":"On-call","count":621},{"language":"zh","tag":"On-call","count":621},{"language":"en","tag":"API Reference","count":396},{"language":"zh","tag":"API 参考","count":396},{"language":"en","tag":"Integrations","count":378},{"language":"zh","tag":"集成中心","count":378},{"language":"en","tag":"Alert Integration","count":297},{"language":"zh","tag":"告警集成","count":297},{"language":"en","tag":"RUM","count":125},{"language":"zh","tag":"RUM","count":125},{"language":"en","tag":"AI SRE","count":70},{"language":"en","tag":"Monitors","count":70},{"language":"zh","tag":"AI SRE","count":70},{"language":"zh","tag":"Monitors","count":70},{"language":"zh","tag":"故障管理","count":65},{"language":"en","tag":"Incidents","count":55},{"language":"en","tag":"Change Integration","count":40},{"language":"en","tag":"SDK Integration","count":40},{"language":"zh","tag":"变更集成","count":40},{"language":"zh","tag":"SDK 接入","count":40}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"zh/openapi/pagination","slug":"/zh/openapi/pagination","pageMetadata":{"title":"关于分页","description":"Flashduty Open API 分页机制说明","keywords":["API分页","游标分页","传统分页","OFFSET","LIMIT","SEARCH_AFTER_CTX"],"href":"/zh/openapi/pagination","hidden":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Flashduty Open API 分页机制说明\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,hr:`hr`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Tab,Table,Tabs,Tip,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`列表接口分页返回结果。大多数接口使用页码分页;数据量大或变化快的集合还支持游标分页。每个接口支持哪些分页参数、上限和默认值是多少,以该接口页面为准——下文给出的是常见默认值,并非对所有接口都成立。`}),`\n`,_jsx(Heading,{level:`2`,id:`页码分页`,children:`页码分页`}),`\n`,_jsx(Heading,{level:`3`,id:`请求参数`,children:`请求参数`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`参数`}),_jsx(_components.th,{children:`类型`}),_jsx(_components.th,{children:`描述`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`p`})}),_jsx(_components.td,{children:`integer`}),_jsxs(_components.td,{children:[`页码,从 1 开始。不传或传 `,_jsx(_components.code,{children:`0`}),` 视为 1。offset = (p - 1) × limit`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`limit`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`每页条数。通常最大 100、默认 20;部分接口的范围不同,见接口页面。`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`响应字段`,children:`响应字段`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`字段`}),_jsx(_components.th,{children:`类型`}),_jsx(_components.th,{children:`描述`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`total`})}),_jsx(_components.td,{children:`integer`}),_jsxs(_components.td,{children:[`匹配条数(见`,_jsx(_components.a,{href:`#%E5%85%B3%E4%BA%8E-total`,children:`关于 total`}),`)`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`has_next_page`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`是否还有下一页`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`示例`,children:`示例`}),`\n`,_jsxs(Tabs,{children:[_jsx(Tab,{title:`请求示例`,id:`%E8%AF%B7%E6%B1%82%E7%A4%BA%E4%BE%8B`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"p\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"limit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`20`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),_jsx(Tab,{title:`响应示例`,id:`%E5%93%8D%E5%BA%94%E7%A4%BA%E4%BE%8B`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`5`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_next_page\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: []`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]}),`\n`,_jsx(Heading,{level:`3`,id:`深度限制`,children:`深度限制`}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`On-call 的列表接口要求 `,_jsx(_components.code,{children:`p × limit`}),` 不超过 10,000,更深的页返回 `,_jsx(_components.code,{children:`400 InvalidParameter`}),`。如需继续往后取,请在接口支持时改用游标分页,或收窄筛选条件(例如缩短时间范围)。`]})}),`\n`,_jsx(_components.p,{children:`两次调用之间如有数据新增或删除,偏移量会随之移动,页码分页可能漏掉或重复部分数据。需要完整、稳定地导出时请使用游标分页。`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`游标分页`,children:`游标分页`}),`\n`,_jsxs(_components.p,{children:[`把上一次响应中的 `,_jsx(_components.code,{children:`search_after_ctx`}),` 传回即可获取下一页。游标是不透明的:不要自行构造或修改,翻页过程中其他请求参数保持不变。传了 `,_jsx(_components.code,{children:`search_after_ctx`}),` 时 `,_jsx(_components.code,{children:`p`}),` 会被忽略。`]}),`\n`,_jsxs(_components.p,{children:[`在查询故障列表和查询告警列表上,可以先用页码分页、随时切换为游标分页:每个非空页都会同时返回 `,_jsx(_components.code,{children:`search_after_ctx`}),`,即该页最后一条之后的游标。`]}),`\n`,_jsx(Heading,{level:`3`,id:`请求参数-2`,children:`请求参数`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`参数`}),_jsx(_components.th,{children:`类型`}),_jsx(_components.th,{children:`描述`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`search_after_ctx`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`上一次响应返回的游标,首页不传。`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`limit`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`每页条数,范围见接口页面。`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`响应字段-2`,children:`响应字段`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`字段`}),_jsx(_components.th,{children:`类型`}),_jsx(_components.th,{children:`描述`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`has_next_page`})}),_jsx(_components.td,{children:`boolean`}),_jsx(_components.td,{children:`是否还有下一页`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`search_after_ctx`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`下一页的游标。游标模式下仅当 `,_jsx(_components.code,{children:`has_next_page`}),` 为 `,_jsx(_components.code,{children:`true`}),` 时返回。`]})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`示例-2`,children:`示例`}),`\n`,_jsxs(Tabs,{children:[_jsx(Tab,{title:`请求示例`,id:`%E8%AF%B7%E6%B1%82%E7%A4%BA%E4%BE%8B-2`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"search_after_ctx\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"658bcbae6ab5a67b3b800230\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"limit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`20`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})}),_jsx(Tab,{title:`响应示例`,id:`%E5%93%8D%E5%BA%94%E7%A4%BA%E4%BE%8B-2`,children:_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"total\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1000`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"has_next_page\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"search_after_ctx\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"658ba7f9566077d6090e8d51\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"items\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: []`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]}),`\n`,_jsxs(Heading,{level:`3`,id:`支持-search_after_ctx-的接口`,children:[`支持 `,_jsx(_components.code,{children:`search_after_ctx`}),` 的接口`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/incidents/incident-list`,children:`查询故障列表`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/alerts/alert-read-list`,children:`查询告警列表`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/alerts/alert-read-event-list`,children:`查询告警事件列表`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/alerts/alert-event-read-list`,children:`查询原始告警事件列表`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/incidents/incident-post-mortem-list`,children:`查询复盘报告列表`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/incidents/postmortem-read-list-templates`,children:`查询故障复盘模板列表`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/incidents/incident-service-desk-plus-request-read-list`,children:`获取 ServiceDeskPlus 关联故障`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/alert-enrichment/mapping-data-read-list`,children:`查询映射数据列表`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/on-call/integrations/webhook-history-list`,children:`查询 Webhook 推送历史`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/rum/session-replay/rum-session-replay-read-segments`,children:`查询会话回放分段`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/zh/api-reference/platform/audit-logs/audit-read-search`,children:`检索审计日志`})}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`/zh/api-reference/ai-sre/sessions/session-read-info`,children:`查看会话详情`}),`(分页读取会话事件)`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`少数接口使用其他分页方式,详见其页面:`,_jsx(_components.a,{href:`/zh/api-reference/on-call/incidents/incident-work-item-list`,children:`查询跟进事项列表`}),`使用 `,_jsx(_components.code,{children:`cursor`}),`,部分 AI SRE 和监控接口使用 `,_jsx(_components.code,{children:`offset`}),`。`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`关于-total`,children:`关于 total`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`total`}),` 不总是精确值。为保证大查询的响应速度,故障、告警、告警事件、复盘报告和映射数据相关的列表最多计数到 1,000:`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`匹配数据少于 1,000 条时,`,_jsx(_components.code,{children:`total`}),` 是精确值。`]}),`\n`,_jsxs(_components.li,{children:[`匹配数据达到或超过 1,000 条时,`,_jsx(_components.code,{children:`total`}),` 固定为 1,000,表示”1,000 条及以上”。`]}),`\n`]})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`请用 `,_jsx(_components.code,{children:`has_next_page`}),` 而不是 `,_jsx(_components.code,{children:`total`}),` 判断是否还有下一页:`,_jsx(_components.code,{children:`has_next_page`}),` 不依赖 `,_jsx(_components.code,{children:`total`}),`,超过 1,000 条后仍然准确。`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"关于分页","description":"Flashduty Open API 分页机制说明","keywords":["API分页","游标分页","传统分页","OFFSET","LIMIT","SEARCH_AFTER_CTX"],"href":"/zh/openapi/pagination","hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"页码分页","slug":"页码分页","depth":2,"children":[{"title":"请求参数","slug":"请求参数","depth":3,"children":[]},{"title":"响应字段","slug":"响应字段","depth":3,"children":[]},{"title":"示例","slug":"示例","depth":3,"children":[]},{"title":"深度限制","slug":"深度限制","depth":3,"children":[]}]},{"title":"游标分页","slug":"游标分页","depth":2,"children":[{"title":"请求参数","slug":"请求参数-2","depth":3,"children":[]},{"title":"响应字段","slug":"响应字段-2","depth":3,"children":[]},{"title":"示例","slug":"示例-2","depth":3,"children":[]},{"title":"支持 search_after_ctx 的接口","slug":"支持-search_after_ctx-的接口","depth":3,"children":[]}]},{"title":"关于 total","slug":"关于-total","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"flashduty-com","siteName":"Flashduty Docs","title":"关于分页 - Flashduty Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"zh":{"href":"/zh/openapi/pagination","matchLevel":0},"en":{"href":"/en/openapi/pagination","matchLevel":1,"hidden":true}}},"lastModified":"2026-11-12T08:48:42.800Z","originalFileLocation":"zh/openapi/pagination.mdx","locale":"zh"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Flashduty Open API 分页机制说明\">\u003cmeta data-mint-head name=\"application-name\" content=\"Flashduty Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"关于分页 - Flashduty Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Flashduty Open API 分页机制说明\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flashduty Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flashduty.com/zh/openapi/pagination\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flashduty-com.mintlify.site/_mintlify/api/og/v2?division=%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97\u0026amp;title=%E5%85%B3%E4%BA%8E%E5%88%86%E9%A1%B5\u0026amp;description=Flashduty+Open+API+%E5%88%86%E9%A1%B5%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E\u0026amp;theme=e69468df7fc0f2b1601c6217\u0026amp;signature=c260d8acca162f1219b9b3735c0315734ec53a688bc937a22c9c414486325997\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"关于分页 - Flashduty Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Flashduty Open API 分页机制说明\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flashduty-com.mintlify.site/_mintlify/api/og/v2?division=%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97\u0026amp;title=%E5%85%B3%E4%BA%8E%E5%88%86%E9%A1%B5\u0026amp;description=Flashduty+Open+API+%E5%88%86%E9%A1%B5%E6%9C%BA%E5%88%B6%E8%AF%B4%E6%98%8E\u0026amp;theme=e69468df7fc0f2b1601c6217\u0026amp;signature=c260d8acca162f1219b9b3735c0315734ec53a688bc937a22c9c414486325997\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/flashduty-com/ZomM9gFDgYEBUD0S/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flashduty Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#8B5CF6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flashduty.com/zh/openapi/pagination\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/zh/openapi/pagination.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.flashduty.com/zh/openapi/pagination\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.flashduty.com/en/openapi/pagination\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.flashduty.com/zh/openapi/pagination\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://flashduty.com/#organization\",\"name\":\"Flashduty\",\"legalName\":\"北京快猫星云科技有限公司\",\"url\":\"https://flashduty.com/\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.flashduty.com/logo/saas-logo.svg\"},\"sameAs\":[\"https://github.com/flashcatcloud\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flashduty.com#website\",\"name\":\"Flashduty Docs\",\"url\":\"https://docs.flashduty.com\",\"publisher\":{\"@id\":\"https://flashduty.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flashduty.com/zh/openapi/pagination#webpage\",\"url\":\"https://docs.flashduty.com/zh/openapi/pagination\",\"name\":\"关于分页\",\"description\":\"Flashduty Open API 分页机制说明\",\"dateModified\":\"2026-11-12T08:48:42.800Z\",\"isPartOf\":{\"@id\":\"https://docs.flashduty.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flashduty.com/zh/openapi/pagination#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flashduty.com/zh/openapi/pagination#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"开发指南\",\"item\":\"https://docs.flashduty.com/zh/openapi/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"关于分页\",\"item\":\"https://docs.flashduty.com/zh/openapi/pagination\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.flashduty.com/zh/openapi/pagination#article\",\"headline\":\"关于分页\",\"name\":\"关于分页\",\"description\":\"Flashduty Open API 分页机制说明\",\"url\":\"https://docs.flashduty.com/zh/openapi/pagination\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flashduty.com/zh/openapi/pagination#webpage\"},\"dateModified\":\"2026-11-12T08:48:42.800Z\",\"keywords\":\"API分页, 游标分页, 传统分页, OFFSET, LIMIT, SEARCH_AFTER_CTX\",\"publisher\":{\"@id\":\"https://flashduty.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flashduty.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flashduty Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Flashduty\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/zh/openapi/pagination.md","siteName":"Flashduty Docs","nav":{"global":null,"languages":[{"language":"zh","footer":{"socials":{"github":"https://github.com/flashcatcloud"},"links":[{"header":"Flashduty","items":[{"label":"官网","href":"https://www.flashduty.com/zh"},{"label":"定价","href":"https://www.flashduty.com/zh/pricing"},{"label":"集成目录","href":"https://www.flashduty.com/zh/integrations"},{"label":"博客","href":"https://www.flashduty.com/zh/now/blog"}]},{"header":"支持","items":[{"label":"联系我们","href":"https://www.flashduty.com/zh/contact"},{"label":"安全与合规","href":"https://www.flashduty.com/zh/legal/security"},{"label":"服务 SLA","href":"/zh/compliance/service-sla"}]},{"header":"法律","items":[{"label":"服务条款","href":"/zh/compliance/terms-of-service"},{"label":"用户协议","href":"/zh/compliance/user-agreement"},{"label":"隐私政策","href":"/zh/compliance/privacy-policy"},{"label":"退款政策","href":"/zh/compliance/refund-policy"}]}]},"navbar":{"links":[{"icon":"code","href":"/zh/openapi/introduction","label":"API 参考"}],"primary":{"type":"button","label":"控制台","href":"https://console.flashcat.cloud"}},"tabs":[{"tab":"首页","icon":"house","pages":[{"title":"首页","href":"/zh/home"}]},{"tab":"AI SRE","icon":"sparkles","pages":[{"title":"AI SRE","href":"/zh/ai-sre/quickstart"}]},{"tab":"On-call","icon":"light-emergency-on","pages":[{"title":"On-call","href":"/zh/on-call/quickstart/quickstart"}]},{"tab":"RUM","icon":"monitor-waveform","pages":[{"title":"RUM","href":"/zh/rum/quickstart/quickstart"}]},{"tab":"Monitors","icon":"chart-area","pages":[{"title":"Monitors","href":"/zh/monitors/quickstart/quickstart"}]},{"tab":"API 参考","icon":"terminal","hidden":true,"groups":[{"group":"开发指南","icon":"book-open","pages":[{"title":"快速入门","description":"Flashduty Open API 快速入门指南","href":"/zh/openapi/introduction"},{"title":"API 目录","description":"Flashduty Open API 接口完整列表,按产品模块组织并链接到详细文档","href":"/zh/openapi/api-catalog"},{"title":"关于分页","href":"/zh/openapi/pagination"},{"title":"使用限制与错误码","description":"Flashduty Open API 频率限制、权限校验、错误码与重试建议","href":"/zh/openapi/rate-limits"}]},{"group":"On-call","icon":"light-emergency-on","pages":[{"group":"故障管理","icon":"siren-on","pages":[{"group":"故障信息","icon":"circle-info","pages":[{"title":"查询故障列表","description":"分页查询故障列表,支持按协作空间、严重程度、状态、处理人员和时间范围过滤。","deprecated":null,"version":null,"sidebarTitle":"查询故障列表","openapi":"/api-reference/on-call.openapi.zh.json post /incident/list","href":"/zh/api-reference/on-call/incidents/incident-list"},{"title":"获取故障详情","description":"按 ID 或短编号查询单个故障,包含处理人、分派、自定义字段和告警数量。","deprecated":null,"version":null,"sidebarTitle":"获取故障详情","openapi":"/api-reference/on-call.openapi.zh.json post /incident/info","href":"/zh/api-reference/on-call/incidents/incident-info"},{"title":"批量查询故障","description":"通过故障 ID 列表批量获取故障信息。","deprecated":null,"version":null,"sidebarTitle":"批量查询故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/list-by-ids","href":"/zh/api-reference/on-call/incidents/incident-list-by-ids"},{"title":"查询故障关联告警","description":"查询合并到指定故障中的所有告警列表。","deprecated":null,"version":null,"sidebarTitle":"查询故障关联告警","openapi":"/api-reference/on-call.openapi.zh.json post /incident/alert/list","href":"/zh/api-reference/on-call/incidents/incident-alert-list"},{"title":"获取故障时间线","description":"查询故障的时间线条目,包括状态变化、分派、通知、评论和工作项事件等。","deprecated":null,"version":null,"sidebarTitle":"获取故障时间线","openapi":"/api-reference/on-call.openapi.zh.json post /incident/feed","href":"/zh/api-reference/on-call/incidents/incident-feed"},{"title":"查询历史相似故障","description":"查询与指定故障相似、同一协作空间内已关闭的历史故障,便于复用过往的根因和解决方案。","deprecated":null,"version":null,"sidebarTitle":"查询历史相似故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/past/list","href":"/zh/api-reference/on-call/incidents/incident-past-list"},{"title":"获取 ServiceDeskPlus 关联故障","description":"分页查询 ServiceDeskPlus 请求与 Flashduty 故障的同步映射记录。","deprecated":null,"version":null,"sidebarTitle":"获取 ServiceDeskPlus 关联故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/sdp/request/list","href":"/zh/api-reference/on-call/incidents/incident-service-desk-plus-request-read-list"},{"title":"更新故障信息","description":"在一次调用中更新故障的标题、描述、影响、根因、解决方案或严重程度。","deprecated":null,"version":null,"sidebarTitle":"更新故障信息","openapi":"/api-reference/on-call.openapi.zh.json post /incident/reset","href":"/zh/api-reference/on-call/incidents/incident-reset"},{"title":"评论故障","description":"在故障时间线上添加文字评论。","deprecated":null,"version":null,"sidebarTitle":"评论故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/comment","href":"/zh/api-reference/on-call/incidents/incident-comment"},{"title":"更新故障自定义字段","description":"更新故障的自定义字段值。","deprecated":null,"version":null,"sidebarTitle":"更新故障自定义字段","openapi":"/api-reference/on-call.openapi.zh.json post /incident/field/reset","href":"/zh/api-reference/on-call/incidents/incident-field-reset"},{"title":"执行自定义操作","description":"执行为故障配置的自定义操作。","deprecated":null,"version":null,"sidebarTitle":"执行自定义操作","openapi":"/api-reference/on-call.openapi.zh.json post /incident/custom-action/do","href":"/zh/api-reference/on-call/incidents/incident-custom-action-do"}]},{"group":"状态流转","icon":"timeline","pages":[{"title":"创建故障","description":"手动创建一个新故障并分派处理人员。","deprecated":null,"version":null,"sidebarTitle":"创建故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/create","href":"/zh/api-reference/on-call/incidents/incident-create"},{"title":"认领故障","description":"认领一个故障以表明正在积极处理。","deprecated":null,"version":null,"sidebarTitle":"认领故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/ack","href":"/zh/api-reference/on-call/incidents/incident-ack"},{"title":"取消认领故障","description":"撤销调用成员对一个或多个故障的认领。","deprecated":null,"version":null,"sidebarTitle":"取消认领故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/unack","href":"/zh/api-reference/on-call/incidents/incident-unack"},{"title":"恢复故障","description":"关闭一个或多个故障,可同时记录根因、解决方案和关闭表单的填写内容。","deprecated":null,"version":null,"sidebarTitle":"恢复故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/resolve","href":"/zh/api-reference/on-call/incidents/incident-resolve"},{"title":"重开故障","description":"重新打开已关闭的故障,并从第一级重新分派。","deprecated":null,"version":null,"sidebarTitle":"重开故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/reopen","href":"/zh/api-reference/on-call/incidents/incident-reopen"},{"title":"暂停故障通知","description":"在指定分钟数内暂停已认领故障的通知。","deprecated":null,"version":null,"sidebarTitle":"暂停故障通知","openapi":"/api-reference/on-call.openapi.zh.json post /incident/snooze","href":"/zh/api-reference/on-call/incidents/incident-snooze"},{"title":"恢复故障通知","description":"结束故障的暂停状态,立即恢复通知。","deprecated":null,"version":null,"sidebarTitle":"恢复故障通知","openapi":"/api-reference/on-call.openapi.zh.json post /incident/wake","href":"/zh/api-reference/on-call/incidents/incident-wake"},{"title":"合并故障","description":"将一个或多个故障合并到目标故障中。","deprecated":null,"version":null,"sidebarTitle":"合并故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/merge","href":"/zh/api-reference/on-call/incidents/incident-merge"},{"title":"禁止故障合并","description":"停止将新的告警和事件合并进指定故障。","deprecated":null,"version":null,"sidebarTitle":"禁止故障合并","openapi":"/api-reference/on-call.openapi.zh.json post /incident/disable-merge","href":"/zh/api-reference/on-call/incidents/incident-disable-merge"},{"title":"删除故障","description":"永久删除故障及其告警、原始事件和时间线。","deprecated":null,"version":null,"sidebarTitle":"删除故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/remove","href":"/zh/api-reference/on-call/incidents/incident-remove"},{"title":"分派故障","description":"将故障重新分派给成员或分派策略,替换当前处理人。","deprecated":null,"version":null,"sidebarTitle":"分派故障","openapi":"/api-reference/on-call.openapi.zh.json post /incident/assign","href":"/zh/api-reference/on-call/incidents/incident-assign"},{"title":"添加故障处理人员","description":"为未关闭的故障添加处理人,并通知新加入的处理人。","deprecated":null,"version":null,"sidebarTitle":"添加故障处理人员","openapi":"/api-reference/on-call.openapi.zh.json post /incident/responder/add","href":"/zh/api-reference/on-call/incidents/incident-responder-add"}]},{"group":"作战室","icon":"shield-halved","pages":[{"title":"获取战情室详情","description":"从 IM 平台读取作战室群组当前的名称和加入链接。","deprecated":null,"version":null,"sidebarTitle":"获取战情室详情","openapi":"/api-reference/on-call.openapi.zh.json post /incident/war-room/detail","href":"/zh/api-reference/on-call/incidents/incident-war-room-detail"},{"title":"查询战情室列表","description":"查询故障关联的 IM 作战室群组。","deprecated":null,"version":null,"sidebarTitle":"查询战情室列表","openapi":"/api-reference/on-call.openapi.zh.json post /incident/war-room/list","href":"/zh/api-reference/on-call/incidents/incident-war-room-list"},{"title":"创建战情室","description":"为故障创建 IM 群聊作为作战室,并邀请成员加入。","deprecated":null,"version":null,"sidebarTitle":"创建战情室","openapi":"/api-reference/on-call.openapi.zh.json post /incident/war-room/create","href":"/zh/api-reference/on-call/incidents/incident-war-room-create"},{"title":"删除战情室","description":"在 IM 平台解散故障的作战室群组,并解除与故障的关联。","deprecated":null,"version":null,"sidebarTitle":"删除战情室","openapi":"/api-reference/on-call.openapi.zh.json post /incident/war-room/delete","href":"/zh/api-reference/on-call/incidents/incident-war-room-delete"}]},{"group":"故障复盘","icon":"file-lines","pages":[{"title":"获取复盘报告","description":"按 ID 查询故障复盘报告的完整内容和自动汇总的基础信息。","deprecated":null,"version":null,"sidebarTitle":"获取复盘报告","openapi":"/api-reference/on-call.openapi.zh.json get /incident/post-mortem/info","href":"/zh/api-reference/on-call/incidents/incident-post-mortem-info"},{"title":"查询复盘报告列表","description":"查询故障复盘报告列表,可按状态、团队、协作空间和创建时间过滤。","deprecated":null,"version":null,"sidebarTitle":"查询复盘报告列表","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/list","href":"/zh/api-reference/on-call/incidents/incident-post-mortem-list"},{"title":"删除复盘报告","description":"永久删除故障复盘报告及其上传的媒体文件。","deprecated":null,"version":null,"sidebarTitle":"删除复盘报告","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/delete","href":"/zh/api-reference/on-call/incidents/incident-post-mortem-delete"}]},{"group":"评论类型","icon":"tag","pages":[{"title":"查询评论类型列表","description":"获取账户下全部评论类型,按展示位置排序。","deprecated":null,"version":null,"sidebarTitle":"查询评论类型列表","openapi":"/api-reference/on-call.openapi.zh.json post /incident/comment-type/list","href":"/zh/api-reference/on-call/incidents/incident-comment-type-list"},{"title":"创建评论类型","description":"创建可附加到故障评论的评论类型。","deprecated":null,"version":null,"sidebarTitle":"创建评论类型","openapi":"/api-reference/on-call.openapi.zh.json post /incident/comment-type/create","href":"/zh/api-reference/on-call/incidents/incident-comment-type-create"},{"title":"更新评论类型","description":"更新已有账户评论类型的名称和/或颜色。","deprecated":null,"version":null,"sidebarTitle":"更新评论类型","openapi":"/api-reference/on-call.openapi.zh.json post /incident/comment-type/update","href":"/zh/api-reference/on-call/incidents/incident-comment-type-update"},{"title":"删除评论类型","description":"永久删除评论类型;使用过它的评论保留内容,但不再显示该类型标签。","deprecated":null,"version":null,"sidebarTitle":"删除评论类型","openapi":"/api-reference/on-call.openapi.zh.json post /incident/comment-type/delete","href":"/zh/api-reference/on-call/incidents/incident-comment-type-delete"},{"title":"调整评论类型顺序","description":"传入账户全部评论类型 ID 的期望顺序,设置评论类型的展示顺序。","deprecated":null,"version":null,"sidebarTitle":"调整评论类型顺序","openapi":"/api-reference/on-call.openapi.zh.json post /incident/comment-type/reorder","href":"/zh/api-reference/on-call/incidents/incident-comment-type-reorder"}]},{"group":"跟进事项","icon":"list-check","pages":[{"title":"查询跟进事项列表","description":"以游标分页列出故障的跟进事项(行动项和复盘后续行动)。","deprecated":null,"version":null,"sidebarTitle":"查询跟进事项列表","openapi":"/api-reference/on-call.openapi.zh.json post /incident/work-item/list","href":"/zh/api-reference/on-call/incidents/incident-work-item-list"},{"title":"创建跟进事项","description":"在未关闭的故障上创建行动项,或在已关闭的故障上创建后续行动。","deprecated":null,"version":null,"sidebarTitle":"创建跟进事项","openapi":"/api-reference/on-call.openapi.zh.json post /incident/work-item/create","href":"/zh/api-reference/on-call/incidents/incident-work-item-create"},{"title":"更新跟进事项","description":"部分更新跟进事项的标题、描述、状态或优先级。","deprecated":null,"version":null,"sidebarTitle":"更新跟进事项","openapi":"/api-reference/on-call.openapi.zh.json post /incident/work-item/update","href":"/zh/api-reference/on-call/incidents/incident-work-item-update"},{"title":"删除跟进事项","description":"软删除跟进事项,使其不再出现在事项列表中。","deprecated":null,"version":null,"sidebarTitle":"删除跟进事项","openapi":"/api-reference/on-call.openapi.zh.json post /incident/work-item/delete","href":"/zh/api-reference/on-call/incidents/incident-work-item-delete"},{"title":"完成跟进事项","description":"将跟进事项标记为已完成;仅当前负责人可以操作。","deprecated":null,"version":null,"sidebarTitle":"完成跟进事项","openapi":"/api-reference/on-call.openapi.zh.json post /incident/work-item/complete","href":"/zh/api-reference/on-call/incidents/incident-work-item-complete"},{"title":"转化跟进事项为复盘后续行动","description":"将故障行动项原地转化为故障复盘后续行动。","deprecated":null,"version":null,"sidebarTitle":"转化跟进事项为复盘后续行动","openapi":"/api-reference/on-call.openapi.zh.json post /incident/work-item/convert","href":"/zh/api-reference/on-call/incidents/incident-work-item-convert"},{"title":"重置跟进事项负责人","description":"整体替换跟进事项的负责人集合。","deprecated":null,"version":null,"sidebarTitle":"重置跟进事项负责人","openapi":"/api-reference/on-call.openapi.zh.json post /incident/work-item/assignees/reset","href":"/zh/api-reference/on-call/incidents/incident-work-item-reset-assignees"},{"title":"绑定跟进事项到复盘","description":"将故障下已转化但未绑定的后续行动批量绑定到故障复盘。","deprecated":null,"version":null,"sidebarTitle":"绑定跟进事项到复盘","openapi":"/api-reference/on-call.openapi.zh.json post /incident/work-item/post-mortem/bind","href":"/zh/api-reference/on-call/incidents/incident-work-item-bind-post-mortem"}]},{"title":"查看作战室默认观察者","description":"返回曾被分派到故障、但当前已不是处理人员的人,作为作战室的建议观察者。","deprecated":null,"version":null,"sidebarTitle":"查看作战室默认观察者","openapi":"/api-reference/on-call.openapi.zh.json post /incident/war-room/default-observers","href":"/zh/api-reference/on-call/incidents/incident-read-get-war-room-default-observers"},{"title":"添加作战室成员","description":"向飞书、钉钉、企业微信或 Slack 上已有的故障作战室添加成员。","deprecated":null,"version":null,"sidebarTitle":"添加作战室成员","openapi":"/api-reference/on-call.openapi.zh.json post /incident/war-room/add-member","href":"/zh/api-reference/on-call/incidents/incident-write-add-war-room-member"},{"title":"初始化故障复盘","description":"根据一个或多个故障和模板创建复盘草稿。","deprecated":null,"version":null,"sidebarTitle":"初始化故障复盘","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/init","href":"/zh/api-reference/on-call/incidents/postmortem-write-init"},{"title":"更新故障复盘基础信息","description":"覆盖复盘报告中保存的故障基本信息(严重程度、时间、处理人员)。","deprecated":null,"version":null,"sidebarTitle":"更新故障复盘基础信息","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/basics/reset","href":"/zh/api-reference/on-call/incidents/postmortem-write-reset-basics"},{"title":"更新故障复盘状态","description":"将复盘报告设置为草稿或已发布。","deprecated":null,"version":null,"sidebarTitle":"更新故障复盘状态","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/status/reset","href":"/zh/api-reference/on-call/incidents/postmortem-write-reset-status"},{"title":"更新故障复盘标题","description":"替换复盘报告标题。","deprecated":null,"version":null,"sidebarTitle":"更新故障复盘标题","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/title/reset","href":"/zh/api-reference/on-call/incidents/postmortem-write-reset-title"},{"title":"更新故障复盘后续行动","description":"替换复盘报告中保存的后续行动文本。","deprecated":null,"version":null,"sidebarTitle":"更新故障复盘后续行动","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/follow-ups/reset","href":"/zh/api-reference/on-call/incidents/postmortem-write-reset-follow-ups"},{"title":"重置故障复盘正文","description":"用 Markdown 完整替换草稿状态故障复盘的正文。","deprecated":null,"version":null,"sidebarTitle":"重置故障复盘正文","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/content/reset","href":"/zh/api-reference/on-call/incidents/incident-post-mortem-write-reset-content"},{"title":"创建或更新故障复盘模板","description":"创建自定义复盘模板,或按 `template_id` 替换已有模板。","deprecated":null,"version":null,"sidebarTitle":"创建或更新故障复盘模板","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/template/upsert","href":"/zh/api-reference/on-call/incidents/postmortem-write-upsert-template"},{"title":"删除故障复盘模板","description":"删除自定义复盘模板。","deprecated":null,"version":null,"sidebarTitle":"删除故障复盘模板","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/template/delete","href":"/zh/api-reference/on-call/incidents/postmortem-write-delete-template"},{"title":"查询故障复盘模板列表","description":"返回内置复盘模板,以及账户的自定义模板。","deprecated":null,"version":null,"sidebarTitle":"查询故障复盘模板列表","openapi":"/api-reference/on-call.openapi.zh.json post /incident/post-mortem/template/list","href":"/zh/api-reference/on-call/incidents/postmortem-read-list-templates"},{"title":"查看故障复盘模板详情","description":"按 ID 返回单个故障复盘模板。","deprecated":null,"version":null,"sidebarTitle":"查看故障复盘模板详情","openapi":"/api-reference/on-call.openapi.zh.json get /incident/post-mortem/template/info","href":"/zh/api-reference/on-call/incidents/postmortem-read-template-info"}]},{"group":"协作空间","icon":"comments","pages":[{"title":"获取协作空间详情","description":"返回单个协作空间的完整配置,以及近 30 天内活跃故障的统计。","deprecated":null,"version":null,"sidebarTitle":"获取协作空间详情","openapi":"/api-reference/on-call.openapi.zh.json post /channel/info","href":"/zh/api-reference/on-call/channels/channel-info"},{"title":"查询协作空间列表","description":"分页查询调用者可见的协作空间,支持过滤和排序。","deprecated":null,"version":null,"sidebarTitle":"查询协作空间列表","openapi":"/api-reference/on-call.openapi.zh.json post /channel/list","href":"/zh/api-reference/on-call/channels/channel-list"},{"title":"批量获取协作空间","description":"一次返回最多 1,000 个协作空间的 ID、名称和状态。","deprecated":null,"version":null,"sidebarTitle":"批量获取协作空间","openapi":"/api-reference/on-call.openapi.zh.json post /channel/infos","href":"/zh/api-reference/on-call/channels/channel-infos"},{"title":"创建协作空间","description":"创建协作空间,可同时创建默认分派策略和协作空间专属集成。","deprecated":null,"version":null,"sidebarTitle":"创建协作空间","openapi":"/api-reference/on-call.openapi.zh.json post /channel/create","href":"/zh/api-reference/on-call/channels/channel-create"},{"title":"更新协作空间","description":"更新协作空间设置,仅修改请求中出现的字段。","deprecated":null,"version":null,"sidebarTitle":"更新协作空间","openapi":"/api-reference/on-call.openapi.zh.json post /channel/update","href":"/zh/api-reference/on-call/channels/channel-update"},{"title":"删除协作空间","description":"删除已禁用的协作空间,并一并删除其下的策略和协作空间专属集成。","deprecated":null,"version":null,"sidebarTitle":"删除协作空间","openapi":"/api-reference/on-call.openapi.zh.json post /channel/delete","href":"/zh/api-reference/on-call/channels/channel-delete"},{"title":"启用协作空间","description":"启用已禁用的协作空间,使其重新处理新的告警事件。","deprecated":null,"version":null,"sidebarTitle":"启用协作空间","openapi":"/api-reference/on-call.openapi.zh.json post /channel/enable","href":"/zh/api-reference/on-call/channels/channel-enable"},{"title":"禁用协作空间","description":"禁用协作空间;禁用期间新进入的告警事件全部丢弃。","deprecated":null,"version":null,"sidebarTitle":"禁用协作空间","openapi":"/api-reference/on-call.openapi.zh.json post /channel/disable","href":"/zh/api-reference/on-call/channels/channel-disable"},{"group":"分派策略","icon":"arrow-up-right-dots","pages":[{"title":"获取分派策略详情","description":"返回协作空间下的单条分派策略,包括环节、时间窗口和过滤条件。","deprecated":null,"version":null,"sidebarTitle":"获取分派策略详情","openapi":"/api-reference/on-call.openapi.zh.json post /channel/escalate/rule/info","href":"/zh/api-reference/on-call/channels/channel-escalate-rule-info"},{"title":"查询分派策略列表","description":"按匹配顺序列出协作空间的分派策略。","deprecated":null,"version":null,"sidebarTitle":"查询分派策略列表","openapi":"/api-reference/on-call.openapi.zh.json post /channel/escalate/rule/list","href":"/zh/api-reference/on-call/channels/channel-escalate-rule-list"},{"title":"创建分派策略","description":"创建分派策略,决定协作空间的故障通知谁、如何通知。","deprecated":null,"version":null,"sidebarTitle":"创建分派策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/escalate/rule/create","href":"/zh/api-reference/on-call/channels/channel-escalate-rule-create"},{"title":"更新分派策略","description":"整体替换已有分派策略的配置。","deprecated":null,"version":null,"sidebarTitle":"更新分派策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/escalate/rule/update","href":"/zh/api-reference/on-call/channels/channel-escalate-rule-update"},{"title":"删除分派策略","description":"删除已禁用的分派策略,使其不再出现在协作空间的策略列表中。","deprecated":null,"version":null,"sidebarTitle":"删除分派策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/escalate/rule/delete","href":"/zh/api-reference/on-call/channels/channel-escalate-rule-delete"},{"title":"启用分派策略","description":"启用已禁用的分派策略,使其重新参与新故障的分派。","deprecated":null,"version":null,"sidebarTitle":"启用分派策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/escalate/rule/enable","href":"/zh/api-reference/on-call/channels/channel-escalate-rule-enable"},{"title":"禁用分派策略","description":"禁用分派策略但不删除。","deprecated":null,"version":null,"sidebarTitle":"禁用分派策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/escalate/rule/disable","href":"/zh/api-reference/on-call/channels/channel-escalate-rule-disable"},{"title":"调整分派策略顺序","description":"通过将一条策略移动到另一条策略的位置,改变协作空间内分派策略的评估顺序。","deprecated":null,"version":null,"sidebarTitle":"调整分派策略顺序","openapi":"/api-reference/on-call.openapi.zh.json post /channel/escalate/rule/reorder","href":"/zh/api-reference/on-call/channels/channel-escalate-rule-reorder"}]},{"group":"静默策略","icon":"bell-slash","pages":[{"title":"查询静默策略列表","description":"列出协作空间的静默策略,以及每条策略当前是否生效。","deprecated":null,"version":null,"sidebarTitle":"查询静默策略列表","openapi":"/api-reference/on-call.openapi.zh.json post /channel/silence/rule/list","href":"/zh/api-reference/on-call/channels/channel-silence-rule-list"},{"title":"创建静默策略","description":"创建静默策略,在时间窗口内屏蔽或丢弃命中的告警事件。","deprecated":null,"version":null,"sidebarTitle":"创建静默策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/silence/rule/create","href":"/zh/api-reference/on-call/channels/channel-silence-rule-create"},{"title":"更新静默策略","description":"整体替换已有静默策略的配置。","deprecated":null,"version":null,"sidebarTitle":"更新静默策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/silence/rule/update","href":"/zh/api-reference/on-call/channels/channel-silence-rule-update"},{"title":"删除静默策略","description":"删除已禁用的静默策略,使其不再出现在协作空间的策略列表中。","deprecated":null,"version":null,"sidebarTitle":"删除静默策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/silence/rule/delete","href":"/zh/api-reference/on-call/channels/channel-silence-rule-delete"},{"title":"启用静默策略","description":"启用已禁用的静默策略,使其重新静默命中的告警事件。","deprecated":null,"version":null,"sidebarTitle":"启用静默策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/silence/rule/enable","href":"/zh/api-reference/on-call/channels/channel-silence-rule-enable"},{"title":"禁用静默策略","description":"禁用静默策略但不删除。","deprecated":null,"version":null,"sidebarTitle":"禁用静默策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/silence/rule/disable","href":"/zh/api-reference/on-call/channels/channel-silence-rule-disable"}]},{"group":"抑制策略","icon":"volume-xmark","pages":[{"title":"查询抑制策略列表","description":"按创建时间先后列出协作空间的抑制策略。","deprecated":null,"version":null,"sidebarTitle":"查询抑制策略列表","openapi":"/api-reference/on-call.openapi.zh.json post /channel/inhibit/rule/list","href":"/zh/api-reference/on-call/channels/channel-inhibit-rule-list"},{"title":"创建抑制策略","description":"创建抑制策略,在相关的源告警仍处于活跃状态时屏蔽新的告警事件。","deprecated":null,"version":null,"sidebarTitle":"创建抑制策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/inhibit/rule/create","href":"/zh/api-reference/on-call/channels/channel-inhibit-rule-create"},{"title":"更新抑制策略","description":"整体替换已有抑制策略的配置。","deprecated":null,"version":null,"sidebarTitle":"更新抑制策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/inhibit/rule/update","href":"/zh/api-reference/on-call/channels/channel-inhibit-rule-update"},{"title":"删除抑制策略","description":"删除已禁用的抑制策略,使其不再出现在协作空间的策略列表中。","deprecated":null,"version":null,"sidebarTitle":"删除抑制策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/inhibit/rule/delete","href":"/zh/api-reference/on-call/channels/channel-inhibit-rule-delete"},{"title":"启用抑制策略","description":"启用已禁用的抑制策略,使其重新抑制命中的告警事件。","deprecated":null,"version":null,"sidebarTitle":"启用抑制策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/inhibit/rule/enable","href":"/zh/api-reference/on-call/channels/channel-inhibit-rule-enable"},{"title":"禁用抑制策略","description":"禁用抑制策略但不删除。","deprecated":null,"version":null,"sidebarTitle":"禁用抑制策略","openapi":"/api-reference/on-call.openapi.zh.json post /channel/inhibit/rule/disable","href":"/zh/api-reference/on-call/channels/channel-inhibit-rule-disable"}]},{"group":"排除规则","icon":"filter-circle-xmark","pages":[{"title":"查询排除规则列表","description":"按创建时间先后列出协作空间的排除规则。","deprecated":null,"version":null,"sidebarTitle":"查询排除规则列表","openapi":"/api-reference/on-call.openapi.zh.json post /channel/unsubscribe/rule/list","href":"/zh/api-reference/on-call/channels/channel-unsubscribe-rule-list"},{"title":"创建排除规则","description":"创建排除规则,在生成告警和故障之前丢弃命中的告警事件。","deprecated":null,"version":null,"sidebarTitle":"创建排除规则","openapi":"/api-reference/on-call.openapi.zh.json post /channel/unsubscribe/rule/create","href":"/zh/api-reference/on-call/channels/channel-unsubscribe-rule-create"},{"title":"更新排除规则","description":"整体替换已有排除规则的名称、描述和匹配条件。","deprecated":null,"version":null,"sidebarTitle":"更新排除规则","openapi":"/api-reference/on-call.openapi.zh.json post /channel/unsubscribe/rule/update","href":"/zh/api-reference/on-call/channels/channel-unsubscribe-rule-update"},{"title":"删除排除规则","description":"删除已禁用的排除规则,使其不再出现在协作空间的策略列表中。","deprecated":null,"version":null,"sidebarTitle":"删除排除规则","openapi":"/api-reference/on-call.openapi.zh.json post /channel/unsubscribe/rule/delete","href":"/zh/api-reference/on-call/channels/channel-unsubscribe-rule-delete"},{"title":"启用排除规则","description":"启用已禁用的排除规则,使其重新丢弃命中的告警事件。","deprecated":null,"version":null,"sidebarTitle":"启用排除规则","openapi":"/api-reference/on-call.openapi.zh.json post /channel/unsubscribe/rule/enable","href":"/zh/api-reference/on-call/channels/channel-unsubscribe-rule-enable"},{"title":"禁用排除规则","description":"禁用排除规则但不删除。","deprecated":null,"version":null,"sidebarTitle":"禁用排除规则","openapi":"/api-reference/on-call.openapi.zh.json post /channel/unsubscribe/rule/disable","href":"/zh/api-reference/on-call/channels/channel-unsubscribe-rule-disable"}]}]},{"group":"告警管理","icon":"bell","pages":[{"title":"查询告警列表","description":"返回满足过滤条件的告警列表,支持游标分页。","deprecated":null,"version":null,"sidebarTitle":"查询告警列表","openapi":"/api-reference/on-call.openapi.zh.json post /alert/list","href":"/zh/api-reference/on-call/alerts/alert-read-list"},{"title":"查看告警详情","description":"通过告警 ID 返回单条告警的完整详情,包括关联故障和事件数量。","deprecated":null,"version":null,"sidebarTitle":"查看告警详情","openapi":"/api-reference/on-call.openapi.zh.json post /alert/info","href":"/zh/api-reference/on-call/alerts/alert-read-info"},{"title":"批量查询告警","description":"按告警 ID 一次返回多条告警详情,不分页。","deprecated":null,"version":null,"sidebarTitle":"批量查询告警","openapi":"/api-reference/on-call.openapi.zh.json post /alert/list-by-ids","href":"/zh/api-reference/on-call/alerts/alert-read-list-by-ids"},{"title":"查询告警事件列表","description":"通过游标或页码分页返回指定告警的原始事件。","deprecated":null,"version":null,"sidebarTitle":"查询告警事件列表","openapi":"/api-reference/on-call.openapi.zh.json post /alert/event/list","href":"/zh/api-reference/on-call/alerts/alert-read-event-list"},{"title":"查询告警动态","description":"返回单条告警的动态记录(评论、状态变更、合并、静默事件),支持分页查询。","deprecated":null,"version":null,"sidebarTitle":"查询告警动态","openapi":"/api-reference/on-call.openapi.zh.json post /alert/feed","href":"/zh/api-reference/on-call/alerts/alert-read-feed"},{"title":"将告警合并到故障","description":"将一条或多条告警移入已有故障,并关闭因此变空的来源故障。","deprecated":null,"version":null,"sidebarTitle":"将告警合并到故障","openapi":"/api-reference/on-call.openapi.zh.json post /alert/merge","href":"/zh/api-reference/on-call/alerts/alert-write-merge"},{"title":"查看告警处理规则","description":"返回指定集成的告警处理规则配置。","deprecated":null,"version":null,"sidebarTitle":"查看告警处理规则","openapi":"/api-reference/on-call.openapi.zh.json post /alert/pipeline/info","href":"/zh/api-reference/on-call/alerts/alert-read-pipeline-info"},{"title":"批量查询告警处理规则","description":"返回多个集成的告警处理规则配置。","deprecated":null,"version":null,"sidebarTitle":"批量查询告警处理规则","openapi":"/api-reference/on-call.openapi.zh.json post /alert/pipeline/list","href":"/zh/api-reference/on-call/alerts/alert-read-pipeline-list"},{"title":"创建或更新告警处理规则","description":"为集成设置告警处理规则,将完全替换已有配置。","deprecated":null,"version":null,"sidebarTitle":"创建或更新告警处理规则","openapi":"/api-reference/on-call.openapi.zh.json post /alert/pipeline/upsert","href":"/zh/api-reference/on-call/alerts/alert-write-pipeline-upsert"},{"title":"预览告警处理规则效果","description":"用未保存的告警处理规则按接入的方式处理一个事件,返回处理前后的差异。","deprecated":null,"version":null,"sidebarTitle":"预览告警处理规则效果","openapi":"/api-reference/on-call.openapi.zh.json post /alert/pipeline/preview","href":"/zh/api-reference/on-call/alerts/alert-read-pipeline-preview"},{"title":"查询原始告警事件列表","description":"返回跨所有告警的原始告警事件分页列表,支持按集成、协作空间、时间范围和严重程度过滤。","deprecated":null,"version":null,"sidebarTitle":"查询原始告警事件列表","openapi":"/api-reference/on-call.openapi.zh.json post /alert-event/list","href":"/zh/api-reference/on-call/alerts/alert-event-read-list"}]},{"group":"集成中心","icon":"plug","pages":[{"group":"公共集成","pages":[{"title":"查询集成类型列表","description":"查询当前账户可配置的集成类型列表。","deprecated":null,"version":null,"sidebarTitle":"查询集成类型列表","openapi":"/api-reference/on-call.openapi.zh.json post /integration/type/list","href":"/zh/api-reference/on-call/integrations/integration-api-read-type-list"},{"title":"查询公共集成列表","description":"查询公共集成列表,返回存储配置、解密 Key 与当前调用者的编辑权限。","deprecated":null,"version":null,"sidebarTitle":"查询公共集成列表","openapi":"/api-reference/on-call.openapi.zh.json post /integration/list","href":"/zh/api-reference/on-call/integrations/integration-api-read-list"},{"title":"查看公共集成详情","description":"查询单个公共集成详情,返回存储配置及解密后的集成 Key。","deprecated":null,"version":null,"sidebarTitle":"查看公共集成详情","openapi":"/api-reference/on-call.openapi.zh.json post /integration/info","href":"/zh/api-reference/on-call/integrations/integration-api-read-info"},{"title":"创建公共集成","description":"创建支持的告警源、变更源、IM 或 Webhook 类型公共集成。","deprecated":null,"version":null,"sidebarTitle":"创建公共集成","openapi":"/api-reference/on-call.openapi.zh.json post /integration/create","href":"/zh/api-reference/on-call/integrations/integration-api-write-create"},{"title":"更新公共集成","description":"更新集成的名称、描述、所属团队或配置。","deprecated":null,"version":null,"sidebarTitle":"更新公共集成","openapi":"/api-reference/on-call.openapi.zh.json post /integration/update","href":"/zh/api-reference/on-call/integrations/integration-api-write-update"},{"title":"删除公共集成","description":"删除指定的集成。","deprecated":null,"version":null,"sidebarTitle":"删除公共集成","openapi":"/api-reference/on-call.openapi.zh.json post /integration/delete","href":"/zh/api-reference/on-call/integrations/integration-api-write-delete"},{"title":"启用公共集成","description":"重新启用已禁用的集成,恢复接收事件。","deprecated":null,"version":null,"sidebarTitle":"启用公共集成","openapi":"/api-reference/on-call.openapi.zh.json post /integration/enable","href":"/zh/api-reference/on-call/integrations/integration-api-write-enable"},{"title":"禁用公共集成","description":"禁用集成,但保留其配置。","deprecated":null,"version":null,"sidebarTitle":"禁用公共集成","openapi":"/api-reference/on-call.openapi.zh.json post /integration/disable","href":"/zh/api-reference/on-call/integrations/integration-api-write-disable"},{"title":"轮换公共集成 Key","description":"生成新的集成 Key,并使旧 Key 立即失效。","deprecated":null,"version":null,"sidebarTitle":"轮换公共集成 Key","openapi":"/api-reference/on-call.openapi.zh.json post /integration/key/rotate","href":"/zh/api-reference/on-call/integrations/integration-api-write-rotate-key"}]},{"group":"专属集成","pages":[{"title":"查询专属集成列表","description":"查询指定协作空间的专属集成。","deprecated":null,"version":null,"sidebarTitle":"查询专属集成列表","openapi":"/api-reference/on-call.openapi.zh.json post /channel/integration/list","href":"/zh/api-reference/on-call/dedicated-integrations/channel-integration-read-list"},{"title":"查看专属集成详情","description":"查看专属集成详情、集成 Key 和脱敏配置。","deprecated":null,"version":null,"sidebarTitle":"查看专属集成详情","openapi":"/api-reference/on-call.openapi.zh.json post /channel/integration/info","href":"/zh/api-reference/on-call/dedicated-integrations/channel-integration-read-info"},{"title":"创建专属集成","description":"为已启用的协作空间创建专属告警集成。","deprecated":null,"version":null,"sidebarTitle":"创建专属集成","openapi":"/api-reference/on-call.openapi.zh.json post /channel/integration/create","href":"/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-create"},{"title":"更新专属集成","description":"更新专属集成的名称、描述或配置。","deprecated":null,"version":null,"sidebarTitle":"更新专属集成","openapi":"/api-reference/on-call.openapi.zh.json post /channel/integration/update","href":"/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-update"},{"title":"删除专属集成","description":"删除已解除资源引用的专属集成。","deprecated":null,"version":null,"sidebarTitle":"删除专属集成","openapi":"/api-reference/on-call.openapi.zh.json post /channel/integration/delete","href":"/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-delete"},{"title":"启用专属集成","description":"启用专属集成,使其接收告警。","deprecated":null,"version":null,"sidebarTitle":"启用专属集成","openapi":"/api-reference/on-call.openapi.zh.json post /channel/integration/enable","href":"/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-enable"},{"title":"禁用专属集成","description":"禁用专属集成,暂停接收告警。","deprecated":null,"version":null,"sidebarTitle":"禁用专属集成","openapi":"/api-reference/on-call.openapi.zh.json post /channel/integration/disable","href":"/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-disable"},{"title":"轮换专属集成 Key","description":"生成新的专属集成 Key,并使原 Key 失效。","deprecated":null,"version":null,"sidebarTitle":"轮换专属集成 Key","openapi":"/api-reference/on-call.openapi.zh.json post /channel/integration/key/rotate","href":"/zh/api-reference/on-call/dedicated-integrations/channel-integration-write-rotate-key"}]},{"title":"查询 Webhook 推送历史","description":"查询出站 Webhook 通知的推送历史记录。","deprecated":null,"version":null,"sidebarTitle":"查询 Webhook 推送历史","openapi":"/api-reference/on-call.openapi.zh.json post /webhook/history/list","href":"/zh/api-reference/on-call/integrations/webhook-history-list"},{"title":"获取 Webhook 推送详情","description":"获取指定 Webhook 推送尝试的详细请求体和响应信息。","deprecated":null,"version":null,"sidebarTitle":"获取 Webhook 推送详情","openapi":"/api-reference/on-call.openapi.zh.json post /webhook/history/detail","href":"/zh/api-reference/on-call/integrations/webhook-history-detail"},{"title":"尝试关联 IM 人员","description":"为指定集成尝试将未绑定成员自动关联到对应的 IM 账号。","deprecated":null,"version":null,"sidebarTitle":"尝试关联 IM 人员","openapi":"/api-reference/on-call.openapi.zh.json post /datasource/im/person/try-link","href":"/zh/api-reference/on-call/integrations/datasource-im-person-try-link"},{"title":"预览邮件转告警效果","description":"用未保存的邮件集成配置,按接入的方式处理一封邮件,返回判定结果与生成的事件。","deprecated":null,"version":null,"sidebarTitle":"预览邮件转告警效果","openapi":"/api-reference/on-call.openapi.zh.json post /alert/email/preview","href":"/zh/api-reference/on-call/integrations/alert-read-email-preview"}]},{"group":"IM 集成","icon":"comments","pages":[{"title":"查看开启作战室功能的集成","description":"查询账户下已开启作战室功能的 IM 集成。","deprecated":null,"version":null,"sidebarTitle":"查看开启作战室功能的集成","openapi":"/api-reference/on-call.openapi.zh.json post /datasource/im/war-room-enabled/list","href":"/zh/api-reference/on-call/integrations/im-war-room-enabled-list"}]},{"group":"路由规则","icon":"shuffle","pages":[{"title":"获取路由规则详情","description":"返回单个共享集成的路由规则。","deprecated":null,"version":null,"sidebarTitle":"获取路由规则详情","openapi":"/api-reference/on-call.openapi.zh.json post /route/info","href":"/zh/api-reference/on-call/channels/route-info"},{"title":"查询路由规则列表","description":"一次返回多个共享集成的路由规则。","deprecated":null,"version":null,"sidebarTitle":"查询路由规则列表","openapi":"/api-reference/on-call.openapi.zh.json post /route/list","href":"/zh/api-reference/on-call/channels/route-list"},{"title":"创建或更新路由规则","description":"创建或整体替换共享集成的路由规则,决定其告警进入哪些协作空间。","deprecated":null,"version":null,"sidebarTitle":"创建或更新路由规则","openapi":"/api-reference/on-call.openapi.zh.json post /route/upsert","href":"/zh/api-reference/on-call/channels/route-upsert"}]},{"group":"值班排班","icon":"calendar-days","pages":[{"title":"创建值班表","description":"创建值班表,包括轮转分层和换班通知设置。","deprecated":null,"version":null,"sidebarTitle":"创建值班表","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/create","href":"/zh/api-reference/on-call/schedules/schedule-create"},{"title":"更新值班表","description":"更新 `schedule_id` 指定的值班表;分层列表整体替换。","deprecated":null,"version":null,"sidebarTitle":"更新值班表","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/update","href":"/zh/api-reference/on-call/schedules/schedule-update"},{"title":"预览值班表","description":"预览值班表配置生成的排班结果,不会持久化。请求体与创建/更新相同,并需要指定 start 和 end 时间窗口(最多 45 天)。","deprecated":null,"version":null,"sidebarTitle":"预览值班表","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/preview","href":"/zh/api-reference/on-call/schedules/schedule-preview"},{"title":"删除值班表","description":"按 ID 删除一个或多个值班表及其分层。","deprecated":null,"version":null,"sidebarTitle":"删除值班表","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/delete","href":"/zh/api-reference/on-call/schedules/schedule-delete"},{"title":"获取值班表详情","description":"返回单个值班表的配置及分层,并计算指定时间窗口(最长 45 天)内的班次。","deprecated":null,"version":null,"sidebarTitle":"获取值班表详情","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/info","href":"/zh/api-reference/on-call/schedules/schedule-info"},{"title":"查询值班表列表","description":"分页查询值班表,支持过滤;同时传入 `start` 和 `end` 时会一并计算班次。","deprecated":null,"version":null,"sidebarTitle":"查询值班表列表","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/list","href":"/zh/api-reference/on-call/schedules/schedule-list"},{"title":"查询我的值班表","description":"列出调用成员所属的已启用值班表,并给出该成员在时间窗口内的班次。","deprecated":null,"version":null,"sidebarTitle":"查询我的值班表","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/self","href":"/zh/api-reference/on-call/schedules/schedule-self"},{"title":"查看成员值班状态","description":"查看某成员正在值班的班次、下一次值班以及其参与的全部启用排班。","deprecated":null,"version":null,"sidebarTitle":"查看成员值班状态","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/by-person","href":"/zh/api-reference/on-call/schedules/schedule-by-person"},{"title":"批量获取值班表","description":"按 ID 批量返回值班表的基础配置,不含分层和班次计算结果。","deprecated":null,"version":null,"sidebarTitle":"批量获取值班表","openapi":"/api-reference/on-call.openapi.zh.json post /schedule/infos","href":"/zh/api-reference/on-call/schedules/schedule-infos"}]},{"group":"许可管理","icon":"id-card","pages":[{"title":"查询 On-call 许可列表","description":"查询当前许可窗口的用量,以及计入该窗口的人员。","deprecated":null,"version":null,"sidebarTitle":"查询 On-call 许可列表","openapi":"/api-reference/on-call.openapi.zh.json post /oncall/license/list","href":"/zh/api-reference/on-call/licenses/oncall-license-read-license-list"}]},{"group":"日历管理","icon":"calendar","pages":[{"title":"创建服务日历","description":"创建个人服务日历,并设置每周工作日与关联的节假日日历。","deprecated":null,"version":null,"sidebarTitle":"创建服务日历","openapi":"/api-reference/on-call.openapi.zh.json post /calendar/create","href":"/zh/api-reference/on-call/calendars/calendar-create"},{"title":"更新服务日历","description":"更新个人服务日历,仅修改传入的字段。","deprecated":null,"version":null,"sidebarTitle":"更新服务日历","openapi":"/api-reference/on-call.openapi.zh.json post /calendar/update","href":"/zh/api-reference/on-call/calendars/calendar-update"},{"title":"删除服务日历","description":"删除个人服务日历及其事件,前提是没有策略引用它。","deprecated":null,"version":null,"sidebarTitle":"删除服务日历","openapi":"/api-reference/on-call.openapi.zh.json post /calendar/delete","href":"/zh/api-reference/on-call/calendars/calendar-delete"},{"title":"获取服务日历详情","description":"按 ID 返回账户中一个服务日历的详情。","deprecated":null,"version":null,"sidebarTitle":"获取服务日历详情","openapi":"/api-reference/on-call.openapi.zh.json post /calendar/info","href":"/zh/api-reference/on-call/calendars/calendar-info"},{"title":"查询服务日历列表","description":"返回当前账户可见的服务日历列表。","deprecated":null,"version":null,"sidebarTitle":"查询服务日历列表","openapi":"/api-reference/on-call.openapi.zh.json post /calendar/list","href":"/zh/api-reference/on-call/calendars/calendar-list"},{"group":"日历事件","icon":"calendar-plus","pages":[{"title":"创建或更新日历事件","description":"创建或更新个人日历自有的事件:休息日或工作日覆盖。","deprecated":null,"version":null,"sidebarTitle":"创建或更新日历事件","openapi":"/api-reference/on-call.openapi.zh.json post /calendar/event/upsert","href":"/zh/api-reference/on-call/calendars/cal-event-upsert"},{"title":"删除日历事件","description":"按 ID 删除个人日历的一个事件,或清除该日历自有事件在某个日期范围内的部分。","deprecated":null,"version":null,"sidebarTitle":"删除日历事件","openapi":"/api-reference/on-call.openapi.zh.json post /calendar/event/delete","href":"/zh/api-reference/on-call/calendars/cal-event-delete"},{"title":"查询日历事件列表","description":"返回个人日历在指定年、月或日内的事件,以及每一天的判定结果。","deprecated":null,"version":null,"sidebarTitle":"查询日历事件列表","openapi":"/api-reference/on-call.openapi.zh.json post /calendar/event/list","href":"/zh/api-reference/on-call/calendars/cal-event-list"}]}]},{"group":"通知模板","icon":"envelope-open-text","pages":[{"title":"查看模板详情","description":"按 ID 返回单个通知模板。","deprecated":null,"version":null,"sidebarTitle":"查看模板详情","openapi":"/api-reference/on-call.openapi.zh.json post /template/info","href":"/zh/api-reference/on-call/notification-templates/template-read-info"},{"title":"查询模板列表","description":"分页返回当前账户下的通知模板列表。","deprecated":null,"version":null,"sidebarTitle":"查询模板列表","openapi":"/api-reference/on-call.openapi.zh.json post /template/list","href":"/zh/api-reference/on-call/notification-templates/template-read-list"},{"title":"创建模板","description":"创建通知模板,按通道配置消息模板。","deprecated":null,"version":null,"sidebarTitle":"创建模板","openapi":"/api-reference/on-call.openapi.zh.json post /template/create","href":"/zh/api-reference/on-call/notification-templates/template-write-create"},{"title":"更新模板","description":"更新通知模板,只写入请求中出现的字段。","deprecated":null,"version":null,"sidebarTitle":"更新模板","openapi":"/api-reference/on-call.openapi.zh.json post /template/update","href":"/zh/api-reference/on-call/notification-templates/template-write-update"},{"title":"删除模板","description":"按 ID 软删除通知模板。","deprecated":null,"version":null,"sidebarTitle":"删除模板","openapi":"/api-reference/on-call.openapi.zh.json post /template/delete","href":"/zh/api-reference/on-call/notification-templates/template-write-delete"},{"title":"预览模板","description":"用故障数据或模拟数据渲染模板,返回该通道实际会发送的内容。","deprecated":null,"version":null,"sidebarTitle":"预览模板","openapi":"/api-reference/on-call.openapi.zh.json post /template/preview","href":"/zh/api-reference/on-call/notification-templates/template-read-preview"}]},{"group":"标签增强","icon":"tags","pages":[{"title":"查看富化规则","description":"返回指定集成配置的告警富化规则集。","deprecated":null,"version":null,"sidebarTitle":"查看富化规则","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/info","href":"/zh/api-reference/on-call/alert-enrichment/enrichment-read-info"},{"title":"批量查询富化规则","description":"批量返回指定集成 ID 列表的告警富化规则集。","deprecated":null,"version":null,"sidebarTitle":"批量查询富化规则","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/list","href":"/zh/api-reference/on-call/alert-enrichment/enrichment-read-list"},{"title":"创建或替换富化规则","description":"创建或整体替换某个集成的告警富化规则集。","deprecated":null,"version":null,"sidebarTitle":"创建或替换富化规则","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/upsert","href":"/zh/api-reference/on-call/alert-enrichment/enrichment-write-upsert"},{"title":"预览标签增强规则效果","description":"用未保存的标签增强规则按接入的方式处理一个事件,返回规则逐步的结果。","deprecated":null,"version":null,"sidebarTitle":"预览标签增强规则效果","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/preview","href":"/zh/api-reference/on-call/alert-enrichment/enrichment-read-preview"},{"title":"查询事件样本列表","description":"查询某个集成最近收到的原始事件,最新的在前。","deprecated":null,"version":null,"sidebarTitle":"查询事件样本列表","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/sample/list","href":"/zh/api-reference/on-call/alert-enrichment/enrichment-sample-read-list"},{"group":"映射 Schema","icon":"table-columns","pages":[{"title":"查询映射规则列表","description":"返回账户下的全部映射规则,按创建时间倒序排列。","deprecated":null,"version":null,"sidebarTitle":"查询映射规则列表","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/schema/list","href":"/zh/api-reference/on-call/alert-enrichment/mapping-schema-read-list"},{"title":"查看映射规则详情","description":"根据映射规则 ID 返回单个映射规则的详细信息。","deprecated":null,"version":null,"sidebarTitle":"查看映射规则详情","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/schema/info","href":"/zh/api-reference/on-call/alert-enrichment/mapping-schema-read-info"},{"title":"创建映射规则","description":"创建映射规则,定义用于查找的来源标签和要填充的结果标签。","deprecated":null,"version":null,"sidebarTitle":"创建映射规则","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/schema/create","href":"/zh/api-reference/on-call/alert-enrichment/mapping-schema-write-create"},{"title":"更新映射规则","description":"更新映射规则的名称、描述或所属团队。来源标签和结果标签创建后不可更改。","deprecated":null,"version":null,"sidebarTitle":"更新映射规则","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/schema/update","href":"/zh/api-reference/on-call/alert-enrichment/mapping-schema-write-update"},{"title":"删除映射规则","description":"删除映射规则及其全部数据行;仍被富化规则或机器人 Webhook 引用时拒绝删除。","deprecated":null,"version":null,"sidebarTitle":"删除映射规则","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/schema/delete","href":"/zh/api-reference/on-call/alert-enrichment/mapping-schema-write-delete"}]},{"group":"映射数据","icon":"table","pages":[{"title":"查询映射数据列表","description":"分页返回指定映射规则的数据行,可按来源标签值进行精确过滤。","deprecated":null,"version":null,"sidebarTitle":"查询映射数据列表","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/data/list","href":"/zh/api-reference/on-call/alert-enrichment/mapping-data-read-list"},{"title":"写入映射数据","description":"向映射规则中插入或更新最多 1000 条数据行,每行须包含所有来源标签和结果标签。","deprecated":null,"version":null,"sidebarTitle":"写入映射数据","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/data/upsert","href":"/zh/api-reference/on-call/alert-enrichment/mapping-data-write-upsert"},{"title":"删除映射数据","description":"按键名批量删除最多 100 条映射数据行。","deprecated":null,"version":null,"sidebarTitle":"删除映射数据","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/data/delete","href":"/zh/api-reference/on-call/alert-enrichment/mapping-data-write-delete"},{"title":"清空映射数据","description":"删除指定映射规则的全部数据行。","deprecated":null,"version":null,"sidebarTitle":"清空映射数据","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/data/truncate","href":"/zh/api-reference/on-call/alert-enrichment/mapping-data-write-truncate"},{"title":"通过 CSV 上传映射数据","description":"上传 CSV 文件批量导入映射数据。默认情况下,导入前先清空现有数据。","deprecated":null,"version":null,"sidebarTitle":"通过 CSV 上传映射数据","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/data/upload","href":"/zh/api-reference/on-call/alert-enrichment/mapping-data-write-upload"},{"title":"下载映射数据 CSV","description":"将映射规则的所有数据行导出为 CSV 文件。","deprecated":null,"version":null,"sidebarTitle":"下载映射数据 CSV","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/data/download","href":"/zh/api-reference/on-call/alert-enrichment/mapping-data-read-download"}]},{"group":"API 数据源","icon":"cloud-arrow-down","pages":[{"title":"查询映射 API 列表","description":"返回账户下的全部映射 API,按创建时间倒序排列。","deprecated":null,"version":null,"sidebarTitle":"查询映射 API 列表","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/api/list","href":"/zh/api-reference/on-call/alert-enrichment/mapping-api-read-list"},{"title":"查看映射 API 详情","description":"根据映射 API ID 返回单个映射 API 的详细信息。","deprecated":null,"version":null,"sidebarTitle":"查看映射 API 详情","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/api/info","href":"/zh/api-reference/on-call/alert-enrichment/mapping-api-read-info"},{"title":"创建映射 API","description":"登记一个外部 HTTP API,供富化规则调用以查询告警标签。","deprecated":null,"version":null,"sidebarTitle":"创建映射 API","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/api/create","href":"/zh/api-reference/on-call/alert-enrichment/mapping-api-write-create"},{"title":"更新映射 API","description":"更新现有映射 API 的配置。","deprecated":null,"version":null,"sidebarTitle":"更新映射 API","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/api/update","href":"/zh/api-reference/on-call/alert-enrichment/mapping-api-write-update"},{"title":"删除映射 API","description":"软删除映射 API;仍被富化规则引用时拒绝删除。","deprecated":null,"version":null,"sidebarTitle":"删除映射 API","openapi":"/api-reference/on-call.openapi.zh.json post /enrichment/mapping/api/delete","href":"/zh/api-reference/on-call/alert-enrichment/mapping-api-write-delete"}]},{"title":"查看自定义字段","description":"按 ID 查询单个故障自定义字段的配置。","deprecated":null,"version":null,"sidebarTitle":"查看自定义字段","openapi":"/api-reference/on-call.openapi.zh.json post /field/info","href":"/zh/api-reference/on-call/alert-enrichment/field-read-info"},{"title":"查看自定义字段列表","description":"返回账号下所有的故障自定义字段。","deprecated":null,"version":null,"sidebarTitle":"查看自定义字段列表","openapi":"/api-reference/on-call.openapi.zh.json post /field/list","href":"/zh/api-reference/on-call/alert-enrichment/field-read-list"},{"title":"创建自定义字段","description":"为账号新建一个故障自定义字段。","deprecated":null,"version":null,"sidebarTitle":"创建自定义字段","openapi":"/api-reference/on-call.openapi.zh.json post /field/create","href":"/zh/api-reference/on-call/alert-enrichment/field-write-create"},{"title":"变更自定义字段","description":"修改已有自定义字段的可变属性。","deprecated":null,"version":null,"sidebarTitle":"变更自定义字段","openapi":"/api-reference/on-call.openapi.zh.json post /field/update","href":"/zh/api-reference/on-call/alert-enrichment/field-write-update"},{"title":"删除自定义字段","description":"删除自定义字段,并异步清理历史故障中的同名字段值。","deprecated":null,"version":null,"sidebarTitle":"删除自定义字段","openapi":"/api-reference/on-call.openapi.zh.json post /field/delete","href":"/zh/api-reference/on-call/alert-enrichment/field-write-delete"}]},{"group":"分析看板","icon":"chart-line","pages":[{"title":"查看按 check/resource 聚合的 Top-K 告警","description":"返回指定时间范围内按 `check` 或 `resource` 聚合的 Top-K 告警组。","deprecated":null,"version":null,"sidebarTitle":"查看按 check/resource 聚合的 Top-K 告警","openapi":"/api-reference/on-call.openapi.zh.json post /insight/alert/topk-by-label","href":"/zh/api-reference/on-call/analytics/insight-topk-alerts-by-label"},{"title":"查看账户级别洞察","description":"按时间桶返回整个账户的故障与告警指标汇总。","deprecated":null,"version":null,"sidebarTitle":"查看账户级别洞察","openapi":"/api-reference/on-call.openapi.zh.json post /insight/account","href":"/zh/api-reference/on-call/analytics/insight-by-account"},{"title":"查询洞察故障列表","description":"返回用于分析看板的故障分页列表,包含每条故障的处理效能指标。","deprecated":null,"version":null,"sidebarTitle":"查询洞察故障列表","openapi":"/api-reference/on-call.openapi.zh.json post /insight/incident/list","href":"/zh/api-reference/on-call/analytics/insight-incident-list"},{"title":"导出洞察故障","description":"将分析过滤条件命中的故障导出为 CSV 文件,每条故障一行。","deprecated":null,"version":null,"sidebarTitle":"导出洞察故障","openapi":"/api-reference/on-call.openapi.zh.json post /insight/incident/export","href":"/zh/api-reference/on-call/analytics/insight-incident-export"},{"title":"查看协作空间洞察","description":"按协作空间分组返回故障与告警指标,每个协作空间、每个时间桶一行。","deprecated":null,"version":null,"sidebarTitle":"查看协作空间洞察","openapi":"/api-reference/on-call.openapi.zh.json post /insight/channel","href":"/zh/api-reference/on-call/analytics/insight-by-channel"},{"title":"导出协作空间洞察","description":"将协作空间维度洞察指标导出为 CSV 文件,行与 `/insight/channel` 的返回一致。","deprecated":null,"version":null,"sidebarTitle":"导出协作空间洞察","openapi":"/api-reference/on-call.openapi.zh.json post /insight/channel/export","href":"/zh/api-reference/on-call/analytics/insight-channel-export"},{"title":"查看团队洞察","description":"按团队分组返回故障与告警指标,每个团队、每个时间桶一行。","deprecated":null,"version":null,"sidebarTitle":"查看团队洞察","openapi":"/api-reference/on-call.openapi.zh.json post /insight/team","href":"/zh/api-reference/on-call/analytics/insight-by-team"},{"title":"导出团队洞察","description":"将团队维度洞察指标导出为 CSV 文件,行与 `/insight/team` 的返回一致。","deprecated":null,"version":null,"sidebarTitle":"导出团队洞察","openapi":"/api-reference/on-call.openapi.zh.json post /insight/team/export","href":"/zh/api-reference/on-call/analytics/insight-team-export"},{"title":"查看处理人员洞察","description":"按响应人返回故障处理指标,每个响应人、每个时间桶一行。","deprecated":null,"version":null,"sidebarTitle":"查看处理人员洞察","openapi":"/api-reference/on-call.openapi.zh.json post /insight/responder","href":"/zh/api-reference/on-call/analytics/insight-by-responder"},{"title":"导出处理人员洞察","description":"将响应人维度洞察指标导出为 CSV 文件,行与 `/insight/responder` 的返回一致。","deprecated":null,"version":null,"sidebarTitle":"导出处理人员洞察","openapi":"/api-reference/on-call.openapi.zh.json post /insight/responder/export","href":"/zh/api-reference/on-call/analytics/insight-responder-export"}]},{"group":"状态页","icon":"signal-stream","pages":[{"group":"变更公告","icon":"newspaper","pages":[{"title":"获取状态页事件详情","description":"获取状态页指定事件(故障或维护)的详细信息。","deprecated":null,"version":null,"sidebarTitle":"获取状态页事件详情","openapi":"/api-reference/on-call.openapi.zh.json get /status-page/change/info","href":"/zh/api-reference/on-call/status-pages/status-page-change-info"},{"title":"查询状态页事件列表","description":"按状态和时间窗查询状态页的故障或维护事件,包含隐藏组件。","deprecated":null,"version":null,"sidebarTitle":"查询状态页事件列表","openapi":"/api-reference/on-call.openapi.zh.json get /status-page/change/list","href":"/zh/api-reference/on-call/status-pages/status-page-change-list"},{"title":"创建状态页事件","description":"在状态页上创建新的故障或维护事件。","deprecated":null,"version":null,"sidebarTitle":"创建状态页事件","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/change/create","href":"/zh/api-reference/on-call/status-pages/status-page-change-create"},{"title":"更新状态页事件","description":"更新状态页事件的标题、负责人或关联事件。","deprecated":null,"version":null,"sidebarTitle":"更新状态页事件","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/change/update","href":"/zh/api-reference/on-call/status-pages/status-page-change-update"},{"title":"删除状态页事件","description":"删除状态页上的一个故障或维护事件。","deprecated":null,"version":null,"sidebarTitle":"删除状态页事件","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/change/delete","href":"/zh/api-reference/on-call/status-pages/status-page-change-delete"},{"title":"创建事件时间线","description":"在状态页事件上添加时间线更新。","deprecated":null,"version":null,"sidebarTitle":"创建事件时间线","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/change/timeline/create","href":"/zh/api-reference/on-call/status-pages/status-page-change-timeline-create"},{"title":"更新事件时间线","description":"修改状态页事件时间线更新的时间或描述。","deprecated":null,"version":null,"sidebarTitle":"更新事件时间线","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/change/timeline/update","href":"/zh/api-reference/on-call/status-pages/status-page-change-timeline-update"},{"title":"删除事件时间线","description":"从状态页事件中删除一条时间线更新。","deprecated":null,"version":null,"sidebarTitle":"删除事件时间线","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/change/timeline/delete","href":"/zh/api-reference/on-call/status-pages/status-page-change-timeline-delete"}]},{"group":"订阅者","icon":"envelope","pages":[{"title":"查询状态页订阅者列表","description":"查询已订阅状态页通知的用户列表。","deprecated":null,"version":null,"sidebarTitle":"查询状态页订阅者列表","openapi":"/api-reference/on-call.openapi.zh.json get /status-page/subscriber/list","href":"/zh/api-reference/on-call/status-pages/status-page-subscriber-list"},{"title":"批量导入订阅者","description":"批量导入状态页订阅者,不发送确认邮件。","deprecated":null,"version":null,"sidebarTitle":"批量导入订阅者","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/subscriber/import","href":"/zh/api-reference/on-call/status-pages/status-page-subscriber-import"},{"title":"导出订阅者","description":"以 CSV 文件导出状态页的订阅者。","deprecated":null,"version":null,"sidebarTitle":"导出订阅者","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/subscriber/export","href":"/zh/api-reference/on-call/status-pages/status-page-subscriber-export"}]},{"group":"迁移","icon":"truck-moving","pages":[{"title":"迁移状态页结构","description":"启动迁移任务,从 Atlassian Statuspage 导入结构和历史事件到新的 Flashduty 状态页。","deprecated":null,"version":null,"sidebarTitle":"迁移状态页结构","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/migrate-structure","href":"/zh/api-reference/on-call/status-pages/status-page-migrate-structure"},{"title":"迁移邮件订阅者","description":"启动迁移任务,从 Atlassian Statuspage 将邮件订阅者导入到已有的 Flashduty 状态页。","deprecated":null,"version":null,"sidebarTitle":"迁移邮件订阅者","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/migrate-email-subscribers","href":"/zh/api-reference/on-call/status-pages/status-page-migrate-email-subscribers"},{"title":"获取迁移状态","description":"获取状态页迁移任务的当前状态和进度。","deprecated":null,"version":null,"sidebarTitle":"获取迁移状态","openapi":"/api-reference/on-call.openapi.zh.json get /status-page/migration/status","href":"/zh/api-reference/on-call/status-pages/status-page-migration-status"},{"title":"取消状态页迁移","description":"取消正在运行的 Atlassian Statuspage 迁移任务。","deprecated":null,"version":null,"sidebarTitle":"取消状态页迁移","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/migration/cancel","href":"/zh/api-reference/on-call/status-pages/status-page-migration-cancel"}]},{"title":"查询状态页列表","description":"查询账户下所有状态页,包含其组件与分组。","deprecated":null,"version":null,"sidebarTitle":"查询状态页列表","openapi":"/api-reference/on-call.openapi.zh.json get /status-page/list","href":"/zh/api-reference/on-call/status-pages/status-page-read-page-list"},{"title":"查询状态页活跃事件列表","description":"查询状态页指定类型的进行中(非终态)事件列表。","deprecated":null,"version":null,"sidebarTitle":"查询状态页活跃事件列表","openapi":"/api-reference/on-call.openapi.zh.json get /status-page/change/active/list","href":"/zh/api-reference/on-call/status-pages/status-page-change-active-list"},{"title":"获取状态页详情","description":"获取指定状态页的详细配置信息。","deprecated":null,"version":null,"sidebarTitle":"获取状态页详情","openapi":"/api-reference/on-call.openapi.zh.json get /status-page/info","href":"/zh/api-reference/on-call/status-pages/status-page-info"},{"title":"创建状态页","description":"为账户创建一个公开或内部状态页。","deprecated":null,"version":null,"sidebarTitle":"创建状态页","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/create","href":"/zh/api-reference/on-call/status-pages/status-page-create"},{"title":"更新状态页","description":"更新已有状态页的配置,未传的字段保持不变。","deprecated":null,"version":null,"sidebarTitle":"更新状态页","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/update","href":"/zh/api-reference/on-call/status-pages/status-page-update"},{"title":"删除状态页","description":"删除状态页及其全部事件和订阅。","deprecated":null,"version":null,"sidebarTitle":"删除状态页","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/delete","href":"/zh/api-reference/on-call/status-pages/status-page-delete"},{"title":"创建或更新状态页组件","description":"在状态页上批量创建或更新服务组件。","deprecated":null,"version":null,"sidebarTitle":"创建或更新状态页组件","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/component/upsert","href":"/zh/api-reference/on-call/status-pages/status-page-component-upsert"},{"title":"删除状态页组件","description":"从状态页批量删除服务组件。","deprecated":null,"version":null,"sidebarTitle":"删除状态页组件","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/component/delete","href":"/zh/api-reference/on-call/status-pages/status-page-component-delete"},{"title":"创建或更新状态页区域","description":"在状态页上批量创建或更新用于组织组件的分组。","deprecated":null,"version":null,"sidebarTitle":"创建或更新状态页区域","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/section/upsert","href":"/zh/api-reference/on-call/status-pages/status-page-section-upsert"},{"title":"删除状态页区域","description":"从状态页批量删除分组,分组内的组件会移到顶层。","deprecated":null,"version":null,"sidebarTitle":"删除状态页区域","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/section/delete","href":"/zh/api-reference/on-call/status-pages/status-page-section-delete"},{"title":"创建或更新状态页模板","description":"创建或更新状态页的完整状态更新模板或状态描述模板。","deprecated":null,"version":null,"sidebarTitle":"创建或更新状态页模板","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/template/upsert","href":"/zh/api-reference/on-call/status-pages/status-page-template-upsert"},{"title":"删除状态页模板","description":"删除状态页的一个完整状态更新模板或状态描述模板。","deprecated":null,"version":null,"sidebarTitle":"删除状态页模板","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/template/delete","href":"/zh/api-reference/on-call/status-pages/status-page-template-delete"},{"title":"查询状态页模板列表","description":"查询状态页的完整状态更新模板或状态描述模板。","deprecated":null,"version":null,"sidebarTitle":"查询状态页模板列表","openapi":"/api-reference/on-call.openapi.zh.json get /status-page/template/list","href":"/zh/api-reference/on-call/status-pages/status-page-template-list"},{"title":"创建状态页草稿","description":"存储状态页事件草稿,供人工在控制台审核后发布。","deprecated":null,"version":null,"sidebarTitle":"创建状态页草稿","openapi":"/api-reference/on-call.openapi.zh.json post /status-page/draft/create","href":"/zh/api-reference/on-call/status-pages/status-page-draft-create"}]},{"group":"变更管理","icon":"code-commit","pages":[{"title":"查询变更列表","description":"在指定时间窗口内查询变更记录,支持过滤、搜索与分页。","deprecated":null,"version":null,"sidebarTitle":"查询变更列表","openapi":"/api-reference/on-call.openapi.zh.json post /change/list","href":"/zh/api-reference/on-call/changes/change-read-list"}]}]},{"group":"Monitors","icon":"chart-area","pages":[{"group":"告警规则","icon":"diamond-exclamation","pages":[{"title":"查询告警规则列表","description":"返回指定文件夹下告警规则的基础信息;如需完整配置,请调用 `POST /monit/rule/v2/info`。","deprecated":null,"version":null,"sidebarTitle":"查询告警规则列表","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/list/basic","href":"/zh/api-reference/monitors/alert-rules/monit-rule-read-list"},{"title":"获取告警规则详情 V2","description":"通过 ID 返回告警规则的完整 V2 配置,包含 lifecycle v2 的恢复与结束模式设置。","deprecated":null,"version":null,"sidebarTitle":"获取告警规则详情 V2","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/v2/info","href":"/zh/api-reference/monitors/alert-rules/monit-rule-read-info-v2"},{"title":"创建告警规则 V2","description":"创建新的 V2 告警规则,返回带有分配 ID 的已创建规则。","deprecated":null,"version":null,"sidebarTitle":"创建告警规则 V2","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/v2/create","href":"/zh/api-reference/monitors/alert-rules/monit-rule-write-create-v2"},{"title":"更新告警规则 V2","description":"按 ID 全量替换告警规则的 V2 配置,返回更新后的规则。","deprecated":null,"version":null,"sidebarTitle":"更新告警规则 V2","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/v2/update","href":"/zh/api-reference/monitors/alert-rules/monit-rule-write-update-v2"},{"title":"删除告警规则","description":"通过 ID 删除单条告警规则。","deprecated":null,"version":null,"sidebarTitle":"删除告警规则","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/delete","href":"/zh/api-reference/monitors/alert-rules/monit-rule-write-delete"},{"title":"批量删除告警规则","description":"在单次请求中删除多条告警规则。","deprecated":null,"version":null,"sidebarTitle":"批量删除告警规则","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/delete/batch","href":"/zh/api-reference/monitors/alert-rules/monit-rule-write-delete-batch"},{"title":"批量更新规则字段","description":"在一次调用中为多条告警规则更新 `fields` 中列出的字段。","deprecated":null,"version":null,"sidebarTitle":"批量更新规则字段","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/update/fields","href":"/zh/api-reference/monitors/alert-rules/monit-rule-write-fields-update"},{"title":"移动告警规则到文件夹","description":"将一条或多条告警规则移动到其他文件夹。","deprecated":null,"version":null,"sidebarTitle":"移动告警规则到文件夹","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/move","href":"/zh/api-reference/monitors/alert-rules/monit-rule-write-move"},{"title":"查询规则变更历史","description":"返回告警规则的变更历史(审计记录)。","deprecated":null,"version":null,"sidebarTitle":"查询规则变更历史","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/audits","href":"/zh/api-reference/monitors/alert-rules/monit-rule-read-audits"},{"title":"查看规则审计快照","description":"返回告警规则的一条审计记录,包含保存在 `content` 中的规则快照。","deprecated":null,"version":null,"sidebarTitle":"查看规则审计快照","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/audit/detail","href":"/zh/api-reference/monitors/alert-rules/monit-rule-read-audit-detail"},{"title":"查看规则数量时序","description":"返回当前账户下规则总数的历史时序数据,每个 `clock` 时间戳对应一个采样。","deprecated":null,"version":null,"sidebarTitle":"查看规则数量时序","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/counter/total","href":"/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-total"},{"title":"按协作空间查询规则统计","description":"按协作空间名称返回将告警路由到各协作空间的告警规则数量。","deprecated":null,"version":null,"sidebarTitle":"按协作空间查询规则统计","openapi":"/api-reference/monitors.openapi.zh.json post /monit/rule/counter/channel","href":"/zh/api-reference/monitors/alert-rules/monit-rule-read-counter-channel"}]},{"group":"告警数据源","icon":"database","pages":[{"title":"查询数据源列表","description":"列出账户下调用方有权查询的数据源,可按类型或名称精确过滤。","deprecated":null,"version":null,"sidebarTitle":"查询数据源列表","openapi":"/api-reference/monitors.openapi.zh.json post /monit/datasource/list","href":"/zh/api-reference/monitors/data-sources/monit-datasource-read-list"},{"title":"查看数据源详情","description":"按 ID 返回单个数据源,包含完整的 `payload` 配置。","deprecated":null,"version":null,"sidebarTitle":"查看数据源详情","openapi":"/api-reference/monitors.openapi.zh.json post /monit/datasource/info","href":"/zh/api-reference/monitors/data-sources/monit-datasource-read-info"},{"title":"创建数据源","description":"创建一个监控数据源(支持 15 种类型),并将其绑定到某个 Monitors edge 集群。","deprecated":null,"version":null,"sidebarTitle":"创建数据源","openapi":"/api-reference/monitors.openapi.zh.json post /monit/datasource/create","href":"/zh/api-reference/monitors/data-sources/monit-datasource-write-create"},{"title":"更新数据源","description":"按 ID 更新数据源,整体替换其名称、备注、地址、payload 和 edge 集群。","deprecated":null,"version":null,"sidebarTitle":"更新数据源","openapi":"/api-reference/monitors.openapi.zh.json post /monit/datasource/update","href":"/zh/api-reference/monitors/data-sources/monit-datasource-write-update"},{"title":"删除数据源","description":"按 ID 删除数据源;引用它的告警规则不会被阻止。","deprecated":null,"version":null,"sidebarTitle":"删除数据源","openapi":"/api-reference/monitors.openapi.zh.json post /monit/datasource/delete","href":"/zh/api-reference/monitors/data-sources/monit-datasource-write-delete"},{"title":"调用数据源工具","description":"对已配置的数据源执行单个确定性诊断或查询工具。","deprecated":null,"version":null,"sidebarTitle":"调用数据源工具","openapi":"/api-reference/monitors.openapi.zh.json post /monit/datasource/tools/invoke","href":"/zh/api-reference/monitors/data-sources/monit-datasource-tools-invoke"},{"title":"查询 SLS 项目列表","description":"列出指定 SLS 数据源中可用的阿里云日志服务(SLS)项目。","deprecated":null,"version":null,"sidebarTitle":"查询 SLS 项目列表","openapi":"/api-reference/monitors.openapi.zh.json post /monit/datasource/sls/projects","href":"/zh/api-reference/monitors/data-sources/monit-datasource-read-sls-projects"},{"title":"查询 SLS 日志库列表","description":"列出指定 SLS 数据源中某个项目下的日志库。","deprecated":null,"version":null,"sidebarTitle":"查询 SLS 日志库列表","openapi":"/api-reference/monitors.openapi.zh.json post /monit/datasource/sls/logstores","href":"/zh/api-reference/monitors/data-sources/monit-datasource-read-sls-logstores"},{"title":"查询 Prometheus 标签值列表","description":"通过监控代理从 Prometheus 兼容数据源读取标签值列表。","deprecated":null,"version":null,"sidebarTitle":"查询 Prometheus 标签值列表","openapi":"/api-reference/monitors.openapi.zh.json get /monit/prometheus/api/v1/label/{label_name}/values","href":"/zh/api-reference/monitors/data-sources/monit-prometheus-read-label-values"}]},{"group":"诊断分析","icon":"stethoscope","pages":[{"title":"查询结构化数据","description":"对数据源执行同步即席查询,返回 `query_result.v1` 结果,形态为 frames、records 或 samples。","deprecated":null,"version":null,"sidebarTitle":"查询结构化数据","openapi":"/api-reference/monitors.openapi.zh.json post /monit/query/data","href":"/zh/api-reference/monitors/diagnostics/monit-read-query-data"},{"title":"执行探索查询","description":"对已配置的数据源执行探索查询,返回 frames、samples 或 logs 形态的结果。","deprecated":null,"version":null,"sidebarTitle":"执行探索查询","openapi":"/api-reference/monitors.openapi.zh.json post /monit/query/explore","href":"/zh/api-reference/monitors/diagnostics/monit-read-query-explore"}]},{"group":"仪表盘","icon":"chart-pie","pages":[{"title":"查询仪表盘列表","description":"列出某个目录下直接存放的仪表盘,支持关键词搜索与分页。","deprecated":null,"version":null,"sidebarTitle":"查询仪表盘列表","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/list","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-read-list"},{"title":"搜索仪表盘","description":"在所有可读目录中搜索仪表盘。","deprecated":null,"version":null,"sidebarTitle":"搜索仪表盘","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/search","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-read-search"},{"title":"查看仪表盘详情","description":"获取单个仪表盘及其完整定义。","deprecated":null,"version":null,"sidebarTitle":"查看仪表盘详情","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/get","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-read-get"},{"title":"获取仪表盘大纲","description":"获取仪表盘结构,不含查询与定义。","deprecated":null,"version":null,"sidebarTitle":"获取仪表盘大纲","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/outline","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-read-outline"},{"title":"创建仪表盘","description":"按完整定义创建仪表盘。","deprecated":null,"version":null,"sidebarTitle":"创建仪表盘","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/create","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-write-create"},{"title":"更新仪表盘","description":"通过版本号 compare-and-swap 替换仪表盘定义。","deprecated":null,"version":null,"sidebarTitle":"更新仪表盘","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/update","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-write-update"},{"title":"移动仪表盘","description":"把仪表盘移到另一个目录,不改动定义。","deprecated":null,"version":null,"sidebarTitle":"移动仪表盘","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/move","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-write-move"},{"title":"删除仪表盘","description":"把仪表盘移入回收站,30 天内可恢复。","deprecated":null,"version":null,"sidebarTitle":"删除仪表盘","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/delete","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-write-delete"},{"title":"恢复仪表盘","description":"把回收站中的仪表盘恢复,可选恢复到其他目录。","deprecated":null,"version":null,"sidebarTitle":"恢复仪表盘","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/restore","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-write-restore"},{"title":"查询回收站仪表盘","description":"列出仍在 30 天保留期内的已删除仪表盘。","deprecated":null,"version":null,"sidebarTitle":"查询回收站仪表盘","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/trash/list","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-trash-read-list"},{"title":"查询仪表盘版本列表","description":"按最新在前列出仪表盘的版本历史。","deprecated":null,"version":null,"sidebarTitle":"查询仪表盘版本列表","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/revisions/list","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-revision-read-list"},{"title":"查看仪表盘版本详情","description":"获取某个历史版本及其完整定义。","deprecated":null,"version":null,"sidebarTitle":"查看仪表盘版本详情","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/revisions/get","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-revision-read-get"},{"title":"解析仪表盘变量","description":"按时间范围解析已存仪表盘的全部变量。","deprecated":null,"version":null,"sidebarTitle":"解析仪表盘变量","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/runtime/variables/resolve","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-variable-read-resolve"},{"title":"预览草稿变量","description":"解析尚未存入任何仪表盘的草稿变量组。","deprecated":null,"version":null,"sidebarTitle":"预览草稿变量","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/runtime/variables/preview","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-variable-read-preview"},{"title":"解析面板查询","description":"把面板查询绑定到数据源并完成变量替换,但不执行。","deprecated":null,"version":null,"sidebarTitle":"解析面板查询","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/runtime/queries/resolve","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-query-read-resolve"},{"title":"运行仪表盘面板","description":"执行已存仪表盘的单个面板并返回数据源结果。","deprecated":null,"version":null,"sidebarTitle":"运行仪表盘面板","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/panel/run","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-panel-read-run"},{"title":"预览草稿面板","description":"内联执行草稿面板,不产生仪表盘新版本。","deprecated":null,"version":null,"sidebarTitle":"预览草稿面板","openapi":"/api-reference/monitors.openapi.zh.json post /monit/dashboard/panel/preview","href":"/zh/api-reference/monitors/dashboards/monit-dashboard-panel-read-preview"}]},{"group":"规则分组","icon":"folder-tree","pages":[{"title":"查询监控目录列表","description":"列出调用方可读的全部监控节点。","deprecated":null,"version":null,"sidebarTitle":"查询监控目录列表","openapi":"/api-reference/monitors.openapi.zh.json post /monit/folder/list","href":"/zh/api-reference/monitors/rule-folders/monit-folder-read-list"},{"title":"获取监控目录健康摘要","description":"获取可见监控文件夹的问题标记,包含后代文件夹中的问题。","deprecated":null,"version":null,"sidebarTitle":"获取监控目录健康摘要","openapi":"/api-reference/monitors.openapi.zh.json post /monit/folder/health","href":"/zh/api-reference/monitors/rule-folders/monit-folder-read-health"},{"title":"创建监控目录","description":"在根级别或调用方有权修改的父文件夹下创建监控文件夹。","deprecated":null,"version":null,"sidebarTitle":"创建监控目录","openapi":"/api-reference/monitors.openapi.zh.json post /monit/folder/create","href":"/zh/api-reference/monitors/rule-folders/monit-folder-write-create"},{"title":"更新监控目录","description":"替换调用方有权修改的监控文件夹的名称、备注和团队归属。","deprecated":null,"version":null,"sidebarTitle":"更新监控目录","openapi":"/api-reference/monitors.openapi.zh.json post /monit/folder/update","href":"/zh/api-reference/monitors/rule-folders/monit-folder-write-update"},{"title":"移动监控目录","description":"将监控目录及其后代移至其他目录下或顶层。","deprecated":null,"version":null,"sidebarTitle":"移动监控目录","openapi":"/api-reference/monitors.openapi.zh.json post /monit/folder/move","href":"/zh/api-reference/monitors/rule-folders/monit-folder-write-move"},{"title":"删除监控目录","description":"删除调用方有权修改的空监控文件夹。","deprecated":null,"version":null,"sidebarTitle":"删除监控目录","openapi":"/api-reference/monitors.openapi.zh.json post /monit/folder/delete","href":"/zh/api-reference/monitors/rule-folders/monit-folder-write-delete"}]}]},{"group":"RUM","icon":"monitor-waveform","pages":[{"group":"应用管理","icon":"mobile-screen-button","pages":[{"title":"查询应用列表","description":"返回当前用户可访问的 RUM 应用分页列表。","deprecated":null,"version":null,"sidebarTitle":"查询应用列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/list","href":"/zh/api-reference/rum/applications/rum-application-read-list"},{"title":"查看应用详情","description":"通过 `application_id` 获取单个 RUM 应用的完整信息。","deprecated":null,"version":null,"sidebarTitle":"查看应用详情","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/info","href":"/zh/api-reference/rum/applications/rum-application-read-info"},{"title":"批量查询应用详情","description":"通过 ID 列表批量获取多个 RUM 应用的详情。","deprecated":null,"version":null,"sidebarTitle":"批量查询应用详情","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/infos","href":"/zh/api-reference/rum/applications/rum-application-read-infos"},{"title":"创建应用","description":"创建新的 RUM 应用,返回生成的 `application_id` 和 `client_token`。","deprecated":null,"version":null,"sidebarTitle":"创建应用","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/create","href":"/zh/api-reference/rum/applications/rum-application-write-create"},{"title":"更新应用","description":"更新 RUM 应用的指定字段;请求中未出现的字段保持原值。","deprecated":null,"version":null,"sidebarTitle":"更新应用","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/update","href":"/zh/api-reference/rum/applications/rum-application-write-update"},{"title":"删除应用","description":"通过 `application_id` 删除 RUM 应用。","deprecated":null,"version":null,"sidebarTitle":"删除应用","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/delete","href":"/zh/api-reference/rum/applications/rum-application-write-delete"},{"title":"测试应用 Webhook","description":"发送一条 RUM 告警样例事件,用于验证应用的 Webhook URL。","deprecated":null,"version":null,"sidebarTitle":"测试应用 Webhook","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/webhook/test","href":"/zh/api-reference/rum/applications/rum-application-webhook-test"},{"title":"查看远程配置详情","description":"获取 RUM 应用当前生效的远程配置及其版本号。","deprecated":null,"version":null,"sidebarTitle":"查看远程配置详情","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/remote-config/get","href":"/zh/api-reference/rum/applications/rum-application-remote-config-read-get"},{"title":"更新远程配置","description":"为 RUM 应用发布一个全新的远程配置版本。","deprecated":null,"version":null,"sidebarTitle":"更新远程配置","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/remote-config/update","href":"/zh/api-reference/rum/applications/rum-application-remote-config-write-update"},{"title":"预览远程配置","description":"在不发布的情况下评估一份草稿远程配置在给定客户端上下文下的效果。","deprecated":null,"version":null,"sidebarTitle":"预览远程配置","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/remote-config/preview","href":"/zh/api-reference/rum/applications/rum-application-remote-config-read-preview"},{"title":"查询远程配置历史列表","description":"查询 RUM 应用已发布的远程配置版本列表。","deprecated":null,"version":null,"sidebarTitle":"查询远程配置历史列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/remote-config/history/list","href":"/zh/api-reference/rum/applications/rum-application-remote-config-read-history-list"},{"title":"回滚远程配置版本","description":"将某个历史版本的远程配置内容重新发布为新版本。","deprecated":null,"version":null,"sidebarTitle":"回滚远程配置版本","openapi":"/api-reference/rum.openapi.zh.json post /rum/application/remote-config/history/revert","href":"/zh/api-reference/rum/applications/rum-application-remote-config-write-history-revert"}]},{"group":"RUM 数据查询","icon":"chart-line","pages":[{"title":"查询 RUM 数据","description":"在指定时间范围内执行一个或多个 SQL 风格的 RUM 数据查询。","deprecated":null,"version":null,"sidebarTitle":"查询 RUM 数据","openapi":"/api-reference/rum.openapi.zh.json post /rum/data/query","href":"/zh/api-reference/rum/data-query/rum-read-data-query"}]},{"group":"仪表盘","icon":"gauge","pages":[{"title":"创建仪表盘","description":"按完整定义创建一个 RUM 自定义仪表盘。","deprecated":null,"version":null,"sidebarTitle":"创建仪表盘","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/create","href":"/zh/api-reference/rum/dashboards/rum-dashboard-write-create"},{"title":"删除仪表盘","description":"在期望版本号校验下把仪表盘移入回收站。","deprecated":null,"version":null,"sidebarTitle":"删除仪表盘","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/delete","href":"/zh/api-reference/rum/dashboards/rum-dashboard-write-delete"},{"title":"查看仪表盘详情","description":"查看单个仪表盘及其当前定义与版本号。","deprecated":null,"version":null,"sidebarTitle":"查看仪表盘详情","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/get","href":"/zh/api-reference/rum/dashboards/rum-dashboard-read-get"},{"title":"查询仪表盘列表","description":"查询本账户的仪表盘列表,默认按最近修改倒序。","deprecated":null,"version":null,"sidebarTitle":"查询仪表盘列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/list","href":"/zh/api-reference/rum/dashboards/rum-dashboard-read-list"},{"title":"恢复仪表盘","description":"把回收站中的仪表盘恢复为一个新版本。","deprecated":null,"version":null,"sidebarTitle":"恢复仪表盘","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/restore","href":"/zh/api-reference/rum/dashboards/rum-dashboard-write-restore"},{"title":"查看仪表盘版本详情","description":"查看仪表盘的某个版本及其完整定义。","deprecated":null,"version":null,"sidebarTitle":"查看仪表盘版本详情","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/revisions/get","href":"/zh/api-reference/rum/dashboards/rum-dashboard-read-revision-get"},{"title":"查询仪表盘版本历史","description":"查询仪表盘的版本历史,最新在前。","deprecated":null,"version":null,"sidebarTitle":"查询仪表盘版本历史","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/revisions/list","href":"/zh/api-reference/rum/dashboards/rum-dashboard-read-revision-list"},{"title":"查询回收站列表","description":"查询已删除的仪表盘,默认按删除时间倒序。","deprecated":null,"version":null,"sidebarTitle":"查询回收站列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/trash/list","href":"/zh/api-reference/rum/dashboards/rum-dashboard-read-trash-list"},{"title":"更新仪表盘","description":"在期望版本号校验下替换仪表盘定义。","deprecated":null,"version":null,"sidebarTitle":"更新仪表盘","openapi":"/api-reference/rum.openapi.zh.json post /rum/dashboard/update","href":"/zh/api-reference/rum/dashboards/rum-dashboard-write-update"}]},{"group":"RUM 问题跟踪","icon":"bug","pages":[{"title":"查询 Issue 列表","description":"返回符合过滤条件的 RUM 异常追踪 Issue 分页列表。","deprecated":null,"version":null,"sidebarTitle":"查询 Issue 列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/list","href":"/zh/api-reference/rum/issues/rum-issue-read-list"},{"title":"导出 Issue 列表","description":"按 `POST /rum/issue/list` 的过滤条件导出 Issue,生成最多 100 行的 CSV 文件。","deprecated":null,"version":null,"sidebarTitle":"导出 Issue 列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/export","href":"/zh/api-reference/rum/issues/rum-issue-read-export"},{"title":"查看 Issue 详情","description":"通过 `issue_id` 获取单个 Issue 的完整信息。","deprecated":null,"version":null,"sidebarTitle":"查看 Issue 详情","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/info","href":"/zh/api-reference/rum/issues/rum-issue-read-info"},{"title":"更新 Issue","description":"更新 Issue 的状态或疑似原因。","deprecated":null,"version":null,"sidebarTitle":"更新 Issue","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/update","href":"/zh/api-reference/rum/issues/rum-issue-write-update"}]},{"group":"RUM 会话回放","icon":"clapperboard-play","pages":[{"title":"查看会话回放元数据","description":"返回可回放会话记录的应用、设备、会话时间范围及全部视图信息。","deprecated":null,"version":null,"sidebarTitle":"查看会话回放元数据","openapi":"/api-reference/rum.openapi.zh.json post /rum/session-replay/metadata","href":"/zh/api-reference/rum/session-replay/rum-session-replay-read-metadata"},{"title":"查询会话回放分段","description":"分页获取会话录制的回放分段,可返回预签名下载地址或原始数据流。","deprecated":null,"version":null,"sidebarTitle":"查询会话回放分段","openapi":"/api-reference/rum.openapi.zh.json post /rum/session-replay/segments","href":"/zh/api-reference/rum/session-replay/rum-session-replay-read-segments"}]},{"group":"RUM 自定义字段","icon":"filter","pages":[{"title":"查询分值分布","description":"按出现次数降序返回指定时间范围内某个分面字段的 Top N 值及其计数。","deprecated":null,"version":null,"sidebarTitle":"查询分值分布","openapi":"/api-reference/rum.openapi.zh.json post /rum/facet/count","href":"/zh/api-reference/rum/facets/rum-read-facet-count"},{"title":"查询字段列表","description":"返回 RUM 字段定义,可按 scope 和是否为分面字段过滤。","deprecated":null,"version":null,"sidebarTitle":"查询字段列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/field/list","href":"/zh/api-reference/rum/facets/rum-read-field-list"}]},{"group":"RUM Sourcemap","icon":"map","pages":[{"title":"查询 Sourcemap 列表","description":"分页返回已上传的 Sourcemap 文件列表,可按平台类型、服务和版本过滤。","deprecated":null,"version":null,"sidebarTitle":"查询 Sourcemap 列表","openapi":"/api-reference/rum.openapi.zh.json post /sourcemap/list","href":"/zh/api-reference/rum/sourcemaps/sourcemap-read-list"},{"title":"丰富错误栈信息","description":"使用某服务版本已上传的 Sourcemap 或符号文件,对错误栈进行符号化或反混淆。","deprecated":null,"version":null,"sidebarTitle":"丰富错误栈信息","openapi":"/api-reference/rum.openapi.zh.json post /sourcemap/stack/enrich","href":"/zh/api-reference/rum/sourcemaps/sourcemap-read-stack-enrich"}]},{"group":"错误采集规则","icon":"bug-slash","pages":[{"title":"查询错误采集规则列表","description":"返回某 RUM 应用下配置的全部错误采集规则。","deprecated":null,"version":null,"sidebarTitle":"查询错误采集规则列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/list","href":"/zh/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-list"},{"title":"创建错误采集规则","description":"创建一条错误采集规则:命中的错误不再归入任何问题(Issue),但仍会照常入库。","deprecated":null,"version":null,"sidebarTitle":"创建错误采集规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/create","href":"/zh/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-create"},{"title":"更新错误采集规则","description":"更新错误采集规则的名称、描述或过滤条件。","deprecated":null,"version":null,"sidebarTitle":"更新错误采集规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/update","href":"/zh/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-update"},{"title":"删除错误采集规则","description":"从 RUM 应用中删除一条错误采集规则。","deprecated":null,"version":null,"sidebarTitle":"删除错误采集规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/delete","href":"/zh/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-delete"},{"title":"启用错误采集规则","description":"重新启用一条已被禁用的错误采集规则。","deprecated":null,"version":null,"sidebarTitle":"启用错误采集规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/enable","href":"/zh/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-enable"},{"title":"禁用错误采集规则","description":"禁用一条错误采集规则但不删除它。","deprecated":null,"version":null,"sidebarTitle":"禁用错误采集规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/disable","href":"/zh/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-disable"},{"title":"查询错误采集规则历史","description":"分页返回某应用错误采集规则集合的历史快照。","deprecated":null,"version":null,"sidebarTitle":"查询错误采集规则历史","openapi":"/api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/history/list","href":"/zh/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-history-list"},{"title":"回滚错误采集规则到历史版本","description":"将某应用的全部错误采集规则恢复到指定历史版本。","deprecated":null,"version":null,"sidebarTitle":"回滚错误采集规则到历史版本","openapi":"/api-reference/rum.openapi.zh.json post /rum/error-ingestion/rules/history/revert","href":"/zh/api-reference/rum/error-ingestion-rules/rum-error-ingestion-rules-history-revert"}]},{"group":"Issue 预设严重性规则","icon":"triangle-exclamation","pages":[{"title":"查询预设严重性规则列表","description":"返回指定 RUM 应用下配置的所有预设严重性规则。","deprecated":null,"version":null,"sidebarTitle":"查询预设严重性规则列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/list","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-list"},{"title":"创建预设严重性规则","description":"为 RUM 应用创建新的预设严重性规则。","deprecated":null,"version":null,"sidebarTitle":"创建预设严重性规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/create","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-create"},{"title":"更新预设严重性规则","description":"更新预设严重性规则的名称、描述、过滤条件或严重级别。","deprecated":null,"version":null,"sidebarTitle":"更新预设严重性规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/update","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-update"},{"title":"删除预设严重性规则","description":"删除指定的预设严重性规则。","deprecated":null,"version":null,"sidebarTitle":"删除预设严重性规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/delete","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-delete"},{"title":"启用预设严重性规则","description":"启用指定的预设严重性规则。","deprecated":null,"version":null,"sidebarTitle":"启用预设严重性规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/enable","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-enable"},{"title":"禁用预设严重性规则","description":"禁用指定的预设严重性规则。","deprecated":null,"version":null,"sidebarTitle":"禁用预设严重性规则","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/disable","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-disable"},{"title":"调整预设严重性规则顺序","description":"将一条预设严重性规则移动到另一条规则的评估顺序位置。","deprecated":null,"version":null,"sidebarTitle":"调整预设严重性规则顺序","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/reorder","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-reorder"},{"title":"查询预设严重性规则历史列表","description":"返回指定 RUM 应用下预设严重性规则的变更历史列表。","deprecated":null,"version":null,"sidebarTitle":"查询预设严重性规则历史列表","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/history/list","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-history-list"},{"title":"回滚预设严重性规则到历史版本","description":"将预设严重性规则回滚到指定历史快照时的状态。","deprecated":null,"version":null,"sidebarTitle":"回滚预设严重性规则到历史版本","openapi":"/api-reference/rum.openapi.zh.json post /rum/issue/preset-severity/rules/history/revert","href":"/zh/api-reference/rum/issue-preset-severity-rules/rum-issue-preset-severity-rules-history-revert"}]},{"group":"资源","icon":"gauge-high","pages":[{"title":"查看 RUM 资源信息","description":"返回账户的 RUM 资源记录及当前会话用量。","deprecated":null,"version":null,"sidebarTitle":"查看 RUM 资源信息","openapi":"/api-reference/rum.openapi.zh.json post /rum/resource/info","href":"/zh/api-reference/rum/resources/rum-resource-read-info"}]}]},{"group":"AI SRE","icon":"robot","pages":[{"group":"会话","icon":"comments","pages":[{"title":"查询会话列表","description":"分页查询调用者可见的智能体会话,可按应用、入口、归档状态与团队过滤。","deprecated":null,"version":null,"sidebarTitle":"查询会话列表","openapi":"/api-reference/safari.openapi.zh.json post /safari/session/list","href":"/zh/api-reference/ai-sre/sessions/session-read-list"},{"title":"查看会话详情","description":"查看单个会话,并返回其最近事件的一页(向更早方向分页)。","deprecated":null,"version":null,"sidebarTitle":"查看会话详情","openapi":"/api-reference/safari.openapi.zh.json post /safari/session/get","href":"/zh/api-reference/ai-sre/sessions/session-read-info"},{"title":"导出会话记录","description":"以换行分隔的 JSON(NDJSON)流式导出会话的完整事件记录。","deprecated":null,"version":null,"sidebarTitle":"导出会话记录","openapi":"/api-reference/safari.openapi.zh.json post /safari/session/export","href":"/zh/api-reference/ai-sre/sessions/session-read-export"},{"title":"删除会话","description":"软删除会话,并一并删除其子智能体会话和会话中展示过的文件。","deprecated":null,"version":null,"sidebarTitle":"删除会话","openapi":"/api-reference/safari.openapi.zh.json post /safari/session/delete","href":"/zh/api-reference/ai-sre/sessions/session-write-delete"}]},{"group":"自动化","icon":"clock","pages":[{"title":"创建自动化规则","description":"创建自动化规则,可配置定时、HTTP POST、On-call 故障和作战室触发器。","deprecated":null,"version":null,"sidebarTitle":"创建自动化规则","openapi":"/api-reference/safari.openapi.zh.json post /safari/automation/rule/create","href":"/zh/api-reference/ai-sre/automations/automation-rule-write-create"},{"title":"列出自动化规则","description":"列出调用者可见的自动化规则,按更新时间倒序,支持分页和过滤。","deprecated":null,"version":null,"sidebarTitle":"列出自动化规则","openapi":"/api-reference/safari.openapi.zh.json post /safari/automation/rule/list","href":"/zh/api-reference/ai-sre/automations/automation-rule-read-list"},{"title":"列出自动化模板","description":"列出用于预填创建规则表单的内置自动化模板,支持中文或英文。","deprecated":null,"version":null,"sidebarTitle":"列出自动化模板","openapi":"/api-reference/safari.openapi.zh.json post /safari/automation/template/list","href":"/zh/api-reference/ai-sre/automations/automation-template-read-list"},{"title":"列出自动化运行历史","description":"列出一条自动化规则的运行记录,按开始时间倒序,支持按状态、触发来源和时间过滤。","deprecated":null,"version":null,"sidebarTitle":"列出自动化运行历史","openapi":"/api-reference/safari.openapi.zh.json post /safari/automation/run/list","href":"/zh/api-reference/ai-sre/automations/automation-run-read-list"},{"title":"查看自动化规则","description":"按 ID 获取一条自动化规则,包括触发器配置和运行位置。","deprecated":null,"version":null,"sidebarTitle":"查看自动化规则","openapi":"/api-reference/safari.openapi.zh.json post /safari/automation/rule/get","href":"/zh/api-reference/ai-sre/automations/automation-rule-read-get"},{"title":"更新自动化规则","description":"更新自动化规则的字段和触发器配置;省略的字段保持不变。","deprecated":null,"version":null,"sidebarTitle":"更新自动化规则","openapi":"/api-reference/safari.openapi.zh.json post /safari/automation/rule/update","href":"/zh/api-reference/ai-sre/automations/automation-rule-write-update"},{"title":"删除自动化规则","description":"删除一条自动化规则,并同时删除其全部触发器及订阅。","deprecated":null,"version":null,"sidebarTitle":"删除自动化规则","openapi":"/api-reference/safari.openapi.zh.json post /safari/automation/rule/delete","href":"/zh/api-reference/ai-sre/automations/automation-rule-write-delete"},{"title":"运行自动化规则","description":"立即运行一次自动化规则,不受其触发器和启用状态限制。","deprecated":null,"version":null,"sidebarTitle":"运行自动化规则","openapi":"/api-reference/safari.openapi.zh.json post /safari/automation/rule/run","href":"/zh/api-reference/ai-sre/automations/automation-rule-write-run"}]},{"group":"技能","icon":"wand-magic-sparkles","pages":[{"title":"查询技能列表","description":"分页查询调用者在账户与团队范围内可见的 AI SRE 技能。","deprecated":null,"version":null,"sidebarTitle":"查询技能列表","openapi":"/api-reference/safari.openapi.zh.json post /safari/skill/list","href":"/zh/api-reference/ai-sre/skills/skill-read-list"},{"title":"查看技能详情","description":"查看单个技能,包含完整的 SKILL.md 内容。","deprecated":null,"version":null,"sidebarTitle":"查看技能详情","openapi":"/api-reference/safari.openapi.zh.json post /safari/skill/get","href":"/zh/api-reference/ai-sre/skills/skill-read-get"},{"title":"更新技能","description":"更新技能的描述信息或重新分配团队范围。","deprecated":null,"version":null,"sidebarTitle":"更新技能","openapi":"/api-reference/safari.openapi.zh.json post /safari/skill/update","href":"/zh/api-reference/ai-sre/skills/skill-write-update"},{"title":"删除技能","description":"软删除技能,智能体不再加载它,其名称可被重新使用。","deprecated":null,"version":null,"sidebarTitle":"删除技能","openapi":"/api-reference/safari.openapi.zh.json post /safari/skill/delete","href":"/zh/api-reference/ai-sre/skills/skill-write-delete"},{"title":"上传技能","description":"上传技能压缩包(.skill/.zip/.tar.gz/.tgz)以创建或覆盖技能。","deprecated":null,"version":null,"sidebarTitle":"上传技能","openapi":"/api-reference/safari.openapi.zh.json post /safari/skill/upload","href":"/zh/api-reference/ai-sre/skills/skill-write-upload"},{"title":"启用技能","description":"启用已禁用的技能,使智能体可加载。","deprecated":null,"version":null,"sidebarTitle":"启用技能","openapi":"/api-reference/safari.openapi.zh.json post /safari/skill/enable","href":"/zh/api-reference/ai-sre/skills/skill-read-enable"},{"title":"禁用技能","description":"禁用已启用的技能,使智能体不再加载。","deprecated":null,"version":null,"sidebarTitle":"禁用技能","openapi":"/api-reference/safari.openapi.zh.json post /safari/skill/disable","href":"/zh/api-reference/ai-sre/skills/skill-write-disable"}]},{"group":"MCP 服务器","icon":"plug","pages":[{"title":"查询 MCP 服务器列表","description":"分页查询调用者在账户与团队范围内可见的 MCP 服务器。","deprecated":null,"version":null,"sidebarTitle":"查询 MCP 服务器列表","openapi":"/api-reference/safari.openapi.zh.json post /safari/mcp/server/list","href":"/zh/api-reference/ai-sre/mcp-servers/mcp-read-server-list"},{"title":"创建 MCP 服务器","description":"在账户下注册新的 MCP 服务器(连接器)。","deprecated":null,"version":null,"sidebarTitle":"创建 MCP 服务器","openapi":"/api-reference/safari.openapi.zh.json post /safari/mcp/server/create","href":"/zh/api-reference/ai-sre/mcp-servers/mcp-write-server-create"},{"title":"查看 MCP 服务器详情","description":"查看单个 MCP 服务器(纯数据库读取,不实时探测远端服务器)。","deprecated":null,"version":null,"sidebarTitle":"查看 MCP 服务器详情","openapi":"/api-reference/safari.openapi.zh.json post /safari/mcp/server/get","href":"/zh/api-reference/ai-sre/mcp-servers/mcp-read-server-get"},{"title":"更新 MCP 服务器","description":"更新 MCP 服务器配置;省略字段表示不变。","deprecated":null,"version":null,"sidebarTitle":"更新 MCP 服务器","openapi":"/api-reference/safari.openapi.zh.json post /safari/mcp/server/update","href":"/zh/api-reference/ai-sre/mcp-servers/mcp-write-server-update"},{"title":"删除 MCP 服务器","description":"按 ID 删除 MCP 服务器。","deprecated":null,"version":null,"sidebarTitle":"删除 MCP 服务器","openapi":"/api-reference/safari.openapi.zh.json post /safari/mcp/server/delete","href":"/zh/api-reference/ai-sre/mcp-servers/mcp-write-server-delete"},{"title":"启用 MCP 服务器","description":"启用已禁用的 MCP 服务器。","deprecated":null,"version":null,"sidebarTitle":"启用 MCP 服务器","openapi":"/api-reference/safari.openapi.zh.json post /safari/mcp/server/enable","href":"/zh/api-reference/ai-sre/mcp-servers/mcp-write-server-enable"},{"title":"禁用 MCP 服务器","description":"禁用已启用的 MCP 服务器。","deprecated":null,"version":null,"sidebarTitle":"禁用 MCP 服务器","openapi":"/api-reference/safari.openapi.zh.json post /safari/mcp/server/disable","href":"/zh/api-reference/ai-sre/mcp-servers/mcp-write-server-disable"}]},{"group":"A2A 智能体","icon":"robot","pages":[{"title":"创建 A2A 智能体","description":"通过智能体卡片 URL 注册新的 A2A 远程智能体。","deprecated":null,"version":null,"sidebarTitle":"创建 A2A 智能体","openapi":"/api-reference/safari.openapi.zh.json post /safari/a2a-agent/create","href":"/zh/api-reference/ai-sre/a2a-agents/remote-agent-write-create"},{"title":"查询 A2A 智能体列表","description":"分页查询调用者在账户与团队范围内可见的 A2A 智能体。","deprecated":null,"version":null,"sidebarTitle":"查询 A2A 智能体列表","openapi":"/api-reference/safari.openapi.zh.json post /safari/a2a-agent/list","href":"/zh/api-reference/ai-sre/a2a-agents/remote-agent-read-list"},{"title":"查看 A2A 智能体详情","description":"按 ID 返回单个 A2A 智能体的配置,认证密钥已脱敏。","deprecated":null,"version":null,"sidebarTitle":"查看 A2A 智能体详情","openapi":"/api-reference/safari.openapi.zh.json post /safari/a2a-agent/get","href":"/zh/api-reference/ai-sre/a2a-agents/remote-agent-read-get"},{"title":"更新 A2A 智能体","description":"对 A2A 智能体执行部分更新;省略字段表示不变。","deprecated":null,"version":null,"sidebarTitle":"更新 A2A 智能体","openapi":"/api-reference/safari.openapi.zh.json post /safari/a2a-agent/update","href":"/zh/api-reference/ai-sre/a2a-agents/remote-agent-write-update"},{"title":"启用 A2A 智能体","description":"启用已禁用的 A2A 智能体。","deprecated":null,"version":null,"sidebarTitle":"启用 A2A 智能体","openapi":"/api-reference/safari.openapi.zh.json post /safari/a2a-agent/enable","href":"/zh/api-reference/ai-sre/a2a-agents/remote-agent-write-enable"},{"title":"禁用 A2A 智能体","description":"禁用已启用的 A2A 智能体。","deprecated":null,"version":null,"sidebarTitle":"禁用 A2A 智能体","openapi":"/api-reference/safari.openapi.zh.json post /safari/a2a-agent/disable","href":"/zh/api-reference/ai-sre/a2a-agents/remote-agent-write-disable"},{"title":"删除 A2A 智能体","description":"按 ID 软删除 A2A 智能体。","deprecated":null,"version":null,"sidebarTitle":"删除 A2A 智能体","openapi":"/api-reference/safari.openapi.zh.json post /safari/a2a-agent/delete","href":"/zh/api-reference/ai-sre/a2a-agents/remote-agent-write-delete"}]},{"group":"产物","icon":"images","pages":[{"title":"查询产物列表","description":"分页查询调用者可见的产物列表,支持按标题搜索。","deprecated":null,"version":null,"sidebarTitle":"查询产物列表","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/list","href":"/zh/api-reference/ai-sre/artifacts/artifact-read-list"},{"title":"获取产物详情","description":"按 ID 获取单个已发布产物,包括来源文件、归属和公开分享状态。","deprecated":null,"version":null,"sidebarTitle":"获取产物详情","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/get","href":"/zh/api-reference/ai-sre/artifacts/artifact-read-get"},{"title":"查询文件发布状态","description":"批量查询文件是否已发布为产物。","deprecated":null,"version":null,"sidebarTitle":"查询文件发布状态","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/file-state","href":"/zh/api-reference/ai-sre/artifacts/artifact-read-get-file-state"},{"title":"签发文件访问链接","description":"为文件签发短期有效的下载/预览链接。","deprecated":null,"version":null,"sidebarTitle":"签发文件访问链接","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/sign","href":"/zh/api-reference/ai-sre/artifacts/artifact-read-sign"},{"title":"下载或预览文件","description":"使用签名令牌下载或预览文件内容。","deprecated":null,"version":null,"sidebarTitle":"下载或预览文件","openapi":"/api-reference/safari.openapi.zh.json get /safari/artifact/stream","href":"/zh/api-reference/ai-sre/artifacts/artifact-read-stream"},{"title":"发布文件为产物","description":"将会话中生成的文件发布到产物库。","deprecated":null,"version":null,"sidebarTitle":"发布文件为产物","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/publish-from-file","href":"/zh/api-reference/ai-sre/artifacts/artifact-write-publish"},{"title":"更新产物","description":"更新产物标题,或在个人/团队空间之间转移产物。","deprecated":null,"version":null,"sidebarTitle":"更新产物","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/update","href":"/zh/api-reference/ai-sre/artifacts/artifact-write-update"},{"title":"从产物库移除产物","description":"将产物从产物库移除;来源文件仍保留在会话中。","deprecated":null,"version":null,"sidebarTitle":"从产物库移除产物","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/delete","href":"/zh/api-reference/ai-sre/artifacts/artifact-write-delete"},{"title":"开启公开分享","description":"开启产物的匿名公开分享并返回公开链接。","deprecated":null,"version":null,"sidebarTitle":"开启公开分享","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/share/enable","href":"/zh/api-reference/ai-sre/artifacts/artifact-write-share-enable"},{"title":"更新公开分享快照","description":"将公开分享的内容快照更新为产物最新内容。","deprecated":null,"version":null,"sidebarTitle":"更新公开分享快照","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/share/sync","href":"/zh/api-reference/ai-sre/artifacts/artifact-write-share-sync"},{"title":"撤销公开分享","description":"撤销产物的公开分享,公开链接立即失效。","deprecated":null,"version":null,"sidebarTitle":"撤销公开分享","openapi":"/api-reference/safari.openapi.zh.json post /safari/artifact/gallery/share/revoke","href":"/zh/api-reference/ai-sre/artifacts/artifact-write-share-revoke"}]},{"group":"知识","icon":"book","pages":[{"title":"查询知识列表","description":"查询调用者可见的账户与团队范围知识列表。","deprecated":null,"version":null,"sidebarTitle":"查询知识列表","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/pack/list","href":"/zh/api-reference/ai-sre/knowledge/knowledge-pack-read-list"},{"title":"查看账户知识","description":"返回账户范围知识的元数据及其文件列表。","deprecated":null,"version":null,"sidebarTitle":"查看账户知识","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/get","href":"/zh/api-reference/ai-sre/knowledge/knowledge-pack-read-get"},{"title":"确保知识存在","description":"在指定范围幂等创建知识,已存在时直接返回现有知识。","deprecated":null,"version":null,"sidebarTitle":"确保知识存在","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/pack/ensure","href":"/zh/api-reference/ai-sre/knowledge/knowledge-pack-write-ensure"},{"title":"更新知识","description":"将知识移动到其他账户或团队范围。","deprecated":null,"version":null,"sidebarTitle":"更新知识","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/pack/update","href":"/zh/api-reference/ai-sre/knowledge/knowledge-pack-write-update"},{"title":"删除知识","description":"删除知识及其全部文件。","deprecated":null,"version":null,"sidebarTitle":"删除知识","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/pack/delete","href":"/zh/api-reference/ai-sre/knowledge/knowledge-pack-write-delete"},{"title":"查询知识文件列表","description":"查询知识文件列表,包含大小、校验和等元数据。","deprecated":null,"version":null,"sidebarTitle":"查询知识文件列表","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/file/list","href":"/zh/api-reference/ai-sre/knowledge/knowledge-file-read-list"},{"title":"获取知识文件","description":"返回知识文件的元数据及 Base64 编码的文件内容。","deprecated":null,"version":null,"sidebarTitle":"获取知识文件","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/file/get","href":"/zh/api-reference/ai-sre/knowledge/knowledge-file-read-get"},{"title":"上传知识文件","description":"以 Base64 编码的内容创建或覆盖知识文件。","deprecated":null,"version":null,"sidebarTitle":"上传知识文件","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/file/put","href":"/zh/api-reference/ai-sre/knowledge/knowledge-file-write-put"},{"title":"删除知识文件","description":"按相对路径删除知识文件。","deprecated":null,"version":null,"sidebarTitle":"删除知识文件","openapi":"/api-reference/safari.openapi.zh.json post /safari/knowledge/file/delete","href":"/zh/api-reference/ai-sre/knowledge/knowledge-file-write-delete"}]}]},{"group":"平台","icon":"gear","pages":[{"group":"成员管理","icon":"users","pages":[{"title":"获取当前成员信息","description":"返回当前凭据所属成员的资料及其所在账户信息。","deprecated":null,"version":null,"sidebarTitle":"获取当前成员信息","openapi":"/api-reference/platform.openapi.zh.json post /member/info","href":"/zh/api-reference/platform/members/member-info"},{"title":"查询成员列表","description":"返回组织成员的分页列表。","deprecated":null,"version":null,"sidebarTitle":"查询成员列表","openapi":"/api-reference/platform.openapi.zh.json post /member/list","href":"/zh/api-reference/platform/members/member-list"},{"title":"删除成员","description":"通过 ID、邮箱、手机号或名称从组织中移除成员。","deprecated":null,"version":null,"sidebarTitle":"删除成员","openapi":"/api-reference/platform.openapi.zh.json post /member/delete","href":"/zh/api-reference/platform/members/member-delete"},{"title":"邀请成员","description":"通过邮箱或手机号批量邀请新成员加入组织。每个账户 24 小时内最多发出 200 条邀请,单次请求最多邀请 20 名成员。","deprecated":null,"version":null,"sidebarTitle":"邀请成员","openapi":"/api-reference/platform.openapi.zh.json post /member/invite","href":"/zh/api-reference/platform/members/member-invite"},{"title":"授予成员角色","description":"为成员在现有角色之外追加一个或多个角色。","deprecated":null,"version":null,"sidebarTitle":"授予成员角色","openapi":"/api-reference/platform.openapi.zh.json post /member/role/grant","href":"/zh/api-reference/platform/members/member-grant-role"},{"title":"解除成员角色","description":"从成员的角色中移除一个或多个角色。","deprecated":null,"version":null,"sidebarTitle":"解除成员角色","openapi":"/api-reference/platform.openapi.zh.json post /member/role/revoke","href":"/zh/api-reference/platform/members/member-revoke-role"},{"title":"更新成员角色","description":"用给定的角色集合整体替换成员的角色。","deprecated":null,"version":null,"sidebarTitle":"更新成员角色","openapi":"/api-reference/platform.openapi.zh.json post /member/role/update","href":"/zh/api-reference/platform/members/member-update-role"},{"title":"重置成员信息","description":"通过成员标识定位成员,并重置指定资料字段。","deprecated":null,"version":null,"sidebarTitle":"重置成员信息","openapi":"/api-reference/platform.openapi.zh.json post /member/info/reset","href":"/zh/api-reference/platform/members/member-reset-info"},{"title":"通知成员","description":"以调用方 AI SRE 会话的身份,向账户成员发送其撰写的邮件。","deprecated":null,"version":null,"sidebarTitle":"通知成员","openapi":"/api-reference/platform.openapi.zh.json post /member/notify","href":"/zh/api-reference/platform/members/member-notify"},{"title":"批量获取人员信息","description":"根据 ID 批量返回成员或账户的资料信息。","deprecated":null,"version":null,"sidebarTitle":"批量获取人员信息","openapi":"/api-reference/platform.openapi.zh.json post /person/infos","href":"/zh/api-reference/platform/members/person-infos"}]},{"group":"团队管理","icon":"users-line","pages":[{"title":"查看团队详情","description":"按 ID、名称或外部引用 ID 返回单个团队的详细信息。","deprecated":null,"version":null,"sidebarTitle":"查看团队详情","openapi":"/api-reference/platform.openapi.zh.json post /team/info","href":"/zh/api-reference/platform/teams/team-read-info"},{"title":"批量查看团队信息","description":"一次请求按 ID 列表批量返回多个团队的基本信息。","deprecated":null,"version":null,"sidebarTitle":"批量查看团队信息","openapi":"/api-reference/platform.openapi.zh.json post /team/infos","href":"/zh/api-reference/platform/teams/team-read-infos"},{"title":"查看团队列表","description":"分页返回当前账户下的团队列表。","deprecated":null,"version":null,"sidebarTitle":"查看团队列表","openapi":"/api-reference/platform.openapi.zh.json post /team/list","href":"/zh/api-reference/platform/teams/team-read-list"},{"title":"变更团队信息","description":"创建新团队或更新已有团队,更新时传入 `team_id`。","deprecated":null,"version":null,"sidebarTitle":"变更团队信息","openapi":"/api-reference/platform.openapi.zh.json post /team/upsert","href":"/zh/api-reference/platform/teams/team-write-upsert"},{"title":"删除团队","description":"按 ID、名称或外部引用 ID 删除团队,并移除其全部成员。","deprecated":null,"version":null,"sidebarTitle":"删除团队","openapi":"/api-reference/platform.openapi.zh.json post /team/delete","href":"/zh/api-reference/platform/teams/team-write-delete"}]},{"group":"角色与权限","icon":"user-shield","pages":[{"title":"查看角色详情","description":"按角色 ID 返回单个角色的详细信息。","deprecated":null,"version":null,"sidebarTitle":"查看角色详情","openapi":"/api-reference/platform.openapi.zh.json post /role/info","href":"/zh/api-reference/platform/roles-permissions/role-read-info"},{"title":"查看角色列表","description":"返回当前账户下所有自定义及内置角色。","deprecated":null,"version":null,"sidebarTitle":"查看角色列表","openapi":"/api-reference/platform.openapi.zh.json post /role/list","href":"/zh/api-reference/platform/roles-permissions/role-read-list"},{"title":"创建或更新角色","description":"创建新的自定义角色或更新已有角色,更新时传入 `role_id`。","deprecated":null,"version":null,"sidebarTitle":"创建或更新角色","openapi":"/api-reference/platform.openapi.zh.json post /role/upsert","href":"/zh/api-reference/platform/roles-permissions/role-write-upsert"},{"title":"启用角色","description":"重新启用已被禁用的自定义角色。","deprecated":null,"version":null,"sidebarTitle":"启用角色","openapi":"/api-reference/platform.openapi.zh.json post /role/enable","href":"/zh/api-reference/platform/roles-permissions/role-write-enable"},{"title":"禁用角色","description":"将自定义角色置为禁用状态,但不删除它。","deprecated":null,"version":null,"sidebarTitle":"禁用角色","openapi":"/api-reference/platform.openapi.zh.json post /role/disable","href":"/zh/api-reference/platform/roles-permissions/role-write-disable"},{"title":"删除角色","description":"删除自定义角色,可选择先从所有仍持有它的成员身上解除。","deprecated":null,"version":null,"sidebarTitle":"删除角色","openapi":"/api-reference/platform.openapi.zh.json post /role/delete","href":"/zh/api-reference/platform/roles-permissions/role-write-delete"},{"title":"查看角色权限集合","description":"列出权限项,并标记其中哪些由指定角色授予。","deprecated":null,"version":null,"sidebarTitle":"查看角色权限集合","openapi":"/api-reference/platform.openapi.zh.json post /role/permission/list","href":"/zh/api-reference/platform/roles-permissions/role-read-list-permission"},{"title":"查看权限因子集合","description":"列出调用成员通过其角色获得的权限因子。","deprecated":null,"version":null,"sidebarTitle":"查看权限因子集合","openapi":"/api-reference/platform.openapi.zh.json post /role/permission/factor/list","href":"/zh/api-reference/platform/roles-permissions/role-read-list-permission-factor"},{"title":"授予成员账户权限","description":"将角色授予一个或多个成员,赋予其该角色包含的权限。","deprecated":null,"version":null,"sidebarTitle":"授予成员账户权限","openapi":"/api-reference/platform.openapi.zh.json post /role/member/grant","href":"/zh/api-reference/platform/roles-permissions/role-write-grant-role"},{"title":"解除成员账户权限","description":"从一个或多个成员处撤销角色授权。","deprecated":null,"version":null,"sidebarTitle":"解除成员账户权限","openapi":"/api-reference/platform.openapi.zh.json post /role/member/revoke","href":"/zh/api-reference/platform/roles-permissions/role-write-revoke-role"}]},{"group":"审计日志","icon":"scroll","pages":[{"title":"检索审计日志","description":"按时间范围返回游标分页的操作审计日志列表。","deprecated":null,"version":null,"sidebarTitle":"检索审计日志","openapi":"/api-reference/platform.openapi.zh.json post /audit/search","href":"/zh/api-reference/platform/audit-logs/audit-read-search"},{"title":"查看事件类型列表","description":"返回所有会记录到审计日志中的操作名称,可用于 `operations` 过滤参数。","deprecated":null,"version":null,"sidebarTitle":"查看事件类型列表","openapi":"/api-reference/platform.openapi.zh.json post /audit/operation/list","href":"/zh/api-reference/platform/audit-logs/audit-read-operation-list"}]},{"group":"账户设置","icon":"id-card","pages":[{"title":"查看主体信息","description":"返回当前主体(账户)的基本信息与设置。","deprecated":null,"version":null,"sidebarTitle":"查看主体信息","openapi":"/api-reference/platform.openapi.zh.json post /account/info","href":"/zh/api-reference/platform/account/account-read-info"}]}]}]}]},{"language":"en","footer":{"socials":{"github":"https://github.com/flashcatcloud"},"links":[{"header":"Flashduty","items":[{"label":"Website","href":"https://www.flashduty.com/en"},{"label":"Pricing","href":"https://www.flashduty.com/en/pricing"},{"label":"Integrations","href":"https://www.flashduty.com/en/integrations"},{"label":"Blog","href":"https://www.flashduty.com/en/now/blog"}]},{"header":"Support","items":[{"label":"Contact us","href":"https://www.flashduty.com/en/contact"},{"label":"Security","href":"https://www.flashduty.com/en/legal/security"},{"label":"Service SLA","href":"/en/compliance/service-sla"}]},{"header":"Legal","items":[{"label":"Terms of Service","href":"/en/compliance/terms-of-service"},{"label":"User Agreement","href":"/en/compliance/user-agreement"},{"label":"Privacy Policy","href":"/en/compliance/privacy-policy"},{"label":"Refund Policy","href":"/en/compliance/refund-policy"}]}]},"navbar":{"links":[{"icon":"code","href":"/en/openapi/introduction","label":"API Reference"}],"primary":{"type":"button","label":"Console","href":"https://console.flashcat.cloud"}},"pages":[{"title":"en","href":"/en/openapi/pagination"}]}]},"basePath":"","title":"关于分页 - Flashduty Docs","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}