Status API是一个面向公众的API,用于确定Zendesk基础架构中组件和子组件的状态。亚博

此API不需要身份验证。

API的路径

Status API的路径与Zendesk v2 API不同。亚博而不是https://{子域名}.zendes亚博k.com,它允许你访问Zendesk实例,Status API的路径如下:亚博

https://status.亚博zendesk.com

API允许您访问status.亚博zendesk.com而不是Zendesk实例。亚博

在本指南中,端点使用部分资源标识符列出,例如:

GET / api /组件/ {id_or_tag} ?域={子域名}.zendesk.com亚博

前置API路径以获得完整的端点:

https://status.亚博zendesk.com/api/components/ {id_or_tag} ?域={子域名}.zendesk.com

速率限制

此API的速率限制为每分钟10个请求。

JSON格式

状态表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
active_incidents 数组 真正的 看到事件
描述 字符串 真正的 组件或子组件的描述
id 整数 真正的 组件或子组件的Id
影响 字符串 真正的 仅用于GET请求。取值为minor、major、critical、security、no impact。
名字 字符串 真正的 组件或子组件的名称
pod_id 整数 真正的 Zendesk基础设施中pod(服务点)的Id亚博
状态 字符串 真正的 仅用于GET请求。允许的值为“可操作”、“阻碍”或“不操作”。
子组件 数组 真正的 子组件列表。看到子组件列表
标签 字符串 真正的 由组件或子组件的名称生成

例子

             
{“active_incidents”“描述”“聊天”“id”23“影响”“关键”“名称”“聊天”“pod_id”1“状态”“不起作用”“子组件”{“active_incidents”“component_id”23“描述”“仪表盘”“id”24“名称”“仪表盘”“pod_id”1“标签”“仪表盘”}{“active_incidents”“component_id”23“描述”“聊天窗口小部件”“id”25“名称”“聊天窗口小部件”“pod_id”1“标签”“chat_widget”}“标签”“聊天”}

子组件状态

子组件状态由具有以下属性的JSON对象表示:

名字 类型 描述
id 整数 子组件Id
component_id 整数 父组件的Id
名字 字符串 子组件的名称
描述 字符串 子组件的描述信息
pod_id 整数 Zendesk基础设施中pod(服务点)的Id亚博
标签 字符串 由子组件的名称生成
状态 字符串 仅用于GET请求。允许的值为“可操作”、“阻碍”或“不可操作”。
影响 字符串 仅用于GET请求。允许的值为"minor", "major", "critical"或"security"
active_incidents 字符串 看到事件

事件

要查看事件,show_incidents = true必须包含在列表组件子组件列表API调用。

事件由具有以下属性的JSON对象表示:

名字 类型 描述
id 整数 事件发生的原因
名字 字符串 事件名称
started_at 日期 事件发生的时间
影响 字符串 允许的值为"minor", "major", "critical"或"security"
状态 字符串 允许的值为“可操作”、“阻碍”或“不可操作”。
更新 数组 看到事件的更新

例子

             
{“id”123“名称”“大坏事件”“started_at”“2018 - 01 - 19 t22:58:45.126z”“状态”“阻碍”“影响”“小”“更新”{“id”123“created_at”“2018 - 01 - 19 t22:58:45.126z”“updated_at”“2018 - 01 - 19 t23:18:11.156z”“描述”“事件更新1”“incident_id”456}{“id”456“created_at”“2018 - 01 - 19 t22:58:55.126z”“updated_at”“2018 - 01 - 19 t23:19:11.156z”“描述”“事件更新2”“incident_id”789}}

事件的更新

事件更新由具有以下属性的JSON对象表示:

名字 类型 描述
id 整数 事件更新的Id
created_at 日期 创建事件更新的时间
updated_at 日期 事件更新被修改的时间
描述 字符串 事件更新的描述
incident_id 整数 事件发生的原因

例子

             
{“id”123“created_at”“2018 - 01 - 19 t22:58:45.126z”“updated_at”“2018 - 01 - 19 t23:18:11.156z”“描述””事件更新”“incident_id”456}

列表组件

  • 得到/ api /组件?域={域}

弃用)要在响应中包含active_incidents,请包含show_incidents = true如下:得到/ api /组件?域={子域名}.zendesk.com&show_in亚博cidents = true

列出组件及其子组件。组件由具有以下属性的JSON对象表示:

名字 类型 评论
id 整数 组件或子组件的Id
名字 字符串 组件或子组件的名称
标签 字符串 由组件或子组件的名称生成
描述 字符串 组件或子组件的描述
pod_id 整数 Zendesk基础架构中pod的Id亚博
子组件 数组 子组件列表。看到子组件列表
active_incidents 一系列事件 看到事件

允许

  • 匿名用户

参数

名字 类型 要求 描述
字符串 查询 真正的 子域名
show_incidents 布尔 查询 查看事件

代码示例

旋度
              
旋度https://status.亚博zendesk.com/api/components?domain{子域名}.亚博zendesk.com
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/components?domain=mycompany&show_incidents=true”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/components”newBuilderaddQueryParameter“域”“mycompany”addQueryParameter“show_incidents”“真正的”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置{方法“得到”url“https://support.亚博zendesk.com/api/components”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数{“域”“mycompany”“show_incidents”“真正的”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/components?domain=mycompany&show_incidents=true”{“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/components”uri查询URIencode_www_form“域”“mycompany”“show_incidents”“真正的”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“组件”{“active_incidents”{“id”789“影响”“主要的”“名称””事件1”“started_at”“2018 - 01 - 19 t21:01:31.063z”“状态”“操作”“更新”{“created_at”“2018 - 01 - 19 t22:58:45.126z”“描述””事件更新”“id”123“incident_id”456“updated_at”“2018 - 01 - 19 t23:18:11.156z”}}“描述”“聊天”“id”23“名称”“聊天”“pod_id”1“子组件”{“active_incidents”“component_id”23“描述”“仪表盘”“id”24“名称”“仪表盘”“pod_id”1“标签”“仪表盘”}{“active_incidents”“component_id”23“描述”“聊天窗口小部件”“id”25“名称”“聊天窗口小部件”“pod_id”1“标签”“chat_widget”}“标签”“聊天”}{“active_incidents”“描述”“探索”“id”58“名称”“探索”“pod_id”1“子组件”{“active_incidents”“component_id”58“描述”“数据提取与转换”“id”59“名称”“数据提取与转换”“pod_id”1“标签”“data_extraction_transformation”}“标签”“探索”}}

显示组件状态

  • GET / api /组件/ {component_id_or_tag} ?域={域}

弃用)使用列表组件端点,以获取组件的id或标记。

允许

  • 匿名用户

参数

名字 类型 要求 描述
字符串 查询 真正的 子域名
component_id_or_tag 字符串 路径 真正的 组件的ID或名称

代码示例

旋度
              
旋度https://status.亚博zendesk.com/api/components/{component_id_or_tag}域?{子域名}.亚博zendesk.com
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/components/chat_widget?domain=mycompany”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/components/chat_widget”newBuilderaddQueryParameter“域”“mycompany”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置{方法“得到”url“https://support.亚博zendesk.com/api/components/chat_widget”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数{“域”“mycompany”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/components/chat_widget?domain=mycompany”{“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/components/chat_widget”uri查询URIencode_www_form“域”“mycompany”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“active_incidents”{“id”789“影响”“主要的”“名称””事件1”“started_at”“2018 - 01 - 19 t21:01:31.063z”“状态”“操作”“更新”{“created_at”“2018 - 01 - 19 t22:58:45.126z”“描述””事件更新”“id”123“incident_id”456“updated_at”“2018 - 01 - 19 t23:18:11.156z”}}“id”50“影响”“主要的”“名称”“分析”“pod_id”456“状态”“操作”“标签”“部件”}

子组件列表

  • GET / api /组件/ {component_id_or_tag} /子组件?域={域}

弃用)要在响应中包含active_incidents,请包含show_incidents = true如下:GET / api /组件/ {component_id_or_tag} /子组件?域={子域名}.zendesk.com&show_incident亚博s = true

列出指定组件的子组件。使用列表组件端点,以获取组件的id或标记。

子组件由具有以下属性的JSON对象表示:

名字 类型 评论
id 整数 组件或子组件的Id
名字 字符串 组件或子组件的名称
标签 字符串 由组件或子组件的名称生成
描述 字符串 组件或子组件的描述
component_id 整数 父组件的Id
pod_id 整数 Zendesk基础架构中pod的Id亚博
active_incidents 一系列事件 看到事件

允许

  • 匿名用户

参数

名字 类型 要求 描述
字符串 查询 真正的 子域名
show_incidents 布尔 查询 查看事件
component_id_or_tag 字符串 路径 真正的 组件的ID或名称

代码示例

旋度
              
旋度https://status.亚博zendesk.com/api/components/{component_id_or_tag}/子组件?域{子域名}.亚博zendesk.com
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents?domain=mycompany&show_incidents=true”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents”newBuilderaddQueryParameter“域”“mycompany”addQueryParameter“show_incidents”“真正的”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置{方法“得到”url“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数{“域”“mycompany”“show_incidents”“真正的”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents?domain=mycompany&show_incidents=true”{“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents”uri查询URIencode_www_form“域”“mycompany”“show_incidents”“真正的”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“子组件”{“active_incidents”{“id”789“影响”“主要的”“名称””事件1”“started_at”“2018 - 01 - 19 t21:01:31.063z”“状态”“操作”“更新”{“created_at”“2018 - 01 - 19 t22:58:45.126z”“描述””事件更新”“id”123“incident_id”456“updated_at”“2018 - 01 - 19 t23:18:11.156z”}}“component_id”23“描述”“仪表盘”“id”24“名称”“仪表盘”“pod_id”1“标签”“仪表盘”}{“active_incidents”“component_id”23“描述”“聊天窗口小部件”“id”25“名称”“聊天窗口小部件”“pod_id”1“标签”“chat_widget”}{“active_incidents”“component_id”23“描述”“静态资产”“id”26“名称”“静态资产”“pod_id”1“标签”“static_assets”}{“active_incidents”“component_id”23“描述”“移动应用”“id”27“名称”“移动应用”“pod_id”1“标签”“mobile_apps”}{“active_incidents”“component_id”23“描述”“聊天SDK”“id”28“名称”“聊天SDK”“pod_id”1“标签”“chat_sdk”}{“active_incidents”“component_id”23“描述”“API”“id”30.“名称”“API”“pod_id”1“标签”“api”}{“active_incidents”“component_id”23“描述”“聊天对话API”“id”57“名称”“聊天对话API”“pod_id”1“标签”“chat_conversation_api”}}

显示子组件状态

  • GET / api /组件/ {component_id_or_tag} /子组件/ {subcomponent_id_or_tag} ?域={域}

弃用)使用子组件列表端点获取子组件的id或标记。

允许

  • 匿名用户

参数

名字 类型 要求 描述
字符串 查询 真正的 子域名
component_id_or_tag 字符串 路径 真正的 组件的ID或名称
subcomponent_id_or_tag 字符串 路径 真正的 子组件的ID或名称

代码示例

旋度
              
旋度https://status.亚博zendesk.com/api/components/{component_id_or_tag}/子组件?域{子域名}.亚博zendesk.com
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents/dashboard?domain=mycompany”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents/dashboard”newBuilderaddQueryParameter“域”“mycompany”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置{方法“得到”url“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents/dashboard”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数{“域”“mycompany”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents/dashboard?domain=mycompany”{“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/components/chat_widget/subcomponents/dashboard”uri查询URIencode_www_form“域”“mycompany”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“active_incidents”{“id”789“影响”“主要的”“名称””事件1”“started_at”“2018 - 01 - 19 t21:01:31.063z”“状态”“操作”“更新”{“created_at”“2018 - 01 - 19 t22:58:45.126z”“描述””事件更新”“id”123“incident_id”456“updated_at”“2018 - 01 - 19 t23:18:11.156z”}}“component_id”23“描述”“仪表盘”“id”24“名称”“仪表盘”“pod_id”1“标签”“仪表盘”}

列出正在发生的事故

  • GET / api /事件/活动

使用列出正在发生的事故端点获取所有活动事件。可选地通过附加子域过滤结果?子域名={子域名}

参数

名字 类型 要求 描述
子域名 字符串 查询 子域名

代码示例

旋度
              
旋度https://status.亚博zendesk.com/api/incidents/active
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/incidents/active?subdomain=mycompany”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/incidents/active”newBuilderaddQueryParameter“子域名”“mycompany”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置{方法“得到”url“https://support.亚博zendesk.com/api/incidents/active”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数{“子域名”“mycompany”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/incidents/active?subdomain=mycompany”{“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/incidents/active”uri查询URIencode_www_form“子域名”“mycompany”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“数据”{“属性”{“退化”“影响”“主要的”“停机”真正的“后期””““resolved_at”“started_at”“2022 - 05 - 11 - t19:56:49.000z”“状态”“调查”“标题”“大而坏的事件”}“id”“247”“关系”{“incident_services”{“数据”{“id”“5032”“类型”“incident_service”}{“id”“5033”“类型”“incident_service”}{“id”“5034”“类型”“incident_service”}}“incident_updates”{“数据”{“id”“7”“类型”“incident_update”}{“id”“8”“类型”“incident_update”}}}“类型”“事件”}“包括”{“属性”{“created_at”“2022 - 05 - 11 - t19:58:13.000z”“描述”“这是一个事件描述”}“id”“7”“类型”“incident_update”}{“属性”{“created_at”“2022 - 05 - 11 - t19:58:13.000z”“描述”“首次事故更新”}“id”“8”“类型”“incident_update”}{“属性”{“名称”“售票”“鼻涕虫”“support-ticketing”}“id”“2”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“resolved_at”“service_id”“2”“started_at”“2022 - 05 - 11 - t19:56:49.000z”}“id”“5052”“关系”{“服务”{“数据”{“id”“2”“类型”“服务”}}}“类型”“incident_service”}{“属性”{“名称”“API”“鼻涕虫”“support-api”}“id”“10”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“resolved_at”“service_id”“10”“started_at”“2022 - 05 - 11 - t19:56:49.000z”}“id”“5053”“关系”{“服务”{“数据”{“id”“10”“类型”“服务”}}}“类型”“incident_service”}{“属性”{“名称”“支持”“鼻涕虫”“支持”}“id”“1”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“resolved_at”“service_id”“1”“started_at”“2022 - 05 - 11 - t19:56:49.000z”}“id”“5054”“关系”{“服务”{“数据”{“id”“1”“类型”“服务”}}}“类型”“incident_service”}}

维修事故清单

  • GET / api /事件/维护

使用维修事故清单端点获取所有即将发生的维护事件。可选地通过附加子域过滤结果?子域名={子域名}

参数

名字 类型 要求 描述
子域名 字符串 查询 子域名

代码示例

旋度
              
旋度https://status.亚博zendesk.com/api/incidents/maintenance
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/incidents/maintenance?subdomain=mycompany”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/incidents/maintenance”newBuilderaddQueryParameter“子域名”“mycompany”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置{方法“得到”url“https://support.亚博zendesk.com/api/incidents/maintenance”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数{“子域名”“mycompany”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/incidents/maintenance?subdomain=mycompany”{“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/incidents/maintenance”uri查询URIencode_www_form“子域名”“mycompany”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“数据”{“属性”{“退化”“影响”“主要的”“maintenance_article””““maintenance_end_time”“2022 - 05 - 11 - t20:12:49.000z”“maintenance_start_time”“2022 - 05 - 11 - t19:56:49.000z”“停机”真正的“标题”“即将进行的定期维护”}“id”“247”“关系”{“incident_services”{“数据”{“id”“5032”“类型”“incident_service”}{“id”“5033”“类型”“incident_service”}{“id”“5034”“类型”“incident_service”}}“incident_updates”{“数据”{“id”“7”“类型”“incident_update”}{“id”“8”“类型”“incident_update”}}}“类型”“事件”}“包括”{“属性”{“created_at”“2022 - 05 - 11 - t19:58:13.000z”“描述”“这是维修说明”}“id”“7”“类型”“incident_update”}{“属性”{“created_at”“2022 - 05 - 11 - t19:58:13.000z”“描述”“首次维修更新”}“id”“8”“类型”“incident_update”}{“属性”{“名称”“售票”“鼻涕虫”“support-ticketing”}“id”“2”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“service_id”“2”}“id”“5052”“关系”{“服务”{“数据”{“id”“2”“类型”“服务”}}}“类型”“incident_service”}{“属性”{“名称”“API”“鼻涕虫”“support-api”}“id”“10”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“service_id”“10”}“id”“5053”“关系”{“服务”{“数据”{“id”“10”“类型”“服务”}}}“类型”“incident_service”}{“属性”{“名称”“支持”“鼻涕虫”“支持”}“id”“1”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“service_id”“1”}“id”“5054”“关系”{“服务”{“数据”{“id”“1”“类型”“服务”}}}“类型”“incident_service”}}

显示活动事件

  • GET / api /事件/ {incident_id}

使用显示活动事件端点通过其id获取活动事件。

可选地通过追加包括关联的记录?包括[]= {resource_types},在那里{resource_type}是以下一个或多个以逗号分隔的列表:

  • incident_update:包括事件更新详细信息。此信息也可以在亚博Zendesk状态页面
  • incident_services.service:包括有关哪些服务影响事件的信息。
  • incident_service:包括有关事件的产品级信息。通常用于incident_services.service

参数

名字 类型 要求 描述
包括 字符串 查询 可选的事件副负载
incident_id 字符串 路径 真正的 事件发生的原因

代码示例

旋度
              
旋度https://status.亚博zendesk.com/api/incidents/{incident_id}}?包括incident_services、incident_updates incident_services.service
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/incidents/247?includes=marklar”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=&http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttp*OkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://support.亚博zendesk.com/api/incidents/247”newBuilderaddQueryParameter“包括”“marklar”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置{方法“得到”url“https://support.亚博zendesk.com/api/incidents/247”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}参数个数{“包括”“marklar”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url“https://support.亚博zendesk.com/api/incidents/247?includes=marklar”{“内容类型”“application / json”}响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://support.亚博zendesk.com/api/incidents/247”uri查询URIencode_www_form“包括”“marklar”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“数据”{“属性”{“退化”“影响”“主要的”“停机”真正的“后期””““resolved_at”“started_at”“2022 - 05 - 11 - t19:56:49.000z”“状态”“调查”“标题”“大而坏的事件”}“id”“247”“关系”{“incident_services”{“数据”{“id”“5032”“类型”“incident_service”}{“id”“5033”“类型”“incident_service”}{“id”“5034”“类型”“incident_service”}}“incident_updates”{“数据”{“id”“7”“类型”“incident_update”}{“id”“8”“类型”“incident_update”}}}“类型”“事件”}“包括”{“属性”{“created_at”“2022 - 05 - 11 - t19:58:13.000z”“描述”“这是一个事件描述”}“id”“7”“类型”“incident_update”}{“属性”{“created_at”“2022 - 05 - 11 - t19:58:13.000z”“描述”“首次事故更新”}“id”“8”“类型”“incident_update”}{“属性”{“名称”“售票”“鼻涕虫”“support-ticketing”}“id”“2”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“resolved_at”“service_id”“2”“started_at”“2022 - 05 - 11 - t19:56:49.000z”}“id”“5052”“关系”{“服务”{“数据”{“id”“2”“类型”“服务”}}}“类型”“incident_service”}{“属性”{“名称”“API”“鼻涕虫”“support-api”}“id”“10”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“resolved_at”“service_id”“10”“started_at”“2022 - 05 - 11 - t19:56:49.000z”}“id”“5053”“关系”{“服务”{“数据”{“id”“10”“类型”“服务”}}}“类型”“incident_service”}{“属性”{“名称”“支持”“鼻涕虫”“支持”}“id”“1”“类型”“服务”}{“属性”{“退化”“incident_id”“247”“停机”真正的“resolved_at”“service_id”“1”“started_at”“2022 - 05 - 11 - t19:56:49.000z”}“id”“5054”“关系”{“服务”{“数据”{“id”“1”“类型”“服务”}}}“类型”“incident_service”}}