Reading an Add-on Instance¶

Function¶

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

Note

The URL for add-on management is in the format of https://{clusterid}.Endpoint/uri. In the URL, {clusterid} indicates the cluster ID, and uri indicates the resource path, that is, the path for API access.

URI¶

GET /api/v3/addons/{id}?cluster_id={cluster_id}

Table 1 describes the parameters of this API.

**Table 1** Parameter description¶
Parameter	Mandatory	Type	Description
cluster_id	Yes	String	Cluster ID. For details about how to obtain the cluster ID, see How to Obtain Parameters in the API URI.
id	Yes	String	Add-on instance ID. For details about how to obtain the ID, see Table 4.

Request¶

Request parameters:

Table 2 lists the request parameters.

**Table 2** Parameters in the request header¶
Parameter	Mandatory	Description
Content-Type	Yes	Message body type (format). Default: application/json
X-Auth-Token	Yes	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 on how to obtain a user token, see API Usage Guidelines.

Example request:

N/A

Response¶

Response parameters:

For details about the response parameters, see Table 3.

**Table 3** Parameters in the response body¶
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	metadata object	Basic information about the add-on. Metadata is a collection of attributes.
spec	spec object	Detailed description of the add-on instance.
status	status object	Add-on instance status.

**Table 4** Data structure of the metadata field¶
Parameter	Type	Description
uid	String	Unique ID of the add-on instance.
name	String	Add-on name.
labels	Object	Add-on labels in the format of key-value pairs.
annotations	Object	Add-on annotations in the format of key-value pairs.
updateTimestamp	String	Time when the add-on instance was updated.
creationTimestamp	String	Time when the add-on instance was created.

**Table 5** Data structure of the spec field¶
Parameter	Type	Description
clusterID	String	Cluster ID.
version	String	Add-on template version, for example, v1.0.0.
addonTemplateName	String	Add-on template name, for example, coredns.
addonTemplateType	String	Add-on template type.
addonTemplateLabels	Array of strings	Group to which the add-on template belongs.
description	String	Add-on template description.
values	Object	Add-on template installation parameters. These parameters vary depending on the add-on.

**Table 6** Data structure of the status field¶
Parameter	Type	Description
status	String	Add-on instance status.
Reason	String	Cause why the system failed to read add-on instance details.
message	String	Installation error details.
targetVersions	Array of strings	Versions to which the current add-on version can be upgraded.
currentVersion	versions object	Current add-on version.

**Table 7** Data structure of the versions field¶
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. Note This field is not supported for the current version.
creationTimestamp	String	Time when the add-on instance was created.
updateTimestamp	String	Time when the add-on instance was updated.

**Table 8** Data structure of the supportVersions field¶
Parameter	Type	Description
clusterType	String	Cluster type that supports the add-on.
clusterVersion	Array of string	Cluster versions that support the add-on. The parameter value is a regular expression.

Example response:

{
    "kind": "Addon",
    "apiVersion": "v3",
    "metadata": {
        "uid": "24b23108-55c0-11e9-926f-0255ac101a31",
        "name": "gpu-beta",
        "creationTimestamp": "2019-04-03T03:25:34Z",
        "updateTimestamp": "2019-04-03T03:25:34Z"
    },
    "apiVersion": "v3",
    "kind": "Addon",
    "spec": {
        "addonTemplateName": "gpu-beta",
        "addonTemplateLogo": "",
        "addonTemplateType": "helm",
        "values": {
            "basic": {
                "rbac_enabled": true,
                "swr_user": "swr_test",
                "swr_addr": "10.125.6.246:20202"
            }
        },
        "description": "A device plugin for nvidia.com/gpu resource on nvidia driver",
        "addonTemplateLabels": [
            "Accelerator"
        ],
        "clusterID": "0c0e4a63-5539-11e9-95f7-0255ac10177e",
        "version": "1.0.0"
    },
    "status": {
        "message": "",
        "Reason": "",
        "currentVersion": {
            "input": {
                "basic": {
                    "swr_user": "swr_test",
                    "swr_addr": "10.125.6.246:20202"
                },
                "parameters": {}
            },
            "stable": true,
            "creationTimestamp": "2018-10-23T13:14:55Z",
            "version": "1.0.0",
            "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"
                    }
                }
            },
            "updateTimestamp": "2018-12-07T09:40:24Z"
        },
        "status": "installing"
    }
}

Status Codes¶

**Table 9** Status codes¶
Status Code	Description
200	OK
500	Internal Server Error

For the description about error status codes, see Status Code.

last updated: 2024-05-17 00:31