获取事件类型列表
功能介绍
获取事件类型列表接口用于获取训练管理中支持的事件类型列表。
该接口适用于以下场景：当用户需要了解训练管理中支持的事件类型，以便在创建或管理训练任务时进行相关配置时，可以通过此接口获取事件类型列表。使用该接口的前提条件是用户已登录且具有访问训练管理的权限。获取操作完成后，响应消息体中将包含所有支持的事件类型及其描述。若用户无权限访问或系统中无事件类型信息，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/training-event-categories
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
flavor_type |
否 |
String |
参数解释：规格类型 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
event-categories |
Array of EventCategoriesResp objects |
参数解释：事件类型。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释：事件类型id。 取值范围：枚举值如下：
|
|
name |
String |
参数解释：事件类型名称。 取值范围：不涉及。 |
|
description |
String |
参数解释：事件类型描述。 取值范围：不涉及。 |
|
notification |
Boolean |
参数解释：是否通知。 取值范围：
|
请求示例
无
响应示例
状态码：200
{
"event-categories" : [ {
"id" : "JobStarted",
"name" : "JobStarted",
"description" : "Job started.",
"notification" : true
}, {
"id" : "JobCompleted",
"name" : "JobCompleted",
"description" : "Job completed.",
"notification" : true
}, {
"id" : "JobFailed",
"name" : "JobFailed",
"description" : "Job failed.",
"notification" : true
}, {
"id" : "JobTerminated",
"name" : "JobTerminated",
"description" : "Job terminated.",
"notification" : false
}, {
"id" : "JobRestarted",
"name" : "JobRestarted",
"description" : "Job restarted.",
"notification" : false
}, {
"id" : "JobHanged",
"name" : "JobHanged",
"description" : "Job hanged.",
"notification" : true
}, {
"id" : "JobPreempted",
"name" : "JobPreempted",
"description" : "Job preempted.",
"notification" : false
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
错误码
请参见错误码。
