Querying an Add-on Instance

Function

This API is used to obtain details about an add-on instance.

URI

GET /api/v3/addons/{id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Add-on instance ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cluster_id	No	String	Cluster ID (deprecated). For details about how to obtain the cluster ID, see How Do I Obtain Parameters in the API URI.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
kind	String	API type. The value is fixed at Addon and cannot be changed.
apiVersion	String	API version. The value is fixed at v3 and cannot be changed.
metadata	AddonMetadata object	Basic information about the object. Metadata is a collection of attributes.
spec	InstanceSpec object	Detailed description of the add-on instance.
status	AddonInstanceStatus object	Add-on instance status.

**Table 5** AddonMetadata
Parameter	Type	Description
uid	String	Unique ID
name	String	Add-on name
alias	String	Add-on alias
labels	Map<String,String>	Add-on labels in key-value pairs. This is a reserved field and does not take effect.
annotations	Map<String,String>	Add-on annotations in the format of key-value pairs. For add-on installation, the value is fixed at {"addon.install/type":"install"}. For add-on upgrade, the value is fixed at {"addon.upgrade/type":"upgrade"}.
updateTimestamp	String	Updated at
creationTimestamp	String	Created at

**Table 6** InstanceSpec
Parameter	Type	Description
clusterID	String	Cluster ID.
version	String	Add-on template version, for example, 1.0.0.
addonTemplateName	String	Add-on template name, for example, coredns.
addonTemplateType	String	Add-on template type.
addonTemplateLogo	String	URL for obtaining the add-on template logo.
addonTemplateLabels	Array of strings	Labels of the add-on template.
description	String	Add-on template description.
values	Map<String,Object>	Add-on template installation parameters (varying depending on the add-on). Set the parameters accordingly.

**Table 7** AddonInstanceStatus
Parameter	Type	Description
status	String	Statuses of add-on instances. Options: running: All of the add-on instances are running and the add-on is running properly. abnormal: The add-on instances are abnormal and the add-on cannot be used. Click the add-on name to view exceptions. installing: The add-on is being installed. installFailed: Installing the add-on failed. In this case, uninstall the add-on and then reinstall it. upgrading: The add-on is being upgraded. upgradeFailed: Upgrading the add-on failed. In this case, upgrade the add-on again or uninstall the add-on and reinstall it. deleting: The add-on is being deleted. deleteFailed: Deleting the add-on failed. In this case, uninstall the add-on again. deleteSuccess: Deleting the add-on succeeded. available: Only some instances of the add-on are running. This indicates that some functions of the add-on are available. rollbacking: The add-on is being rolled back. rollbackFailed: Rolling back the add-on failed. In this case, roll back the add-on again or uninstall the add-on and reinstall it. unknown: The add-on chart instance does not exist.
Reason	String	Cause of the add-on installation failure.
message	String	Installation error details.
targetVersions	Array of strings	Versions to which the current add-on version can be upgraded.
currentVersion	Versions object	Information about the current add-on version.
isRollbackable	Boolean	Whether the add-on version can be rolled back to the source version.
previousVersion	String	The add-on version before upgrade or rollback

**Table 8** Versions
Parameter	Type	Description
version	String	Add-on version.
input	Object	Add-on installation parameters.
stable	Boolean	Whether the add-on version is a stable release.
translate	Object	Translation information used by the GUI.
supportVersions	Array of SupportVersions objects	Cluster versions that support the add-on.
creationTimestamp	String	Creation time.
updateTimestamp	String	Update time.

**Table 9** SupportVersions
Parameter	Type	Description
clusterType	String	Cluster type that supports the add-on.
clusterVersion	Array of strings	Cluster versions that support the add-on. The value is a regular expression.

Example Requests

None

Example Responses

Status code: 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"
    }
  }
}