获取AddonInstance详情
功能介绍
获取插件实例详情。
调用方法
请参见如何调用API。
URI
GET /api/v3/addons/{id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| id | 是 | String | 参数解释: 插件实例ID。 约束限制: 不涉及 取值范围: UUID格式,长度范围1~255位。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| cluster_id | 否 | String | 参数解释: 集群ID(废弃中),获取方式请参见如何获取接口URI中参数。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式),默认为application/json,有其他取值时会在具体接口中专门说明。 约束限制: GET方法不做校验 取值范围: 不涉及 默认取值: 不涉及 |
| X-Auth-Token | 是 | String | 参数解释: 调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| kind | String | 参数解释: API类型,固定值"Addon",该值不可修改。 取值范围: |
| apiVersion | String | 参数解释: API版本,固定值"v3",该值不可修改。 取值范围: |
| metadata | AddonMetadata object | 参数解释: 基本信息,为集合类的元素类型,包含一组由不同名称定义的属性 取值范围: 不涉及 |
| spec | InstanceSpec object | 参数解释: spec是集合类的元素类型,内容为插件实例具体信息,实例的详细描述主体部分都在spec中给出。 取值范围: 不涉及 |
| status | AddonInstanceStatus object | 参数解释: 插件实例状态信息。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| uid | String | 参数解释: 插件实例唯一ID标识,创建成功后系统自动生成。 取值范围: 不涉及 |
| name | String | 参数解释: 插件名称 取值范围: 不涉及 |
| alias | String | 参数解释: 插件别名。 取值范围: 不涉及 |
| labels | Map<String,String> | 参数解释: 插件标签,key/value对格式,接口保留字段,填写不会生效。 取值范围: 不涉及 |
| annotations | Map<String,String> | 参数解释: 插件注解,由key/value组成。 取值范围: |
| updateTimestamp | String | 参数解释: 更新时间 取值范围: 不涉及 |
| creationTimestamp | String | 参数解释: 创建时间,创建成功后系统自动生成,填写无效。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| clusterID | String | 参数解释: 集群ID 取值范围: 不涉及 |
| version | String | 参数解释: 插件模板版本号,如1.0.0。 取值范围: 不涉及 |
| addonTemplateName | String | 参数解释: 插件模板名称,如coredns。 取值范围: 不涉及 |
| addonTemplateType | String | 参数解释: 插件模板类型。 取值范围: |
| addonTemplateLogo | String | 参数解释: 插件模板logo图片的地址。 取值范围: 不涉及 |
| addonTemplateLabels | Array of strings | 参数解释: 插件模板所属类型。 取值范围: 不涉及 |
| description | String | 参数解释: 插件模板描述。 取值范围: 不涉及 |
| values | Map<String,Object> | 参数解释: 插件模板安装参数(各插件不同),请根据具体插件模板信息填写安装参数。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 插件实例状态。 取值范围: |
| Reason | String | 参数解释: 插件安装失败原因。 取值范围: 不涉及 |
| message | String | 参数解释: 安装错误详情。 取值范围: 不涉及 |
| targetVersions | Array of strings | 参数解释: 此插件版本,支持升级的集群版本。 取值范围: 不涉及 |
| currentVersion | Versions object | 参数解释: 当前插件实例使用的具体插件版本信息。 取值范围: 不涉及 |
| isRollbackable | Boolean | 参数解释: 是否支持回滚到插件升级前的插件版本。 取值范围: |
| previousVersion | String | 参数解释: 插件升级或回滚前的版本。 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| version | String | 参数解释: 插件版本号。 取值范围: 不涉及 |
| input | Object | 参数解释: 插件安装参数。 取值范围: 不涉及 |
| stable | Boolean | 参数解释: 是否为稳定版本。 取值范围: |
| translate | Object | 参数解释: 供界面使用的翻译信息。 取值范围: 不涉及 |
| supportVersions | Array of SupportVersions objects | 参数解释: 支持集群版本号。 取值范围: 不涉及 |
| creationTimestamp | String | 参数解释: 创建时间。 取值范围: 不涉及 |
| updateTimestamp | String | 参数解释: 更新时间。 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
表示获取插件实例详情成功。
{
"kind" : "Addon",
"apiVersion" : "v3",
"metadata" : {
"uid" : "24b23108-55c0-11e9-926f-0255ac101a31",
"name" : "gpu-beta",
"alias" : "gpu",
"creationTimestamp" : "2019-04-03T03:25:34Z",
"updateTimestamp" : "2019-04-03T03:25:34Z"
},
"spec" : {
"clusterID" : "0c0e4a63-5539-11e9-95f7-0255ac10177e",
"version" : "1.0.0",
"addonTemplateName" : "gpu-beta",
"addonTemplateType" : "helm",
"addonTemplateLogo" : "",
"addonTemplateLabels" : [ "Accelerator" ],
"description" : "A device plugin for nvidia.com/gpu resource on nvidia driver",
"values" : {
"basic" : {
"rbac_enabled" : true,
"swr_addr" : "100.125.6.246:20202",
"swr_user" : "hwofficial"
}
}
},
"status" : {
"status" : "installing",
"Reason" : "",
"message" : "",
"targetVersions" : null,
"currentVersion" : {
"version" : "1.0.0",
"input" : {
"basic" : {
"swr_addr" : "100.125.6.246:20202",
"swr_user" : "hwofficial"
},
"parameters" : { }
},
"stable" : true,
"translate" : {
"en_US" : {
"addon" : {
"changeLog" : "A device plugin for nvidia.com/gpu resource on nvidia driver",
"description" : "A device plugin for nvidia.com/gpu resource on nvidia driver"
}
},
"zh_CN" : {
"addon" : {
"changeLog" : "",
"description" : ""
}
}
},
"supportVersions" : null,
"creationTimestamp" : "2018-10-23T13:14:55Z",
"updateTimestamp" : "2018-12-07T09:40:24Z"
}
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示获取插件实例详情成功。 |
错误码
请参见错误码。