查询插件模板
功能介绍
查询插件模板接口用于获取指定插件模板的详细信息。该接口适用于以下场景：当需要了解特定插件模板的配置、功能或使用方式时，用户可通过此接口查询插件模板的详细信息。使用该接口的前提条件是插件模板已存在且用户具有访问权限。查询操作完成后，用户将获得指定插件模板的详细信息，包括模板的配置参数、功能描述等，便于后续的插件开发或配置管理。若插件模板不存在或用户无权限访问，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/plugintemplates/{plugintemplate_name}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
|
plugintemplate_name |
是 |
String |
参数解释：插件模板的名称。 约束限制：不涉及。 取值范围：可选值如下：
默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数解释：API版本。 取值范围：可选值如下：
|
|
kind |
String |
参数解释：资源类型。 取值范围：可选值如下：
|
|
metadata |
PluginTemplateMetadata object |
参数解释：插件模板的metadata信息。 |
|
spec |
PluginTemplateSpec object |
参数解释：插件模板的规格信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释：插件模板的名称。 取值范围：不涉及。 |
|
annotations |
Map<String,String> |
参数解释：插件模板注解，由key/value组成。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
type |
String |
参数解释：插件模板类型。 取值范围：可选值如下：
|
|
description |
String |
参数解释：插件模板描述。 取值范围：不涉及。 |
|
versions |
Map<String,PluginTemplateVersionV2> |
参数解释：插件模板版本描述信息。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
version |
String |
参数解释：插件模板的版本号。 取值范围：不涉及。 |
|
creationtimestamp |
String |
参数解释：创建时间。 取值范围：不涉及。 |
|
inputs |
Object |
参数解释：插件安装参数。 |
|
translate |
Object |
参数解释：供界面使用的翻译信息。 |
|
description |
String |
参数解释：版本描述信息。 取值范围：不涉及。 |
|
detail |
String |
参数解释：版本描述信息。 取值范围：不涉及。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释：ModelArts错误码。 取值范围：不涉及。 |
|
error_msg |
String |
参数解释：具体错误信息。 取值范围：不涉及。 |
请求示例
GET https://{endpoint}/v1/{project_id}/plugintemplates/{plugintemplate_name}
响应示例
状态码：200
OK。
{
"apiVersion" : "v1",
"kind" : "PluginTemplate",
"metadata" : {
"name" : "npu-driver"
},
"spec" : {
"type" : "npuDriver",
"description" : "npu driver",
"versions" : { }
}
}
状态码：404
Not Found。
{
"error_code" : "ModelArts.50005101",
"error_msg" : "Plugintemplate {name} not found."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK。 |
|
404 |
Not Found。 |
错误码
请参见错误码。
