查看系统错误码

GET/zstack/v1/errorcode/elaborations

操作 ID

GetElaborations

起始版本

3.3.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

查询参数

category
String
错误码的类别，指向资源或服务的类别，例如HOST
regex
String
错误码关键字
code
String
错误代码，与category一起使用
systemTags
List
系统标签
userTags
List
用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

error
ErrorCode必填
错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error
- code
  String必填
  错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001
- description
  String必填
  错误的概要描述
- details
  String必填
  错误的详细信息
- elaboration
  String必填
  保留字段，默认为null
- opaque
  LinkedHashMap必填
  保留字段，默认为null
- cause
  ErrorCode必填
  根错误，引发当前错误的源错误，若无原错误，该字段为null
contents
List必填
详情参考contents
- category
  String必填
  错误码所属目录
- code
  String必填
  错误码代号
- regex
  String必填
  错误码匹配关键字
- message_cn
  String必填
  错误码内容中文
- message_en
  String必填
  错误码内容英文
- source
  String必填
  错误来源
- method
  String必填
  匹配方法，distance(字符串比较)或regex(正则)
- distance
  Double必填
  若使用distance匹配，此处为精确度(1为最精确)

请求示例

转换警告

python: command should begin with "curl" but instead begins with "has" -X GET http://localhost:8080/zstack/v1/errorcode/elaborations?category=BS&regex=certificate has expired or is not yet valid ^^^
javascript: command should begin with "curl" but instead begins with "has" -X GET http://localhost:8080/zstack/v1/errorcode/elaborations?category=BS&regex=certificate has expired or is not yet valid ^^^
java: command should begin with "curl" but instead begins with "has" -X GET http://localhost:8080/zstack/v1/errorcode/elaborations?category=BS&regex=certificate has expired or is not yet valid ^^^
go: command should begin with "curl" but instead begins with "has" -X GET http://localhost:8080/zstack/v1/errorcode/elaborations?category=BS&regex=certificate has expired or is not yet valid ^^^

curl -X GET '{host}/zstack/v1/errorcode/elaborations?category={category}&regex={regex}&code={code}&systemTags={systemTags}&userTags={userTags}' \
  -H 'Authorization: Bearer {token}'

响应示例

{
  "contents": [
    {
      "category": "HOST",
      "code": "1003",
      "regex": "host[uuid:%s, name:%s] is in status[%s], cannot perform required operation",
      "message_cn": "物理机正处于[停止]状态，不能进行该操作",
      "message_en": "Host is in status[Stopped], cannot perform required operation",
      "source": "zstack",
      "method": "distance",
      "distance": 0
    }
  ]
}

云主机相关接口

云盘相关接口

镜像相关接口

亲和组相关接口

云主机调度策略相关接口

计算规格相关接口

云盘规格相关接口

弹性伸缩组相关接口

快照组相关接口

SSH密钥相关接口

区域相关接口

集群相关接口

物理机相关接口

GPU设备相关接口

主存储相关接口

镜像服务器相关接口

SAN存储相关接口

物理网络相关接口

PCI设备相关接口

USB重定向相关接口

USB透传相关接口

SR-IOV相关接口

龙芯SE模块相关接口

海光SE模块相关接口

本地存储相关接口

NFS主存储相关接口

Shared Mount Point主存储相关接口

Ceph主存储相关接口

Shared Block主存储相关接口

XStor Block主存储相关接口

镜像仓库服务器相关接口

Ceph镜像服务器相关接口

iSCSI服务器相关接口

FC存储相关接口

NVMe存储相关接口

SDN设备相关接口

二层网络资源相关接口

三层网络相关接口

路由资源相关接口

VPC相关接口

OSPF相关接口

组播路由相关接口

策略路由相关接口

路由器路由表相关接口

网络服务相关接口

防火墙相关接口

安全组相关接口

虚拟IP相关接口

弹性IP相关接口

端口转发相关接口

负载均衡相关接口

IPsec相关接口

Netflow相关接口

端口镜像相关接口

共享带宽相关接口

安全策略定时计划相关接口

资源编排相关接口

裸金属管理相关接口

安装服务相关接口

弹性裸金属管理(Plus)

vCenter相关接口

容量管理相关接口

管理节点相关接口

通知服务相关接口

时序数据（Metric）

事件（Event）

报警器（Alarm）

事件订阅（Event Subscription）

报警文本模板（Text Template）

审计

CBT相关接口

灾备服务相关接口

持续数据保护(CDP)相关接口

脚本库相关接口

XML Hook相关接口

定时运维相关接口

标签管理相关接口

迁移服务相关接口

组织架构相关接口

项目管理相关接口