現在このページは英語のみ対応しており、日本語は準備中です。今しばらくお待ちください。

DescribeClusterAttachScripts

更新日時2025-03-28 02:33
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the scripts used to add existing nodes to a Container Service for Kubernetes (ACK) cluster. ACK allows you to manually add existing Elastic Compute Service (ECS) instances to an ACK cluster as worker nodes or re-add worker nodes that you remove from the cluster to a node pool.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
OperationAccess levelResource typeCondition keyAssociated operation
cs:DescribeClusterAttachScriptsupdate
*Cluster
acs:cs:{#regionId}:{#accountId}:cluster/{#ClusterId}
    none
none

Request syntax

POST /clusters/{ClusterId}/attachscript HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The cluster ID.

ca375a93a30474552ad2a0ebe183e****
bodyobjectNo

The request body.

nodepool_idstringNo

The ID of the node pool to which you want to add an existing node.

Note
If you do not specify a node pool ID, the node is added to the default node pool.
np1c9229d9be2d432c93f77a88fca0****
format_diskbooleanNo

Specifies whether to mount data disks to an existing instance when you manually add this instance to the cluster. You can use data disks to store container data and images. Valid values:

  • true: mounts data disks to the instance that you want to add. After a data disk is mounted, the original data on the disk is erased. Back up data before you mount a data disk.
  • false: does not mount data disks to the instance.

Default value: false.

How a data disk is mounted:

  • If the Elastic Compute Service (ECS) instances are already mounted with data disks and the file system of the last data disk is uninitialized, the system automatically formats this data disk to ext4 and uses the disk to store the data in the /var/lib/docker and /var/lib/kubelet directories.
  • If no data disk is mounted to the ECS instance, the system does not purchase a new data disk.
false
keep_instance_namebooleanNo

Specifies whether to retain the name of an existing instance when it is added to the cluster. If you do not retain the instance name, the instance is renamed in the worker-k8s-for-cs-<clusterid> format. Valid values:

  • true: retains the instance name.
  • false: does not retain the instance name.

Default value: true.

true
rds_instancesarrayNo

A list of ApsaraDB RDS instances. ECS instances in the cluster are automatically added to the whitelist of the ApsaraDB RDS instances.

stringNo

The name of the ApsaraDB RDS instance.

rm-xxx
archstringNo

The CPU architecture of the node. Valid values: amd64, arm, and arm64.

Default value: amd64.

Note
This parameter is required if you want to add a node to an ACK Edge cluster.
amd64
optionsstringNo

The node configurations for the node that you want to add.

Note
This parameter is required if you want to add a node to an ACK Edge cluster.
{\"enableIptables\": true,\"manageRuntime\": true,\"quiet\": true,\"allowedClusterAddons\": [\"kube-proxy\",\"flannel\",\"coredns\"]}
expiredlongNo

The expiration time of the token that is generated. The value is a UNIX timestamp. For example, a value of 1739980800 indicates 00:00:00 (UTC+8) on February 20, 2025.

1740037333

Response parameters

ParameterTypeDescriptionExample
ParameterTypeDescriptionExample
string

The returned script that is used to add nodes to the cluster.

wget http://***.oss-cn-hangzhou.aliyuncs.com/***

Examples

Sample success responses

JSONformat

"wget http://***.oss-cn-hangzhou.aliyuncs.com/***"

Error codes

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

Change history

Change timeSummary of changesOperation
Change timeSummary of changesOperation
2025-02-20The internal configuration of the API is changed, but the call is not affectedView Change Details
2024-11-25The internal configuration of the API is changed, but the call is not affectedView Change Details
  • 目次 (1)
  • Debugging
  • Authorization information
  • Request syntax
  • Request parameters
  • Response parameters
  • Examples
  • Error codes
  • Change history
フィードバック
phone お問い合わせ

Chat now with Alibaba Cloud Customer Service to assist you in finding the right products and services to meet your needs.

alicare alicarealicarealicare