Obtaining an Add-on Instance

Function

This API is used to obtain the add-on instance.

URI

GET /v1/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
is_database_status	No	String	Whether to use the add-on status stored in the database
cluster_id	No	String	Cluster ID

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	Identity authentication information. 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.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
kind	String	API type. The value must be Addon.
apiVersion	String	API version. The value must be v3.
metadata	ObjectMeta object	Resource metadata
spec	AddonInstanceSpec object	Desired status of the add-on instance
status	AddonInstanceStatus object	Actual status of the add-on instance

**Table 5** ObjectMeta
Parameter	Type	Description
uid	String	Resource ID
name	String	Resource name
generateName	String	If no name is provided, the server uses the prefix to generate a unique name.
namespace	String	Namespace
labels	Map<String,String>	Label
annotations	Map<String,String>	Annotation
creationTimestamp	String	Creation time
updateTimestamp	String	Update time
resourceVersion	String	Internal version of a resource
generation	String	Generation of the desired resource state
managedFields	Array of ManagedFieldsEntry objects	Fields managed by workflows
ownerReferences	Array of OwnerReference objects	Ownership, dependencies, and garbage collection mechanism of objects. It supports resource management by the controller.

**Table 6** ManagedFieldsEntry
Parameter	Type	Description
manager	String	Manager name
operation	String	Operation type that causes this entry being created. The value can only be Apply or Update.
apiVersion	String	Resource API version used by a manager for defining fields
time	String	Timestamp when this entry was created or last updated
fieldsType	String	Field structure format. The value is fixed at "FieldsV1".
fieldsV1	Object	Information about the managed fields

**Table 7** OwnerReference
Parameter	Type	Description
apiVersion	String	API version of the referent
kind	String	Type of the referent
name	String	Name of the referent
uid	String	UID of the referent
controller	Boolean	If the value is true, this reference points to the controller that manages the resource.
blockOwnerDeletion	Boolean	If the value is true and the owner has a finalizer named foregroundDeletion, the owner cannot be deleted until this reference is removed.

**Table 8** AddonInstanceSpec
Parameter	Type	Description
clusterID	String	Cluster ID
version	String	Add-on version
addonTemplateName	String	Add-on template name
addonTemplateType	String	Add-on template type
addonTemplateLogo	String	Add-on template logo
addonTemplateLabels	Array of strings	Add-on template label
description	String	Description
values	Map<String,Object>	Add-on instance configuration parameters
parameters	ReleaseParams object	Release parameters
namespace	String	Namespace

**Table 9** ReleaseParams
Parameter	Type	Description
dry_run	Boolean	Whether to simulate only the installation process
replace	Boolean	Whether to allow the reuse of existing names
recreate	Boolean	Whether to forcibly recreate resources
no_hooks	Boolean	Whether hooks are forbidden
reset_values	Boolean	Used for resetting values during the update
name_template	String	Name template of the resources to be published
release_version	Integer	Source version for rollback
include_hooks	Boolean	Whether hooks are allowed during the update or deletion

**Table 10** AddonInstanceStatus
Parameter	Type	Description
status	String	Status
Reason	String	Reason for the change
message	String	Change details
targetVersions	Array of strings	Target version
currentVersion	AddonVersion object	Current version

**Table 11** AddonVersion
Parameter	Type	Description
id	String	Add-on package version ID
version	String	Add-on version
input	Map<String,Object>	Input
stable	Boolean	Whether the add-on version is a stable release
translate	Map<String,Object>	Translation information used by the GUI
supportVersions	Array of SupportVersion objects	Supported cluster types and versions
creationTimestamp	String	Record creation time
updateTimestamp	String	Record update time

**Table 12** SupportVersion
Parameter	Type	Description
category	String	Supported cluster types
clusterType	String	Supported cluster types (such as BareMetal, VirtualMachine, and Windows)
clusterVersion	Array of strings	Supported cluster versions (regular expressions are supported, for example, .* matches all cluster versions)

Status code: 400

**Table 13** Response body parameters
Parameter	Type	Description
-	String	-

Status code: 404

**Table 14** Response body parameters
Parameter	Type	Description
-	String	-

Status code: 500

**Table 15** Response body parameters
Parameter	Type	Description
-	String	-

Example Requests

None

Example Responses

Status code: 200

Add-on instance information returned

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "929633dc-2dae-4db7-84e4-a33c91370d53",
    "name" : "log-agent",
    "creationTimestamp" : "2025-10-15T09:03:57Z",
    "updateTimestamp" : "2025-10-15T09:04:24Z"
  },
  "spec" : {
    "clusterID" : "871bfe78-0528-4267-8a94-d19139210f80",
    "version" : "1.7.14",
    "addonTemplateName" : "log-agent",
    "addonTemplateType" : "helm",
    "addonTemplateLogo" : "",
    "addonTemplateLabels" : [ "Maintenance" ],
    "description" : "log-agent is a logging collector and forward center.",
    "parameters" : {
      "no_hooks" : false,
      "reset_values" : false,
      "name_template" : "",
      "release_version" : 0
    },
    "namespace" : "monitoring"
  },
  "status" : {
    "status" : "running",
    "Reason" : "",
    "message" : "",
    "targetVersions" : null,
    "currentVersion" : {
      "id" : "",
      "version" : "1.7.14",
      "stable" : true,
      "supportVersions" : null,
      "creationTimestamp" : "2025-09-17T07:59:47Z",
      "updateTimestamp" : "2025-09-17T07:59:47Z"
    }
  }
}

Status Codes

Status Code	Description
200	Add-on instance information returned
400	Client request error. The server could not execute the request.
404	Resources not found
500	Internal server error