All Products
Search
Document Center

Container Service for Kubernetes:DescribeClusterAddonsVersion

Last Updated:Feb 29, 2024

You can call the DescribeClusterAddonsVersion operation to query the details about all components in a cluster by cluster ID.

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:Queryk8sComponentsUpdateVersionRead
  • Cluster
    acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

GET /clusters/{ClusterId}/components/version

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

c82e6987e2961451182edacd74faf****

Response parameters

ParameterTypeDescriptionExample
object

The response body.

object

The details of the component.

component_namestring

The component name.

ack-node-problem-detector
versionstring

The current version of the component.

Note If the value of version is not empty, it indicates that the component is installed.
1.2.1
next_versionstring

The version to which the component can be updated.

1.2.1
changedstring

Indicates whether the component is updated. Valid values:

  • true: The component is updated.
  • false: The component is not updated.
false
can_upgradeboolean

Indicates whether the component is updatable. Valid values:

  • true: The component is updatable.
  • false: The component is not updatable.
false
policystring

The update policy of the component.

  • overwrite: The component configurations of the later version overwrite those of the current version.

Default value: overwrite.

overwrite
ready_to_upgradestring

Indicates whether the component meets the update conditions. Valid values:

  • true: The component meets the update conditions.
  • false: The component does not meet the update conditions.
false
existboolean

Indicates whether the component can be installed in the specified ACK cluster. Valid values:

  • true: The component can be installed in the cluster.
  • false: The component cannot be installed in the cluster.
true
requiredboolean

Indicates whether the component is required in the cluster. Valid values:

  • true: The component is required in the cluster.
  • false: The component is not required in the cluster.
false
messagestring

Additional information about whether the component is updatable.

Addons that detect node failures and report to event center.
valuestring

The custom parameters. When you install a component, you can customize parameters for the component.

npd:\n # Custom monitor definitions to add to Node Problem Detector ****

Examples

Sample success responses

JSONformat

{
  "key": {
    "component_name": "ack-node-problem-detector",
    "version": "1.2.1",
    "next_version": "1.2.1",
    "changed": "false",
    "can_upgrade": false,
    "policy": "overwrite",
    "ready_to_upgrade": "false",
    "exist": true,
    "required": false,
    "message": "Addons that detect node failures and report to event center.\n",
    "value": "npd:\\n  # Custom monitor definitions to add to Node Problem Detector ****"
  }
}

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.