# 获取插件模板列表 - ListAddonTemplates
#### 功能介绍
获取插件模板列表
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ucs/ucs_api_0026.html)。
#### URI
GET /v1/addontemplates
表1Query参数 
| 参数                        | 是否必选 | 参数类型   | 描述             |
|:---|:---|:---|:---|
| version                   | 否    | String | 插件包版本号         |
| newest                    | 否    | String | 是否获取集群内创建的最新状态 |
| cluster_id                | 否    | String | 集群id           |
| addon_template_name       | 否    | String | 插件模板名称         |
| base_update_addon_version | 否    | String | 插件的最低版本        |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                              |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | 身份认证信息，调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值 |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数         | 参数类型                                                                          | 描述     |
|:---|:---|:---|
| kind       | String                                                                        | API类型  |
| apiVersion | String                                                                        | API版本  |
| items      | Array of [AddonTemplate] objects | 插件模板列表 |
   
 表4AddonTemplate 
| 参数         | 参数类型                                                                        | 描述        |
|:---|:---|:---|
| kind       | String                                                                      | API类型     |
| apiVersion | String                                                                      | API版本     |
| metadata   | [AddonObjectMeta] object     | 资源元数据     |
| spec       | [AddonTemplateSpec] object | 插件模板的期望状态 |
   
 表5AddonObjectMeta 
| 参数                | 参数类型                 | 描述    |
|:---|:---|:---|
| uid               | String               | 唯一标识符 |
| name              | String               | 对象的名称 |
| labels            | Map\<String,String\> | 对象的标签 |
| annotations       | Map\<String,String\> | 对象的注解 |
| creationTimestamp | String               | 创建时间  |
| updateTimestamp   | String               | 更新时间  |
   
 表6AddonTemplateSpec 
| 参数          | 参数类型                                                                        | 描述                        |
|:---|:---|:---|
| type        | String                                                                      | 插件的安装类型，支持helm安装或static安装 |
| require     | Boolean                                                                     | 该插件是否为必装                  |
| labels      | Array of strings                                                            | 插件的标签列表                   |
| logoURL     | String                                                                      | Logo链接                    |
| readmeURL   | String                                                                      | README文档链接                |
| description | String                                                                      | 描述信息                      |
| versions    | Array of [AddonVersion] objects | 插件的版本列表                   |
   
 表7AddonVersion 
| 参数                | 参数类型                                                                            | 描述                 |
|:---|:---|:---|
| id                | String                                                                          | 插件包版本id            |
| version           | String                                                                          | 插件版本信息             |
| input             | Map\<String,Object\>                                                            | 输入                 |
| stable            | Boolean                                                                         | 是否为稳定版本            |
| translate         | Map\<String,Object\>                                                            | 供界面使用的翻译信息         |
| supportVersions   | Array of [SupportVersion] objects | 支持的集群类型和和支持的集群版本信息 |
| creationTimestamp | String                                                                          | 记录创建时间             |
| updateTimestamp   | String                                                                          | 记录更新时间             |
   
 表8SupportVersion 
| 参数             | 参数类型             | 描述                                         |
|:---|:---|:---|
| category       | String           | 支持的集群类型                                    |
| clusterType    | String           | 支持的集群类型（BareMetal，VirtualMachine，windows等） |
| clusterVersion | Array of strings | 支持的集群版本，支持正则表达式，如".\*"匹配所有集群版本             |
   
**状态码：400**
表9响应Body参数 
| 参数 | 参数类型   | 描述 |
|:---|:---|:---|
| -  | String | -  |
   
**状态码：404**
表10响应Body参数 
| 参数 | 参数类型   | 描述 |
|:---|:---|:---|
| -  | String | -  |
   
**状态码：500**
表11响应Body参数 
| 参数 | 参数类型   | 描述 |
|:---|:---|:---|
| -  | String | -  |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
返回插件模板列表
```
{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "Addon",
    "apiVersion" : "v3",
    "metadata" : {
      "uid" : "swr-kritis",
      "name" : "swr-kritis",
      "creationTimestamp" : "2021-06-07T03:08:19Z",
      "updateTimestamp" : "2021-07-22T06:12:30Z"
    },
    "spec" : {
      "type" : "helm",
      "labels" : [ "Maintenance" ],
      "description" : "A component",
      "versions" : [ {
        "version" : "1.0.1",
        "input" : {
          "basic" : {
            "image_version" : "1.0.1",
            "platform" : "linux-amd64",
            "swr_addr" : "100.79.1.215:20202",
            "swr_user" : "hwofficial"
          },
          "parameters" : {
            "custom" : {
              "kms" : {
                "key_id" : "291bb3b7-c57f-45fb-8690-66f68a06de58,291bb3b7-c57f-45fb-8690-66f68a06de58"
              },
              "verify_images" : "niuwz2-asm4a4-cer.swr.myhuaweicloud.com/test/*:*,niuwz2-asm4a4-cer.swr.myhuaweicloud.com/test2/*:*"
            },
            "flavor1" : {
              "description" : "Has only one instance",
              "name" : "Single",
              "replicas" : 1,
              "resources" : [ {
                "limitsCpu" : "2000m",
                "limitsMem" : "256Mi",
                "name" : "swr-kritis",
                "requestsCpu" : "200m",
                "requestsMem" : "64Mi"
              } ]
            }
          }
        },
        "stable" : true,
        "translate" : {
          "en_US" : {
            "addon" : {
              "changeLog" : "add kritis",
              "description" : "kritis plugin, signature"
            },
            "description" : {
              "Parameters.custom.kms.keyid" : "kms of key id, 291bb3b7-c57f-45fb-8690-66f68a06de58,391aa321-az72-3fab-4680-12f58c1645g6",
              "Parameters.custom.verifyimages" : "verify signature of the blacklist, test-asm4a4-cer.swr.myhuaweicloud.com/test/*:*,test-asm4a4-cer.swr.myhuaweicloud.com/test2/*:*"
            }
          },
          "zh_CN" : {
            "addon" : {
              "changeLog" : "新增kritis",
              "description" : "kritis插件，验签机制"
            },
            "description" : {
              "Parameters.custom.kms.keyid.d" : "kms签名的秘钥ID，格式：291bb3b7-c57f-45fb-8690-66f68a06de58,391aa321-az72-3fab-4680-12f58c1645g6",
              "Parameters.custom.verifyimages" : "需要验签的黑名单，格式：test-asm4a4-cer.swr.myhuaweicloud.com/test/*:*,test-asm4a4-cer.swr.myhuaweicloud.com/test2/*:*"
            }
          }
        },
        "supportVersions" : [ {
          "clusterType" : "VirtualMachine",
          "clusterVersion" : [ "v1.(15|17|19).*" ]
        }, {
          "clusterType" : "ARM64",
          "clusterVersion" : [ "v1.(15).*" ]
        } ],
        "creationTimestamp" : "2021-06-08T14:02:02Z",
        "updateTimestamp" : "2021-06-09T12:29:07Z"
      } ]
    }
  } ]
}
```
#### 状态码
| 状态码 | 描述                |
|:---|:---|
| 200 | 返回插件模板列表          |
| 400 | 客户端请求错误，服务器无法执行请求 |
| 404 | 资源不存在             |
| 500 | 服务器内部错误           |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ucs/ErrorCode.html)。