All Products
Search
Document Center

Container Service for Kubernetes:GetClusterAddonInstance

Last Updated:Apr 22, 2024

You can call the GetClusterAddonInstance operation to query the information of a component instance in a cluster, including the version, configurations, and log status of the component instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /clusters/{cluster_id}/addon_instances/{instance_name}

Request parameters

ParameterTypeRequiredDescriptionExample
cluster_idstringNo

The ID of the cluster.

c02b3e03be10643e8a644a843ffcb****
instance_namestringNo

The name of the component instance.

ack-node-problem-detector

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

namestring

The name of the component instance.

ack-node-problem-detector
statestring

The status of the component. Valid values:

  • active: The component is installed.
  • updating: The component is being modified.
  • upgrading: The component is being updated.
  • deleting: The component is being uninstalled.
active
versionstring

The version of the component instance.

1.2.16
configstring

The custom configurations of the component.

{"sls_project_name":""}
loggingobject

The status of Simple Log Service.

capableboolean

Indicates whether Simple Log Service is supported by the component.

false
enabledboolean

Indicates whether Simple Log Service is enabled for the component.

false
log_projectstring

The Simple Log Service project that is used to collect logs for the component.

my-log-project
logstorestring

The Simple Log Service Logstore that is used to collect logs for the component.

my-logstore

Examples

Sample success responses

JSONformat

{
  "name": "ack-node-problem-detector",
  "state": "active",
  "version": "1.2.16",
  "config": "{\"sls_project_name\":\"\"}",
  "logging": {
    "capable": false,
    "enabled": false,
    "log_project": "my-log-project",
    "logstore": "my-logstore"
  }
}

Error codes

For a list of error codes, visit the Service error codes.