All Products
Search
Document Center

Container Service for Kubernetes:DescribeClusterAddonInstance

Last Updated:Feb 21, 2024

You can call the DescribeClusterAddonInstance operation to query the information about a cluster component, including the version, status, and configuration of the component.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeClusterAddonInstanceRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

GET /clusters/{ClusterID}/components/{AddonName}/instance

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIDstringNo

The ID of the cluster.

cd06bbf8a86764a31bcac76136691****
AddonNamestringNo

The name of the component.

terway-eniip

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

namestring

The name of the component.

terway-eniip
versionstring

The version of the component.

v1.4.3
statestring

The status of the component. Valid values:

  • initial: The component is being installed.
  • active: The component is installed.
  • unhealthy: The component is in an abnormal state.
  • upgrading: The component is being updated.
  • updating: The component is being modified.
  • deleting: The component is being uninstalled.
  • deleted: The component is deleted.
active
configstring

The configuration of the component.

{"NetworkPolicy":"true"}

Examples

Sample success responses

JSONformat

{
  "name": "terway-eniip",
  "version": "v1.4.3",
  "state": "active",
  "config": "{\"NetworkPolicy\":\"true\"}"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-01-12The API operation is deprecatedsee changesets
Change itemChange content
API Deprecation DescriptionThe API operation is deprecated.
2023-04-17The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.