diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/cs/2015-12-15/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/cs/2015-12-15/api-docs.php')
| -rw-r--r-- | data/zh_cn/cs/2015-12-15/api-docs.php | 29348 |
1 files changed, 29348 insertions, 0 deletions
diff --git a/data/zh_cn/cs/2015-12-15/api-docs.php b/data/zh_cn/cs/2015-12-15/api-docs.php new file mode 100644 index 0000000..32a182a --- /dev/null +++ b/data/zh_cn/cs/2015-12-15/api-docs.php @@ -0,0 +1,29348 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'CS', + 'version' => '2015-12-15', + ], + 'directories' => [ + 'OpenAckService', + 'DescribeRegions', + [ + 'id' => 159670, + 'title' => '集群', + 'type' => 'directory', + 'children' => [ + 'CreateCluster', + 'DeleteCluster', + 'ModifyCluster', + 'UpgradeCluster', + 'DescribeClustersV1', + 'DescribeClustersForRegion', + 'DescribeClusterDetail', + 'DescribeClusterResources', + 'DescribeKubernetesVersionMetadata', + 'DescribeUserClusterNamespaces', + 'DescribeClusterLogs', + 'DescribeUserQuota', + 'MigrateCluster', + 'DescribeClusterUserKubeconfig', + 'DescribeSubaccountK8sClusterUserConfig', + 'ListUserKubeConfigStates', + 'ListClusterKubeconfigStates', + 'UpdateK8sClusterUserConfigExpire', + 'RevokeK8sClusterKubeConfig', + 'CleanClusterUserPermissions', + 'CleanUserPermissions', + ], + ], + [ + 'id' => 159698, + 'title' => '节点池', + 'type' => 'directory', + 'children' => [ + 'CreateClusterNodePool', + 'DeleteClusterNodepool', + 'DescribeClusterNodePoolDetail', + 'DescribeClusterNodePools', + 'DescribeNodePoolVuls', + 'ModifyClusterNodePool', + 'ScaleClusterNodePool', + 'AttachInstancesToNodePool', + 'RemoveNodePoolNodes', + 'UpgradeClusterNodepool', + 'RepairClusterNodePool', + 'FixNodePoolVuls', + 'ModifyNodePoolNodeConfig', + 'SyncClusterNodePool', + 'DescribeClusterAttachScripts', + 'CreateAutoscalingConfig', + ], + ], + [ + 'id' => 159692, + 'title' => '节点', + 'type' => 'directory', + 'children' => [ + 'DescribeClusterNodes', + 'DeleteClusterNodes', + 'AttachInstances', + ], + ], + [ + 'id' => 159734, + 'title' => '组件', + 'type' => 'directory', + 'children' => [ + 'InstallClusterAddons', + 'UnInstallClusterAddons', + 'ListAddons', + 'ListClusterAddonInstances', + 'GetClusterAddonInstance', + 'DescribeAddon', + 'ModifyClusterAddon', + 'UpgradeClusterAddons', + 'ListClusterAddonInstanceResources', + ], + ], + [ + 'id' => 159660, + 'title' => '权限', + 'type' => 'directory', + 'children' => [ + 'DescribeUserPermission', + 'GrantPermissions', + 'UpdateUserPermissions', + 'CheckServiceRole', + ], + ], + [ + 'id' => 159706, + 'title' => '安全', + 'type' => 'directory', + 'children' => [ + 'ScanClusterVuls', + 'DescribeClusterVuls', + 'UpdateResourcesDeleteProtection', + 'DescribeResourcesDeleteProtection', + 'DeployPolicyInstance', + 'ModifyPolicyInstance', + 'DeletePolicyInstance', + 'DescribePolicies', + 'DescribePolicyDetails', + 'DescribePolicyGovernanceInCluster', + 'DescribePolicyInstances', + 'DescribePolicyInstancesStatus', + ], + ], + [ + 'id' => 204201, + 'title' => '集群检查/巡检/诊断', + 'type' => 'directory', + 'children' => [ + 'RunClusterCheck', + 'ListClusterChecks', + 'GetClusterCheck', + 'CreateClusterInspectConfig', + 'UpdateClusterInspectConfig', + 'GetClusterInspectConfig', + 'RunClusterInspect', + 'ListClusterInspectReports', + 'GetClusterInspectReportDetail', + 'DeleteClusterInspectConfig', + 'CreateClusterDiagnosis', + 'GetClusterDiagnosisResult', + 'GetClusterDiagnosisCheckItems', + ], + ], + [ + 'id' => 159720, + 'title' => '编排模版', + 'type' => 'directory', + 'children' => [ + 'CreateTemplate', + 'DescribeTemplateAttribute', + 'DescribeTemplates', + 'UpdateTemplate', + 'DeleteTemplate', + ], + ], + [ + 'id' => 159726, + 'title' => '触发器', + 'type' => 'directory', + 'children' => [ + 'CreateTrigger', + 'DeleteTrigger', + 'DescribeTrigger', + ], + ], + [ + 'id' => 159745, + 'title' => '标签', + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + 'ModifyClusterTags', + ], + ], + [ + 'id' => 159654, + 'title' => '报警', + 'type' => 'directory', + 'children' => [ + 'StartAlert', + 'UpdateContactGroupForAlert', + 'StopAlert', + 'DeleteAlertContact', + 'DeleteAlertContactGroup', + ], + ], + [ + 'id' => 188651, + 'title' => '日志', + 'type' => 'directory', + 'children' => [ + 'UpdateControlPlaneLog', + 'CheckControlPlaneLogEnable', + 'GetClusterAuditProject', + 'UpdateClusterAuditLogConfig', + ], + ], + [ + 'id' => 159652, + 'title' => '事件', + 'type' => 'directory', + 'children' => [ + 'DescribeEventsForRegion', + 'DescribeEvents', + 'DescribeClusterEvents', + ], + ], + [ + 'id' => 187251, + 'title' => '任务', + 'type' => 'directory', + 'children' => [ + 'DescribeTaskInfo', + 'PauseTask', + 'ResumeTask', + 'CancelTask', + 'DescribeClusterTasks', + ], + ], + [ + 'id' => 208849, + 'title' => '运维计划', + 'type' => 'directory', + 'children' => [ + 'ListOperationPlansForRegion', + 'ListOperationPlans', + 'CancelOperationPlan', + ], + ], + [ + 'id' => 187255, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'GetUpgradeStatus', + 'PauseClusterUpgrade', + 'CancelClusterUpgrade', + 'ResumeUpgradeCluster', + 'DescribeAddons', + 'DescribeClusterAddonsVersion', + 'DescribeClusterAddonInstance', + 'DescribeClusterAddonMetadata', + 'DescribeClusterAddonsUpgradeStatus', + 'UpdateNodePoolComponent', + 'InstallNodePoolComponents', + ], + ], + [ + 'id' => 188712, + 'title' => '废弃', + 'type' => 'directory', + 'children' => [ + 'DescribeExternalAgent', + 'CreateKubernetesTrigger', + 'ResumeComponentUpgrade', + 'PauseComponentUpgrade', + 'GetKubernetesTrigger', + 'DescribeClusters', + 'DescribeClusterV2UserKubeconfig', + 'DescribeClusterAddonUpgradeStatus', + 'CancelComponentUpgrade', + 'DeleteKubernetesTrigger', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'CreateAutoRepairPolicy', + 'DeleteAutoRepairPolicy', + 'ModifyAutoRepairPolicy', + 'DescribeAutoRepairPolicy', + 'ListAutoRepairPolicies', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'DiskInit' => [ + 'title' => '块设备初始化配置', + 'description' => '块设备初始化配置', + 'type' => 'object', + 'properties' => [ + 'disk_name' => [ + 'title' => '唯一标识该节点池中的一块盘。'."\n" + .'- 当local_disk为false时，必须与scaling_group.data_disks中的某一个disk_name匹配；'."\n" + .'- 当local_disk为true时，必须与scaling_group.data_disks中的任意disk_name不同。', + 'type' => 'string', + 'required' => true, + 'example' => 'disk0', + ], + 'mkfs_type' => [ + 'title' => '自动格式化文件系统的类型。留空表示不格式化。', + 'type' => 'string', + 'example' => 'ext4', + ], + 'mount_target' => [ + 'title' => '挂载目录，留空则不挂载。', + 'type' => 'string', + 'example' => '/mnt/disk0', + ], + 'mount_for_runtime' => [ + 'title' => '容器运行时数据存储到该盘。', + 'type' => 'boolean', + ], + 'local_disk' => [ + 'title' => '该配置为本地盘的配置。设置为true时'."\n" + .'- 通过ECS DiskName和符号链接匹配不上时，可匹配本地盘，'."\n" + .'- 开机时若检测到未初始化则会重新初始化，'."\n" + .'- 要求mount_target和mkfs_type必须同时设置或不设置。'."\n" + .'- 当和mount_for_runtime组合使用时，若本地盘重新初始化，该节点需要移出再重新导入节点池。', + 'type' => 'boolean', + ], + ], + ], + 'Hugepage' => [ + 'type' => 'object', + 'properties' => [ + 'transparentEnabled' => [ + 'title' => '', + 'type' => 'string', + ], + 'transparentDefrag' => [ + 'type' => 'string', + ], + 'khugepagedDefrag' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'khugepagedAllocSleepMillisecs' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'khugepagedScanSleepMillisecs' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'khugepagedPagesToScan' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'InstanceMetadataOptions' => [ + 'description' => 'ECS 实例元数据访问配置。', + 'type' => 'object', + 'properties' => [ + 'http_tokens' => [ + 'title' => '该参数目前仅白名单开放，如需使用，请提交工单申请。'."\n" + .'访问实例元数据时是否强制使用加固模式。取值范围：'."\n" + .'optional：不强制使用。'."\n" + .'required：强制使用（IMDSv2）。设置该取值后，普通模式无法访问实例元数据。'."\n" + .'默认值：optional。', + 'description' => 'ECS 实例元数据访问模式配置。取值范围：'."\n" + ."\n" + .'* `optional`：同时兼容普通模式和加固模式。'."\n" + .'* `required`：启用仅加固模式（IMDSv2）。启用后，节点内应用将无法通过普通模式访问 ECS 实例元数据。'."\n" + ."\n" + .'默认值：`optional`。'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'* 该参数目前仅白名单开放，如需使用，请提交工单申请。'."\n" + .'* 仅1.28及以上版本的ACK托管集群支持该参数.'."\n" + ."\n" + .'></notice>'."\n" + ."\n" + .'> 有关实例元数据访问模式的更多信息，请参见[实例元数据访问模式](~~108460~~)。', + 'type' => 'string', + 'example' => 'optional', + 'default' => 'optional', + 'enum' => [ + 'optional', + 'required', + ], + ], + ], + ], + 'addon' => [ + 'title' => '集群插件配置', + 'description' => '集群组件的配置。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '插件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'nginx-ingress-controller', + ], + 'config' => [ + 'title' => '插件配置参数。', + 'description' => '组件配置。', + 'type' => 'string', + 'example' => '{\\"IngressSlbNetworkType\\":\\"internet\\"}', + ], + 'disabled' => [ + 'title' => '是否禁止默认安装。true | false。', + 'description' => '是否禁止默认安装。集群创建时除了安装必需组件外，还会额外安装一些日志组件等，您可以禁止这些默认行为，后续通过安装组件的API进行安装或者通过控制台安装。取值：'."\n" + ."\n" + .'- `true`：禁止默认安装。'."\n" + .'- `false`：允许默认安装。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'version' => [ + 'title' => '版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => 'v1.9.3-aliyun.1', + ], + ], + ], + 'containerd_config' => [ + 'title' => 'containerd配置', + 'description' => 'containerd 运行时配置。', + 'type' => 'object', + 'properties' => [ + 'registryMirrors' => [ + 'title' => '替代镜像仓库配置。', + 'description' => '镜像加速器配置。', + 'type' => 'array', + 'items' => [ + 'description' => '镜像加速器地址。', + 'type' => 'string', + 'example' => 'https://example.com', + ], + ], + 'insecureRegistries' => [ + 'title' => '跳过证书认证的镜像仓库。', + 'description' => '跳过证书认证的镜像仓库。', + 'type' => 'array', + 'items' => [ + 'description' => '跳过证书认证的镜像仓库地址。', + 'type' => 'string', + 'example' => 'example.com', + ], + ], + 'maxConcurrentDownloads' => [ + 'title' => '最大并发下载数。', + 'description' => '最大并发下载数。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ignoreImageDefinedVolume' => [ + 'title' => '忽略镜像中定义的数据卷。', + 'description' => '忽略镜像中定义的数据卷。', + 'type' => 'boolean', + ], + 'limitCore' => [ + 'title' => 'coredump 大小。', + 'description' => 'coredump 大小。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'limitNoFile' => [ + 'title' => '最大文件句柄数量限制。', + 'description' => '最大文件句柄数量限制。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'limitMemLock' => [ + 'title' => '最大内存锁定量限制。', + 'description' => '最大内存锁定量限制。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'data_disk' => [ + 'title' => '节点数据盘配置', + 'description' => '节点数据盘配置。', + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'title' => '数据盘类型', + 'description' => '数据盘类型。取值：'."\n" + ."\n" + .'- `cloud`：普通云盘。'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。'."\n" + .'- `elastic_ephemeral_disk_premium`：弹性临时盘高级版。'."\n" + .'- `elastic_ephemeral_disk_standard`：弹性临时盘标准版。'."\n" + ."\n" + .'默认值：`cloud_efficiency`。', + 'type' => 'string', + 'example' => 'cloud_ssd', + ], + 'size' => [ + 'title' => '数据盘大小，取值范围：40～32767', + 'description' => '数据盘大小，单位为GiB。'."\n" + ."\n" + .'取值范围：\\[40,32768\\]。'."\n" + ."\n" + .'默认值：`120`。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '40', + ], + 'encrypted' => [ + 'title' => '是否对数据盘加密。', + 'description' => '是否对数据盘加密。取值：'."\n" + ."\n" + .'- `true`：对数据盘加密。'."\n" + .'- `false`：不对数据盘加密。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'string', + 'example' => 'true', + ], + 'kms_key_id' => [ + 'title' => '数据盘对应的KMS密钥ID', + 'description' => '数据盘对应的KMS密钥ID', + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'auto_snapshot_policy_id' => [ + 'title' => '开启云盘备份时的自动备份策略。', + 'description' => '选择自动快照策略ID，云盘会按照快照策略自动备份。'."\n" + ."\n" + .'默认值：空，不自动备份。', + 'type' => 'string', + 'example' => 'sp-2zej1nogjvovnz4z****', + ], + 'performance_level' => [ + 'title' => '数据盘磁盘性能，只针对ESSD磁盘生效', + 'description' => '节点数据盘磁盘性能等级，仅对ESSD磁盘生效。磁盘性能等级和磁盘大小有关。更多信息，请参见[ESSD云盘](~~122389~~)。', + 'type' => 'string', + 'example' => 'PL1', + ], + 'provisioned_iops' => [ + 'title' => '数据盘预配置的读写IOPS，磁盘类型为cloud_auto时配置。', + 'description' => '数据盘预配置的读写IOPS。可能值：0~min{50,000, 1000\\*容量-基准性能}。'."\n" + .'基准性能=min{1,800+50*容量, 50000}。'."\n" + ."\n" + .'当`DiskCategory`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'bursting_enabled' => [ + 'title' => '数据盘是否开启Burst（性能突发），磁盘类型为cloud_auto时配置。', + 'description' => '数据盘是否开启Burst（性能突发）。'."\n" + .'取值：'."\n" + .'- `true`：是。'."\n" + .'- `false`：否。'."\n" + ."\n" + .'当`DiskCategory`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_format' => [ + 'title' => '是否挂载。', + 'description' => '是否挂载。', + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'true', + ], + 'file_system' => [ + 'title' => '挂载文件系统类型。auto_format为true时生效，可选值：[ext4,xfs]', + 'description' => '挂载文件系统类型。auto_format为true时生效，可选值：[ext4,xfs]', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'ext4', + ], + 'mount_target' => [ + 'title' => '挂载路径。auto_format为true时生效', + 'description' => '挂载路径。需要为合法文件路径。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '/mnt/path1', + ], + 'disk_name' => [ + 'title' => '数据盘名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'description' => '数据盘名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。', + 'type' => 'string', + 'example' => 'DataDiskName', + ], + 'device' => [ + 'title' => '数据盘的挂载点。如果您没有指定该参数，则默认在自动创建ECS实例时由系统分配，从/dev/xvdb开始，到/dev/xvdz结束。', + 'description' => '数据盘的挂载点。如果您没有指定该参数，则默认在自动创建ECS实例时由系统分配，从/dev/xvdb开始，到/dev/xvdz结束。', + 'type' => 'string', + 'example' => '/dev/xvdb', + ], + 'snapshot_id' => [ + 'title' => '创建数据盘时使用的快照。指定该参数后，DataDisks.Size会被忽略，实际创建的磁盘大小为指定快照的大小。如果该快照创建于2013年7月15日或之前，调用会被拒绝，返回参数中会提示InvalidSnapshot.TooOld。', + 'description' => '创建数据盘时使用的快照。指定该参数后，DataDisks.Size会被忽略，实际创建的磁盘大小为指定快照的大小。如果该快照创建于2013年7月15日或之前，调用会被拒绝，返回参数中会提示InvalidSnapshot.TooOld。', + 'type' => 'string', + 'example' => 's-280s7****', + ], + ], + ], + 'instance_patterns' => [ + 'title' => '实例属性配置。', + 'description' => '实例属性', + 'type' => 'object', + 'properties' => [ + 'cores' => [ + 'title' => '实例规格的 vCPU 内核数目。', + 'description' => '实例规格的 vCPU 内核数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'memory' => [ + 'title' => '实例规格的内存大小，单位为 GiB。', + 'description' => '实例规格的内存大小，单位为 GiB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + 'instance_family_level' => [ + 'title' => '实例规格族级别。', + 'description' => '实例规格族级别。', + 'type' => 'string', + 'example' => 'EnterpriseLevel', + ], + 'excluded_instance_types' => [ + 'title' => '需要排除的实例规格。', + 'description' => '需要排除的实例规格。', + 'type' => 'array', + 'items' => [ + 'description' => '需要排除的实例规格。', + 'type' => 'string', + 'example' => 'ecs.c6.large', + ], + ], + 'min_cpu_cores' => [ + 'title' => '实例规格的最小vCPU内核数目', + 'description' => '实例规格的最小vCPU内核数目', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4', + ], + 'max_cpu_cores' => [ + 'title' => '实例规格的最大vCPU内核数目', + 'description' => '实例规格的最大vCPU内核数目', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'min_memory_size' => [ + 'title' => '实例规格的最小内存。单位：GiB。', + 'description' => '实例规格的最小内存。单位：GiB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '8', + ], + 'max_memory_size' => [ + 'title' => '实例规格的最大内存。单位：GiB。', + 'description' => '实例规格的最大内存。单位：GiB。', + 'type' => 'number', + 'format' => 'float', + 'example' => '16', + ], + 'instance_categories' => [ + 'title' => '实例分类', + 'description' => '实例分类。', + 'type' => 'array', + 'items' => [ + 'description' => '实例分类。', + 'type' => 'string', + 'example' => 'General-purpose', + ], + ], + 'cpu_architectures' => [ + 'title' => '实例的CPU架构', + 'description' => '实例的CPU架构。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的CPU架构。', + 'type' => 'string', + 'example' => 'X86', + ], + ], + 'core' => [ + 'title' => '【该参数已废弃，请使用cores参数替代】实例规格的 vCPU 内核数目。', + 'description' => '【该参数已废弃，使用cores参数替代】实例规格的 vCPU 内核数目。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '4', + ], + 'max_price' => [ + 'title' => '【该参数已废弃】实例每小时最高价格。', + 'description' => '【该参数已废弃，请勿使用】实例每小时最高价格。', + 'type' => 'number', + 'format' => 'float', + 'deprecated' => true, + 'example' => '2', + ], + 'architectures' => [ + 'title' => '【该参数已废弃，请使用cpu_architectures参数替代】实例规格所属的架构类型。', + 'description' => '【该参数已废弃，使用cpu_architectures参数替代】实例规格所属的架构类型。', + 'type' => 'array', + 'items' => [ + 'description' => '【该参数已废弃，使用cpu_architectures参数替代】实例规格所属的架构类型。', + 'type' => 'string', + 'example' => 'X86', + ], + 'deprecated' => true, + ], + 'burst_performance_option' => [ + 'title' => '【该参数已废弃】是否为性能突发实例规格。', + 'description' => '【该参数已废弃，请勿使用】是否为性能突发实例规格。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Exclude', + ], + 'instance_type_families' => [ + 'title' => '指定实例规格族。', + 'description' => '指定实例规格族。', + 'type' => 'array', + 'items' => [ + 'description' => '指定实例规格族。', + 'type' => 'string', + 'example' => 'ecs.c6', + ], + ], + 'minimum_eni_quantity' => [ + 'title' => '期望最小支持挂载的弹性网卡数。', + 'description' => '期望最小支持挂载的弹性网卡数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'minimum_eni_private_ip_address_quantity' => [ + 'title' => '期望最小单块弹性网卡的 IPv4 地址数。', + 'description' => '期望最小单块弹性网卡的 IPv4 地址数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'minimum_eni_ipv6_address_quantity' => [ + 'title' => '期望最小单块弹性网卡的 IPv6 地址数。', + 'description' => '期望最小单块弹性网卡的 IPv6 地址数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'maximum_gpu_amount' => [ + 'title' => '期望最大 GPU 数目。', + 'description' => '期望最大 GPU 数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + ], + ], + 'kubelet_config' => [ + 'title' => 'Kubelet参数配置。', + 'description' => '支持的kubelet配置', + 'type' => 'object', + 'properties' => [ + 'registryPullQPS' => [ + 'title' => '镜像仓库的QPS上限。', + 'description' => '镜像仓库的QPS上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'registryBurst' => [ + 'title' => '突发性镜像拉取的个数上限。', + 'description' => '突发性镜像拉取的个数上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'eventRecordQPS' => [ + 'title' => '每秒可生成的事件数量。', + 'description' => '每秒可生成的事件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'eventBurst' => [ + 'title' => '事件记录的个数的突发峰值上限。', + 'description' => '事件记录的个数的突发峰值上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'kubeAPIQPS' => [ + 'title' => '与API Server通信的每秒查询个数。', + 'description' => '与API Server通信的每秒查询个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'kubeAPIBurst' => [ + 'title' => '每秒发送到API Server的突发请求数量上限。', + 'description' => '每秒发送到API Server的突发请求数量上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'serializeImagePulls' => [ + 'title' => '是否逐一拉取镜像。', + 'description' => '是否逐一拉取镜像。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cpuManagerPolicy' => [ + 'title' => 'CPU管理器策略。', + 'description' => 'CPU管理器策略。', + 'type' => 'string', + 'example' => 'none', + ], + 'evictionHard' => [ + 'title' => '触发Pod驱逐操作的一组硬性门限。', + 'description' => '触发Pod驱逐操作的一组硬性门限。', + 'type' => 'object', + ], + 'evictionSoft' => [ + 'title' => '设置一组驱逐阈值。', + 'description' => '设置一组驱逐阈值。', + 'type' => 'object', + ], + 'evictionSoftGracePeriod' => [ + 'title' => '设置一组驱逐宽限期。', + 'description' => '设置一组驱逐宽限期。', + 'type' => 'object', + ], + 'systemReserved' => [ + 'title' => '系统预留的资源配置。', + 'description' => '系统预留的资源配置。', + 'type' => 'object', + ], + 'kubeReserved' => [ + 'title' => 'kubernetes系统预留的资源配置。', + 'description' => 'kubernetes系统预留的资源配置。', + 'type' => 'object', + ], + 'readOnlyPort' => [ + 'title' => '只读端口号。', + 'description' => '只读端口号。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'maxPods' => [ + 'title' => '运行的Pod个数上限。', + 'description' => '运行的Pod个数上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '110', + ], + 'containerLogMaxSize' => [ + 'title' => '日志文件被轮转之前可以到达的最大大小。', + 'description' => '日志文件被轮转之前可以到达的最大大小。', + 'type' => 'string', + 'example' => '10Mi', + ], + 'containerLogMaxFiles' => [ + 'title' => '每个容器可以存在的日志文件个数上限。', + 'description' => '每个容器可以存在的日志文件个数上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'featureGates' => [ + 'title' => '特性开关，用来开启实验性功能的配置。', + 'description' => '特性开关，用来开启实验性功能的配置。', + 'type' => 'object', + ], + 'allowedUnsafeSysctls' => [ + 'title' => '允许的sysctl模式白名单。', + 'description' => '允许的sysctl模式白名单。', + 'type' => 'array', + 'items' => [ + 'description' => '允许的sysctl模式白名单。', + 'type' => 'string', + 'example' => 'net.core.somaxconn', + ], + ], + 'reservedMemory' => [ + 'title' => '为NUMA节点预留内存。', + 'description' => '为NUMA节点预留内存。', + 'type' => 'array', + 'items' => [ + 'description' => '内存资源限制。', + 'type' => 'object', + 'properties' => [ + 'numaNode' => [ + 'title' => 'NUMA 节点。', + 'description' => 'NUMA 节点。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'limits' => [ + 'title' => '资源列表。', + 'description' => '内存资源限制。', + 'type' => 'object', + 'example' => '{"memory": "1Gi"}', + ], + ], + ], + ], + 'memoryManagerPolicy' => [ + 'title' => '内存管理器要使用的策略。', + 'description' => '内存管理器要使用的策略。', + 'type' => 'string', + 'example' => 'none', + ], + 'cpuCFSQuota' => [ + 'title' => 'CPU CFS配额约束开关。', + 'description' => 'CPU CFS配额约束开关。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cpuCFSQuotaPeriod' => [ + 'title' => 'CPU CFS配额周期值。', + 'description' => 'CPU CFS配额周期值。', + 'type' => 'string', + 'example' => '100ms', + ], + 'imageGCHighThresholdPercent' => [ + 'title' => '镜像用量超过此阈值，则镜像垃圾回收会持续执行。', + 'description' => '镜像用量超过此阈值，则镜像垃圾回收会持续执行。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '85', + ], + 'imageGCLowThresholdPercent' => [ + 'title' => '镜像用量低于此阈值时不会执行镜像垃圾回收操作。', + 'description' => '镜像用量低于此阈值时不会执行镜像垃圾回收操作。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'podPidsLimit' => [ + 'title' => 'Pod 中可使用的 PID 个数上限。', + 'description' => 'Pod 中可使用的 PID 个数上限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'topologyManagerPolicy' => [ + 'title' => '使用的拓扑管理器策略名称。', + 'description' => '使用的拓扑管理器策略名称。', + 'type' => 'string', + 'example' => 'restricted', + ], + 'clusterDNS' => [ + 'title' => '集群 DNS 服务器的 IP 地址的列表。', + 'description' => '集群 DNS 服务器的 IP 地址的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群 DNS 服务器的 IP 地址。', + 'type' => 'string', + 'example' => '127.0.xx.xx', + ], + ], + 'tracing' => [ + 'title' => 'OpenTelemetry 追踪客户端设置版本化的配置信息。', + 'description' => 'OpenTelemetry 追踪客户端设置版本化的配置信息。', + 'type' => 'object', + 'properties' => [ + 'endpoint' => [ + 'title' => '采集器的端点。', + 'description' => '采集器的端点。', + 'type' => 'string', + 'example' => 'localhost:4317', + ], + 'samplingRatePerMillion' => [ + 'title' => '每百万 span 要采集的样本数。', + 'description' => '每百万 span 要采集的样本数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200000', + ], + ], + ], + 'containerLogMaxWorkers' => [ + 'title' => '指定执行日志轮换操作所需的并发工作程序的最大数量。', + 'description' => '指定执行日志轮换操作所需的并发工作程序的最大数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'containerLogMonitorInterval' => [ + 'title' => '指定监视容器日志以执行日志轮转操作的持续时间。', + 'description' => '指定监视容器日志以执行日志轮转操作的持续时间。', + 'type' => 'string', + 'example' => '10s', + ], + 'serverTLSBootstrap' => [ + 'description' => '启用 kubelet 服务端证书的自动签发与轮换功能。启用时，需同时在 kubelet 的 featureGates 中配置 "RotateKubeletServerCertificate": true'."\n" + ."\n" + .'> - 仅 1.30 及以上版本的集群可用。'."\n" + .'> - 1.30 至 v1.33 版本的集群需提交工单申请。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'maintenance_window' => [ + 'title' => '集群维护窗口。', + 'description' => '集群维护窗口。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启维护窗口。默认值false。', + 'description' => '是否开启维护窗口。取值：'."\n" + .'- `true`：开启维护窗口。'."\n" + .'- `false`：不开启维护窗口。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'maintenance_time' => [ + 'title' => '维护起始时间。RFC3339标准格式。', + 'description' => '维护起始时间。RFC3339标准格式。', + 'type' => 'string', + 'example' => '2020-10-15T12:31:00.000+08:00', + ], + 'duration' => [ + 'title' => '维护时长。取值范围1～24，单位为小时。 默认值：3h。', + 'description' => '维护时长。取值范围\\[1,24\\]，单位为小时。'."\n" + ."\n" + .'默认值：3h。', + 'type' => 'string', + 'example' => '3h', + ], + 'weekly_period' => [ + 'title' => '维护周期。取值范围为:Monday~Sunday，多个值用逗号分隔。 默认值：Thursday。', + 'description' => '维护周期，多个值用英文半角逗号（,）分隔。取值：{Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday}'."\n" + ."\n" + .'默认值：`Thursday`。', + 'type' => 'string', + 'example' => 'Monday,Thursday', + ], + 'recurrence' => [ + 'title' => '使用RFC5545 Recurrence Rule语法定义的维护窗口循环规则，目前仅支持FREQ=WEEKLY，且不支持指定COUNT或UNTIL', + 'description' => '使用RFC5545 Recurrence Rule语法定义的维护窗口循环规则，目前仅支持FREQ=WEEKLY，且不支持指定COUNT或UNTIL', + 'type' => 'string', + 'example' => 'FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU', + ], + ], + ], + 'nodepool' => [ + 'title' => '节点池信息。', + 'description' => '节点池。', + 'type' => 'object', + 'properties' => [ + 'auto_scaling' => [ + 'title' => '自动伸缩节点池配置。', + 'description' => '自动伸缩节点池配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启自动伸缩。', + 'description' => '是否启用自动伸缩。'."\n" + ."\n" + .'- `true`：开启节点池自动伸缩功能。'."\n" + .'- `false`：不开启自动伸缩，当取值为false时，`auto_scaling`内的其他配置参数将不生效。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'max_instances' => [ + 'title' => '最大实例数。', + 'description' => '自动伸缩组最大实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + 'min_instances' => [ + 'title' => '最小实例数。', + 'description' => '自动伸缩组最小实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '0', + ], + 'type' => [ + 'title' => '扩容节点类型。', + 'description' => '自动伸缩类型，按照自动伸缩实例类型划分。取值：'."\n" + ."\n" + .'- `cpu`：普通实例型。'."\n" + .'- `gpu`：GPU实例型。'."\n" + .'- `gpushare`：GPU共享型。'."\n" + .'- `spot`：抢占式实例型。'."\n" + ."\n" + .'默认值：`cpu`。', + 'type' => 'string', + 'example' => 'cpu', + ], + 'is_bond_eip' => [ + 'title' => '是否绑定EIP。', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'是否绑定EIP，取值：'."\n" + ."\n" + .'- `true`：绑定EIP。'."\n" + .'- `false`：不绑定EIP。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'true', + ], + 'eip_internet_charge_type' => [ + 'title' => 'EIP实例规格。', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'EIP计费类型，取值：'."\n" + ."\n" + .'- `PayByBandwidth`：按固定带宽计费。'."\n" + .'- `PayByTraffic`：按使用流量计费。'."\n" + ."\n" + .'默认值：PayByBandwidth。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'PayByBandwidth', + ], + 'eip_bandwidth' => [ + 'title' => '带宽峰值。', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'EIP带宽峰值。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '5', + ], + ], + ], + 'kubernetes_config' => [ + 'title' => '集群配置。', + 'description' => '集群相关配置。', + 'type' => 'object', + 'properties' => [ + 'cms_enabled' => [ + 'title' => '是否开启云监控。', + 'description' => '是否在ECS节点上安装云监控，安装后可以在云监控控制台查看所创建ECS实例的监控信息，推荐开启。取值：'."\n" + ."\n" + .'- `true`：在ECS节点上安装云监控。'."\n" + .'- `false`：不在ECS节点上安装云监控。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cpu_policy' => [ + 'title' => 'CPU管理策略。', + 'description' => '节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略：'."\n" + ."\n" + .'- `static`：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + .'- `none`：表示启用现有的默认CPU亲和性方案。'."\n" + ."\n" + .'默认值：`none`。', + 'type' => 'string', + 'example' => 'none', + ], + 'labels' => [ + 'title' => '节点标签。', + 'description' => '节点标签，为Kubernetes集群节点添加标签。', + 'type' => 'array', + 'items' => [ + 'description' => '节点标签。', + '$ref' => '#/components/schemas/tag', + ], + ], + 'runtime' => [ + 'title' => '容器运行时。', + 'description' => '容器运行时。取值：'."\n" + .'- `containerd`：推荐使用，支持所有集群版本。'."\n" + .'- `Sandboxed-Container.runv`：安全沙箱容器，提供更高的隔离性，支持1.24版本及以下集群。'."\n" + .'- `docker`：支持1.22版本及以下集群。'."\n" + ."\n" + .'默认值：`containerd`', + 'type' => 'string', + 'required' => true, + 'example' => 'containerd', + ], + 'runtime_version' => [ + 'title' => '容器运行时版本。', + 'description' => '容器运行时版本。', + 'type' => 'string', + 'required' => true, + 'example' => '1.6.20', + ], + 'taints' => [ + 'title' => '污点信息。', + 'description' => '污点配置。', + 'type' => 'array', + 'items' => [ + 'description' => '污点配置。', + '$ref' => '#/components/schemas/taint', + ], + ], + 'user_data' => [ + 'title' => '节点自定义数据。', + 'description' => '节点自定义数据。', + 'type' => 'string', + 'example' => 'MXM=', + ], + 'node_name_mode' => [ + 'title' => '自定义节点名称', + 'description' => '节点名称由三部分组成：前缀 + 节点 IP + 后缀：'."\n" + ."\n" + .'- 前缀和后缀均可由“.”分隔的一个或多个部分构成，每个部分可以使用小写字母、数字和“-”，节点名称首尾必须为小写字母和数字；'."\n" + .'- 节点 IP为完整的节点私网 IP 地址；'."\n" + ."\n" + .'传参包含四个部分，由逗号分隔，例如：参数传入"customized,aliyun,ip,com"字符串（其中“customized”和"ip"为固定的字符串，aliyun为前缀，com为后缀），则节点的名称为：aliyun.192.168.xxx.xxx.com。', + 'type' => 'string', + 'example' => 'customized,aliyun,ip,com', + ], + ], + ], + 'nodepool_info' => [ + 'title' => '节点池配置。', + 'description' => '节点池配置。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '节点池名称', + 'description' => '节点池名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'np-test', + ], + 'resource_group_id' => [ + 'title' => '资源组ID。', + 'description' => '节点池所在资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyvw3wjm****', + ], + 'type' => [ + 'title' => '节点池类型，对于边缘节点池来说，类型为"edge"', + 'description' => '节点池类型，取值范围：'."\n" + ."\n" + .'- `ess`：节点池。'."\n" + .'- `edge`：边缘节点池。', + 'type' => 'string', + 'example' => 'ess', + ], + ], + ], + 'scaling_group' => [ + 'title' => '伸缩组配置。', + 'description' => '节点池扩容组配置。', + 'type' => 'object', + 'properties' => [ + 'auto_renew' => [ + 'title' => '节点是否开启自动续费', + 'description' => '节点池是否开启自动续费，当`instance_charge_type`取值为`PrePaid`时才生效，取值：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n" + ."\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'auto_renew_period' => [ + 'title' => '节点自动续费周期', + 'description' => '节点池自动续费周期。当`instance_charge_type`取值为`PrePaid`时才生效，且为必选值。'."\n" + ."\n" + .'当`PeriodUnit=Month`时，取值范围：{1, 2, 3, 6, 12}。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'data_disks' => [ + 'title' => '数据盘配置。', + 'description' => '节点池节点数据盘配置。', + 'type' => 'array', + 'items' => [ + 'description' => '节点池节点数据盘配置。', + '$ref' => '#/components/schemas/data_disk', + ], + ], + 'disk_init' => [ + 'title' => '块设备初始化配置。', + 'description' => '块设备初始化配置。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/DiskInit', + ], + ], + 'image_id' => [ + 'title' => '自定义镜像。', + 'description' => '自定义镜像ID，默认使用系统提供的镜像。', + 'type' => 'string', + 'example' => 'aliyun_2_1903_x64_20G_alibase_20200904.vhd', + ], + 'instance_charge_type' => [ + 'title' => '节点付费类型', + 'description' => '节点池节点付费类型，取值：'."\n" + ."\n" + .'- `PrePaid`：预付费。'."\n" + .'- `PostPaid`：按量付费。'."\n" + ."\n" + .'默认值：`PostPaid`。', + 'type' => 'string', + 'required' => true, + 'example' => 'PostPaid', + ], + 'instance_types' => [ + 'title' => '实例规格。', + 'description' => '实例规格。', + 'type' => 'array', + 'items' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'ecs.n1.medium', + ], + 'required' => true, + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。', + 'description' => '密钥对名称，和`login_password`二选一。'."\n" + ."\n" + .'> 如果创建托管节点池，则只支持`key_pair`。', + 'type' => 'string', + 'required' => false, + 'example' => 'np-key', + ], + 'login_password' => [ + 'title' => 'SSH登录密码。', + 'description' => 'SSH登录密码，和`key_pair`二选一。密码规则为8~30个字符，且至少同时包含三项（大小写字母、数字和特殊符号）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hello1234', + ], + 'login_as_non_root' => [ + 'title' => '弹出的ECS实例是否使用以非root用户登陆。', + 'description' => '弹出的ECS实例是否使用以非root用户登录。', + 'type' => 'boolean', + ], + 'period' => [ + 'title' => '节点包年包月时长。', + 'description' => '节点池节点包年包月时长，当`instance_charge_type`取值为`PrePaid`时才生效且为必选值，取值范围：`period_unit`取值为Month时，`period`取值范围：{ 1, 2, 3, 6, 12}。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'period_unit' => [ + 'title' => '节点包年包月周期。', + 'description' => '节点池节点付费周期，当`instance_charge_type`取值为`PrePaid`时需要指定周期。'."\n" + ."\n" + .'`Month`：目前只支持以月为单位。', + 'type' => 'string', + 'example' => 'Month', + ], + 'platform' => [ + 'title' => '操作系统发行版，和image_type二选一', + 'description' => '操作系统发行版。取值：'."\n" + ."\n" + .'- `CentOS`'."\n" + .'- `AliyunLinux`'."\n" + .'- `Windows`'."\n" + .'- `WindowsCore`'."\n" + ."\n" + .'默认值：`AliyunLinux`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'AliyunLinux', + ], + 'rds_instances' => [ + 'title' => 'RDS实例列表。', + 'description' => 'RDS实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'RDS实例ID。', + 'type' => 'string', + 'example' => 'rm-2zey3t89t6280****', + ], + ], + 'spot_strategy' => [ + 'title' => '抢占式实例类型', + 'description' => '抢占式实例类型，取值：'."\n" + .'- NoSpot：非抢占式实例。'."\n" + .'- SpotWithPriceLimit：设置抢占实例价格上限。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。'."\n" + ."\n" + .'更多信息，请参见[抢占式实例](~~157759~~)。', + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'spot_price_limit' => [ + 'title' => '抢占实例价格上限配置。', + 'description' => '当前单台抢占式实例规格市场价格区间配置。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'instance_type' => [ + 'title' => '抢占实例规格。', + 'description' => '抢占式实例规格。', + 'type' => 'string', + 'example' => 'ecs.c6.large', + ], + 'price_limit' => [ + 'title' => '抢占实例单价。', + 'description' => '单台实例上限价格。'."\n", + 'type' => 'string', + 'example' => '0.39', + ], + ], + ], + ], + 'scaling_policy' => [ + 'title' => '自动伸缩。', + 'description' => '伸缩组模式，取值：'."\n" + ."\n" + .'- `release`：标准模式，根据申请资源值的使用量，通过创建、释放ECS的方式进行伸缩。'."\n" + .'- `recycle`：极速模式，通过创建、停机、启动的方式进行伸缩，提高再次伸缩的速度（停机时计算资源不收费，只收取存储费用，本地盘机型除外）。'."\n" + ."\n" + .'默认值：`release`。', + 'type' => 'string', + 'example' => 'release', + ], + 'security_group_id' => [ + 'title' => '安全组ID。', + 'description' => '节点池安全组ID，与`security_group_ids`二选一，推荐使用`security_group_ids`。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-2zeihch86ooz9io4****', + ], + 'security_group_ids' => [ + 'title' => '多安全组ID', + 'description' => '安全组ID列表，与`security_group_id`二选一，推荐使用`security_group_ids`，当同时指定`security_group_id`和`security_group_ids`将优先使用`security_group_ids`。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-2zeihch86ooz9io4****', + ], + ], + 'system_disk_category' => [ + 'title' => '节点系统盘类型。', + 'description' => '节点系统盘类型，取值：'."\n" + ."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry云盘。'."\n" + ."\n" + .'默认值：`cloud_efficiency`。', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'system_disk_categories' => [ + 'title' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。取值范围：cloud：普通云盘。cloud_efficiency：高效云盘。cloud_ssd：SSD云盘。cloud_essd：ESSD云盘。', + 'description' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。取值范围：'."\n" + ."\n" + .'- cloud：普通云盘。'."\n" + .'- cloud_efficiency：高效云盘。'."\n" + .'- cloud_ssd：SSD云盘。'."\n" + .'- cloud_essd：ESSD云盘。', + 'type' => 'array', + 'items' => [ + 'title' => '节点系统盘类型', + 'description' => '节点系统盘类型。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'required' => false, + 'maxItems' => 10, + ], + 'system_disk_size' => [ + 'title' => '节点系统盘大小。', + 'description' => '节点系统盘大小，单位：GiB。'."\n" + ."\n" + .'取值范围：[40,500]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'system_disk_performance_level' => [ + 'title' => '节点系统盘磁盘性能，只针对ESSD磁盘生效', + 'description' => '节点系统盘磁盘性能，只对ESSD磁盘生效。'."\n" + ."\n" + .'- PL0：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL1：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL2：并发极限I/O性能较高，读写时延稳定。'."\n" + .'- PL3：并发极限I/O性能极高，读写时延极稳定。', + 'type' => 'string', + 'example' => 'PL1', + ], + 'system_disk_encrypted' => [ + 'title' => '是否加密系统盘。取值范围：true：加密。false：不加密。', + 'description' => '是否加密系统盘。取值范围：true：加密。false：不加密。', + 'type' => 'boolean', + ], + 'system_disk_kms_key_id' => [ + 'title' => '节点系统盘使用的KMS密钥ID。', + 'description' => '节点系统盘使用的KMS密钥ID。', + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'system_disk_encrypt_algorithm' => [ + 'title' => '节点系统盘采用的加密算法。取值范围：aes-256。', + 'description' => '节点系统盘采用的加密算法。取值范围：aes-256。', + 'type' => 'string', + 'example' => 'aes-256', + ], + 'system_disk_provisioned_iops' => [ + 'title' => '节点系统盘预配置的读写IOPS，磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘预配置的读写IOPS。可能值：0~min{50,000, 1000\\*容量-基准性能}。 基准性能=min{1,800+50\\*容量, 50000}。'."\n" + ."\n" + .'当`SystemDiskCategory`为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'system_disk_bursting_enabled' => [ + 'title' => '节点系统盘是否开启Burst（性能突发），磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘是否开启Burst（性能突发）。 取值：'."\n" + ."\n" + .'- true：是。'."\n" + .'- false：否。'."\n" + ."\n" + .'当`SystemDiskCategory`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'tags' => [ + 'title' => 'ECS标签', + 'description' => '仅为ECS实例添加标签。'."\n" + ."\n" + .'标签键不可以重复，最大长度为128个字符；标签键和标签值都不能以“aliyun”、“acs:”开头，或包含“https://”、“http://”。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => 'key', + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'key', + ], + 'value' => [ + 'title' => 'value', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + 'vswitch_ids' => [ + 'title' => '虚拟交换机ID。', + 'description' => '虚拟交换机ID。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-2ze0fmpbwo140ahni****', + ], + 'required' => true, + ], + 'multi_az_policy' => [ + 'title' => '多可用区伸缩组ECS实例扩缩容策略', + 'description' => '多可用区伸缩组ECS实例扩缩容策略。取值：'."\n" + ."\n" + .'- `PRIORITY`：根据您定义的虚拟交换机（VSwitchIds.N）扩缩容。当优先级较高的虚拟交换机所在可用区无法创建ECS实例时，自动使用下一优先级的虚拟交换机创建ECS实例。'."\n" + ."\n" + .'- `COST_OPTIMIZED`：按vCPU单价从低到高进行尝试创建。当伸缩配置设置了抢占式计费方式的多实例规格时，优先创建对应抢占式实例。您可以继续通过`CompensateWithOnDemand`参数指定当抢占式实例由于库存等原因无法创建时，是否自动尝试以按量付费的方式创建。'."\n" + ."\n" + .' >`COST_OPTIMIZED`仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。'."\n" + ."\n" + .'- `BALANCE`：在伸缩组指定的多可用区之间均匀分配ECS实例。如果由于库存不足等原因可用区之间变得不平衡，您可以通过API RebalanceInstances平衡资源。更多信息，请参见[RebalanceInstances](~~71516~~)。'."\n" + ."\n" + .'默认值：`PRIORITY`。', + 'type' => 'string', + 'example' => 'COST_OPTIMIZED', + ], + 'on_demand_base_capacity' => [ + 'title' => '伸缩组所需要按量实例个数的最小值，取值范围：0~1000。当按量实例个数少于该值时，将优先创建按量实例。', + 'description' => '伸缩组所需要按量实例个数的最小值，取值范围：[0,1000]。当按量实例个数少于该值时，将优先创建按量实例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'on_demand_percentage_above_base_capacity' => [ + 'title' => '伸缩组满足最小按量实例数（OnDemandBaseCapacity）要求后，超出的实例中按量实例应占的比例，取值范围：0～100。', + 'description' => '伸缩组满足最小按量实例数（`on_demand_base_capacity`）要求后，超出的实例中按量实例应占的比例。取值范围：[0,100]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'spot_instance_pools' => [ + 'title' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：1~10。', + 'description' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：[1,10]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'spot_instance_remedy' => [ + 'title' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。', + 'description' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。取值：'."\n" + ."\n" + .'- `true`：开启补齐抢占式实例。'."\n" + .'- `false`：不开启补齐抢占式实例。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'compensate_with_on_demand' => [ + 'title' => '当MultiAZPolicy取值为COST_OPTIMIZED时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值范围：true：允许。false：不允许。默认值：true', + 'description' => '当`multi_az_policy`取值为`COST_OPTIMIZED`时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值：'."\n" + ."\n" + .'- `true`：允许自动尝试创建按量实例满足ECS实例数量要求。'."\n" + .'- `false`：不允许自动尝试创建按量实例满足ECS实例数量要求。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'internet_charge_type' => [ + 'title' => '节点公网IP网络计费类型', + 'description' => '公网IP收费类型。取值：'."\n" + ."\n" + .'- `PayByBandwidth`：按固定带宽计费。'."\n" + .'- `PayByTraffic`：按使用流量计费。', + 'type' => 'string', + 'example' => 'PayByBandwidth', + ], + 'internet_max_bandwidth_out' => [ + 'title' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：1~100', + 'description' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：[1,100]', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'image_type' => [ + 'title' => '操作系统发行版类型，推荐使用该字段指定节点操作系统。取值：CentOS、AliyunLinux、AliyunLinux Qboot、AliyunLinuxUEFI、AliyunLinux3、Windows、WindowsCore、AliyunLinux3Arm64、ContainerOS。', + 'description' => '操作系统镜像类型，和platform参数二选一，取值范围：'."\n" + ."\n" + .'- `AliyunLinux`：Alinux2镜像。'."\n" + .'- `AliyunLinux3`：Alinux3镜像。'."\n" + .'- `AliyunLinux3Arm64`：Alinux3镜像ARM版。'."\n" + .'- `AliyunLinuxUEFI`：Alinux2镜像UEFI版。'."\n" + .'- `CentOS`：CentOS镜像。'."\n" + .'- `Windows`：Windows镜像。'."\n" + .'- `WindowsCore`：WindowsCore镜像。'."\n" + .'- `ContainerOS`：容器优化镜像。', + 'type' => 'string', + 'example' => 'AliyunLinux', + ], + 'deploymentset_id' => [ + 'title' => '部署集ID。', + 'description' => '部署集ID。', + 'type' => 'string', + 'example' => 'ds-bp1d19mmbsv3jf6xxxxx', + ], + 'desired_size' => [ + 'title' => '节点池期望节点数', + 'description' => '节点池期望节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'private_pool_options' => [ + 'title' => '私有节点池配置。', + 'description' => '私有节点池配置。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '私有节点池ID。', + 'description' => '私有节点池ID。', + 'type' => 'string', + 'example' => 'eap-bp67acfmxazb4****', + ], + 'match_criteria' => [ + 'title' => '私有节点池类型。', + 'description' => '私有节点池类型，实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值：'."\n" + ."\n" + .'- `Open`：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。'."\n" + ."\n" + .'- `Target`：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。'."\n" + ."\n" + .'- `None`：不使用模式。实例启动将不使用私有池容量。', + 'type' => 'string', + 'example' => 'Open', + ], + ], + ], + 'ram_role_name' => [ + 'title' => 'Worker RAM角色名称。', + 'description' => 'Worker RAM角色名称。'."\n" + .'><notice>仅1.22及以上版本的ACK托管集群支持在创建节点池时配置该参数></notice>', + 'type' => 'string', + 'example' => 'example-role', + ], + 'instance_metadata_options' => [ + 'title' => 'ECS 实例的元数据访问配置。该参数目前仅白名单开放，如需使用，请提交工单申请。', + 'description' => 'ECS 实例的元数据访问配置。'."\n" + .'目前仅白名单开放，需提交工单申请。', + '$ref' => '#/components/schemas/InstanceMetadataOptions', + ], + 'resource_pool_options' => [ + 'title' => '创建实例时使用的资源池及资源池策略。当您设置该参数后，需要注意：'."\n" + .'该参数只在创建按量付费实例时生效。'."\n" + .'该参数不能与private_pool_options.match_criteria、private_pool_options.id同时设置。', + 'description' => '创建实例时使用的资源池及资源池策略。当您设置该参数后，需要注意：'."\n" + .'该参数只在创建按量付费实例时生效。'."\n" + .'该参数不能与private_pool_options.match_criteria、private_pool_options.id同时设置。', + 'type' => 'object', + 'properties' => [ + 'strategy' => [ + 'title' => '创建实例时使用的资源池策略。资源池包括弹性保障服务或容量预定服务生效后生成的私有池以及公共池，供实例启动时选择。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。选择此种策略时， 当指定了 resouce_pool_options.private_pool_ids，优先使用指定的私有池。如果未指定私有池或指定的私有池容量不足，将自动匹配开放类型的私有池。如果没有符合条件的私有池，则使用公共池创建实例。'."\n" + .'PrivatePoolOnly：仅限私有池。选择此种策略时，必须指定 resouce_pool_options.private_pool_ids。如果指定的私有池容量不足，则实例会启动失败。'."\n" + .'None：不使用资源池策略。'."\n" + .'默认值：None。', + 'description' => '创建实例时使用的资源池策略。资源池包括弹性保障服务或容量预定服务生效后生成的私有池以及公共池，供实例启动时选择。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。选择此种策略时， 当指定了 resouce_pool_options.private_pool_ids，优先使用指定的私有池。如果未指定私有池或指定的私有池容量不足，将自动匹配开放类型的私有池。如果没有符合条件的私有池，则使用公共池创建实例。'."\n" + .'PrivatePoolOnly：仅限私有池。选择此种策略时，必须指定 resouce_pool_options.private_pool_ids。如果指定的私有池容量不足，则实例会启动失败。'."\n" + .'None：不使用资源池策略。'."\n" + .'默认值：None。', + 'type' => 'string', + 'example' => 'PrivatePoolFirst', + 'enum' => [ + 'PrivatePoolFirst', + 'PrivatePoolOnly', + 'None', + ], + ], + 'private_pool_ids' => [ + 'title' => '私有池 ID列表。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。N 的取值范围：1~20。', + 'description' => '私有池 ID列表。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。N 的取值范围：1~20。', + 'type' => 'array', + 'items' => [ + 'title' => '私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。', + 'description' => '私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。', + 'type' => 'string', + 'example' => 'eap-bp67acfmxazb4****', + ], + 'maxItems' => 20, + ], + ], + ], + ], + ], + 'tee_config' => [ + 'title' => '加密计算节点池配置。', + 'description' => '加密计算节点池配置。', + 'type' => 'object', + 'properties' => [ + 'tee_enable' => [ + 'title' => '是否为加密计算节点池。', + 'description' => '是否为加密计算节点池。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + ], + 'management' => [ + 'title' => '托管节点池配置。', + 'description' => '托管节点池配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启托管版节点池。', + 'description' => '是否开启托管版节点池，取值：'."\n" + ."\n" + .'- `true`：开启托管节点池。'."\n" + .'- `false`：不开启托管节点池，只有当`enable=true`时，其他相关配置才生效。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'auto_repair' => [ + 'title' => '自动修复。', + 'description' => '自动修复，仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：自动修复。'."\n" + .'- `false`：不自动修复。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'upgrade_config' => [ + 'title' => '自动升级配置。', + 'description' => '自动升级配置，仅当`enable=true`时生效。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade' => [ + 'title' => '是否启用自动升级，自修复。', + 'description' => '是否启用自动升级，取值：'."\n" + ."\n" + .'- `true`：启用自动升级。'."\n" + .'- `false`：不启用自动升级。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'surge' => [ + 'title' => '额外节点数量。', + 'description' => '额外节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'surge_percentage' => [ + 'title' => '额外节点比例，和surge二选一。', + 'description' => '额外节点比例，和`surge`二选一。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'max_unavailable' => [ + 'title' => '最大不可用节点数量。', + 'description' => '最大不可用节点数量，取值范围：\\[1,1000\\]。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + 'deprecated' => true, + ], + 'auto_repair_policy' => [ + 'title' => '自动修复节点策略。', + 'description' => '自动修复节点策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'auto_vul_fix' => [ + 'title' => '是否自动修复CVE。', + 'description' => '是否自动修复CVE。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_vul_fix_policy' => [ + 'title' => '自动修复CVE策略。', + 'description' => '自动修复CVE策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'vul_level' => [ + 'title' => '允许自动修复的漏洞级别，以逗号分隔。', + 'description' => '允许自动修复的漏洞级别，以逗号分隔。', + 'type' => 'string', + 'example' => 'asap,nntf', + ], + ], + ], + 'auto_upgrade' => [ + 'title' => '是否自动升级。', + 'description' => '是否自动升级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_upgrade_policy' => [ + 'title' => '自动升级策略。', + 'description' => '自动升级策略。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade_kubelet' => [ + 'title' => '是否允许自动升级kubelet。', + 'description' => '是否允许自动升级kubelet。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'count' => [ + 'title' => '节点数量。', + 'description' => '【该字段已废弃，请使用desired_size代替】'."\n" + ."\n" + .'节点池节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '1', + ], + 'interconnect_mode' => [ + 'title' => '边缘节点池的网络类型。basic：基础型；improved：增强型。该值只对edge类型的节点池有意义。', + 'description' => '边缘节点池的网络类型，该值只对`type`为`edge`类型的节点池有意义，取值范围：'."\n" + ."\n" + .'- `basic`：基础型。'."\n" + .'- `private`: 专用型。1.22及以上版本支持。', + 'type' => 'string', + 'example' => 'basic', + ], + 'interconnect_config' => [ + 'title' => '边缘节点池网络相关的配置。该值只对edge类型的节点池有意义', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘节点池配置。', + 'type' => 'object', + 'properties' => [ + 'cen_id' => [ + 'title' => '边缘增强型节点池绑定的云企业网实例ID(CENID)', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云企业网实例ID(CENID)。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'cen-ey9k9nfhz0f*******', + ], + 'ccn_id' => [ + 'title' => '边缘增强型节点池绑定的云连接网实例ID(CCNID)', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云连接网实例ID(CCNID)。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'ccn-qm5i0i0q9yi*******', + ], + 'ccn_region_id' => [ + 'title' => '边缘增强型节点池绑定的云连接网实例所属的区域', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云连接网实例所属的地域。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'cn-shanghai', + ], + 'bandwidth' => [ + 'title' => '边缘增强型节点池的网络带宽，单位M。', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池的网络带宽，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '10', + ], + 'improved_period' => [ + 'title' => '边缘增强型节点池的购买时长，单位月', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池的购买时长，单位：月。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '1', + ], + ], + 'deprecated' => true, + ], + 'max_nodes' => [ + 'title' => '边缘节点池允许容纳的最大节点数量. 节点池内可以容纳的最大节点数量，该参数大于等于0。0表示无额外限制(仅受限于集群整体可以容纳的节点数，节点池本身无额外限制)。边缘节点池该参数值往往大于0；ess类型节点池和默认的edge类型节点池该参数值为0。', + 'description' => '边缘节点池允许容纳的最大节点数量，该参数大于等于0。0表示无额外限制（仅受限于集群整体可以容纳的节点数，节点池本身无额外限制）。边缘节点池该参数值往往大于0；ess类型节点池和默认的edge类型节点池该参数值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'node_config' => [ + 'title' => '节点配置。', + 'description' => '节点配置。', + 'type' => 'object', + 'properties' => [ + 'kubelet_configuration' => [ + 'title' => 'Kubelet参数配置。', + 'description' => 'Kubelet参数配置。', + '$ref' => '#/components/schemas/kubelet_config', + ], + ], + ], + 'node_components' => [ + 'title' => '节点组件列表。', + 'description' => '节点组件列表。', + 'type' => 'array', + 'items' => [ + 'title' => '节点组件。', + 'description' => '节点组件。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '节点组件名称。', + 'description' => '节点组件名称。', + 'type' => 'string', + 'example' => 'kubelet', + ], + 'version' => [ + 'title' => '节点组件版本', + 'description' => '节点组件版本', + 'type' => 'string', + 'example' => '1.33.3-aliyun.1', + ], + 'config' => [ + 'title' => '节点组件配置。', + 'description' => '节点组件配置。', + 'type' => 'object', + 'properties' => [ + 'custom_config' => [ + 'title' => '节点组件自定义配置。', + 'description' => '节点组件自定义配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'cpuManagerPolicy', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'runtime' => [ + 'title' => '容器运行时配置', + 'description' => '容器运行时。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '容器运行时名称', + 'description' => '指定容器运行时。可取值：'."\n" + ."\n" + .'- `containerd`：推荐使用。支持1.20及以上版本。'."\n" + .'- `Sandboxed-Container.runv`：安全沙箱容器，提供更高的隔离性。支持1.16及以上版本。'."\n" + .'- `docker`：支持1.22版本及以下集群。'."\n" + ."\n" + .'默认值：`containerd`', + 'type' => 'string', + 'example' => 'containerd', + ], + 'version' => [ + 'title' => '容器运行时版本', + 'description' => '容器运行时版本，默认为最新版。'."\n" + ."\n" + .'变更详情，请参见[运行时发布记录](~~207829~~)。', + 'type' => 'string', + 'example' => '1.6.20', + ], + ], + ], + 'tag' => [ + 'title' => '集群Tag配置', + 'description' => '标签配置。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => 'key值。', + 'description' => '标签`key`值。', + 'type' => 'string', + 'example' => 'env', + ], + 'value' => [ + 'title' => 'value值。', + 'description' => '标签`value`值。', + 'type' => 'string', + 'example' => 'prod', + ], + ], + ], + 'taint' => [ + 'title' => '节点污点配置', + 'description' => '节点污点配置。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => 'key值。', + 'description' => '污点`key`值。', + 'type' => 'string', + 'example' => 'key', + ], + 'value' => [ + 'title' => 'value值。', + 'description' => '污点`value`值。', + 'type' => 'string', + 'example' => 'value', + ], + 'effect' => [ + 'title' => '污点生效策略。', + 'description' => '调度策略。取值：'."\n" + ."\n" + .'- `NoSchedule`：不能容忍，但仅影响调度过程，已被调度的Pod不受影响，仅对新增加的Pod生效。'."\n" + ."\n" + .'- `NoExecute`：不能容忍，当污点变动时，Pod对象会被驱逐。'."\n" + ."\n" + .'- `PreferNoSchedule`：柔性约束，节点现存Pod不受影响。尽量不去满足不合要求的Pod调度到节点上。'."\n" + ."\n" + .'默认策略：`NoSchedule`。', + 'type' => 'string', + 'example' => 'NoSchedule', + ], + ], + ], + ], + ], + 'apis' => [ + 'OpenAckService' => [ + 'summary' => '首次使用容器服务Kubernetes版（Alibaba Cloud Container Service for Kubernetes，简称容器服务ACK）时，您需要调用OpenAckService接口开通服务。', + 'path' => '/service/open', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '11154', + 'abilityTreeNodes' => [ + 'FEATUREcskJEIDU7', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'title' => '要开通的服务类型', + 'description' => '待开通的服务类型。可选值：'."\n" + ."\n" + .'- `propayasgo`：容器服务Kubernetes版（包括ACK托管集群和ACK专有集群）、容器服务Serverless版、注册集群。'."\n" + .'- `edgepayasgo`：容器服务Edge版。', + 'type' => 'string', + 'required' => false, + 'example' => 'propayasgo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体参数', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '20758A-585D-4A41-A9B2-28DA8F*******', + ], + 'order_id' => [ + 'title' => '开通服务的订单号。', + 'description' => '开通服务的订单号。', + 'type' => 'string', + 'example' => '2067*******0374', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"request_id\\": \\"20758A-585D-4A41-A9B2-28DA8F*******\\",\\n \\"order_id\\": \\"2067*******0374\\"\\n}","errorExample":""},{"type":"xml","example":"<request_id>20758A-585D-4A41-A9B2-28DA8F4F534F</request_id>\\n<order_id>2067*******0374</order_id>","errorExample":""}]', + 'title' => '开通容器服务Kubernetes版', + 'description' => '- 阿里云账号（主账号）可以开通容器服务ACK。'."\n" + .'- RAM用户（子账号）有AdministratorAccess权限的子账号可以开通服务。', + ], + 'DescribeRegions' => [ + 'summary' => '查询地域列表', + 'path' => '/regions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254114', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'clusterType', + 'in' => 'query', + 'schema' => [ + 'title' => '集群类型。', + 'description' => '集群类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ExternalKubernetes' => '注册集群', + 'ManagedKubernetes' => '托管类集群', + 'Kubernetes' => '专有版集群', + ], + 'example' => 'ManagedKubernetes', + 'enum' => [ + 'Kubernetes', + 'ManagedKubernetes', + 'ExternalKubernetes', + ], + ], + ], + [ + 'name' => 'profile', + 'in' => 'query', + 'schema' => [ + 'title' => '集群场景。', + 'description' => '托管类集群子类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Lingjun' => 'ACK Lingjun 集群', + 'Serverless' => 'ACK Serverless 集群', + 'Default' => 'ACK 托管集群', + 'Edge' => 'ACK Edge 集群', + ], + 'example' => 'Default', + 'enum' => [ + 'Default', + 'Serverless', + 'Edge', + 'Lingjun', + ], + ], + ], + [ + 'name' => 'acceptLanguage', + 'in' => 'query', + 'schema' => [ + 'title' => '根据汉语、英语筛选返回结果。', + 'description' => '根据汉语、英语筛选返回结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh-CN', + 'enum' => [ + 'zh-CN', + 'en-US', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求Id', + 'type' => 'string', + 'example' => 'CE0F23E3-C5F5-5FB3-AA9F-134093C49C60', + ], + 'regions' => [ + 'description' => '地域列表', + 'type' => 'array', + 'items' => [ + 'description' => '地域信息', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'localName' => [ + 'description' => '地域名称。', + 'type' => 'string', + 'example' => '华东1（杭州）', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"CE0F23E3-C5F5-5FB3-AA9F-134093C49C60\\",\\n \\"regions\\": [\\n {\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"localName\\": \\"华东1（杭州）\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询地域列表', + ], + 'CreateCluster' => [ + 'summary' => '您可以通过OpenAPI创建ACK集群，包含ACK托管集群、ACK Serverless集群，ACK Edge集群以及注册集群。创建集群时，您将完成集群信息、集群组件以及ACK相关云资源的配置。', + 'path' => '/clusters', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '411', + 'abilityTreeNodes' => [ + 'FEATUREcskJEIDU7', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '集群名称。', + 'description' => '自定义集群名称。由数字、汉字、英文字符或短划线（-）组成，长度范围1~63个字符，且不能以短划线（-）开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'cluster-demo', + ], + 'region_id' => [ + 'title' => '地域ID', + 'description' => '集群所在地域ID。详情请参见[容器服务开服地域](~~216938~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + 'cluster_type' => [ + 'title' => '集群类型', + 'description' => '- `Kubernetes`: ACK专有集群。'."\n" + .'- `ManagedKubernetes`：ACK托管类的集群，包括ACK托管集群（Pro版、基础版）、ACK Serverless集群（Pro版、基础版）、ACK Edge集群（Pro版、基础版）、ACK灵骏集群（Pro版）。'."\n" + .'- `ExternalKubernetes`：注册集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'Kubernetes', + ], + 'cluster_spec' => [ + 'title' => '托管版集群类型', + 'description' => '当您选择`cluster_type`为`ManagedKubernetes`并配置`profile`后，您可以进一步指定集群的规格。'."\n" + ."\n" + .'- `ack.pro.small`：Pro版。'."\n" + .'- `ack.standard`：基础版（取值为空时默认选择）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack.pro.small', + ], + 'profile' => [ + 'title' => '面向场景时的集群类型。 Default：非边缘场景集群。 Edge：边缘场景集群。', + 'description' => '选择`cluster_type`为`ManagedKubernetes`时，即ACK托管类的集群时，可进一步指定集群的子类型。'."\n" + .'- `Default`：ACK托管集群，包括ACK集群（Pro版、基础版）。'."\n" + .'- `Edge`：ACK Edge集群，包括ACK Edge集群（Pro版、基础版）。'."\n" + .'- `Serverless`：ACK Serverless集群，包括ACK Serverless集群（Pro版、基础版）。'."\n" + .'- `Lingjun`：ACK灵骏集群，提供Pro版。', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + 'kubernetes_version' => [ + 'title' => '集群版本', + 'description' => '集群版本，与Kubernetes社区基线版本保持一致。建议选择最新版本。若不指定，默认使用最新版本。'."\n" + ."\n" + .'支持创建最近三个版本的集群，可通过[DescribeKubernetesVersionMetadata](~~2667899~~)接口查询支持的集群版本。'."\n" + ."\n" + .'关于ACK支持的Kubernetes版本，请参见[Kubernetes版本发布概览](~~185269~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1.32.1-aliyun.1', + ], + 'auto_mode' => [ + 'title' => '智能托管模式配置。', + 'description' => '[智能托管模式](~~2938898~~)配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => '是否开启智能托管模式。'."\n" + ."\n" + .'- true：开启。'."\n" + ."\n" + .'- false：不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'tags' => [ + 'title' => '集群标签', + 'description' => '节点标签。标签定义规则：'."\n" + ."\n" + .'- 标签由区分大小写的键值对组成，您最多可以设置20个标签。'."\n" + .'- 标签键不可以重复，最长为64个字符；标签值可以为空，最长为128个字符。标签键和标签值都不能以“aliyun”、“acs:”、“https://”或“http://”开头。详情请参见[Labels and Selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。', + 'type' => 'array', + 'items' => [ + 'description' => '节点标签。标签定义规则：'."\n" + ."\n" + .'- 标签由区分大小写的键值对组成，您最多可以设置20个标签。'."\n" + .'- 标签键不可以重复，最长为64个字符；标签值可以为空，最长为128个字符。标签键和标签值都不能以“aliyun”、“acs:”、“https://”或“http://”开头。详情请参见[Labels and Selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。', + 'required' => false, + '$ref' => '#/components/schemas/tag', + ], + 'required' => false, + ], + 'resource_group_id' => [ + 'title' => '集群所属资源组ID', + 'description' => '集群所属资源组ID，实现不同资源的隔离。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfm3mkrure****', + ], + 'deletion_protection' => [ + 'title' => '集群删除保护', + 'description' => '集群删除保护，防止通过控制台或API误删除集群。取值：'."\n" + ."\n" + .'- `true`：启用集群删除保护，将不能通过控制台或API删除集群。'."\n" + .'- `false`：不启用集群删除保护，则能通过控制台或API删除集群。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'zone_ids' => [ + 'title' => '专有网络虚拟交换机所在的可用区，使用自动创建专有网络创建ACK集群时指定，最多支持5个不同的可用区。', + 'description' => '集群所属地域的多个可用区ID。此参数为ACK托管类的集群特有参数。', + 'type' => 'array', + 'items' => [ + 'description' => '集群所属地域的可用区ID，将在该可用区自动创建虚拟交换机。'."\n" + ."\n" + .'当创建ACK托管类的集群时，如果未指定`vpc_id`和`vswitch_ids`，为集群指定`zone_ids`，用于自动在多个可用区内创建VPC网络资源；指定`vpc_id`和`vswitch_ids`时，该参数无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing-h', + ], + 'required' => false, + ], + 'vpcid' => [ + 'title' => '集群专有网络ID，非自动创建专有网络时必填。', + 'description' => '集群使用的专有网络，创建集群时必须为集群提供。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-2zeik9h3ahvv2zz95****', + ], + 'vswitch_ids' => [ + 'title' => '集群控制面虚拟交换机。非自动创建专有网络时必填。', + 'description' => '集群节点所在虚拟交换机，当创建零节点的托管版集群时，该字段必填。', + 'type' => 'array', + 'items' => [ + 'description' => '集群节点所在虚拟交换机，当创建零节点的托管版集群时，该字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2ze3ds0mdip0hdz8i****', + ], + 'required' => false, + ], + 'ip_stack' => [ + 'title' => '集群的IP协议栈，可取值：'."\n" + .'- ipv4：创建仅支持IPv4协议栈的集群；'."\n" + .'- dual：创建支持IPv4/IPv6双栈的集群。', + 'description' => '集群ip_stack。', + 'type' => 'string', + 'required' => false, + 'example' => '可选值：'."\n" + .'ipv4（单栈）'."\n" + .'dual（双栈），默认值为ipv4。', + 'default' => 'ipv4', + 'enum' => [ + 'ipv4', + 'dual', + ], + ], + 'pod_vswitch_ids' => [ + 'title' => '创建Terway网络类型的集群时，需要为pod指定单独的虚拟交换机', + 'description' => '【**该字段已废弃**】网络插件选择Terway时，您需要为Pod分配IP的虚拟交换机。每个Pod虚拟交换机分别对应一个Worker节点的虚拟交换机，Pod虚拟交换机和Worker节点的虚拟交换机的可用区需保持一致。'."\n" + .'> Pod虚拟交换机的网段掩码建议不超过19，最大不超过25，否则集群网络可分配的Pod IP地址非常有限，会影响集群的正常使用。', + 'type' => 'array', + 'items' => [ + 'description' => '网络插件选择Terway时，您需要为Pod分配IP的虚拟交换机。每个Pod虚拟交换机分别对应一个Worker节点的虚拟交换机，Pod虚拟交换机和Worker节点的虚拟交换机的可用区需保持一致。'."\n" + .'> Pod虚拟交换机的网段掩码建议不超过19，最大不超过25，否则集群网络可分配的Pod IP地址非常有限，会影响集群的正常使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2ze97jwri7cei0mpw****', + ], + 'deprecated' => true, + 'required' => false, + ], + 'container_cidr' => [ + 'title' => 'POD网络网段', + 'description' => 'Pod网络地址段，必须是有效的私有网段，即以下网段及其子网：10.0.0.0/8、172.16-31.0.0/12-16、192.168.0.0/16。不能与VPC及VPC内已有Kubernetes集群使用的网段重复，创建成功后不能修改。'."\n" + ."\n" + .'关于集群网络规划，请参见[ACK托管集群网络规划](~~86500~~)。'."\n" + ."\n" + .'> Flannel集群中，此字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => '172.20.0.0/16', + ], + 'service_cidr' => [ + 'title' => '服务网络网段', + 'description' => 'Service网络地址段，可选范围：10.0.0.0/16-24，172.16-31.0.0/16-24，192.168.0.0/16-24'."\n" + .'不能与VPC网段10.1.0.0/21及VPC内已有Kubernetes集群使用的网段重复，创建成功后不能修改。'."\n" + ."\n" + .'默认使用172.19.0.0/20网段。', + 'type' => 'string', + 'required' => false, + 'example' => '172.21.0.0/20', + ], + 'security_group_id' => [ + 'title' => '安全组ID，和is_enterprise_security_group二选一', + 'description' => '使用已有安全组创建集群时需要指定安全组ID，和`is_enterprise_security_group`二选一，集群节点自动加入到此安全组。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp1bdue0qc1g7k****', + ], + 'is_enterprise_security_group' => [ + 'title' => '自动创建企业安全组', + 'description' => '自动创建企业级安全组，当`security_group_id`为空时生效。'."\n" + ."\n" + .'> 使用普通安全组时，集群内节点与Terway Pod数量之和不能超过2000。所以创建Terway网络类型集群时，建议使用企业安全组。'."\n" + ."\n" + .'- `true`：创建并使用企业级安全组。'."\n" + .'- `false`：使用普通安全组。'."\n" + ."\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'snat_entry' => [ + 'title' => '若您集群内的节点、应用等需要访问公网，勾选该项后我们将为您创建 NAT 网关并自动配置 SNAT 规则', + 'description' => '为专有网络配置SNAT。取值：'."\n" + ."\n" + .'- `true`：自动创建NAT网关并自动配置SNAT规则。集群内的节点、应用等需要访问公网需要设置为`true`。'."\n" + .'- `false`：不创建NAT网关及SNAT规则。集群内节点及应用将不能访问公网。'."\n" + ."\n" + .'> 如果创建集群时未开启，后续业务需要访问公网，可[手动开启](~~178480~~)。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'control_plane_endpoints_config' => [ + 'title' => '集群连接配置。指定该字段时，endpoint_public_access、load_balancer_id参数不生效。如需要指定CLB/NLB，需要使用load_balancers_config指定对应实例ID。', + 'description' => '集群连接配置。', + 'type' => 'object', + 'properties' => [ + 'internal_dns_config' => [ + 'title' => '集群内部域名配置，适用于ACK托管集群。集群内部域名用于 kubelet、kube-proxy 等节点侧系统组件访问 API Server；未开启集群内部域名访问时，节点侧系统组件将通过 CLB IP 方式访问。', + 'description' => '集群内部域名配置，适用于ACK托管集群。集群内部域名用于 kubelet、kube-proxy 等节点侧系统组件访问 API Server；未开启集群内部域名访问时，节点侧系统组件将通过 CLB IP 方式访问。', + 'type' => 'object', + 'properties' => [ + 'bind_vpcs' => [ + 'title' => '集群内部域名记录解析生效的 VPC 范围，默认包括集群所在 VPC。', + 'description' => '集群内部域名记录解析生效的 VPC。', + 'type' => 'array', + 'items' => [ + 'title' => '集群内部域名生效的VPC。', + 'description' => '集群内部域名记录解析生效的 VPC。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-xxxx', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'endpoint_public_access' => [ + 'title' => '使用EIP暴露apiServer', + 'description' => '是否开启公网访问。通过EIP暴露API Server，实现集群公网访问。'."\n" + ."\n" + .'- `true`：开启公网访问。'."\n" + .'- `false`：不开启公网访问。选择不开放时，则无法通过外网访问集群API Server。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'load_balancer_id' => [ + 'title' => '指定用于APIServer访问的CLB实例ID。指定该参数时，将不再自动创建APIServer CLB。', + 'description' => '指定用于API Server访问的CLB实例ID。指定该参数时，将不再自动创建API Server CLB。'."\n" + .'> 请确保该CLB实例无其他依赖（如存在监听、后端服务器等），不支持共享型、公网类型的CLB指定。', + 'type' => 'string', + 'required' => false, + 'example' => 'lb-wz9t256gqa3vbouk****', + ], + 'ssh_flags' => [ + 'title' => '允许公网ssh登录', + 'description' => '是否开放公网SSH登录。用于登录ACK专有集群的Master节点。托管集群中，该参数不生效。'."\n" + .'- `true`：开放。'."\n" + .'- `false`：不开放。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'timezone' => [ + 'title' => '时区', + 'description' => '集群使用的时区。请参见[支持时区](~~354879~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'Asia/Shanghai', + ], + 'node_cidr_mask' => [ + 'title' => '节点IP数量', + 'description' => '节点IP数量，通过指定网络的CIDR来确定IP的数量，只对于Flannel网络类型集群生效。'."\n" + ."\n" + .'默认值：`26`。', + 'type' => 'string', + 'required' => false, + 'example' => '25', + ], + 'proxy_mode' => [ + 'title' => 'Proxy代理模式，ipvs|iptables', + 'description' => 'kube-proxy代理模式'."\n" + ."\n" + .'- `iptables`: 成熟稳定的kube-proxy代理模式，Kubernetes Service的服务发现和负载均衡使用iptables规则配置，但是性能一般，受规模影响较大，适用于集群存在少量的Service。'."\n" + .'- `ipvs`：高性能的kube-proxy代理模式，Kubernetes Service的服务发现和负载均衡使用Linux IPVS模块进行配置，适用于集群存在大量的Service，对负载均衡有高性能要求的场景。'."\n" + ."\n" + .'默认值：`ipvs`。', + 'type' => 'string', + 'required' => false, + 'example' => 'ipvs', + ], + 'controlplane_log_ttl' => [ + 'title' => '控制平面日志', + 'description' => '控制面组件日志保存天数。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'controlplane_log_project' => [ + 'title' => '使用已有log project时，需要指定log project', + 'description' => '控制平面组件日志服务Project，可以使用已有Project用于日志存储，也可以使用系统自动创建Project用户日志存储。如果选择自动创建日志服务Project将会自动创建一个名称为`k8s-log-{ClusterID}`的日志服务Project。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s-log-xxx', + ], + 'controlplane_log_components' => [ + 'title' => '需要采集日志的组件', + 'description' => '组件名称列表，指定采集哪些控制面组件的日志。'."\n" + ."\n" + .'默认采集kube-apiserver、kube-controller-manager、kube-scheduler、cloud-controller-manager的日志。', + 'type' => 'array', + 'items' => [ + 'description' => '组件名称列表，指定采集哪些控制面组件的日志。'."\n" + ."\n" + .'默认采集kube-apiserver、kube-controller-manager、kube-scheduler、cloud-controller-manager的日志。', + 'type' => 'string', + 'required' => false, + 'example' => '["apiserver","kcm","scheduler"]', + ], + 'required' => false, + ], + 'audit_log_config' => [ + 'description' => '集群审计日志配置。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '是否开启集群审计日志功能。'."\n" + ."\n" + .'- true：开启。'."\n" + ."\n" + .'- false：不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'sls_project_name' => [ + 'description' => '集群审计日志[Logstore](~~48873~~)所在的[SLS Project](~~48873~~)。'."\n" + ."\n" + .'- 默认值为`k8s-log-{clusterid}`。'."\n" + ."\n" + .'- 开启集群审计日志功能后会在指定的SLS Project下创建集群审计日志对应的Logstore。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s-log-c2345xxxxxxxxxxxx', + ], + ], + 'required' => false, + ], + 'rrsa_config' => [ + 'title' => '配置 RRSA 功能。', + 'description' => 'RRSA 功能配置。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => '是否启用 RRSA 功能。', + 'description' => '是否开启 RRSA 功能。'."\n" + ."\n" + .'- true：开启。'."\n" + ."\n" + .'- false：不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'cluster_domain' => [ + 'title' => '集群本地域名', + 'description' => '集群本地域名。'."\n" + ."\n" + .'命名规则：域名由小数点（.）分隔的一个或多个部分构成，每个部分最长为63个字符，可以使用小写字母、数字和短划线（-），且首尾必须为小写字母或数字。', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster.local', + ], + 'encryption_provider_key' => [ + 'title' => 'Secret落盘加密', + 'description' => 'KMS密钥ID，使用该密钥对数据盘进行加密。更多详情，请参见[密钥管理服务](~~28935~~)。'."\n" + ."\n" + .'> 该功能只在专业托管版集群（ACK Pro版集群）中生效。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0fe64791-55eb-4fc7-84c5-c6c7cdca****', + ], + 'service_account_issuer' => [ + 'title' => 'serviceaccount token中的签发身份，即token payload中的iss字段。', + 'description' => 'ServiceAccount是Pod和集群API Server通讯的访问凭证。而`service-account-issuer`是`serviceaccount token`中的签发身份，即`token payload`中的`iss`字段。'."\n" + ."\n" + .'关于`ServiceAccount`更多详情，请参见[部署服务账户令牌卷投影](~~160384~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'kubernetes.default.svc', + ], + 'api_audiences' => [ + 'title' => '合法的请求token身份，用于apiserver服务端认证请求token是否合法。', + 'description' => 'ServiceAccount是Pod和集群API Server通讯的访问凭证，而`api-audiences`是合法的请求`token`身份，用于`apiserver`服务端认证请求`token`是否合法。支持配置多个`audience`，通过英文半角逗号（,）分割。'."\n" + ."\n" + .'关于`ServiceAccount`更多详情，请参见[部署服务账户令牌卷投影](~~160384~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'kubernetes.default.svc', + ], + 'extra_sans' => [ + 'title' => '自定义 API Server 证书 SAN（Subject Alternative Name）。', + 'description' => '自定义 API Server 证书 SAN（Subject Alternative Name）。', + 'type' => 'array', + 'items' => [ + 'title' => 'SAN。支持自定义 IP 地址或域名。', + 'description' => '证书 SAN。支持自定义 IP 地址或域名。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.xx.xx', + ], + 'required' => false, + ], + 'maintenance_window' => [ + 'description' => '集群维护窗口。', + 'required' => false, + '$ref' => '#/components/schemas/maintenance_window', + ], + 'operation_policy' => [ + 'title' => '集群自动运维策略。', + 'description' => '集群自动运维策略。', + 'type' => 'object', + 'properties' => [ + 'cluster_auto_upgrade' => [ + 'title' => '集群自动升级。', + 'description' => '集群自动升级。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => '是否开启集群自动升级。', + 'description' => '是否开启集群自动升级。'."\n" + ."\n" + .'- true：开启。'."\n" + ."\n" + .'- false：不开启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'channel' => [ + 'title' => '集群自动升级频次。可取值：'."\n" + .'- patch'."\n" + .'- stable'."\n" + .'- rapid', + 'description' => '集群自动升级频次。可取值：'."\n" + .'- patch：当前次要版本存在可用的补丁版本时，自动升级到该补丁版本，新的Kubernetes版本不会带有破坏性变更（Breaking Changes）。'."\n" + .'- stable：自动升级至次要版本为次新的最新补丁版本。新的Kubernetes版本可能涉及API和功能特性的变更，但其稳定性已经过广泛验证。'."\n" + .'- rapid：自动升级至最新次要版本的最新补丁版本，以更快获取Kubernetes社区的新特性。', + 'type' => 'string', + 'required' => false, + 'example' => 'stable', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'addons' => [ + 'title' => '集群组件配置', + 'description' => '集群组件列表，创建集群时通过`addons`指定想要安装的集群组件。'."\n" + ."\n" + .'**网络组件**：必选，包含Flannel和Terway两种网络类型，创建集群时二选一：'."\n" + ."\n" + .'- Flannel网络：\\[{"name":"flannel","config":""}\\]。'."\n" + .'- Terway网络：\\[{"name": "terway-eniip","config": ""}\\] 。'."\n" + ."\n" + .'**存储组件**：可选，仅支持`csi`类型：'."\n" + ."\n" + .'`csi`：\\[{"name":"csi-plugin","config": ""},{"name": "csi-provisioner","config": ""}\\]。'."\n" + ."\n" + .'**日志组件**：可选。推荐开启，如果不开启日志服务时，将无法使用集群审计功能。'."\n" + ."\n" + .'- 使用已有`SLS Project`：\\[{"name": "loongcollector","config": "{\\"IngressDashboardEnabled\\":\\"true\\",\\"sls_project_name\\":\\"your_sls_project_name\\"}"}\\] 。'."\n" + .'- 创建新的`SLS Project`：\\[{"name": "loongcollector","config": "{\\"IngressDashboardEnabled\\":\\"true\\"}"}\\] 。'."\n" + ."\n" + .'**Ingress组件**：可选，ACK专有版集群默认安装Ingress组件`nginx-ingress-controller`。'."\n" + ."\n" + .'- 安装Ingress并且开启公网：\\[{"name":"nginx-ingress-controller","config":"{\\"IngressSlbNetworkType\\":\\"internet\\"}"}\\] 。'."\n" + .'- 禁止默认安装Ingress：\\[{"name": "nginx-ingress-controller","config": "","disabled": true}\\] 。'."\n" + ."\n" + .'**事件中心**：可选，默认开启。'."\n" + ."\n" + .'事件中心提供对Kubernetes事件的存储、查询、告警等能力。Kubernetes事件中心关联的Logstore在90天内免费。关于免费策略的更多信息，请参见[创建并使用Kubernetes事件中心](~~150476~~)。'."\n" + ."\n" + .'开启事件中心示例：\\[{"name":"ack-node-problem-detector","config":"{\\"sls_project_name\\":\\"your_sls_project_name\\"}"}\\]。', + 'type' => 'array', + 'items' => [ + 'description' => '集群组件列表，创建集群时通过`addons`指定想要安装的集群组件。', + 'required' => false, + '$ref' => '#/components/schemas/addon', + ], + 'required' => false, + ], + 'nodepools' => [ + 'description' => '节点池列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点池配置。', + 'required' => false, + '$ref' => '#/components/schemas/nodepool', + ], + 'required' => false, + ], + 'user_ca' => [ + 'title' => '自定义集群CA', + 'description' => '自定义集群CA。', + 'type' => 'string', + 'required' => false, + 'example' => '-----BEGIN CERTIFICATE-----****', + ], + 'control_plane_config' => [ + 'title' => '专有版集群控制面配置。', + 'description' => 'ACK专有集群控制面配置。', + 'type' => 'object', + 'properties' => [ + 'charge_type' => [ + 'title' => '控制面节点付费类型。', + 'description' => '控制面节点付费类型。'."\n" + ."\n" + .'- `PrePaid`：包年包月。'."\n" + .'- `PostPaid`：按量付费。'."\n" + ."\n" + .'默认值：`PostPaid`。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + ], + 'period' => [ + 'title' => '控制面节点包年包月时间。', + 'description' => '控制面节点包年包月的时长。当付费类型为`PrePaid`时有效且为必选值。'."\n" + ."\n" + .'取值范围：{1, 2, 3, 6, 12, 24, 36, 48, 60}，单位：月。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'period_unit' => [ + 'title' => '控制面节点包年包月时间单位。', + 'description' => '控制面节点包年包月时间单位。当付费类型为`PrePaid`时有效且为必选值。'."\n" + ."\n" + .'取值：`Month`，当前仅支持以月为周期。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + 'auto_renew' => [ + 'title' => '控制面节点是否自动续费。', + 'description' => '控制面节点是否自动续费。当付费类型为`PrePaid`时有效。'."\n" + .'- true：开启自动续费。'."\n" + .'- false：不开启自动续费。'."\n" + ."\n" + .'默认值：true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_renew_period' => [ + 'title' => '控制面节点自动续费时长。', + 'description' => '控制面节点自动续费时长。'."\n" + ."\n" + .'取值范围：{1, 2, 3, 6, 12}，单位：月。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'instance_types' => [ + 'title' => '节点实例类型。', + 'description' => '节点实例类型。', + 'type' => 'array', + 'items' => [ + 'description' => '节点实例规格类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large'."\n", + ], + 'required' => false, + ], + 'image_type' => [ + 'title' => '操作系统镜像类型。', + 'description' => '操作系统镜像类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunLinux3'."\n", + ], + 'image_id' => [ + 'title' => '镜像id', + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_3_x64_20G_alibase_20240819.vhd'."\n", + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。', + 'description' => '密钥对名称，和login_password二选一。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack', + ], + 'login_password' => [ + 'title' => 'SSH登录密码。密码规则为8~30 个字符，且至少同时包含三项（大小写字母、数字和特殊符号），和key_pair二选一。', + 'description' => 'SSH登录密码。密码规则为8~30 个字符，且至少同时包含三项（大小写字母、数字和特殊符号），和key_pair二选一。', + 'type' => 'string', + 'required' => false, + 'example' => '********', + ], + 'system_disk_category' => [ + 'title' => '节点系统盘类型。', + 'description' => '节点系统盘类型。'."\n" + ."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL 云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。'."\n" + ."\n" + .'默认值：`cloud_ssd`。不同可用区，默认值可能会有所差异。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_ssd', + ], + 'system_disk_size' => [ + 'title' => '节点系统盘大小，至少40。', + 'description' => '节点系统盘大小。'."\n" + ."\n" + .'取值范围\\[40,500\\]，单位：GiB。'."\n" + ."\n" + .'默认值：`120`。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '120', + ], + 'system_disk_snapshot_policy_id' => [ + 'title' => '节点自动快照备份策略。', + 'description' => '节点自动快照备份策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'sp-2zej1nogjvovnz4z****'."\n", + ], + 'system_disk_performance_level' => [ + 'title' => '节点系统盘磁盘性能，只针对ESSD磁盘生效。', + 'description' => '节点系统盘磁盘性能，只针对ESSD磁盘生效。'."\n" + ."\n" + .'磁盘性能等级和磁盘大小有关，更多信息，请参见[ESSD云盘](~~122389~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'system_disk_provisioned_iops' => [ + 'title' => '节点系统盘预配置的读写IOPS。', + 'description' => '节点系统盘预配置的读写IOPS。'."\n" + ."\n" + .'可能值：0~min{50,000, 1000\\*容量-基准性能}。 基准性能=min{1,800+50\\*容量, 50000}。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'system_disk_bursting_enabled' => [ + 'title' => '节点系统盘是否开启Burst（性能突发）。', + 'description' => '节点系统盘是否开启Burst（性能突发）。'."\n" + ."\n" + .'- true：开启。'."\n" + ."\n" + .'- false：不开启。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'deploymentset_id' => [ + 'title' => '部署集ID。', + 'description' => '部署集ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp10b35imuam5amw****'."\n", + ], + 'cloud_monitor_flags' => [ + 'title' => '是否为节点安装云监控。', + 'description' => '是否为节点安装云监控。'."\n" + ."\n" + .'- true：安装云监控插件。'."\n" + ."\n" + .'- false：不安装云监控插件。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'instance_metadata_options' => [ + 'title' => 'ECS 实例的元数据访问配置。该参数目前仅白名单开放，如需使用，请提交工单申请。', + 'description' => 'ECS 实例元数据访问配置。', + 'required' => false, + '$ref' => '#/components/schemas/InstanceMetadataOptions', + ], + 'soc_enabled' => [ + 'title' => '是否开启等保安全加固。', + 'description' => '是否开启等保安全加固。'."\n" + ."\n" + .'- true：开启等保加固。'."\n" + ."\n" + .'- false：不开启等保加固。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'security_hardening_os' => [ + 'title' => '是否开启阿里云OS安全加固。', + 'description' => '是否开启阿里云OS安全加固。'."\n" + ."\n" + .'- true：开启阿里云OS安全加固。'."\n" + ."\n" + .'- false：不开启阿里云OS安全加固。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'cpu_policy' => [ + 'title' => '节点CPU管理策略。', + 'description' => '节点CPU管理策略。'."\n" + ."\n" + .'- static：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + ."\n" + .'- none：表示启用现有的默认CPU亲和性方案。'."\n" + ."\n" + .'默认值：none。', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + 'runtime' => [ + 'title' => '运行时名称。', + 'description' => '【**该字段已废弃**】控制面节点运行时名称。取值：'."\n" + ."\n" + .'containerd：Containerd运行时，支持所有集群版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'containerd', + ], + 'node_port_range' => [ + 'title' => '节点服务端口范围。', + 'description' => '【**该字段已废弃**】节点服务端口范围。', + 'type' => 'string', + 'required' => false, + 'example' => '30000-32767'."\n", + ], + 'size' => [ + 'title' => '控制面节点数量。', + 'description' => '控制面节点数量。'."\n" + ."\n" + .'可选值`3`或`5`。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + 'custom_san' => [ + 'title' => '自定义证书SAN', + 'description' => '【**该字段已废弃**】请使用参数`extra_sans`代替。'."\n" + ."\n" + .'自定义证书SAN，多个IP或域名以英文逗号（,）分隔。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cs.aliyun.com', + ], + 'runtime' => [ + 'title' => '该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.runtime及runtime_version，节点池请使用kubernetes_config.runtime及runtime_version。', + 'description' => '集群内容器运行时。支持containerd、安全沙箱和Docker。'."\n" + .'> Kubernetes 1.24不再支持将Docker作为内置容器运行时。'."\n" + ."\n" + .'更多信息，请参见[Docker、containerd、安全沙箱运行时的对比](~~160313~~)。', + 'deprecated' => true, + 'required' => false, + '$ref' => '#/components/schemas/runtime', + ], + 'node_name_mode' => [ + 'title' => '自定义节点名称。该参数已废弃，节点池请使用kubernetes_config.node_name_mode。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`kubernetes_config`下的`node_name_mode`的参数代替。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'user_data' => [ + 'title' => '节点自定义数据', + 'description' => '【**该字段已废弃**】自定义节点数据。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFD****', + ], + 'image_id' => [ + 'title' => '自定义镜像。该参数已废弃，Kubernetes类型集群控制面节点请使用control_plane_config.image_id，节点池请使用scaling_group.image_id。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`image_id`参数代替；节点池配置请使用`nodepool`中`scaling_group`下的`image_id`参数代替。'."\n" + ."\n" + .'节点自定义镜像，默认使用系统镜像。当选择自定义镜像时，将取代默认系统镜像。请参见[自定义镜像](~~146647~~)。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'm-bp16z7xko3vvv8gt****', + ], + 'rds_instances' => [ + 'title' => 'RDS白名单。该参数已废弃，节点池请使用scaling_group.rds_instances。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`rds_instances`参数代替。'."\n" + ."\n" + .'RDS实例列表，选择您想想要添加白名单的RDS实例。 建议前往RDS加入容器Pod网段与Node网段，设置RDS实例会由于实例非运行的状态导致无法弹出。', + 'type' => 'array', + 'items' => [ + 'description' => 'RDS实例列表，选择您想想要添加白名单的RDS实例。 建议前往RDS加入容器Pod网段与Node网段，设置RDS实例会由于实例非运行的状态导致无法弹出。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-2zev748xi27xc****', + ], + 'deprecated' => true, + 'required' => false, + ], + 'taints' => [ + 'title' => '节点污点信息。该参数已废弃，节点池请使用kubernetes_config.taints。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`kubernetes_config`下的`taints`参数代替。'."\n" + ."\n" + .'节点污点信息。污点和容忍度（Toleration）相互配合，可以用来避免Pod被分配到不合适的节点上。更多信息，请参见[taint-and-toleration](https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/)。', + 'type' => 'array', + 'items' => [ + 'description' => '节点污点信息。污点和容忍度（Toleration）相互配合，可以用来避免Pod被分配到不合适的节点上。更多信息，请参见[taint-and-toleration](https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/)。', + 'required' => false, + '$ref' => '#/components/schemas/taint', + ], + 'deprecated' => true, + 'required' => false, + ], + 'cloud_monitor_flags' => [ + 'title' => '为ECS安装云监控。该参数已废弃，Kubernetes类型集群控制面节点请使用control_plane_config.cloud_monitor_flags，节点池请使用kubernetes_config.cms_enabled。', + 'description' => '【**该字段已废弃**】集群控制面节点配置请使用`control_plane_config`下的`cloud_monitor_flags`参数代替；节点池配置请使用nodepool中`kubernetes_config`下的`cms_enabled`参数代替。'."\n" + ."\n" + .'集群是否安装云监控插件。取值：'."\n" + ."\n" + .'- `true`：安装云监控插件。'."\n" + .'- `false`：不安装云监控插件。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + 'platform' => [ + 'title' => '操作系统发行版。该参数已废弃，节点池请使用scaling_group.os_type。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`platform`参数代替。'."\n" + ."\n" + .'操作系统发行版。取值：'."\n" + ."\n" + .'- CentOS'."\n" + .'- AliyunLinux'."\n" + .'- QbootAliyunLinux'."\n" + .'- Qboot'."\n" + .'- Windows'."\n" + .'- WindowsCore'."\n" + ."\n" + .'默认值：`CentOS`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'CentOS', + ], + 'os_type' => [ + 'title' => '操作系统平台类型。该参数已废弃，Kubernetes类型集群控制面节点请使用control_plane_config.image_type，节点池请使用scaling_group.image_type。', + 'description' => '【**该字段已废弃**】集群控制面节点配置请使用`control_plane_config`下的`image_type`参数代替；节点池配置请使用`nodepool`中`scaling_group`下的`image_type`参数代替。'."\n" + ."\n" + .'操作系统平台类型。取值：'."\n" + .'- Windows'."\n" + .'- Linux'."\n" + ."\n" + .'默认值：`Linux`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'Linux', + ], + 'soc_enabled' => [ + 'title' => '等保安全加固。该参数已废弃，Kubernetes类型集群控制面节点请使用control_plane_config.soc_enabled，节点池请使用scaling_group.soc_enabled。', + 'description' => '【**该字段已废弃**】集群控制面节点配置请使用`control_plane_config`下的`soc_enabled`参数代替；节点池配置请使用`nodepool`中`scaling_group`下的`soc_enabled`参数代替。'."\n" + ."\n" + .'等保加固。更多信息，请参见[ACK等保加固使用说明](~~196148~~)。'."\n" + ."\n" + .'取值：'."\n" + .'- `true`：开启等保加固。'."\n" + .'- `false`：不开启等保加固。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + 'security_hardening_os' => [ + 'title' => '是否开启阿里云OS安全加固。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.security_hardening_os，节点池请使用scaling_group.security_hardening_os。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`security_hardening_os`参数代替；节点池配置请使用`nodepool`中`scaling_group`下的`security_hardening_os`参数代替。'."\n" + ."\n" + .'阿里云OS安全加固。取值：'."\n" + ."\n" + .'- `true`：开启阿里云OS安全加固。'."\n" + .'- `false`：不开启阿里云OS安全加固。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + 'cis_enabled' => [ + 'title' => '【已废弃】该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.security_hardening_os，节点池请使用scaling_group.security_hardening_os。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`security_hardening_os`参数代替；节点池配置请使用`nodepool`中`scaling_group`下的`security_hardening_os`参数代替。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + 'cpu_policy' => [ + 'title' => '该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.cpu_policy，节点池请使用kubernetes_config.cpu_policy。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`cpu_policy`参数代替；节点池配置请使用`nodepool`中`kubernetes_config`下的`cpu_policy`参数代替。'."\n" + ."\n" + .'节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略：'."\n" + ."\n" + .'- `static`：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + .'- `none`：表示启用现有的默认CPU亲和性方案。'."\n" + ."\n" + .'默认值：`none`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'none', + ], + 'node_port_range' => [ + 'title' => '节点服务端口范围', + 'description' => '节点服务端口，可选端口范围：\\[30000,65535\\]。'."\n" + ."\n" + .'默认值：`30000-32767`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '30000~32767 ', + ], + 'master_vswitch_ids' => [ + 'title' => '集群Master节点使用的虚拟交换机。该参数已废弃，请使用vswitch_ids。', + 'description' => '【**该字段已废弃**】请使用`vswitch_ids`参数代替。'."\n" + ."\n" + .'Master节点交换机ID列表，交换机个数取值范围为\\[1,3\\]。为确保集群的高可用性，推荐您选择3个交换机，且分布在不同的可用区。'."\n" + ."\n" + .'指定的实例规格数量需要和`master_count`保持一致，和`master_vswitch_ids`中的元素一一对应。', + 'type' => 'array', + 'items' => [ + 'description' => 'Master节点交换机ID列表，交换机个数取值范围为\\[1,3\\]。为确保集群的高可用性，推荐您选择3个交换机，且分布在不同的可用区。'."\n" + ."\n" + .'指定的实例规格数量需要和`master_count`保持一致，和`master_vswitch_ids`中的元素一一对应。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2ze3ds0mdip0hdz8i****', + ], + 'deprecated' => true, + 'required' => false, + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.key_pair，节点池请使用scaling_group.key_pair。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`key_pair`参数代替；节点池配置请使用`nodepool`中`scaling_group`下的`key_pair`参数代替。'."\n" + ."\n" + .'密钥对名称，和`login_password`二选一。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'security-key', + ], + 'login_password' => [ + 'title' => 'SSH登录密码。密码规则为8~30 个字符，且至少同时包含三项（大小写字母、数字和特殊符号），和key_pair二选一。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.login_password，节点池请使用scaling_group.login_password。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`login_password`参数代替；节点池配置请使用`nodepool`中`scaling_group`下的`login_password`参数代替。'."\n" + ."\n" + .'SSH登录密码，和`key_pair `二选一。密码规则为8~30个字符，且至少同时包含三项（大小写字母、数字和特殊符号）。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'master_count' => [ + 'title' => '集群Master节点数量。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.size。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`size`参数代替。'."\n" + ."\n" + .'Master节点数量，可选值`3`或`5`。'."\n" + ."\n" + .'默认值：`3`。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '3', + ], + 'master_instance_types' => [ + 'title' => '集群Master节点类型。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.instance_types。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`instance_types`参数代替。'."\n" + ."\n" + .'Master节点实例类型。更多信息，请参见[实例规格族](~~25378~~)。', + 'type' => 'array', + 'items' => [ + 'description' => 'Master节点实例类型。指定的实例规格数量需要和`master_count`保持一致，和`master_instance_types`中的元素一一对应。更多信息，请参见[实例规格族](~~25378~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n4.xlarge', + ], + 'deprecated' => true, + 'required' => false, + ], + 'master_system_disk_category' => [ + 'title' => '集群Master节点系统盘类型。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.system_disk_category。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`system_disk_category`参数代替。'."\n" + ."\n" + .'Master节点系统盘类型，取值：'."\n" + ."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + ."\n" + .'默认值：`cloud_ssd`。不同可用区，默认值可能会有所差异。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cloud_ssd', + ], + 'master_system_disk_size' => [ + 'title' => '集群Master节点系统盘大小，至少40。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.system_disk_size。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`system_disk_size`参数代替。'."\n" + ."\n" + .'Master节点系统盘大小，取值范围\\[40,500\\]，单位：GiB。'."\n" + ."\n" + .'默认值：`120`。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '120', + ], + 'master_system_disk_performance_level' => [ + 'title' => 'Master节点系统盘磁盘性能，只针对ESSD磁盘生效。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.system_disk_performance_level。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`system_disk_performance_level`参数代替。'."\n" + ."\n" + .'集群Master节点系统盘磁盘性能等级， 仅对ESSD磁盘生效。磁盘性能等级和磁盘大小有关，更多信息，请参见[ESSD云盘](~~122389~~)。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'PL1', + ], + 'master_system_disk_snapshot_policy_id' => [ + 'title' => '集群Master节点自动快照备份策略。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.system_disk_snapshot_policy_id。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`system_disk_snapshot_policy_id`参数代替。'."\n" + ."\n" + .'Master节点系统盘采用的自动快照策略ID。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'sp-2zej1nogjvovnz4z****', + ], + 'master_instance_charge_type' => [ + 'title' => '集群Master节点付费类型。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.instance_charge_type。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`instance_charge_type`参数代替。'."\n" + ."\n" + .'Master节点付费类型，取值：'."\n" + ."\n" + .'- `PrePaid`：包年包月。'."\n" + .'- `PostPaid`：按量付费。'."\n" + ."\n" + .'默认值：`PostPaid`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'PrePaid', + ], + 'master_period_unit' => [ + 'title' => '集群Master节点包年包月周期。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.period_unit。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`period_unit`参数代替。'."\n" + ."\n" + .'Master节点付费周期，当付费类型为`PrePaid`的时候必须指定周期。'."\n" + ."\n" + .'取值：`Month`，当前仅支持以月为周期。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'Month', + ], + 'master_period' => [ + 'title' => '集群Master节点包年包月时长。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.period。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`unit`参数代替。'."\n" + ."\n" + .'Master节点包年包月时长，当`master_instance_charge_type`取值为`PrePaid`时才生效且为必选值。'."\n" + ."\n" + .'取值范围：{1, 2, 3, 6, 12, 24, 36, 48, 60}。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '1', + ], + 'master_auto_renew' => [ + 'title' => '集群Master节点是否自动续费。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.auto_renew。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`auto_renew`参数代替。'."\n" + ."\n" + .'Master节点是否开启自动续费，当`master_instance_charge_type`取值为`PrePaid`时才生效，可选值为：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n" + ."\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + 'master_auto_renew_period' => [ + 'title' => '集群Master节点自动续费时长。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.auto_renew_period。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`auto_renew_period`参数代替。'."\n" + ."\n" + .'Master节点自动续费周期，当选择包年包月付费类型时才生效，且为必选值。'."\n" + ."\n" + .'取值范围：{1, 2, 3, 6, 12}。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '1', + ], + 'num_of_nodes' => [ + 'title' => '集群Worker节点数量。该参数已废弃，请使用节点池scaling_group.desired_size。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`desired_size`参数代替。'."\n" + ."\n" + .'Worker节点数。范围是\\[0，100\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '3', + ], + 'worker_vswitch_ids' => [ + 'title' => '集群Worker节点所在虚拟交换机。该参数已废弃，请使用节点池scaling_group.vswitch_ids。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`vswitch_ids`参数代替。'."\n" + ."\n" + .'集群节点使用的虚拟交换机列表，一个节点对应一个值。'."\n" + ."\n" + .'当创建零节点的托管版集群时，字段`worker_vswitch_ids `非必填，但是需要提供`vswitch_ids`。', + 'type' => 'array', + 'items' => [ + 'description' => 'Worker节点虚拟交换机列表，取值范围：\\[1,20\\]。为保证高可用性，建议选择不同可用区的虚拟交换机。'."\n" + ."\n" + .'当创建零节点的托管版集群时，字段`worker_vswitch_ids `非必填，但是需要提供`vswitch_ids`。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2ze3ds0mdip0hdz8i****', + ], + 'deprecated' => true, + 'required' => false, + ], + 'worker_instance_types' => [ + 'title' => '集群Worker节点类型。该参数已废弃，请使用节点池scaling_group.instance_types。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`instance_types`参数代替。'."\n" + ."\n" + .'Worker节点实例配置。', + 'type' => 'array', + 'items' => [ + 'description' => 'Worker节点实例规格，至少要指定一个实例规格。更多信息，请参见[实例规格族](~~25378~~)。'."\n" + ."\n" + .'> 实例规格优先级随着在数据中的位置增大依次降低。当无法根据优先级较高的实例规格创建出实例时，会自动选择下一优先级的实例规格来创建实例。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.n4.large', + ], + 'deprecated' => true, + 'required' => false, + ], + 'worker_system_disk_category' => [ + 'title' => '集群Worker节点系统盘类型。该参数已废弃，请使用节点池scaling_group.system_disk_category。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`system_disk_category`参数代替。'."\n" + ."\n" + .'Worker节点系统盘类型。更多信息，请参见[块存储概述](~~63136~~)。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + ."\n\n" + .'默认值：`cloud_ssd`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'worker_system_disk_size' => [ + 'title' => '集群Worker节点系统盘大小。该参数已废弃，请使用节点池scaling_group.system_disk_size。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`system_disk_size`参数代替。'."\n" + ."\n" + .'Worker节点系统盘大小，单位为GiB。'."\n" + ."\n" + .'取值范围：\\[40,500\\]。'."\n" + ."\n" + .'该参数的取值必须大于或者等于max{40, ImageSize}。'."\n" + ."\n" + .'默认值：`120`。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '120', + ], + 'worker_system_disk_snapshot_policy_id' => [ + 'title' => '集群Worker节点系统盘快照备份策略。该参数已废弃，请使用节点池scaling_group.system_disk_snapshot_policy_id。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`system_disk_snapshot_policy_id`参数代替。'."\n" + ."\n" + .'Worker节点系统盘采用的自动快照策略ID。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'sp-2zej1nogjvovnz4z****', + ], + 'worker_system_disk_performance_level' => [ + 'title' => '集群Worker节点磁盘性能，只对ESSD类型磁盘生效。该参数已废弃，请使用节点池scaling_group.system_disk_performance_level。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`system_disk_performance_level`参数代替。'."\n" + ."\n" + .'当系统盘为ESSD云盘时，可设置ESSD云盘的性能级别PL（Performance Level）。更多信息，请参见[ESSD云盘](~~122389~~)。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- PL0'."\n" + .'- PL1'."\n" + .'- PL2'."\n" + .'- PL3', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'PL1', + ], + 'worker_data_disks' => [ + 'title' => '集群Worker节点数据盘配置。该参数已废弃，请使用节点池scaling_group.data_disks。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`data_disks`参数代替。'."\n" + ."\n" + .'Worker节点数据盘类型、大小等配置的组合。', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘配置集合。', + 'type' => 'object', + 'properties' => [ + 'category' => [ + 'title' => '集群Worker节点数据盘类型', + 'description' => '数据盘类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'cloud_essd', + ], + 'encrypted' => [ + 'title' => '集群Worker节点数据盘是否加密', + 'description' => '是否对数据盘加密。取值：'."\n" + ."\n" + .'- `true`：对数据盘加密。'."\n" + .'- `false`：不对数据盘加密。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + 'size' => [ + 'title' => '集群Worker节点数据盘大小', + 'description' => '数据盘大小，取值范围：40～32767。单位：GiB。', + 'type' => 'string', + 'required' => true, + 'example' => '120', + ], + 'performance_level' => [ + 'title' => '集群Worker节点数据盘磁盘性能等级，仅对ESSD磁盘生效', + 'description' => '节点数据盘磁盘性能等级，仅针对[ESSD云盘](~~122389~~)生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + ], + 'required' => false, + ], + 'deprecated' => true, + 'required' => false, + ], + 'worker_instance_charge_type' => [ + 'title' => '集群Worker节点付费类型。该参数已废弃，请使用节点池scaling_group.instance_charge_type。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`instance_charge_type`参数代替。'."\n" + ."\n" + .'Worker节点付费类型，取值：'."\n" + ."\n" + .'- `PrePaid`：包年包月。'."\n" + .'- `PostPaid`：按量付费。'."\n" + ."\n" + .'默认值：按量付费。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'PrePaid', + ], + 'worker_period_unit' => [ + 'title' => '集群Worker节点包年包月周期。该参数已废弃，请使用节点池scaling_group.period_unit。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`period_unit`参数代替。'."\n" + ."\n" + .'Worker节点付费周期，当付费类型为`PrePaid`的时候需要指定周期。'."\n" + ."\n" + .'取值：`Month`，当前只支持以月为周期。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'Month', + ], + 'worker_period' => [ + 'title' => '集群Worker节点包年包月时长。该参数已废弃，请使用节点池scaling_group.period。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`period`参数代替。'."\n" + ."\n" + .'Worker节点包年包月时长，当`worker_instance_charge_type`取值为`PrePaid`时才生效且为必选值。'."\n" + ."\n" + .'取值范围：{1, 2, 3, 6, 12, 24, 36, 48, 60}。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '1', + ], + 'worker_auto_renew' => [ + 'title' => '集群Worker节点到期是否自动续费。该参数已废弃，请使用节点池scaling_group.auto_renew。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`auto_renew`参数代替。'."\n" + ."\n" + .'Worker节点是否开启自动续费，当`worker_instance_charge_type`取值为`PrePaid`时才生效，取值：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n" + ."\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + 'worker_auto_renew_period' => [ + 'title' => '集群Worker节点自动续费时长。该参数已废弃，请使用节点池scaling_group.auto_renew_period。', + 'description' => '【**该字段已废弃**】节点池配置请使用`nodepool`中`scaling_group`下的`auto_renew_period`参数代替。'."\n" + ."\n\n" + .'Worker节点自动续费周期，当选择包年包月付费类型时才生效，且为必选值。'."\n" + ."\n" + .'取值范围：{1, 2, 3, 6, 12}。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '1', + ], + 'instances' => [ + 'title' => '使用已有节点创建集群时，已有实例列表。该参数已废弃，请先创建节点池，并通过AttachInstancesToNodePool操作', + 'description' => '【**该字段已废弃**】创建集群时不支持选择已有节点，如需添加已有节点到集群，请先创建节点池，并调用[AttachInstancesToNodePool](~~2667920~~)接口操作。'."\n" + ."\n\n" + .'使用已有节点创建集群时，需要指定ECS实例列表，该实例会作为Worker节点加入集群。'."\n" + ."\n" + .'> 使用已有实例创建集群时，该字段必填。', + 'type' => 'array', + 'items' => [ + 'description' => '使用已有节点创建集群时，需要指定ECS实例列表，该实例会作为Worker节点加入集群。'."\n" + ."\n" + .'> 使用已有实例创建集群时，该字段必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2ze4zxnm36vq00xn****', + ], + 'deprecated' => true, + 'required' => false, + ], + 'format_disk' => [ + 'title' => '使用已有节点创建集群时，是否格式化已有实例的磁盘。该参数已废弃，请先创建节点池，并通过AttachInstancesToNodePool操作', + 'description' => '【**该字段已废弃**】创建集群时不支持选择已有节点，如需添加已有节点到集群，请先创建节点池，并调用[AttachInstancesToNodePool](~~2667920~~)接口操作。'."\n" + ."\n" + .'使用已有实例创建集群时，是否对实例进行数据盘挂载，取值：'."\n" + ."\n" + .'- `true`：将容器和镜像存储在数据盘，数据盘内原有数据将丢失，请注意备份数据。'."\n" + ."\n" + .'- `false`：不将容器和镜像存储在数据盘。'."\n" + ."\n" + .'默认值：`false`。'."\n" + ."\n" + .'数据盘挂载规则：'."\n" + ."\n" + .'- 如果ECS已挂载数据盘，且最后一块数据盘的文件系统未初始化，系统会自动将该数据盘格式化为ext4，用来存放内容/var/lib/docker、/var/lib/kubelet。'."\n" + .'- 如果ECS未挂载数据盘，则不会挂载新的数据盘。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + 'keep_instance_name' => [ + 'title' => '使用已有节点创建集群时，是否保留实例名称。该参数已废弃，请先创建节点池，并通过AttachInstancesToNodePool操作', + 'description' => '【**该字段已废弃**】创建集群时不支持选择已有节点，如需添加已有节点到集群，请先创建节点池，并调用[AttachInstancesToNodePool](~~2667920~~)接口操作。'."\n" + ."\n" + .'使用已有实例创建集群时，是否保留实例名称。'."\n" + ."\n" + .'- `true`：保留。'."\n" + .'- `false`：不保留，会用系统规则进行替换。'."\n" + ."\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + 'service_discovery_types' => [ + 'title' => '创建ACK Serverless集群时，服务发现类型。', + 'description' => '【**该字段已废弃**】集群内服务发现类型，用于在`ACK Serverless`集群中指定服务发现方式。'."\n" + ."\n" + .'- `CoreDNS`：使用Kubernetes原生标准服务发现组件CoreDNS，需要在集群部署一组容器用于DNS解析。默认采用两个0.25 Core 512 MiB规格的ECI实例。'."\n" + .'- `PrivateZone`：使用阿里云PrivateZone产品提供服务发现能力，需要开启PrivateZone服务。'."\n" + ."\n" + .'默认值：不开启。', + 'type' => 'array', + 'items' => [ + 'description' => '集群内服务发现类型，用于在`ACK Serverless`集群中指定服务发现方式。'."\n" + ."\n" + .'- `CoreDNS`：使用Kubernetes原生标准服务发现组件CoreDNS，需要在集群部署一组容器用于DNS解析。默认采用两个0.25 Core 512 MiB规格的ECI实例。'."\n" + .'- `PrivateZone`：使用阿里云PrivateZone产品提供服务发现能力，需要开启PrivateZone服务。'."\n" + ."\n" + .'默认值：不开启。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrivateZone', + ], + 'deprecated' => true, + 'required' => false, + ], + 'nat_gateway' => [ + 'title' => '使用自动创建专有网络创建ACK Serverless集群时，是否在vpc中创建Nat网关并配置SNAT规则。', + 'description' => '【**该字段已废弃**】请使用参数`snat_entry`代替。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + 'zone_id' => [ + 'title' => '使用自动创建专有网络创建ACK集群时，需要指定专有网络的可用区。该参数已废弃，请使用zone_ids指定可用区。', + 'description' => '【**该字段已废弃**】请使用`zone_ids`参数代替。'."\n" + ."\n" + .'集群所属地域的可用区ID。此参数为ACK托管类的集群特有参数。'."\n" + ."\n" + .'当创建ACK托管类的集群时，如果未指定`vpc_id`和`vswitch_ids`，必须为集群指定`zone_id`，用于自动在该可用区创建VPC网络资源；指定`vpc_id`和`vswitch_ids`时，该参数无效。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cn-beiji****', + ], + 'logging_type' => [ + 'title' => 'ASK 集群开启日志服务', + 'description' => '【**该字段已废弃**】集群开启日志服务，只针对ACK Serverless集群生效，且取值必须是`SLS`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'SLS', + ], + 'disable_rollback' => [ + 'title' => '该参数已废弃，集群创建失败时默认不会进行回滚操作，您需要自行清理失败的集群。', + 'description' => '【**该字段已废弃**】集群创建失败时默认不会进行回滚，您需要自行清理创建失败的集群。'."\n" + ."\n" + .'集群创建失败是否回滚。取值：'."\n" + ."\n" + .'- `true`：当集群创建失败时，进行回滚操作。'."\n" + .'- `false`：当集群创建失败时，不进行回滚操作。'."\n" + ."\n\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + 'timeout_mins' => [ + 'title' => '集群创建超时时间。该参数已废弃。', + 'description' => '【**该字段已废弃**】集群创建失败时默认不会进行回滚，您需要自行清理创建失败的集群。'."\n" + ."\n" + .'集群创建超时时间，单位分钟。'."\n" + ."\n" + .'默认值：`60`。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '60', + ], + 'image_type' => [ + 'title' => '操作系统镜像类型。该参数已废弃，Kubernetes类型集群控制面请使用control_plane_config.image_type，节点池请使用scaling_group.image_type。', + 'description' => '【**该字段已废弃**】集群控制面配置请使用`control_plane_config`下的`image_type`参数代替；节点池配置请使用`nodepool`中`scaling_group`下的`image_type`参数代替。'."\n" + ."\n" + .'操作系统发行版类型，推荐使用该字段指定节点操作系统。取值：'."\n" + ."\n" + .'- CentOS'."\n" + .'- AliyunLinux'."\n" + .'- AliyunLinux Qboot'."\n" + .'- AliyunLinuxUEFI'."\n" + .'- AliyunLinux3'."\n" + .'- Windows'."\n" + .'- WindowsCore'."\n" + .'- AliyunLinux3Arm64'."\n" + .'- ContainerOS'."\n" + ."\n" + .'默认值：`CentOS`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'AliyunLinux', + ], + 'load_balancer_spec' => [ + 'title' => '负载均衡规格。【已废弃】CLB按使用量计费，该参数不生效。', + 'description' => '【**该参数已废弃**】CLB按使用量计费，该参数不生效。'."\n" + ."\n" + .'负载均衡规格，取值：'."\n" + .'- slb.s1.small'."\n" + .'- slb.s2.small'."\n" + .'- slb.s2.medium'."\n" + .'- slb.s3.small'."\n" + .'- slb.s3.medium'."\n" + .'- slb.s3.large'."\n" + ."\n" + .'默认值：`slb.s2.small`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'slb.s2.small', + ], + 'enable_rrsa' => [ + 'title' => '启用 RRSA 功能', + 'description' => '【**该字段已废弃**】请使用参数`rrsa_config`代替。'."\n" + ."\n" + .'是否启用RRSA功能。'."\n" + ."\n" + .'- true：开启。'."\n" + ."\n" + .'- false：不开启。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + 'charge_type' => [ + 'title' => '付费类型。', + 'description' => '【**该字段已废弃**】'."\n" + ."\n" + .'API Server所使用的CLB实例的付费类型，默认值为PostPaid。取值：'."\n" + .'- PostPaid：按量付费。'."\n" + .'- PrePaid：包年包月，新建CLB付费类型已不支持，存量不影响。'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- 该字段于2024年10月15日存在变更，更多信息，请参见[关于集群创建接口CreateCluster参数行为变更的公告](~~2849194~~)。'."\n" + .'- 自2024年12月01日起，新创建的CLB实例不再支持包年包月付费类型，同时将新增收取实例费。'."\n" + .'</notice>'."\n" + .'<props="china">详细信息请参见[【产品公告】关于取消新增集群API Server负载均衡CLB包年包月付费的公告](~~2851191~~)、[传统型负载均衡CLB计费项调整公告](~~2839797~~)。</props>'."\n" + .'<props="intl">详细信息请参见[传统型负载均衡CLB计费项调整公告](~~2839797~~)。</props>', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'PostPaid', + ], + 'period_unit' => [ + 'title' => '包年包月时间单位。', + 'description' => '【**该字段已废弃**】'."\n" + ."\n" + .'付费周期，当付费类型为PrePaid的时候，需要指定周期。'."\n" + ."\n" + .'取值：Month，当前仅支持以月为周期。'."\n" + ."\n" + .'该字段于2024年10月15日存在变更，更多信息，请参见[关于集群创建接口CreateCluster参数行为变更的公告](~~2849194~~)。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'Month', + ], + 'period' => [ + 'title' => '包年包月时间。', + 'description' => '【**该字段已废弃**】'."\n" + ."\n" + .'购买时长。包年包月时长，当charge_type取值为PrePaid时才生效，且为必选值。'."\n" + ."\n" + .'取值范围：{1, 2, 3, 6, 12, 24, 36, 48, 60}。'."\n" + ."\n" + .'默认值：1。'."\n" + ."\n" + .'该字段于2024年10月15日存在变更，更多信息，请参见[关于集群创建接口CreateCluster参数行为变更的公告](~~2849194~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '1', + ], + 'auto_renew' => [ + 'title' => '是否开启自动续费。', + 'description' => '【**该字段已废弃**】'."\n" + ."\n" + .'是否开启自动续费，当`charge_type`取值为`PrePaid`时才生效。取值：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n" + ."\n" + .'默认值：`false`。'."\n" + ."\n" + .'该字段于2024年10月15日存在变更，更多信息，请参见[关于集群创建接口CreateCluster参数行为变更的公告](~~2849194~~)。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + 'auto_renew_period' => [ + 'title' => '自动续费周期。', + 'description' => '【**该字段已废弃**】'."\n" + ."\n" + .'自动续费周期，当选择预付费和自动续费时才生效。当`PeriodUnit=Month`时，取值范围：{1, 2, 3, 6, 12}。'."\n" + ."\n" + .'默认值：1。'."\n" + ."\n" + .'该字段于2024年10月15日存在变更，更多信息，请参见[关于集群创建接口CreateCluster参数行为变更的公告](~~2849194~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '1', + ], + 'access_control_list' => [ + 'description' => '【**该字段已废弃**】注册集群 API Server SLB 访问控制列表。', + 'type' => 'array', + 'items' => [ + 'description' => '注册集群 API Server SLB 访问控制列表。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX/24'."\n", + ], + 'deprecated' => true, + 'required' => false, + ], + ], + 'required' => false, + 'example' => 'cluster-demo', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体数据。', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cb95aa626a47740afbf6aa099b650****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4314****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5a54309c80282e39ea****', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"cluster_id\\": \\"cb95aa626a47740afbf6aa099b650****\\",\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4314****\\",\\n \\"task_id\\": \\"T-5a54309c80282e39ea****\\"\\n}","errorExample":""},{"type":"xml","example":"<cluster_id>cb95aa626a47740afbf6aa099b650****</cluster_id>\\n<task_id>T-5a54309c80282e39ea00002f</task_id>\\n<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>","errorExample":""}]', + 'title' => '创建集群', + 'description' => '### 通过控制台生成OpenAPI请求参数'."\n" + .'调用CreateCluster接口创建集群时，如果由于请求参数组合不正确导致接口调用失败，您可以通过控制台生成创建集群所需的请求参数组合。具体操作如下：'."\n" + ."\n" + .'1. 登录[容器服务管理控制台](https://csnew.console.aliyun.com)，在左侧导航栏选择**集群列表**。'."\n" + ."\n" + .'1. 在**集群列表**页面，单击**集群模板**。'."\n" + ."\n" + .'1. 在对话框，选择需要创建的集群类型，并单击创建，然后在集群配置页面配置集群信息。'."\n" + ."\n" + .'1. 配置完成后，在**确认配置**页面，单击右上角的**同等代码**。对话框将展示您创建集群时所需的参数组合，您可以复制使用。'."\n" + ."\n\n" + .'><notice>自2026年07月04日起，部分请求入参不再生效。变更详情及替代参数说明，请参见[关于ACK集群管理相关的OpenAPI出入参变化及OpenAPI下线的公告](~~2932733~~)。</notice>', + ], + 'DeleteCluster' => [ + 'summary' => '如果您的集群无需使用，请删除集群并选择是否删除或保留集群的相关资源。删除集群前，请手动清理工作负载（无状态、有状态、任务和定时任务），否则可能导致集群删除失败。', + 'path' => '/clusters/{ClusterId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '409', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c905d1364c2dd4b6284a3f41790c4****', + ], + ], + [ + 'name' => 'retain_all_resources', + 'in' => 'query', + 'schema' => [ + 'title' => '是否保留所有资源，如果设置了该值，将会忽略retain_resources。默认值：false。', + 'description' => '是否保留所有资源。如果设置该值为`true`，则会忽略`retain_resources`，通过`DescribeClusterResources`接口查询到的通过集群创建的云资源将被保留。如果该值为`false`，请注意`delete_options`中默认保留的资源仍将被保留，如需删除相关资源，请单独在`delete_options`中设置`delete_mode`为`delete`。'."\n" + ."\n" + .'- `true`：保留所有资源，包含所有通过集群创建的云资源。'."\n" + .'- `false`：不保留所有资源（`delete_options`中定义的默认保留资源除外，如`ALB`在该参数取值为`false`时仍然保留）。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'keep_slb', + 'in' => 'query', + 'schema' => [ + 'title' => '是否保留通过service创建的负载均衡SLB实例。默认值：false。'."\n" + .'已废弃，建议使用delete_options替代。', + 'description' => '是否保留SLB，取值：'."\n" + ."\n" + .'- `true`：保留创建的SLB资源。'."\n" + .'- `false`：不保留创建的SLB资源。'."\n" + ."\n" + .'默认值：`false`。'."\n" + .'请使用`delete_options`中的`SLB`管理', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'retain_resources', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '要保留的资源列表。', + 'description' => '资源列表。删除集群时如果需要保留资源，则需要提供对应资源的ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-2ze6ess9kho6fdn9****', + ], + 'required' => false, + ], + ], + [ + 'name' => 'delete_options', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '集群关联资源的删除选项。', + 'description' => '集群关联资源的删除选项。', + 'type' => 'array', + 'items' => [ + 'title' => '特定类型资源的删除选项。', + 'description' => '特定类型资源的删除选项。', + 'type' => 'object', + 'properties' => [ + 'resource_type' => [ + 'title' => '资源类型，可取值：'."\n" + .'- SLB：通过service创建的SLB资源，默认删除，可选择保留'."\n" + .'- ALB：ALB Ingress Controller创建的ALB资源，默认保留，可选择删除'."\n" + .'- SLS_Data：集群日志功能所使用的日志服务Project，默认保留，可选择删除'."\n" + .'- SLS_ControlPlane：托管版集群控制平面日志所使用的日志服务Project，默认保留，可选择删除'."\n" + .'- PrivateZone：ACK Serverless集群创建的PrivateZone资源，默认保留，可选择删除', + 'description' => '资源类型，可取值：'."\n" + .'- SLB：通过service创建的SLB资源，默认删除，可选择保留。'."\n" + .'- ALB：ALB Ingress Controller创建的ALB资源，默认保留，可选择删除。'."\n" + .'- SLS_Data：集群日志功能所使用的日志服务Project，默认保留，可选择删除。'."\n" + .'- SLS_ControlPlane：托管版集群控制平面日志所使用的日志服务Project，默认保留，可选择删除。'."\n" + .'- PrivateZone：ACK Serverless集群创建的PrivateZone资源，默认保留，可选择删除。', + 'type' => 'string', + 'required' => false, + 'example' => 'SLS_Data', + ], + 'delete_mode' => [ + 'title' => '该类型资源的删除策略，可取值：'."\n" + .'- delete：删除该类资源'."\n" + .'- retain：保留该类资源', + 'description' => '该类型资源的删除策略，可取值：'."\n" + .'- delete：删除该类资源。'."\n" + .'- retain：保留该类资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'delete', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体数据。', + 'description' => '返回体数据。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cb95aa626a47740afbf6aa099b650****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4314****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5a54309c80282e39ea****', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"cluster_id\\": \\"cb95aa626a47740afbf6aa099b650****\\",\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4314****\\",\\n \\"task_id\\": \\"T-5a54309c80282e39ea****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteClusterResponse>\\n <task_id>T-5a54309c80282e39ea****</task_id>\\n</DeleteClusterResponse>","errorExample":""}]', + 'title' => '删除集群', + 'description' => '风险提示：'."\n" + .'- 集群内包年包月类型 ECS、灵骏计算节点等资源无法自动释放，为避免不必要的费用，请您手动释放。关于更多细节，请参见 集群删除及节点释放规则 。'."\n" + .'- 包年包月类型的APIServer SLB资源无法自动释放，为避免不必要的费用，请您手动释放。'."\n" + .'- VPC、交换机、安全组、RamRole如被其他资源占用无法删除时会默认保留，请您手动释放。'."\n" + .'- 通过虚拟节点创建的弹性容器实例 ECI 会被自动释放。'."\n" + .'- 部分通过集群创建的云资源在删除集群时不会被自动释放，集群删除后会继续计费，请根据实际需要释放或保留。这些资源包括：集群自动创建的日志服务 SLS Project；通过动态存储卷购买的云盘。', + ], + 'ModifyCluster' => [ + 'summary' => '您可以调用ModifyCluster接口修改ACK集群的配置。', + 'path' => '/api/v2/clusters/{ClusterId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '384', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cb95aa626a47740afbf6aa099b65****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'api_server_eip' => [ + 'title' => '集群是否绑定EIP，用于公网访问API Server。 true | false', + 'description' => '集群是否绑定EIP，用于公网访问API Server。取值：'."\n" + ."\n" + .'- `true`：集群绑定EIP。'."\n" + .'- `false`：集群不绑定EIP。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'api_server_eip_id' => [ + 'title' => '集群API Server 公网连接端点。', + 'description' => '集群API Server绑定的EIP实例ID，仅当`api_server_eip`取值为`true`时生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'eip-wz9fnasl6dsfhmvci****', + ], + 'deletion_protection' => [ + 'title' => '集群是否开启删除保护。默认值false。', + 'description' => '集群删除保护，防止通过控制台或API误删除集群。取值：'."\n" + ."\n" + .'- `true`：启用集群删除保护，将不能通过控制台或API删除集群。'."\n" + .'- `false`：不启用集群删除保护，则能通过控制台或API删除集群。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'resource_group_id' => [ + 'title' => '集群资源组ID。', + 'description' => '集群资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyvw3wjm****', + ], + 'maintenance_window' => [ + 'description' => '集群维护窗口，该功能只在ACK托管集群Pro版中生效。', + 'required' => false, + '$ref' => '#/components/schemas/maintenance_window', + ], + 'enable_rrsa' => [ + 'title' => '启用或禁用 RRSA 功能（只有托管版集群支持配置该参数）。true: 启用，false: 禁用', + 'description' => '启用或禁用RRSA功能（只有托管版集群支持配置该参数）。取值：'."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：禁用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'access_control_list' => [ + 'description' => '注册集群 API Server SLB 访问控制列表。', + 'type' => 'array', + 'items' => [ + 'description' => '注册集群 API Server SLB 访问控制列表。'."\n" + ."\n" + .'**注意**：不允许填写0.0.0.0/0网段。', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.XX.XX/24', + ], + 'deprecated' => true, + 'required' => false, + ], + 'cluster_name' => [ + 'title' => '集群名称。', + 'description' => '自定义集群名称。由数字、汉字、英文字符或短划线（-）组成，长度范围1~63个字符，且不能以短划线（-）开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster-new-name', + ], + 'system_events_logging' => [ + 'title' => '系统事件存储配置。', + 'description' => '系统事件存储配置。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => '是否开启系统事件存储。', + 'description' => '是否开启系统事件存储。'."\n" + ."\n\n" + .'- true：开启系统事件存储。'."\n" + ."\n" + .'- false：不开启系统事件存储。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'logging_project' => [ + 'title' => '系统事件存储的LogProject名称。', + 'description' => '系统事件存储的LogProject名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s-log-cb95aa626a47740afbf6aa099b65****', + ], + ], + 'required' => false, + ], + 'operation_policy' => [ + 'title' => '集群自动运维策略。', + 'description' => '集群自动运维策略。', + 'type' => 'object', + 'properties' => [ + 'cluster_auto_upgrade' => [ + 'title' => '集群自动升级。', + 'description' => '集群自动升级。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => '是否开启集群自动升级。', + 'description' => '是否开启集群自动升级。'."\n" + ."\n" + .'- true：开启自动升级。'."\n" + ."\n" + .'- false：不开启自动升级。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'channel' => [ + 'title' => '集群自动升级频次。可取值：'."\n" + .'- patch'."\n" + .'- stable'."\n" + .'- rapid', + 'description' => '集群自动升级频次。更多信息，请参见[升级频次](~~2712866~~)。'."\n" + ."\n" + .'可取值：'."\n" + .'- patch：最新补丁版本。'."\n" + .'- stable：次新次要版本。'."\n" + .'- rapid：最新次要版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'patch', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'api_server_custom_cert_sans' => [ + 'title' => '自定义ApiServer证书SAN（只有托管版集群支持配置该参数）。', + 'description' => '自定义API Server证书SAN（Subject Alternative Name）。'."\n" + .'用于在集群API Server服务端证书的SAN字段中添加自定义的IP或域名，以实现对客户端的访问控制。'."\n" + ."\n" + .'仅托管版集群支持配置该参数。', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'title' => '覆盖或追加SAN配置。overwrite: 覆盖，append: 追加', + 'description' => '覆盖或追加 SAN 配置。取值：'."\n" + .'- overwrite: 覆盖。'."\n" + .'- append: 追加。', + 'type' => 'string', + 'required' => false, + 'example' => 'append', + 'enum' => [ + 'append', + 'overwrite', + ], + ], + 'subject_alternative_names' => [ + 'title' => 'SAN列表', + 'description' => 'SAN 列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'SAN', + 'description' => 'SAN。支持自定义IP地址或域名，多个IP地址或域名以英文逗号（,）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun.xxx.com,192.168.xx.xx', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'vswitch_ids' => [ + 'title' => '控制面交换机。适用于托管类集群，请注意以下事项：'."\n" + .'- 该参数为覆盖更新，需完全指定目标交换机列表。'."\n" + .'- 变更过程控制面组件会短暂重启，请谨慎操作。'."\n" + .'- 请确保集群所有安全组（包括控制面安全组、所有节点池的安全组、容器网络使用的安全组）的出入方向已放行新的虚拟交换机的 IP 网段，避免节点与容器无法连接 API server。'."\n" + .'- 如新的控制面交换机配置了 ACL 规则，请确保该 ACL 规则已经放行其与集群节点、容器网络等 IP 网段的通信。', + 'description' => '集群控制面虚拟交换机。专有集群变更后，将作用于新扩容的控制面节点。托管类集群变更控制面虚拟交换机，请注意以下事项：'."\n" + .'- 该参数为覆盖更新，需完全指定目标交换机列表。'."\n" + .'- 变更过程控制面组件会短暂重启，请谨慎操作。'."\n" + .'- 请确保集群所有安全组（包括控制面安全组、所有节点池的安全组、容器网络使用的安全组）的出入方向已放行新的虚拟交换机的 IP 网段，避免节点与容器无法连接 API server。'."\n" + .'- 如新的控制面交换机配置了 ACL 规则，请确保该 ACL 规则已经放行其与集群节点、容器网络等 IP 网段的通信。', + 'type' => 'array', + 'items' => [ + 'description' => '集群控制面虚拟交换机。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2ze4jvvvade1yk899****', + ], + 'required' => false, + ], + 'control_plane_config' => [ + 'title' => '专有版集群控制面配置。', + 'description' => '专有版集群控制面配置。', + 'type' => 'object', + 'properties' => [ + 'charge_type' => [ + 'title' => '控制面节点付费类型。', + 'description' => '控制面节点实例付费类型，取值：'."\n" + ."\n" + .'- `PrePaid`：包年包月。'."\n" + .'- `PostPaid`：按量付费。'."\n" + ."\n" + .'默认值：`PostPaid`。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + ], + 'period' => [ + 'title' => '节点包年包月时间。', + 'description' => '控制面节点实例包年包月时长，当`charge_type`取值为`PrePaid`时才生效且为必选值。'."\n" + ."\n" + .'当`period_unit=Month`时，取值范围：{1, 2 , 3, 6, 12, 24, 36, 48, 60}。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'period_unit' => [ + 'title' => '节点包年包月时间单位。', + 'description' => '控制面节点实例付费周期，当`charge_type`取值为`PrePaid`时才生效。'."\n" + ."\n" + .'`Month`：以月为计时单位，当前只支持以月为单位。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + 'auto_renew' => [ + 'title' => '节点是否自动续费。', + 'description' => '控制面节点实例是否开启自动续费，当`charge_type`取值为`PrePaid`时才生效。取值：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'auto_renew_period' => [ + 'title' => '节点自动续费时长。', + 'description' => '控制面节点实例单次自动续费的续费时长。'."\n" + ."\n" + .'取值范围：{1, 2, 3, 6, 12}，单位：月。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'instance_types' => [ + 'title' => '节点实例类型。', + 'description' => '实例规格。更多信息，请参见[实例规格族](~~25378~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.g6.large', + ], + 'required' => false, + ], + 'image_type' => [ + 'title' => '操作系统镜像类型。', + 'description' => '操作系统镜像类型，取值范围：'."\n" + ."\n" + .'- `AliyunLinux3`：Alinux3镜像。'."\n" + .'- `Custom`： 自定义镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunLinux3', + ], + 'image_id' => [ + 'title' => '镜像id', + 'description' => '自定义镜像ID。自定义镜像时指定。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_3_x64_20G_alibase_20240819.vhd', + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。', + 'description' => '密钥对名称，和`login_password`二选一。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack', + ], + 'login_password' => [ + 'title' => 'SSH登录密码。密码规则为8~30 个字符，且至少同时包含三项（大小写字母、数字和特殊符号），和key_pair二选一。', + 'description' => 'SSH登录密码，和`key_pair `二选一。密码规则为8~30个字符，且至少同时包含三项（大小写字母、数字和特殊符号）。如需要使用密码登录，需在扩容时指定。', + 'type' => 'string', + 'required' => false, + 'example' => 'Ack@2000.', + ], + 'system_disk_category' => [ + 'title' => '节点系统盘类型。', + 'description' => '节点系统盘类型，取值：'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL 云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'system_disk_size' => [ + 'title' => '节点系统盘大小，至少40。', + 'description' => '节点系统盘大小，取值范围[40,500]，单位：GiB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '120', + ], + 'system_disk_snapshot_policy_id' => [ + 'title' => '节点自动快照备份策略。', + 'description' => '节点系统盘采用的自动快照策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sp-2zej1nogjvovnz4z****', + ], + 'system_disk_performance_level' => [ + 'title' => '节点系统盘磁盘性能，只针对ESSD磁盘生效。', + 'description' => '节点系统盘磁盘性能等级， 仅对ESSD磁盘生效。磁盘性能等级和磁盘大小有关。更多信息，请参见[ESSD云盘](~~122389~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'system_disk_provisioned_iops' => [ + 'title' => '节点系统盘预配置的读写IOPS。', + 'description' => '节点系统盘预配置的读写IOPS。可能值：0~min{50,000, 1000\\*容量-基准性能}。 基准性能=min{1,800+50\\*容量, 50000}。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'system_disk_bursting_enabled' => [ + 'title' => '节点系统盘是否开启Burst（性能突发）。', + 'description' => '节点系统盘是否开启Burst（性能突发）。 取值：'."\n" + .'- `true`：是。'."\n" + .'- `false`：否。'."\n" + ."\n" + .'当`system_disk_category `取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'deploymentset_id' => [ + 'title' => '部署集ID。', + 'description' => '部署集ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp10b35imuam5amw****', + ], + 'cloud_monitor_flags' => [ + 'title' => '是否为节点安装云监控。', + 'description' => '控制面节点是否安装云监控插件。取值：'."\n" + ."\n" + .'- `true`：安装云监控插件。'."\n" + .'- `false`：不安装云监控插件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'soc_enabled' => [ + 'title' => '是否开启等保安全加固。', + 'description' => '等保加固。更多信息，请参见[ACK等保加固使用说明](~~196148~~)。'."\n" + ."\n" + .'取值：'."\n" + .'- `true`：开启等保加固。'."\n" + .'- `false`：不开启等保加固。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'security_hardening_os' => [ + 'title' => '是否开启阿里云OS安全加固。', + 'description' => '阿里云OS安全加固。取值：'."\n" + ."\n" + .'- `true`：开启阿里云OS安全加固。'."\n" + .'- `false`：不开启阿里云OS安全加固。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'cpu_policy' => [ + 'title' => '节点CPU管理策略。', + 'description' => '节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略：'."\n" + ."\n" + .'- `static`：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + .'- `none`：表示启用现有的默认CPU亲和性方案。'."\n" + ."\n" + .'默认值：`none`。', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + 'runtime' => [ + 'title' => '运行时名称。', + 'description' => '容器运行时名称，取值范围：'."\n" + ."\n" + .'- `containerd`：推荐使用，支持所有集群版本。'."\n" + ."\n" + .'默认值：containerd。', + 'type' => 'string', + 'required' => false, + 'example' => 'containerd', + ], + 'node_port_range' => [ + 'title' => '节点服务端口范围。', + 'description' => '节点服务端口范围。'."\n" + .'可选端口范围：[30000,65535]。'."\n" + ."\n" + .'默认值：30000-32767。', + 'type' => 'string', + 'required' => false, + 'example' => '30000-32767', + ], + 'size' => [ + 'title' => '控制面节点数量。', + 'description' => '控制面节点数量。如需扩容专有版控制面，该参数为目标控制面节点数，需大于当前控制面节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + 'required' => false, + ], + 'security_group_id' => [ + 'title' => '控制面安全组Id。', + 'description' => '控制面安全组ID。'."\n" + ."\n" + .'- 如您在安全组中配置了拦截规则，请确保安全组规则放行集群依赖的协议和端口，关于建议的安全组规则范围，请参见[配置并管理集群安全组](~~353191~~)。'."\n" + .'- 对于非ACK专有集群，变更过程中，集群控制面及已安装的托管组件（例如 terway-controlplane 等）将短暂重启，建议您在业务低峰期操作。变更控制面安全组后，集群控制面及已安装的托管组件使用的弹性网卡 ENI 将自动加入到新的安全组中。'."\n" + .'- 对于 ACK 专有集群，变更控制面安全组后，新扩容的 Master 节点会自动应用新的控制面安全组，现有控制面节点不受影响。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp1h6rk3pgct2a08***', + ], + 'timezone' => [ + 'title' => '集群时区。', + 'description' => '集群时区。请参见[支持时区](~~354879~~)。'."\n" + .'- 变更时区后，集群巡检配置将采用新的时区设置。'."\n" + ."\n" + .'- 对于托管类集群，变更过程中，集群控制面及已安装的托管组件（例如 terway-controlplane 等）将短暂重启，建议您在业务低峰期操作。变更时区后，新扩容的节点会自动应用新的时区设置，现有节点不受影响，您可以通过节点池节点重置功能使现有节点生效。'."\n" + ."\n" + .'- 对于专有集群，变更时区后，新扩容的节点（包括控制面节点）会自动应用新的时区设置，现有节点（包括控制面节点）不受影响，您可以通过节点池节点重置功能使现有节点生效。对于控制面节点，您需要通过扩容后再缩容的方式使全量控制面节点生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'Asia/Shanghai', + ], + 'control_plane_endpoints_config' => [ + 'title' => '集群连接配置。', + 'description' => '集群连接配置。', + 'type' => 'object', + 'properties' => [ + 'internal_dns_config' => [ + 'title' => '集群内部域名配置，适用于ACK托管集群。集群内部域名用于 kubelet、kube-proxy 等节点侧系统组件访问 API Server；未开启集群内部域名访问时，节点侧系统组件将通过 CLB IP 方式访问。', + 'description' => '集群内部域名配置，适用于ACK托管集群。集群内部域名用于 kubelet、kube-proxy 等节点侧系统组件访问 API Server；未开启集群内部域名访问时，节点侧系统组件将通过 CLB IP 方式访问。', + 'type' => 'object', + 'properties' => [ + 'bind_vpcs' => [ + 'title' => '集群内部域名记录解析生效的 VPC 范围，默认包括集群所在 VPC。注意：该参数为覆盖更新，需完整定义目标配置；指定为空数组（即[]）时，配置清空。', + 'description' => '集群内部域名记录解析生效的 VPC。', + 'type' => 'array', + 'items' => [ + 'title' => '集群内部域名记录解析生效的 VPC。', + 'description' => '集群内部域名记录解析生效的 VPC。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-xxxx', + ], + 'required' => false, + ], + 'enabled' => [ + 'title' => '是否开启集群内部域名访问。 - true：开启集群内部域名访问，节点侧组件（kubelet、kube-proxy）将通过集群内部域名访问API Server。', + 'description' => '是否开启集群内部域名访问。 取值：'."\n" + .'- true：开启集群内部域名访问，节点侧组件（kubelet、kube-proxy）将通过集群内部域名访问API Server。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'instance_deletion_protection' => [ + 'title' => '实例删除保护，防止通过控制台或API误删除释放节点。', + 'description' => '实例删除保护，防止通过控制台或API误删除释放节点。取值：'."\n" + ."\n" + .'- `true`: 不能通过控制台或API误删除节点。'."\n" + .'- `false`：能通过控制台或API误删除节点。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + 'ingress_domain_rebinding' => [ + 'title' => '域名是否重新绑定到Ingress的SLB地址。', + 'description' => '重新绑定集群测试域名。取值：'."\n" + ."\n" + .'- `true`：重新绑定集群测试域名。'."\n" + .'- `false`：不重新绑定集群测试域名。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'false', + ], + 'ingress_loadbalancer_id' => [ + 'title' => '集群的Ingress SLB的ID。', + 'description' => '被修改集群的SLB实例ID。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'lb-wz97kes8tnndkpodw****', + ], + ], + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cb95aa626a47740afbf6aa09****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4314****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5a54309c80282e39ea00****', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"cluster_id\\": \\"cb95aa626a47740afbf6aa09****\\",\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4314****\\",\\n \\"task_id\\": \\"T-5a54309c80282e39ea00****\\"\\n}","errorExample":""},{"type":"xml","example":"<cluster_id>cb95aa626a47740afbf6aa09****</cluster_id>\\n<request_id>687C5BAA-D103-4993-884B-C35E4314****</request_id>\\n<task_id>T-5a54309c80282e39ea00****</task_id>","errorExample":""}]', + 'title' => '修改集群配置', + 'description' => '<notice>自2026年07月04日起，请求入参instance_deletion_protection、ingress_loadbalancer_id、access_control_list不再生效。变更详情请参见[关于ACK集群管理相关的OpenAPI出入参变化及OpenAPI下线的公告](~~2932733~~)。</notice>', + ], + 'UpgradeCluster' => [ + 'summary' => '为避免过期版本集群潜在的安全和稳定性风险，同时享用新集群版本的新功能，请随ACK集群的版本发布节奏升级集群。您可以调用UpgradeCluster接口手动升级集群。', + 'path' => '/api/v2/clusters/{ClusterId}/upgrade', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '484', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'component_name' => [ + 'title' => '组件名称，集群升级时取值"k8s"。', + 'description' => '【该参数已废弃】无需传递。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'next_version' => [ + 'title' => '目标版本。', + 'description' => '集群升级的目标版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.32.1-aliyun.1', + ], + 'version' => [ + 'title' => '已废弃，无需传递，请使用 next_version 参数传入升级目标版本。', + 'description' => '【该参数已废弃】请使用`next_version`参数替代。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'master_only' => [ + 'title' => '是否仅升级master。', + 'description' => '是否仅升级控制面。'."\n" + .'- true：仅升级控制面。'."\n" + .'- false：升级控制面和工作节点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + 'rolling_policy' => [ + 'description' => '轮转配置。', + 'type' => 'object', + 'properties' => [ + 'max_parallelism' => [ + 'description' => '每批次工作节点升级的最大并行数。'."\n" + ."\n" + .'工作节点升级过程会根据设置的最大并行数，依次对节点进行升级。每个批次的升级节点数依次为1、2、4、8……直至达到最大并行数。达到最大并行数后，每个批次都按最大并行数的节点进行升级。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, + 'required' => false, + 'example' => '3', + ], + ], + 'deprecated' => true, + 'required' => false, + ], + ], + 'required' => false, + 'example' => 'k8s', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5faa48fb31b6b8078d00****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0527ac9a-c899-4341-a21a-****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cluster_id\\": \\"c82e6987e2961451182edacd74faf****\\",\\n \\"task_id\\": \\"T-5faa48fb31b6b8078d00****\\",\\n \\"request_id\\": \\"0527ac9a-c899-4341-a21a-****\\"\\n}","type":"json"}]', + 'title' => '升级集群', + 'description' => '成功调用UpgradeCluster接口后，该API将返回此次升级任务的`task_id`，您可以通过调用任务API管理该操作任务：'."\n" + ."\n" + .'- [调用DescribeTaskInfo查询任务详情](~~2667985~~)'."\n" + .'- [调用PauseTask暂停正在运行中的任务](~~2667986~~)'."\n" + .'- [调用ResumeTask恢复运行已暂停的任务](~~2667987~~)'."\n" + .'- [调用CancelTask取消运行中的任务](~~2667988~~)'."\n" + ."\n" + .'><notice>自2026年07月04日起，请求入参rolling_policy、rolling_policy.max_parallelism不再生效，推荐使用[UpgradeClusterNodepool](~~2667922~~)升级Worker节点。变更详情请参见[关于ACK集群管理相关的OpenAPI出入参变化及OpenAPI下线的公告](~~2932733~~)。</notice>', + ], + 'DescribeClustersV1' => [ + 'summary' => '您可以调用DescribeClustersV1接口查看本账号下符合条件的ACK集群（例如指定集群类型、集群规格）列表信息。', + 'path' => '/api/v1/clusters', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '393', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + 'FEATUREcskI1OLEY', + 'FEATUREcskZG2TSX', + 'FEATUREcskDGKERY', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => '通过集群名称进行模糊查询。', + 'description' => '集群名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster-demo', + ], + ], + [ + 'name' => 'cluster_type', + 'in' => 'query', + 'schema' => [ + 'title' => '集群类型。', + 'description' => '集群类型。'."\n" + .'- `Kubernetes`: ACK专有集群。'."\n" + .'- `ManagedKubernetes`：ACK托管类的集群，包括ACK托管集群（Pro版、基础版）、ACK Serverless集群（Pro版、基础版）、ACK Edge集群（Pro版、基础版）、ACK灵骏集群（Pro版）。'."\n" + .'- `ExternalKubernetes`：注册集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'Kubernetes', + ], + ], + [ + 'name' => 'page_size', + 'in' => 'query', + 'schema' => [ + 'title' => '单页大小。', + 'description' => '每页显示的记录数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'page_number', + 'in' => 'query', + 'schema' => [ + 'title' => '分页数。', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'profile', + 'in' => 'query', + 'schema' => [ + 'title' => '集群标识。', + 'description' => '当您选择`cluster_type`为`ManagedKubernetes`时，即ACK托管类的集群时，您可以进一步指定集群的子类型。'."\n" + .'- `Default`：ACK托管集群，包括ACK集群Pro版和ACK集群基础版。'."\n" + ."\n" + .'- `Edge`：ACK Edge集群，包括ACK Edge集群Pro版和ACK Edge集群基础版。'."\n" + ."\n" + .'- `Serverless`：ACK Serverless集群，包括ACK Serverless集群Pro版和ACK Serverless集群基础版。'."\n" + ."\n" + .'- `Lingjun`：ACK灵骏集群，提供Pro版。', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'cluster_spec', + 'in' => 'query', + 'schema' => [ + 'title' => '集群规格。', + 'description' => '当您选择`cluster_type`为`ManagedKubernetes`并配置`profile`后，您可以进一步指定集群的规格。'."\n" + ."\n" + .'- `ack.pro.small`：集群Pro版。'."\n" + ."\n" + .'- `ack.standard`：集群基础版（取值为空时默认选择）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack.pro.small', + ], + ], + [ + 'name' => 'region_id', + 'in' => 'query', + 'schema' => [ + 'title' => '地域。', + 'description' => '集群地域。通过指定该字段，可以过滤出该地域下的集群列表。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c3fb96524f9274b4495df0f12a6b5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回体数据。', + 'type' => 'object', + 'properties' => [ + 'clusters' => [ + 'title' => '集群详情列表。', + 'description' => '集群信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群实例。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c3fb96524f9274b4495df0f12a6b5****', + ], + 'cluster_type' => [ + 'title' => '集群类型。', + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'Kubernetes', + ], + 'created' => [ + 'title' => '集群初始化时间。', + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2025-04-07T09:57:26+08:00', + ], + 'init_version' => [ + 'title' => '集群初始化版本。', + 'description' => '集群版本。ACK支持的Kubernetes版本，请参见[Kubernetes版本发布概览](~~185269~~)。', + 'type' => 'string', + 'example' => '1.32.1-aliyun.1', + ], + 'current_version' => [ + 'title' => '集群当前版本。', + 'description' => '集群当前版本。', + 'type' => 'string', + 'example' => '1.32.1-aliyun.1', + ], + 'next_version' => [ + 'title' => '集群可升级版本。', + 'description' => '集群可升级版本。', + 'type' => 'string', + 'example' => '1.xx.x-aliyun.1', + ], + 'deletion_protection' => [ + 'title' => '集群是否开启删除保护。', + 'description' => '集群删除保护，防止通过控制台或API误删除集群。取值：'."\n" + ."\n" + .'- `true`：启用集群删除保护，将不能通过控制台或API删除集群。'."\n" + .'- `false`：不启用集群删除保护，则能通过控制台或API删除集群。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'docker_version' => [ + 'title' => '集群使用的Docker版本。', + 'description' => '集群Docker版本。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '19.03.5', + ], + 'external_loadbalancer_id' => [ + 'title' => '集群负载均衡服务的ID。', + 'description' => '集群中Ingress SLB实例。'."\n" + ."\n" + .'默认实例规格：性能保障型（slb.s1.small）。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'lb-2vcrbmlevo6kjpgch****', + ], + 'master_url' => [ + 'title' => '集群访问地址列表。', + 'description' => '集群API Server访问地址，包含内网访问地址以及公网访问地址。', + 'type' => 'string', + 'example' => '{\\"api_server_endpoint\\":\\"\\",\\"intranet_api_server_endpoint\\":\\"https://192.168.xx.xx:6443\\"}', + ], + 'meta_data' => [ + 'title' => '集群元数据信息。', + 'description' => '集群元数据信息。', + 'type' => 'string', + 'example' => '{\\"Addons\\":[{\\"config\\":***}}', + ], + 'name' => [ + 'title' => '集群名称。', + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'cluster-demo', + ], + 'network_mode' => [ + 'title' => '集群使用的网络类型，例如：VPC网络。', + 'description' => '集群网络模式。取值：'."\n" + ."\n" + .'- `classic`：经典网络。'."\n" + .'- `vpc`：专有网络。'."\n" + .'- `overlay`：叠加网络。'."\n" + .'- `calico`：Calico网络。'."\n", + 'type' => 'string', + 'deprecated' => true, + 'example' => 'vpc', + ], + 'private_zone' => [ + 'title' => '集群是否开启Private Zone。', + 'description' => '集群Private Zone配置。取值：'."\n" + ."\n" + .'- `true`：启用Private Zone。'."\n" + .'- `false`：不启用Private Zone。'."\n", + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'false', + ], + 'profile' => [ + 'title' => '边缘集群表示，用于区分边缘托管版集群。', + 'description' => '集群子类型。', + 'type' => 'string', + 'example' => 'Default', + ], + 'region_id' => [ + 'title' => '地域ID。', + 'description' => '集群所在地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'resource_group_id' => [ + 'title' => '集群资源组ID。', + 'description' => '集群资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyvw3wjm****', + ], + 'security_group_id' => [ + 'title' => '集群安全组ID。', + 'description' => '集群安全组ID。', + 'type' => 'string', + 'example' => 'sg-2vcgwsrwgt5mp0yi****', + ], + 'container_cidr' => [ + 'title' => 'POD网络网段', + 'description' => 'Pod网络网段，Flannel网络配置。', + 'type' => 'string', + 'required' => false, + 'example' => '172.20.xx.xx/16', + ], + 'service_cidr' => [ + 'title' => '服务网络网段', + 'description' => '服务网络网段。', + 'type' => 'string', + 'required' => true, + 'example' => '172.21.xx.xx/20', + ], + 'proxy_mode' => [ + 'title' => 'Proxy代理模式，ipvs|iptables', + 'description' => 'kube-proxy代理模式。'."\n" + ."\n" + .'- `iptables`: 成熟稳定的kube-proxy代理模式，Kubernetes Service的服务发现和负载均衡使用iptables规则配置，但是性能一般，受规模影响较大，适用于集群存在少量的Service。'."\n" + .'- `ipvs`：高性能的kube-proxy代理模式，Kubernetes Service的服务发现和负载均衡使用Linux IPVS模块进行配置，适用于集群存在大量的Service，对负载均衡有高性能要求的场景。', + 'type' => 'string', + 'example' => 'ipvs', + ], + 'timezone' => [ + 'title' => '时区', + 'description' => '时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'ip_stack' => [ + 'title' => '集群的IP协议栈，可取值：'."\n" + .'- ipv4：创建仅支持IPv4协议栈的集群；'."\n" + .'- dual：创建支持IPv4/IPv6双栈的集群。', + 'description' => '集群的IP协议栈，可取值：'."\n" + .'- ipv4：创建仅支持IPv4协议栈的集群。'."\n" + .'- dual：创建支持IPv4/IPv6双栈的集群。', + 'type' => 'string', + 'example' => 'ipv4', + 'default' => 'ipv4', + 'enum' => [ + 'ipv4', + 'dual', + ], + ], + 'cluster_domain' => [ + 'title' => '集群本地域名', + 'description' => '集群本地域名。', + 'type' => 'string', + 'example' => 'cluster.local', + ], + 'size' => [ + 'title' => '集群节点数。', + 'description' => '集群当前节点数量，包含Master节点以及Worker节点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'state' => [ + 'title' => '集群运行状态。', + 'description' => '集群运行状态，取值：'."\n" + ."\n" + .'- `initial`：集群创建中。'."\n" + .'- `failed`：集群创建失败。'."\n" + .'- `running`：集群运行中。'."\n" + .'- `updating`：集群变更中。'."\n" + .'- `upgrading`：集群升级中。'."\n" + .'- `removing`：节点移除中。'."\n" + .'- `draining`：节点排水中。'."\n" + .'- `scaling`：集群伸缩中。'."\n" + .'- `inactive`：集群不活跃。'."\n" + .'- `unavailable`：集群不可用。'."\n" + .'- `deleting`：集群删除中。'."\n" + .'- `deleted`：集群已经被删除。'."\n" + .'- `delete_failed`：集群删除失败。'."\n" + .'- `waiting`：等待接入状态。'."\n" + .'- `disconnected`：断开状态。', + 'type' => 'string', + 'example' => 'running', + ], + 'subnet_cidr' => [ + 'title' => 'POD网段地址。【该字段已废弃】请使用container_cidr获取Pod网络网段。', + 'description' => '【该字段已废弃】请使用container_cidr获取Pod网络网段。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'null', + ], + 'tags' => [ + 'title' => '集群标签。', + 'description' => '集群资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '集群资源标签。', + '$ref' => '#/components/schemas/tag', + ], + ], + 'updated' => [ + 'title' => '集群更新时间。', + 'description' => '集群更新时间。', + 'type' => 'string', + 'example' => '2025-04-07T09:57:26+08:00', + ], + 'vpc_id' => [ + 'title' => '集群所在的VPC ID。', + 'description' => '集群专有网络ID。', + 'type' => 'string', + 'example' => 'vpc-2vcg932hsxsxuqbgl****', + ], + 'vswitch_id' => [ + 'title' => '集群使用的虚拟交换ID。', + 'description' => '集群虚拟交换机ID。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****', + ], + 'vswitch_ids' => [ + 'title' => '集群控制面虚拟交换机。', + 'description' => '集群控制面虚拟交换机。', + 'type' => 'array', + 'items' => [ + 'description' => '集群控制面虚拟交换机。', + 'type' => 'string', + 'example' => 'vsw-2vc41xuumx5z2rdma****', + ], + ], + 'worker_ram_role_name' => [ + 'title' => '集群Worker RAM角色。', + 'description' => 'Worker RAM角色名称，授权ECS实例为集群Worker节点。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****', + ], + 'zone_id' => [ + 'title' => '可用区ID。', + 'description' => '集群所属可用区ID。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'cn-beijing-b', + ], + 'cluster_spec' => [ + 'title' => '托管版集群类型，面向托管集群。 • ack.pro.small：专业托管集群。 • ack.standard ：标准托管集群。', + 'description' => '集群规格。', + 'type' => 'string', + 'example' => 'ack.standard', + ], + 'maintenance_window' => [ + 'description' => '集群维护窗口，该功能只在ACK托管集群和ACK Serverless集群中生效。', + '$ref' => '#/components/schemas/maintenance_window', + ], + 'operation_policy' => [ + 'title' => '集群自动运维策略。', + 'description' => '集群自动运维策略。', + 'type' => 'object', + 'properties' => [ + 'cluster_auto_upgrade' => [ + 'title' => '集群自动升级。', + 'description' => '集群自动升级。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => '是否开启集群自动升级。', + 'description' => '是否开启集群自动升级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'channel' => [ + 'title' => '集群自动升级频次。可取值：'."\n" + .'- patch'."\n" + .'- stable'."\n" + .'- rapid', + 'description' => '集群自动升级频次。更多信息，请参见[升级频次](~~2712866~~)。'."\n" + ."\n" + .'取值：'."\n" + .'- patch：最新补丁版本。'."\n" + .'- stable：次新次要版本。'."\n" + .'- rapid：最新次要版本。', + 'type' => 'string', + 'example' => 'patch', + ], + ], + ], + ], + ], + ], + ], + ], + 'page_info' => [ + 'title' => '分页信息。', + 'description' => '分页信息。'."\n", + 'type' => 'object', + 'properties' => [ + 'page_number' => [ + 'title' => '分页数。', + 'description' => '分页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'page_size' => [ + 'title' => '单页大小。', + 'description' => '单页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'total_count' => [ + 'title' => '结果总数。', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"clusters\\": [\\n {\\n \\"cluster_id\\": \\"c3fb96524f9274b4495df0f12a6b5****\\",\\n \\"cluster_type\\": \\"Kubernetes\\",\\n \\"created\\": \\"2025-04-07T09:57:26+08:00\\",\\n \\"init_version\\": \\"1.32.1-aliyun.1\\",\\n \\"current_version\\": \\"1.32.1-aliyun.1\\",\\n \\"next_version\\": \\"1.xx.x-aliyun.1\\",\\n \\"deletion_protection\\": true,\\n \\"docker_version\\": \\"19.03.5\\",\\n \\"external_loadbalancer_id\\": \\"lb-2vcrbmlevo6kjpgch****\\",\\n \\"master_url\\": \\"{\\\\\\\\\\\\\\"api_server_endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"intranet_api_server_endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://192.168.xx.xx:6443\\\\\\\\\\\\\\"}\\",\\n \\"meta_data\\": \\"{\\\\\\\\\\\\\\"Addons\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"config\\\\\\\\\\\\\\":***}}\\",\\n \\"name\\": \\"cluster-demo\\",\\n \\"network_mode\\": \\"vpc\\",\\n \\"private_zone\\": false,\\n \\"profile\\": \\"Default\\",\\n \\"region_id\\": \\"cn-beijing\\",\\n \\"resource_group_id\\": \\"rg-acfmyvw3wjm****\\",\\n \\"security_group_id\\": \\"sg-2vcgwsrwgt5mp0yi****\\",\\n \\"container_cidr\\": \\"172.20.xx.xx/16\\",\\n \\"service_cidr\\": \\"172.21.xx.xx/20\\",\\n \\"proxy_mode\\": \\"ipvs\\",\\n \\"timezone\\": \\"Asia/Shanghai\\",\\n \\"ip_stack\\": \\"ipv4\\",\\n \\"cluster_domain\\": \\"cluster.local\\",\\n \\"size\\": 5,\\n \\"state\\": \\"running\\",\\n \\"subnet_cidr\\": \\"null\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ],\\n \\"updated\\": \\"2025-04-07T09:57:26+08:00\\",\\n \\"vpc_id\\": \\"vpc-2vcg932hsxsxuqbgl****\\",\\n \\"vswitch_id\\": \\"vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****\\",\\n \\"vswitch_ids\\": [\\n \\"vsw-2vc41xuumx5z2rdma****\\"\\n ],\\n \\"worker_ram_role_name\\": \\"KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****\\",\\n \\"zone_id\\": \\"cn-beijing-b\\",\\n \\"cluster_spec\\": \\"ack.standard\\",\\n \\"maintenance_window\\": {\\n \\"enable\\": false,\\n \\"maintenance_time\\": \\"2020-10-15T12:31:00.000+08:00\\",\\n \\"duration\\": \\"3h\\",\\n \\"weekly_period\\": \\"Monday,Thursday\\",\\n \\"recurrence\\": \\"FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU\\"\\n },\\n \\"operation_policy\\": {\\n \\"cluster_auto_upgrade\\": {\\n \\"enabled\\": true,\\n \\"channel\\": \\"patch\\"\\n }\\n }\\n }\\n ],\\n \\"page_info\\": {\\n \\"page_number\\": 3,\\n \\"page_size\\": 20,\\n \\"total_count\\": 50\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClustersV1Response>\\n <clusters>\\n <cluster_id>c3fb96524f9274b4495df0f12a6b5****</cluster_id>\\n <cluster_type>Kubernetes</cluster_type>\\n <created>2020-08-20T10:51:29+08:00</created>\\n <init_version>1.16.9-aliyun.1</init_version>\\n <current_version>1.16.9-aliyun.1</current_version>\\n <next_version>1.18.8-aliyun.1</next_version>\\n <deletion_protection>true</deletion_protection>\\n <docker_version>19.03.5</docker_version>\\n <external_loadbalancer_id>lb-2vcrbmlevo6kjpgch****</external_loadbalancer_id>\\n <master_url>{\\\\\\"api_server_endpoint\\\\\\":\\\\\\"\\\\\\",\\\\\\"intranet_api_server_endpoint\\\\\\":\\\\\\"https://192.168.0.251:6443\\\\\\"}</master_url>\\n <meta_data>{\\\\\\"Addons\\\\\\":[{\\\\\\"config\\\\\\":***}</meta_data>\\n <name>cluster-demo</name>\\n <network_mode>vpc</network_mode>\\n <private_zone>false</private_zone>\\n <profile>Default</profile>\\n <region_id>cn-beijing</region_id>\\n <resource_group_id>rg-acfmyvw3wjm****</resource_group_id>\\n <security_group_id>sg-2vcgwsrwgt5mp0yi****</security_group_id>\\n <size>5</size>\\n <state>running</state>\\n <subnet_cidr>172.21.0.0/16</subnet_cidr>\\n <tags>\\n <key>env</key>\\n <value>prod</value>\\n </tags>\\n <updated>2020-09-16T11:09:55+08:00</updated>\\n <vpc_id>vpc-2vcg932hsxsxuqbgl****</vpc_id>\\n <vswitch_id>vsw-2vc41xuumx5z2rdma****,vsw-2vc41xuumx5z2rdma****</vswitch_id>\\n <worker_ram_role_name>KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****</worker_ram_role_name>\\n <zone_id>cn-beijing-b</zone_id>\\n <cluster_spec>ack.standard</cluster_spec>\\n <maintenance_window>\\n <enable>false</enable>\\n <maintenance_time>03:00:00Z</maintenance_time>\\n <duration>3h</duration>\\n <weekly_period>Monday,Thursday</weekly_period>\\n </maintenance_window>\\n </clusters>\\n <page_info>\\n <page_number>3</page_number>\\n <page_size>20</page_size>\\n <total_count>50</total_count>\\n </page_info>\\n</DescribeClustersV1Response>","errorExample":""}]', + 'title' => '查询集群列表', + ], + 'DescribeClustersForRegion' => [ + 'summary' => '查询指定地域内全部集群列表。', + 'path' => '/regions/{region_id}/clusters', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249403', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + 'FEATUREcskI1OLEY', + 'FEATUREcskZG2TSX', + 'FEATUREcskDGKERY', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'title' => '通过集群名称进行模糊查询。', + 'description' => '通过集群名称进行模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-cluster', + ], + ], + [ + 'name' => 'cluster_type', + 'in' => 'query', + 'schema' => [ + 'title' => '集群类型。', + 'description' => '查询指定类型的集群，可取值：'."\n" + .'- Kubernetes: ACK 专有集群。'."\n" + .'- ManagedKubernetes：ACK 托管类的集群，包括 ACK 托管集群（ACK 集群 Pro 版、ACK 集群基础版）、ACK Serverless 集群（Pro 版、基础版）、ACK Edge 集群（Pro 版、基础版）、ACK 灵骏集群（Pro 版）。'."\n" + .'- ExternalKubernetes：注册集群。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ExternalKubernetes' => 'ExternalKubernetes', + 'ManagedKubernetes' => 'ManagedKubernetes', + 'Kubernetes' => 'Kubernetes', + ], + 'example' => 'Kubernetes', + ], + ], + [ + 'name' => 'page_size', + 'in' => 'query', + 'schema' => [ + 'title' => '单页大小。', + 'description' => '每页记录数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'page_number', + 'in' => 'query', + 'schema' => [ + 'title' => '分页数。', + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'profile', + 'in' => 'query', + 'schema' => [ + 'title' => '集群标识。', + 'description' => '查询指定子类型的集群，可取值：'."\n" + .'- Default：ACK 托管集群，包括 ACK 集群 Pro 版和 ACK 集群基础版。'."\n" + .'- Edge：ACK Edge 集群，包括 ACK Edge 集群 Pro 版和 ACK Edge 集群基础版。'."\n" + .'- Serverless：ACK Serverless 集群，包括 ACK Serverless 集群 Pro 版和 ACK Serverless 集群基础版。'."\n" + .'- LingJun：ACK 灵骏集群，提供 Pro 版。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'LingJun' => 'LingJun', + 'Serverless' => 'Serverless', + 'Default' => 'Default', + 'Edge' => 'Edge', + ], + 'example' => 'Serverless', + ], + ], + [ + 'name' => 'cluster_spec', + 'in' => 'query', + 'schema' => [ + 'title' => '集群规格。', + 'description' => '查询指定规格的集群，可取值：'."\n" + .'- ack.pro.small：Pro 版。'."\n" + .'- ack.standard：基础版。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ack.pro.small' => 'ack.pro.small', + 'ack.standard' => 'ack.standard', + ], + 'example' => 'ack.standard', + ], + ], + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c8155823d057948c69a****', + ], + ], + [ + 'name' => 'region_id', + 'in' => 'path', + 'schema' => [ + 'title' => '地域。', + 'description' => '地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'clusters' => [ + 'title' => '集群详情列表。', + 'description' => '集群详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群详情。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c905d1364c2dd4b6284a3f41790c4****', + ], + 'cluster_type' => [ + 'title' => '集群类型。', + 'description' => '集群类型：'."\n" + .'- Kubernetes: ACK 专有集群。'."\n" + .'- ManagedKubernetes：ACK 托管类的集群，包括 ACK 托管集群（ACK 集群 Pro 版、ACK 集群基础版）、ACK Serverless 集群（Pro 版、基础版）、ACK Edge 集群（Pro 版、基础版）、ACK 灵骏集群（Pro 版）。'."\n" + .'- ExternalKubernetes：注册集群。', + 'type' => 'string', + 'example' => 'ManagedKubernetes', + ], + 'created' => [ + 'title' => '集群初始化时间。', + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2020-12-01T20:40:40+08:00', + ], + 'init_version' => [ + 'title' => '集群初始化版本。', + 'description' => '集群初始版本。', + 'type' => 'string', + 'example' => '1.16.6-aliyun.1', + ], + 'current_version' => [ + 'title' => '集群当前版本。', + 'description' => '集群当前版本。', + 'type' => 'string', + 'example' => '1.16.6-aliyun.1', + ], + 'next_version' => [ + 'title' => '集群可升级版本。', + 'description' => '集群可升级版本。', + 'type' => 'string', + 'example' => '1.18.8-aliyun.1', + ], + 'deletion_protection' => [ + 'title' => '集群是否开启删除保护。', + 'description' => '集群删除保护，防止通过控制台或 API 误删除集群。取值：'."\n" + .'- true：启用集群删除保护，将不能通过控制台或 API 删除集群。'."\n" + .'- false：不启用集群删除保护，则能通过控制台或 API 删除集群。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'name' => [ + 'title' => '集群名称。', + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test-cluster', + ], + 'profile' => [ + 'title' => '边缘集群表示，用于区分边缘托管版集群。', + 'description' => '集群子类型：'."\n" + .'- Default：ACK 托管集群，包括 ACK 集群 Pro 版和 ACK 集群基础版。'."\n" + .'- Edge：ACK Edge 集群，包括 ACK Edge 集群 Pro 版和 ACK Edge 集群基础版。'."\n" + .'- Serverless：ACK Serverless 集群，包括 ACK Serverless 集群 Pro 版和 ACK Serverless 集群基础版。'."\n" + .'- LingJun：ACK 灵骏集群，提供 Pro 版。', + 'type' => 'string', + 'example' => 'Default', + ], + 'region_id' => [ + 'title' => '地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing-a', + ], + 'resource_group_id' => [ + 'title' => '集群资源组ID。', + 'description' => '集群资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyvw3wjm****', + ], + 'security_group_id' => [ + 'title' => '集群安全组ID。', + 'description' => '集群安全组ID。', + 'type' => 'string', + 'example' => 'sg-2zeihch86ooz9io4****', + ], + 'container_cidr' => [ + 'title' => 'POD网络网段', + 'description' => '集群Pod网络网段。', + 'type' => 'string', + 'required' => false, + 'example' => '172.20.0.0/16', + ], + 'service_cidr' => [ + 'title' => '服务网络网段', + 'description' => '服务网络网段。', + 'type' => 'string', + 'required' => true, + 'example' => '172.21.0.0/20', + ], + 'proxy_mode' => [ + 'title' => 'Proxy代理模式，ipvs|iptables', + 'description' => '集群kube-proxy代理模式。', + 'type' => 'string', + 'enumValueTitles' => [ + 'iptables' => 'iptables', + 'ipvs' => 'ipvs', + ], + 'example' => 'ipvs', + ], + 'timezone' => [ + 'title' => '时区', + 'description' => '时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'ip_stack' => [ + 'title' => '集群的IP协议栈，可取值：'."\n" + .'- ipv4：创建仅支持IPv4协议栈的集群；'."\n" + .'- dual：创建支持IPv4/IPv6双栈的集群。', + 'description' => '集群的IP协议栈。', + 'type' => 'string', + 'example' => 'ipv4', + 'default' => 'ipv4', + 'enum' => [ + 'ipv4', + 'dual', + ], + ], + 'cluster_domain' => [ + 'title' => '集群本地域名', + 'description' => '集群本地域名', + 'type' => 'string', + 'example' => 'cluster.local', + ], + 'size' => [ + 'title' => '集群节点数。', + 'description' => '集群节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'state' => [ + 'title' => '集群运行状态。', + 'description' => '集群运行状态，取值：'."\n" + ."\n" + .'- `initial`：集群创建中。'."\n" + .'- `failed`：集群创建失败。'."\n" + .'- `running`：集群运行中。'."\n" + .'- `updating`：集群变更中。'."\n" + .'- `upgrading`：集群升级中。'."\n" + .'- `removing`：节点移除中。'."\n" + .'- `draining`：节点排水中。'."\n" + .'- `scaling`：集群伸缩中。'."\n" + .'- `inactive`：集群不活跃。'."\n" + .'- `unavailable`：集群不可用。'."\n" + .'- `deleting`：集群删除中。'."\n" + .'- `deleted`：集群已经被删除。'."\n" + .'- `delete_failed`：集群删除失败。'."\n" + .'- `waiting`：等待接入状态。'."\n" + .'- `disconnected`：断开状态。', + 'type' => 'string', + 'example' => 'running', + ], + 'tags' => [ + 'title' => '集群标签。', + 'description' => '集群标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群标签。', + '$ref' => '#/components/schemas/tag', + ], + ], + 'updated' => [ + 'title' => '集群更新时间。', + 'description' => '集群更新时间。', + 'type' => 'string', + 'example' => '2020-12-08T15:37:00+08:00', + ], + 'vpc_id' => [ + 'title' => '集群所在的VPC ID。', + 'description' => '集群所在的VPC ID。', + 'type' => 'string', + 'example' => 'vpc-2zeg8nf1ukc0fcmvq****', + ], + 'vswitch_ids' => [ + 'title' => '集群控制面虚拟交换机。', + 'description' => '集群控制面虚拟交换机列表。', + 'type' => 'array', + 'items' => [ + 'description' => '集群控制面虚拟交换机。', + 'type' => 'string', + 'example' => 'vsw-2vc41xuumx5z2rdma****', + ], + ], + 'cluster_spec' => [ + 'title' => '托管版集群类型，面向托管集群。 • ack.pro.small：专业托管集群。 • ack.standard ：标准托管集群。', + 'description' => '托管版集群规格：'."\n" + ."\n" + .'- ack.pro.small：Pro 版。'."\n" + .'- ack.standard：基础版。', + 'type' => 'string', + 'example' => 'ack.standard', + ], + ], + ], + ], + 'page_info' => [ + 'title' => '分页信息。', + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'page_number' => [ + 'title' => '分页数。', + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'page_size' => [ + 'title' => '单页大小。', + 'description' => '每页记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'total_count' => [ + 'title' => '结果总数。', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"clusters\\": [\\n {\\n \\"cluster_id\\": \\"c905d1364c2dd4b6284a3f41790c4****\\",\\n \\"cluster_type\\": \\"ManagedKubernetes\\",\\n \\"created\\": \\"2020-12-01T20:40:40+08:00\\",\\n \\"init_version\\": \\"1.16.6-aliyun.1\\",\\n \\"current_version\\": \\"1.16.6-aliyun.1\\",\\n \\"next_version\\": \\"1.18.8-aliyun.1\\",\\n \\"deletion_protection\\": false,\\n \\"name\\": \\"test-cluster\\",\\n \\"profile\\": \\"Default\\",\\n \\"region_id\\": \\"cn-beijing-a\\",\\n \\"resource_group_id\\": \\"rg-acfmyvw3wjm****\\",\\n \\"security_group_id\\": \\"sg-2zeihch86ooz9io4****\\",\\n \\"container_cidr\\": \\"172.20.0.0/16\\",\\n \\"service_cidr\\": \\"172.21.0.0/20\\",\\n \\"proxy_mode\\": \\"ipvs\\",\\n \\"timezone\\": \\"Asia/Shanghai\\",\\n \\"ip_stack\\": \\"ipv4\\",\\n \\"cluster_domain\\": \\"cluster.local\\",\\n \\"size\\": 2,\\n \\"state\\": \\"running\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ],\\n \\"updated\\": \\"2020-12-08T15:37:00+08:00\\",\\n \\"vpc_id\\": \\"vpc-2zeg8nf1ukc0fcmvq****\\",\\n \\"vswitch_ids\\": [\\n \\"vsw-2vc41xuumx5z2rdma****\\"\\n ],\\n \\"cluster_spec\\": \\"ack.standard\\"\\n }\\n ],\\n \\"page_info\\": {\\n \\"page_number\\": 1,\\n \\"page_size\\": 10,\\n \\"total_count\\": 10\\n }\\n}","type":"json"}]', + 'title' => '查询指定地域的集群列表', + ], + 'DescribeClusterDetail' => [ + 'summary' => '您可以调用DescribeClusterDetail接口，根据集群ID查询指定集群的详细信息。', + 'path' => '/clusters/{ClusterId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '400', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + 'FEATUREcskI1OLEY', + 'FEATUREcskZG2TSX', + 'FEATUREcskDGKERY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cdde1f21ae22e483ebcb068a6eb7f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + 'cluster_type' => [ + 'title' => '集群类型。', + 'description' => '集群类型。'."\n" + ."\n" + .'- `Kubernetes`: ACK专有集群。'."\n" + .' '."\n" + .'- `ManagedKubernetes`：ACK托管类的集群，包括ACK托管集群（ACK集群Pro版、ACK集群基础版）、ACK Serverless集群（Pro版、基础版）、ACK Edge集群（Pro版、基础版）、ACK灵骏集群（Pro版）。'."\n" + .' '."\n" + .'- `ExternalKubernetes`：注册集群。', + 'type' => 'string', + 'example' => 'Kubernetes', + ], + 'created' => [ + 'title' => '集群创建时间。', + 'description' => '集群创建时间。', + 'type' => 'string', + 'example' => '2025-04-07T09:57:26+08:00', + ], + 'init_version' => [ + 'title' => '集群初始化版本。', + 'description' => '集群初始化版本。', + 'type' => 'string', + 'example' => '1.32.1-aliyun.1', + ], + 'current_version' => [ + 'title' => '集群当前版本。', + 'description' => '集群当前版本。ACK支持的Kubernetes版本，请参见[Kubernetes版本发布概览](~~185269~~)。', + 'type' => 'string', + 'example' => '1.32.1-aliyun.1', + ], + 'next_version' => [ + 'title' => '集群可升级版本。', + 'description' => '集群可升级版本。', + 'type' => 'string', + 'example' => '1.xx.x-aliyun.1', + ], + 'deletion_protection' => [ + 'title' => '集群是否开启删除保护。', + 'description' => '集群删除保护，防止通过控制台或API误删除集群。取值：'."\n" + ."\n" + .'- `true`：启用集群删除保护，将不能通过控制台或API删除集群。'."\n" + .'- `false`：不启用集群删除保护，则能通过控制台或API删除集群。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'docker_version' => [ + 'title' => '集群内Docker版本。', + 'description' => '集群中的Docker版本。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '19.03.5', + ], + 'external_loadbalancer_id' => [ + 'title' => '集群Ingress LB实例ID。', + 'description' => '集群Ingress LB实例ID。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'lb-2zehc05z3b8dwiifh****', + ], + 'meta_data' => [ + 'title' => '集群元数据。', + 'description' => '集群元数据信息。', + 'type' => 'string', + 'example' => '\\"Addons\\":***', + ], + 'name' => [ + 'title' => '集群名称。', + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'cluster-demo', + ], + 'network_mode' => [ + 'title' => '集群采用的网络类型，例如：VPC网络。', + 'description' => '集群采用的网络类型，例如：VPC网络。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'vpc', + ], + 'region_id' => [ + 'title' => '集群所在地域ID。', + 'description' => '集群所在地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'resource_group_id' => [ + 'title' => '集群资源组ID。', + 'description' => '集群资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyvw3wjm****', + ], + 'security_group_id' => [ + 'title' => '集群安全组ID。', + 'description' => '集群安全组ID。', + 'type' => 'string', + 'example' => 'sg-25yq****', + ], + 'size' => [ + 'title' => '集群节点数量。', + 'description' => '集群节点数，包含Master节点及Worker节点。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'state' => [ + 'title' => '集群运行状态。', + 'description' => '集群运行状态，取值：'."\n" + ."\n" + .'- `initial`：集群创建中。'."\n" + .'- `failed`：集群创建失败。'."\n" + .'- `running`：集群运行中。'."\n" + .'- `updating`：集群变更中。'."\n" + .'- `upgrading`：集群升级中。'."\n" + .'- `removing`：节点移除中。'."\n" + .'- `draining`：节点排水中。'."\n" + .'- `scaling`：集群伸缩中。'."\n" + .'- `inactive`：集群不活跃。'."\n" + .'- `unavailable`：集群不可用。'."\n" + .'- `deleting`：集群删除中。'."\n" + .'- `deleted`：集群已经被删除。'."\n" + .'- `delete_failed`：集群删除失败。'."\n" + .'- `waiting`：等待接入状态。'."\n" + .'- `disconnected`：断开状态。', + 'type' => 'string', + 'example' => 'running', + ], + 'tags' => [ + 'title' => '集群标签。', + 'description' => '集群资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '集群资源标签。', + '$ref' => '#/components/schemas/tag', + ], + ], + 'updated' => [ + 'title' => '集群更新时间。', + 'description' => '集群更新时间。', + 'type' => 'string', + 'example' => '2025-04-10T13:28:09+08:00', + ], + 'vpc_id' => [ + 'title' => '集群使用的VPC ID。', + 'description' => '集群专有网络ID，创建集群时的必填参数。', + 'type' => 'string', + 'example' => 'vpc-2zecuu62b9zw7a7qn****', + ], + 'vswitch_id' => [ + 'title' => '集群节点使用的虚拟交换机列表。', + 'description' => '虚拟交换机ID。该字段已废弃，控制面交换机请使用vswitch_ids查询，数据面交换机请通过节点池的vswitch_ids查询。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****', + ], + 'subnet_cidr' => [ + 'title' => 'Pod网络地址段，必须是有效的私有网段，即以下网段及其子网：10.0.0.0/8，172.16-31.0.0/12-16，192.168.0.0/16。不能与 VPC 及VPC 内已有 Kubernetes 集群使用的网段重复，创建成功后不能修改。 有关集群网络规划，请参见：[VPC下 Kubernetes 的网络地址段规划](https://help.aliyun.com/document_detail/～～86500～～)。【该字段已废弃】请使用container_cidr获取Pod网络网段。', + 'description' => 'Pod网络地址段。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '172.20.xx.xx/16', + ], + 'zone_id' => [ + 'title' => '集群所在地域内的可用区ID。', + 'description' => '集群所在地域内的可用区ID。', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'cn-beijing-a', + ], + 'master_url' => [ + 'title' => '集群访问地址。', + 'description' => '集群访问地址，包含内网访问地址及公网访问地址。', + 'type' => 'string', + 'example' => '{\\"intranet_api_server_endpoint\\":\\"https://192.168.xx.xx:6443\\"***}', + ], + 'private_zone' => [ + 'title' => '集群是否启用用PrivateZone。 true：启用 false：不启用 默认值：false。', + 'description' => '集群是否启用PrivateZone。 '."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：不启用 。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'false', + ], + 'profile' => [ + 'title' => '面向场景时的集群类型。 Default：非边缘场景集群。 Edge：边缘场景集群。', + 'description' => '集群子类型。'."\n" + ."\n" + .'- `Default`：ACK托管集群，包括ACK集群Pro版和ACK集群基础版。'."\n" + .' '."\n" + .'- `Edge`：ACK Edge集群，包括ACK Edge集群Pro版和ACK Edge集群基础版。'."\n" + .' '."\n" + .'- `Serverless`：ACK Serverless集群，包括ACK Serverless集群Pro版和ACK Serverless集群基础版。'."\n" + .' '."\n" + .'- `Lingjun`：ACK灵骏集群，提供Pro版。', + 'type' => 'string', + 'example' => 'Default', + ], + 'cluster_spec' => [ + 'title' => '托管版集群类型，面向托管集群。 ack.pro.small：专业托管集群。 ack.standard ：标准托管集群。', + 'description' => '集群的规格。'."\n" + ."\n" + .'- `ack.pro.small`：集群Pro版。'."\n" + .' '."\n" + .'- `ack.standard`：集群基础版。', + 'type' => 'string', + 'example' => 'ack.pro.small', + ], + 'worker_ram_role_name' => [ + 'title' => 'Worker节点RAM角色名称。', + 'description' => 'Worker RAM角色名称，授权ECS实例为集群Woker节点。', + 'type' => 'string', + 'example' => 'KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****', + ], + 'maintenance_window' => [ + 'description' => '集群维护窗口配置，只在托管版本（即：ACK Pro集群）中生效。', + '$ref' => '#/components/schemas/maintenance_window', + ], + 'parameters' => [ + 'description' => '集群ROS参数集合。', + 'type' => 'object', + 'deprecated' => true, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'ROS参数。', + 'example' => '"ALIYUN::Region": "cn-qingdao"', + ], + ], + 'container_cidr' => [ + 'title' => 'POD网络网段', + 'description' => 'Pod网络网段，Flannel网络配置。', + 'type' => 'string', + 'required' => false, + 'example' => '172.20.xx.xx/16', + ], + 'service_cidr' => [ + 'title' => '服务网络网段', + 'description' => '服务网络网段。', + 'type' => 'string', + 'required' => true, + 'example' => '172.21.xx.xx/20', + ], + 'proxy_mode' => [ + 'title' => 'Proxy代理模式，ipvs|iptables', + 'description' => 'kube-proxy代理模式'."\n" + ."\n" + .'- `iptables`: 成熟稳定的kube-proxy代理模式，Kubernetes Service的服务发现和负载均衡使用iptables规则配置，但是性能一般，受规模影响较大，适用于集群存在少量的Service。'."\n" + .'- `ipvs`：高性能的kube-proxy代理模式，Kubernetes Service的服务发现和负载均衡使用Linux IPVS模块进行配置，适用于集群存在大量的Service，对负载均衡有高性能要求的场景。', + 'type' => 'string', + 'example' => 'ipvs', + ], + 'timezone' => [ + 'title' => '时区', + 'description' => '时区。', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'node_cidr_mask' => [ + 'title' => '节点IP数量', + 'description' => '仅适用于Flannel网络插件。 '."\n" + ."\n" + .'节点分配的子网掩码大小，用于控制节点可以分配的IP地址的数量。', + 'type' => 'string', + 'example' => '26', + ], + 'ip_stack' => [ + 'title' => '集群的IP协议栈，可取值：'."\n" + .'- ipv4：创建仅支持IPv4协议栈的集群；'."\n" + .'- dual：创建支持IPv4/IPv6双栈的集群。', + 'description' => '集群的IP协议栈，可取值：'."\n" + .'- ipv4：创建仅支持IPv4协议栈的集群；'."\n" + .'- dual：创建支持IPv4/IPv6双栈的集群。', + 'type' => 'string', + 'example' => 'ipv4', + 'default' => 'ipv4', + 'enum' => [ + 'ipv4', + 'dual', + ], + ], + 'cluster_domain' => [ + 'title' => '集群本地域名', + 'description' => '集群本地域名。', + 'type' => 'string', + 'example' => 'cluster.local', + ], + 'extra_sans' => [ + 'title' => '自定义证书 SAN。', + 'description' => '自定义的 API Server 证书 SAN（Subject Alternative Name）。', + 'type' => 'array', + 'items' => [ + 'title' => '证书 SAN。', + 'description' => '证书 SAN。', + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + ], + 'rrsa_config' => [ + 'title' => 'RRSA 配置。', + 'description' => 'RRSA 配置。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => '是否启用 RRSA。', + 'description' => '是否启用 RRSA。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'oidc_name' => [ + 'title' => 'OIDC 身份提供商名称。', + 'description' => 'OIDC 身份提供商名称。', + 'type' => 'string', + 'example' => 'ack-rrsa-***', + ], + 'oidc_arn' => [ + 'title' => 'OIDC 身份提供商 ARN。', + 'description' => 'OIDC 身份提供商 ARN。', + 'type' => 'string', + 'example' => 'acs:ram::1138***:oidc-provider/ack-rrsa-***', + ], + 'max_oidc_token_expiration' => [ + 'title' => 'OIDC Token 可配置的最大有效期。', + 'description' => 'OIDC Token 可配置的最大有效期。', + 'type' => 'string', + 'example' => '12h', + ], + 'audience' => [ + 'title' => 'OIDC Token 的受众信息。包含多个值时将使用英文逗号（,）分隔。该值将以数组形式成为 OIDC Token 中 aud 字段的值。', + 'description' => 'OIDC Token 的默认受众信息。包含多个值时将使用英文逗号（,）分隔。该值将以数组形式成为 OIDC Token 中 aud 字段的值。', + 'type' => 'string', + 'example' => 'https://kubernetes.default.svc,https://example.***.com', + ], + 'issuer' => [ + 'title' => 'OIDC Token 的签发者信息。包含多个值时将使用英文逗号（,）分隔。其中第一个值将成为 OIDC Token 中 iss 字段的值以及 OIDC 身份提供商的颁发者 URL。', + 'description' => 'OIDC Token 的签发者信息。包含多个值时将使用英文逗号（,）分隔。其中第一个值将成为 OIDC Token 中 iss 字段的值以及 OIDC 身份提供商的颁发者 URL。', + 'type' => 'string', + 'example' => 'https://oidc-ack-***,https://kubernetes.default.svc', + ], + 'open_api_configuration_url' => [ + 'title' => 'OIDC 配置文档 URL。', + 'description' => 'OIDC 配置文档 URL。', + 'type' => 'string', + 'example' => 'https://oidc-ack-***/c12b990***/.well-known/openid-configuration', + ], + 'jwks_url' => [ + 'title' => 'OIDC 公钥信息 URL。', + 'description' => 'OIDC 公钥信息 URL。', + 'type' => 'string', + 'example' => 'https://oidc-ack-***/c12b990***/keys', + ], + ], + ], + 'vswitch_ids' => [ + 'title' => '集群控制面虚拟交换机。', + 'description' => '集群控制面虚拟交换机。', + 'type' => 'array', + 'items' => [ + 'description' => '集群控制面虚拟交换机。', + 'type' => 'string', + 'example' => 'vsw-2zete8s4qocqg0mf6****', + ], + ], + 'operation_policy' => [ + 'title' => '集群自动运维策略。', + 'description' => '集群自动运维策略。', + 'type' => 'object', + 'properties' => [ + 'cluster_auto_upgrade' => [ + 'title' => '集群自动升级。', + 'description' => '集群自动升级。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => '是否开启集群自动升级。', + 'description' => '是否开启集群自动升级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'channel' => [ + 'title' => '集群自动升级频次。可取值：'."\n" + .'- patch'."\n" + .'- stable'."\n" + .'- rapid', + 'description' => '集群自动升级频次。更多信息，请参见[升级频次](~~2712866~~)。'."\n" + ."\n" + .'可取值：'."\n" + .'- patch：最新补丁版本。'."\n" + .'- stable：次新次要版本。'."\n" + .'- rapid：最新次要版本。', + 'type' => 'string', + 'example' => 'patch', + ], + ], + ], + ], + ], + 'control_plane_config' => [ + 'title' => '专有版集群控制面配置。', + 'description' => '专有版集群控制面配置。', + 'type' => 'object', + 'properties' => [ + 'charge_type' => [ + 'title' => '控制面节点付费类型。', + 'description' => '控制面节点付费类型。', + 'type' => 'string', + 'example' => 'PrePaid', + ], + 'period' => [ + 'title' => '节点包年包月时间。', + 'description' => '节点包年包月时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'period_unit' => [ + 'title' => '节点包年包月时间单位。', + 'description' => '节点包年包月时间单位。', + 'type' => 'string', + 'example' => 'Month', + ], + 'auto_renew' => [ + 'title' => '节点是否自动续费。', + 'description' => '节点是否自动续费。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_renew_period' => [ + 'title' => '节点自动续费时长。', + 'description' => '节点自动续费时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'instance_types' => [ + 'title' => '节点实例类型。', + 'description' => '节点实例规格类型。', + 'type' => 'array', + 'items' => [ + 'description' => '实例规格。', + 'type' => 'string', + 'example' => 'ecs.g6.large', + ], + ], + 'image_type' => [ + 'title' => '操作系统镜像类型。', + 'description' => '操作系统镜像类型。', + 'type' => 'string', + 'example' => 'AliyunLinux3', + ], + 'image_id' => [ + 'title' => '镜像id', + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'aliyun_3_x64_20G_alibase_20240819', + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。', + 'description' => '密钥对名称，和login_password二选一。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack', + ], + 'system_disk_category' => [ + 'title' => '节点系统盘类型。', + 'description' => '节点系统盘类型。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'system_disk_size' => [ + 'title' => '节点系统盘大小，至少40。', + 'description' => '节点系统盘大小，至少40。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'system_disk_snapshot_policy_id' => [ + 'title' => '节点自动快照备份策略。', + 'description' => '节点自动快照备份策略。', + 'type' => 'string', + 'example' => 'sp-2zej1nogjvovnz4z****', + ], + 'system_disk_performance_level' => [ + 'title' => '节点系统盘磁盘性能，只针对ESSD磁盘生效。', + 'description' => '节点系统盘磁盘性能，只针对ESSD磁盘生效。', + 'type' => 'string', + 'example' => 'PL1', + ], + 'system_disk_provisioned_iops' => [ + 'title' => '节点系统盘预配置的读写IOPS。', + 'description' => '节点系统盘预配置的读写IOPS。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'system_disk_bursting_enabled' => [ + 'title' => '节点系统盘是否开启Burst（性能突发）。', + 'description' => '节点系统盘是否开启Burst（性能突发）。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'deploymentset_id' => [ + 'title' => '部署集ID。', + 'description' => '部署集ID。', + 'type' => 'string', + 'example' => 'ds-bp10b35imuam5amw****', + ], + 'cloud_monitor_flags' => [ + 'title' => '是否为节点安装云监控。', + 'description' => '是否为节点安装云监控。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'soc_enabled' => [ + 'title' => '是否开启等保安全加固。', + 'description' => '是否开启等保安全加固。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'security_hardening_os' => [ + 'title' => '是否开启阿里云OS安全加固。', + 'description' => '是否开启阿里云OS安全加固。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cpu_policy' => [ + 'title' => '节点CPU管理策略。', + 'description' => '节点CPU管理策略。', + 'type' => 'string', + 'example' => 'none', + ], + 'runtime' => [ + 'title' => '运行时名称。', + 'description' => '运行时名称。', + 'type' => 'string', + 'example' => 'containerd', + ], + 'node_port_range' => [ + 'title' => '节点服务端口范围。', + 'description' => '节点服务端口范围。', + 'type' => 'string', + 'example' => '30000-32767', + ], + 'size' => [ + 'title' => '控制面节点数量。', + 'description' => '控制面节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'instance_metadata_options' => [ + 'title' => 'ECS 实例的元数据访问配置。', + 'description' => 'ECS 实例的元数据访问配置。', + '$ref' => '#/components/schemas/InstanceMetadataOptions', + ], + ], + ], + 'auto_mode' => [ + 'title' => '智能托管模式配置。', + 'description' => '智能托管模式配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启智能托管模式。', + 'description' => '是否开启智能托管模式。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'control_plane_endpoints_config' => [ + 'title' => '集群连接配置。', + 'description' => '集群连接配置。', + 'type' => 'object', + 'properties' => [ + 'internal_dns_config' => [ + 'title' => '集群内部域名配置，适用于ACK托管集群。集群内部域名用于 kubelet、kube-proxy 等节点侧系统组件访问 API Server；未开启集群内部域名访问时，节点侧系统组件将通过 CLB IP 方式访问。', + 'description' => '集群内部域名配置，适用于ACK托管集群。集群内部域名用于 kubelet、kube-proxy 等节点侧系统组件访问 API Server；未开启集群内部域名访问时，节点侧系统组件将通过 CLB IP 方式访问。', + 'type' => 'object', + 'properties' => [ + 'bind_vpcs' => [ + 'title' => '集群内部域名记录解析生效的 VPC 范围，默认包括集群所在 VPC。', + 'description' => '集群内部域名记录解析生效的 VPC 范围，默认包括集群所在 VPC。', + 'type' => 'array', + 'items' => [ + 'title' => '集群内部域名记录解析生效的 VPC。', + 'description' => '集群内部域名记录解析生效的 VPC。', + 'type' => 'string', + 'example' => 'vpc-xxxxxx', + ], + ], + 'enabled' => [ + 'title' => '是否开启集群内部域名访问。 - true：开启集群内部域名访问，节点侧组件（kubelet、kube-proxy）将通过集群内部域名访问API Server。', + 'description' => '是否开启集群内部域名访问。 '."\n" + .'- true：开启集群内部域名访问，节点侧组件（kubelet、kube-proxy）将通过集群内部域名访问API Server。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"cluster_id\\": \\"c82e6987e2961451182edacd74faf****\\",\\n \\"cluster_type\\": \\"Kubernetes\\",\\n \\"created\\": \\"2025-04-07T09:57:26+08:00\\",\\n \\"init_version\\": \\"1.32.1-aliyun.1\\",\\n \\"current_version\\": \\"1.32.1-aliyun.1\\",\\n \\"next_version\\": \\"1.xx.x-aliyun.1\\",\\n \\"deletion_protection\\": true,\\n \\"docker_version\\": \\"19.03.5\\",\\n \\"external_loadbalancer_id\\": \\"lb-2zehc05z3b8dwiifh****\\",\\n \\"meta_data\\": \\"\\\\\\\\\\\\\\"Addons\\\\\\\\\\\\\\":***\\",\\n \\"name\\": \\"cluster-demo\\",\\n \\"network_mode\\": \\"vpc\\",\\n \\"region_id\\": \\"cn-beijing\\",\\n \\"resource_group_id\\": \\"rg-acfmyvw3wjm****\\",\\n \\"security_group_id\\": \\"sg-25yq****\\",\\n \\"size\\": 5,\\n \\"state\\": \\"running\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ],\\n \\"updated\\": \\"2025-04-10T13:28:09+08:00\\",\\n \\"vpc_id\\": \\"vpc-2zecuu62b9zw7a7qn****\\",\\n \\"vswitch_id\\": \\"vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****\\",\\n \\"subnet_cidr\\": \\"172.20.xx.xx/16\\",\\n \\"zone_id\\": \\"cn-beijing-a\\",\\n \\"master_url\\": \\"{\\\\\\\\\\\\\\"intranet_api_server_endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://192.168.xx.xx:6443\\\\\\\\\\\\\\"***}\\",\\n \\"private_zone\\": false,\\n \\"profile\\": \\"Default\\",\\n \\"cluster_spec\\": \\"ack.pro.small\\",\\n \\"worker_ram_role_name\\": \\"KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****\\",\\n \\"maintenance_window\\": {\\n \\"enable\\": false,\\n \\"maintenance_time\\": \\"2020-10-15T12:31:00.000+08:00\\",\\n \\"duration\\": \\"3h\\",\\n \\"weekly_period\\": \\"Monday,Thursday\\",\\n \\"recurrence\\": \\"FREQ=WEEKLY;INTERVAL=4;BYDAY=MO,TU\\"\\n },\\n \\"parameters\\": {\\n \\"key\\": \\"\\\\\\"ALIYUN::Region\\\\\\": \\\\\\"cn-qingdao\\\\\\"\\"\\n },\\n \\"container_cidr\\": \\"172.20.xx.xx/16\\",\\n \\"service_cidr\\": \\"172.21.xx.xx/20\\",\\n \\"proxy_mode\\": \\"ipvs\\",\\n \\"timezone\\": \\"Asia/Shanghai\\",\\n \\"node_cidr_mask\\": \\"26\\",\\n \\"ip_stack\\": \\"ipv4\\",\\n \\"cluster_domain\\": \\"cluster.local\\",\\n \\"extra_sans\\": [\\n \\"192.168.xx.xx\\"\\n ],\\n \\"rrsa_config\\": {\\n \\"enabled\\": true,\\n \\"oidc_name\\": \\"ack-rrsa-***\\",\\n \\"oidc_arn\\": \\"acs:ram::1138***:oidc-provider/ack-rrsa-***\\",\\n \\"max_oidc_token_expiration\\": \\"12h\\",\\n \\"audience\\": \\"https://kubernetes.default.svc,https://example.***.com\\",\\n \\"issuer\\": \\"https://oidc-ack-***,https://kubernetes.default.svc\\",\\n \\"open_api_configuration_url\\": \\"https://oidc-ack-***/c12b990***/.well-known/openid-configuration\\",\\n \\"jwks_url\\": \\"https://oidc-ack-***/c12b990***/keys\\"\\n },\\n \\"vswitch_ids\\": [\\n \\"vsw-2zete8s4qocqg0mf6****\\"\\n ],\\n \\"operation_policy\\": {\\n \\"cluster_auto_upgrade\\": {\\n \\"enabled\\": true,\\n \\"channel\\": \\"patch\\"\\n }\\n },\\n \\"control_plane_config\\": {\\n \\"charge_type\\": \\"PrePaid\\",\\n \\"period\\": 1,\\n \\"period_unit\\": \\"Month\\",\\n \\"auto_renew\\": true,\\n \\"auto_renew_period\\": 1,\\n \\"instance_types\\": [\\n \\"ecs.g6.large\\"\\n ],\\n \\"image_type\\": \\"AliyunLinux3\\",\\n \\"image_id\\": \\"aliyun_3_x64_20G_alibase_20240819\\",\\n \\"key_pair\\": \\"ack\\",\\n \\"system_disk_category\\": \\"cloud_essd\\",\\n \\"system_disk_size\\": 120,\\n \\"system_disk_snapshot_policy_id\\": \\"sp-2zej1nogjvovnz4z****\\",\\n \\"system_disk_performance_level\\": \\"PL1\\",\\n \\"system_disk_provisioned_iops\\": 1000,\\n \\"system_disk_bursting_enabled\\": true,\\n \\"deploymentset_id\\": \\"ds-bp10b35imuam5amw****\\",\\n \\"cloud_monitor_flags\\": true,\\n \\"soc_enabled\\": false,\\n \\"security_hardening_os\\": true,\\n \\"cpu_policy\\": \\"none\\",\\n \\"runtime\\": \\"containerd\\",\\n \\"node_port_range\\": \\"30000-32767\\",\\n \\"size\\": 3,\\n \\"instance_metadata_options\\": {\\n \\"http_tokens\\": \\"optional\\"\\n }\\n },\\n \\"auto_mode\\": {\\n \\"enable\\": false\\n },\\n \\"control_plane_endpoints_config\\": {\\n \\"internal_dns_config\\": {\\n \\"bind_vpcs\\": [\\n \\"vpc-xxxxxx\\"\\n ],\\n \\"enabled\\": true\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<cluster_id>c82e6987e2961451182edacd74faf****</cluster_id>\\n<cluster_type>Kubernetes</cluster_type>\\n<created>2019-11-25T15:50:20+08:00</created>\\n<init_version>1.16.6-aliyun.1</init_version>\\n<current_version>1.16.6-aliyun.1</current_version>\\n<next_version>1.18.8-aliyun.1</next_version>\\n<deletion_protection>true</deletion_protection>\\n<docker_version>19.03.5</docker_version>\\n<external_loadbalancer_id>lb-2ze3buguz3gx9920z****</external_loadbalancer_id>\\n<meta_data>\\\\\\"Addons\\\\\\":***</meta_data>\\n<name>cluster-demo</name>\\n<network_mode>vpc</network_mode>\\n<region_id>cn-beijing</region_id>\\n<resource_group_id>rg-acfmyvw3wjm****</resource_group_id>\\n<security_group_id>sg-25yq****</security_group_id>\\n<size>5</size>\\n<state>running</state>\\n<tags>\\n <key>env</key>\\n <value>prod</value>\\n</tags>\\n<updated>2020-01-13T23:01:03+08:00</updated>\\n<vpc_id>vpc-2zecuu62b9zw7a7qn****</vpc_id>\\n<vswitch_id>vsw-2zete8s4qocqg0mf6****,vsw-2zete8s4qocqg0mf6****</vswitch_id>\\n<subnet_cidr>172.20.0.0/16</subnet_cidr>\\n<zone_id>cn-beijing-a</zone_id>\\n<master_url>{\\\\\\"intranet_api_server_endpoint\\\\\\":\\\\\\"https://192.168.0.251:6443\\\\\\"***}</master_url>\\n<private_zone>false</private_zone>\\n<profile>Default</profile>\\n<cluster_spec>ack.pro.small</cluster_spec>\\n<worker_ram_role_name>KubernetesWorkerRole-ec87d15b-edca-4302-933f-c8a16bf0****</worker_ram_role_name>\\n<maintenance_window>\\n <enable>false</enable>\\n <maintenance_time>03:00:00Z</maintenance_time>\\n <duration>3h</duration>\\n <weekly_period>Monday,Thursday</weekly_period>\\n</maintenance_window>","errorExample":""}]', + 'title' => '查询指定集群的信息', + ], + 'DescribeClusterResources' => [ + 'summary' => '您在使用容器服务 Kubernetes 版过程中，会同时使用其他关联的阿里云云产品资源。您可以调用DescribeClusterResources接口查询指定集群的关联资源，例如VPC、SLB等。如果您需要查询节点池或节点资源，您可以调用DescribeClusterNodePools或DescribeClusterNodes接口。', + 'path' => '/clusters/{ClusterId}/resources', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '397', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。'."\n" + ."\n" + .'关于如何查看集群ID，请参见[查看集群信息](~~89446~~)。'."\n" + ."\n" + .'您也可通过API接口[DescribeClustersV1](~~183905~~)，查看阿里云账号下所有创建的集群信息。', + 'type' => 'string', + 'required' => true, + 'example' => 'cb95aa626a47740afbf6aa099b65****', + ], + ], + [ + 'name' => 'with_addon_resources', + 'in' => 'query', + 'schema' => [ + 'title' => '是否同时查询集群组件创建的资源。', + 'description' => '是否同时查询集群组件创建的资源。'."\n" + ."\n" + .'- true：查询。'."\n" + ."\n" + .'- false：不查询。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '资源对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源详情。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cb95aa626a47740afbf6aa099b65****', + ], + 'created' => [ + 'title' => '资源创建时间。', + 'description' => '资源创建时间。', + 'type' => 'string', + 'example' => '2023-08-15T14:34:42+08:00', + ], + 'instance_id' => [ + 'title' => '资源实例ID。', + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'ngw-wz9sphwk42sdtjixo****', + ], + 'resource_info' => [ + 'title' => '资源元信息。', + 'description' => '资源信息。关于资源的源信息，请参见[ListStackResources](~~133836~~)。', + 'type' => 'string', + 'example' => '{\\"Id\\":\\"KubernetesWorkerRole\\",\\"Name\\":\\"KubernetesWorkerRole\\",\\"Type\\":\\"ALIYUN::RAM::Role\\",\\"Status\\":\\"CREATE_COMPLETE\\",\\"StatusReason\\":\\"state changed\\",\\"Updated\\":\\"2025-04-10T06:21:17\\",\\"PhysicalId\\":\\"KubernetesWorkerRole-7e611193-225f-40f6-bc3c-ea8633******\\"}', + ], + 'resource_type' => [ + 'title' => '资源类型。', + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'ALIYUN::VPC::NatGateway', + ], + 'state' => [ + 'title' => '资源状态。', + 'description' => '资源状态。可选值：'."\n" + ."\n" + .'- `CREATE_COMPLETE`：成功创建资源。'."\n" + .'- `CREATE_FAILED`：创建资源失败。'."\n" + .'- `CREATE_IN_PROGRESS`：创建资源中。'."\n" + .'- `DELETE_FAILED`：删除资源失败。'."\n" + .'- `DELETE_IN_PROGRESS`：删除资源中。'."\n" + .'- `ROLLBACK_COMPLETE`：成功回滚。'."\n" + .'- `ROLLBACK_FAILED`：回滚失败。'."\n" + .'- `ROLLBACK_IN_PROGRESS`：回滚中。', + 'type' => 'string', + 'example' => 'CREATE_COMPLETE', + ], + 'auto_create' => [ + 'title' => '是否为自动创建。', + 'description' => '资源是否由ACK创建：'."\n" + ."\n" + .'- 1：表示由ACK创建。'."\n" + .'- 0：表示该资源为已有资源。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'dependencies' => [ + 'title' => '依赖的资源。', + 'description' => '依赖资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '依赖资源详情。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '依赖资源的集群ID。', + 'description' => '依赖资源的集群ID。', + 'type' => 'string', + 'example' => 'cc5ee03f63e43425cb6f71f1a1756****', + ], + 'resource_type' => [ + 'title' => '依赖资源类型。', + 'description' => '依赖资源类型。', + 'type' => 'string', + 'example' => 'ALIYUN::VPC::NatGateway', + ], + 'instance_id' => [ + 'title' => '依赖资源实例ID。', + 'description' => '依赖资源实例ID。', + 'type' => 'string', + 'example' => 'ngw-wz9sphwk42sdtjixo****', + ], + ], + ], + ], + 'associated_object' => [ + 'title' => '资源关联的k8s对象。', + 'description' => '资源关联的k8s对象。', + 'type' => 'object', + 'properties' => [ + 'kind' => [ + 'title' => 'k8s对象类型。', + 'description' => 'k8s对象类型。', + 'type' => 'string', + 'example' => 'Service', + ], + 'namespace' => [ + 'title' => 'k8s对象命名空间。', + 'description' => 'k8s对象命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + 'name' => [ + 'title' => 'k8s对象名称。', + 'description' => 'k8s对象名称。', + 'type' => 'string', + 'example' => 'nginx-ingress-lb', + ], + ], + ], + 'delete_behavior' => [ + 'title' => '删除集群时该资源的删除行为。', + 'description' => '删除集群时该资源的删除行为。', + 'type' => 'object', + 'properties' => [ + 'delete_by_default' => [ + 'title' => '删除集群时是否默认删除该资源。', + 'description' => '删除集群时是否默认删除该资源。'."\n" + ."\n" + .'- true：默认删除该资源。'."\n" + ."\n" + .'- fasle：不删除该资源。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'changeable' => [ + 'title' => 'delete_by_default中返回的默认行为是否可以更改。', + 'description' => '`delete_by_default`的默认行为是否可以更改。'."\n" + ."\n" + .'- true：可以更改。'."\n" + ."\n" + .'- false：不支持更改。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'creator_type' => [ + 'title' => '该资源创建者的类型。可能的取值：'."\n" + .'- user：由用户自行创建；'."\n" + .'- system：由ACK管控系统创建；'."\n" + .'- addon：由集群组件创建。', + 'description' => '该资源创建者的类型。可能的取值：'."\n" + .'- user：由用户自行创建；'."\n" + .'- system：由ACK管控系统创建；'."\n" + .'- addon：由集群组件创建。', + 'type' => 'string', + 'example' => 'addon', + 'enum' => [ + 'user', + 'system', + 'addon', + ], + ], + 'extra_info' => [ + 'title' => '资源的其他信息。', + 'description' => '资源的其他信息。', + 'type' => 'object', + 'example' => ' { "type": "SLS_Data" }', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"cluster_id\\": \\"cb95aa626a47740afbf6aa099b65****\\",\\n \\"created\\": \\"2023-08-15T14:34:42+08:00\\",\\n \\"instance_id\\": \\"ngw-wz9sphwk42sdtjixo****\\",\\n \\"resource_info\\": \\"{\\\\\\\\\\\\\\"Id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"KubernetesWorkerRole\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"KubernetesWorkerRole\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ALIYUN::RAM::Role\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"CREATE_COMPLETE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"StatusReason\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"state changed\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Updated\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2025-04-10T06:21:17\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"PhysicalId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"KubernetesWorkerRole-7e611193-225f-40f6-bc3c-ea8633******\\\\\\\\\\\\\\"}\\",\\n \\"resource_type\\": \\"ALIYUN::VPC::NatGateway\\",\\n \\"state\\": \\"CREATE_COMPLETE\\",\\n \\"auto_create\\": 1,\\n \\"dependencies\\": [\\n {\\n \\"cluster_id\\": \\"cc5ee03f63e43425cb6f71f1a1756****\\",\\n \\"resource_type\\": \\"ALIYUN::VPC::NatGateway\\",\\n \\"instance_id\\": \\"ngw-wz9sphwk42sdtjixo****\\"\\n }\\n ],\\n \\"associated_object\\": {\\n \\"kind\\": \\"Service\\",\\n \\"namespace\\": \\"kube-system\\",\\n \\"name\\": \\"nginx-ingress-lb\\"\\n },\\n \\"delete_behavior\\": {\\n \\"delete_by_default\\": false,\\n \\"changeable\\": false\\n },\\n \\"creator_type\\": \\"addon\\",\\n \\"extra_info\\": {\\n \\"type\\": \\"SLS_Data\\"\\n }\\n }\\n]","errorExample":""},{"type":"xml","example":"<DescribeClusterResourcesResponse>\\n <cluster_id>cb95aa626a47740afbf6aa099b65****</cluster_id>\\n <created>2023-08-15T14:34:42+08:00</created>\\n <instance_id>ngw-wz9sphwk42sdtjixo****</instance_id>\\n <resource_info>{\\\\\\"Id\\\\\\":\\\\\\"k8s_NAT_Gateway\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"k8s_NAT_Gateway\\\\\\",\\\\\\"Type\\\\\\":\\\\\\"ALIYUN::VPC::NatGateway\\\\\\",\\\\\\"Status\\\\\\":\\\\\\"CREATE_COMPLETE\\\\\\",\\\\\\"StatusReason\\\\\\":\\\\\\"state changed\\\\\\",\\\\\\"Updated\\\\\\":\\\\\\"2023-08-15T06:33:10\\\\\\",\\\\\\"PhysicalId\\\\\\":\\\\\\"ngw-wz9sphwk42sdtjixo****\\\\\\"}</resource_info>\\n <resource_type>ALIYUN::VPC::NatGateway</resource_type>\\n <state>CREATE_COMPLETE</state>\\n <auto_create>1</auto_create>\\n <dependencies>\\n <cluster_id>cc5ee03f63e43425cb6f71f1a1756****</cluster_id>\\n <resource_type>ALIYUN::VPC::NatGateway</resource_type>\\n <instance_id>ngw-wz9sphwk42sdtjixo****</instance_id>\\n </dependencies>\\n</DescribeClusterResourcesResponse>","errorExample":""}]', + 'title' => '查询指定集群的关联资源', + ], + 'DescribeKubernetesVersionMetadata' => [ + 'summary' => '您可以调用DescribeKubernetesVersionMetadata接口查询Kubernetes版本的详细信息，包括Kubernetes版本信息、版本的发布日期和过期时间、兼容的操作系统，使用的运行时等。', + 'path' => '/api/v1/metadata/versions', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '526', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID。', + 'description' => '集群所在地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'title' => '集群类型。', + 'description' => '集群类型，取值：'."\n" + ."\n" + .'- `Kubernetes`: ACK专有版集群。'."\n" + .'- `ManagedKubernetes`：ACK托管版集群，包括ACK Pro版集群、ACK基础版集群、ACK Serverless Pro版集群、ACK Serverless基础版集群、ACK Edge Pro版集群、ACK Edge基础版。', + 'type' => 'string', + 'required' => true, + 'example' => 'Kubernetes', + ], + ], + [ + 'name' => 'KubernetesVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '要查询的版本，如果为空则查所有版本。', + 'description' => '集群版本，与Kubernetes社区基线版本保持一致。建议选择最新版本，若不指定，默认使用最新版本。'."\n" + ."\n" + .'ACK支持的Kubernetes版本，请参见[Kubernetes版本发布概览](~~185269~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1.32.1-aliyun.1', + ], + ], + [ + 'name' => 'Profile', + 'in' => 'query', + 'schema' => [ + 'title' => '边缘集群标识，用于区分边缘集群，取值：Default或Edge。', + 'description' => '面向场景时的集群类型，取值：'."\n" + ."\n" + .'- `Default`：非边缘场景集群。'."\n" + .'- `Edge`：边缘场景集群。'."\n" + .'- `Serverless`：ASK集群。'."\n" + ."\n" + .'默认值：`Default`。', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'runtime', + 'in' => 'query', + 'schema' => [ + 'title' => '运行时。', + 'description' => '运行时类型，可以通过指定运行时类型，过滤出运行时所支持的系统镜像，取值：'."\n" + ."\n" + .'- `docker`：docker运行时。'."\n" + .'- `containerd`：containerd运行时。'."\n" + .'- `Sandboxed-Container.runv`：安全沙箱。'."\n" + ."\n" + .'若指定运行时类型，将返回指定运行时支持的镜像版本。'."\n" + ."\n" + .'若不指定运行时类型，默认返回全部镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'containerd', + ], + ], + [ + 'name' => 'Mode', + 'in' => 'query', + 'schema' => [ + 'title' => '查询模式，取值：supported、creatable', + 'description' => '查询模式，取值：'."\n" + .'- `supported`：查询受支持版本。'."\n" + .'- `creatable`：查询可创建版本。'."\n" + ."\n" + .'若指定`KubernetesVersion`，将忽略查询模式。'."\n" + ."\n" + .'若不指定查询模式，默认返回可创建版本。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'supported', + 'default' => 'creatable', + 'enum' => [], + ], + ], + [ + 'name' => 'QueryUpgradableVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '是否查询该集群版本的可升级版本，仅在指定KubernetesVersion参数时生效。', + 'description' => '是否查询该集群版本的可升级版本，仅在指定KubernetesVersion参数时生效。'."\n" + ."\n" + .'- true：查询可升级版本。'."\n" + ."\n" + .'- false：不查询可升级版本。', + 'type' => 'boolean', + 'required' => false, + 'example' => '1.30.1-aliyun.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。 ', + 'description' => '集群版本详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '版本详情。', + 'type' => 'object', + 'properties' => [ + 'capabilities' => [ + 'title' => 'Kubernetes版本特性。 ', + 'description' => 'Kubernetes版本功能特性。', + 'type' => 'object', + 'example' => '{'."\n" + .' "AnyAZ": true,'."\n" + .' "ChargeType": "PostPaid"'."\n" + .'}', + ], + 'images' => [ + 'title' => 'ECS系统镜像列表。 ', + 'description' => '系统镜像列表。 ', + 'type' => 'array', + 'items' => [ + 'description' => '镜像详情。', + 'type' => 'object', + 'properties' => [ + 'image_id' => [ + 'title' => '镜像ID。 ', + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'aliyun_3_x64_20G_alibase_20241218.vhd', + ], + 'image_name' => [ + 'title' => '镜像名称。 ', + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'Alibaba Cloud Linux 3.2104', + ], + 'platform' => [ + 'title' => '操作系统发行版。取值范围： CentOS,AliyunLinux,Windows,WindowsCore。', + 'description' => '操作系统平台。取值：'."\n" + .'- `AliyunLinux`'."\n" + .'- `CentOS`'."\n" + .'- `Windows`'."\n" + .'- `WindowsCore`', + 'type' => 'string', + 'example' => 'AliyunLinux', + ], + 'os_version' => [ + 'title' => '镜像版本。', + 'description' => '镜像版本。', + 'type' => 'string', + 'example' => '3.2104', + ], + 'image_type' => [ + 'title' => '镜像类型。 ', + 'description' => '操作系统发行版类型，推荐使用该字段指定节点操作系统。取值：'."\n" + ."\n" + .'- `CentOS`'."\n" + .'- `AliyunLinux`'."\n" + .'- `AliyunLinux Qboot`'."\n" + .'- `AliyunLinuxUEFI`'."\n" + .'- `AliyunLinux3`'."\n" + .'- `Windows`'."\n" + .'- `WindowsCore`'."\n" + .'- `AliyunLinux3Arm64`'."\n" + .'- `ContainerOS`', + 'type' => 'string', + 'example' => 'AliyunLinux3', + ], + 'os_type' => [ + 'title' => '操作系统发行版本号。', + 'description' => '操作系统类型，例如：'."\n" + ."\n" + .'- `Windows`'."\n" + .'- `Linux`', + 'type' => 'string', + 'example' => 'Linux', + ], + 'image_category' => [ + 'title' => '镜像分类', + 'description' => '镜像分类，部分取值：'."\n" + ."\n" + .'- `system`：公共镜像。'."\n" + .'- `self`：您的自定义镜像。'."\n" + .'- `others`：其他用户的公开镜像。'."\n" + .'- `marketplace`：镜像市场镜像。'."\n", + 'type' => 'string', + 'example' => 'system', + ], + 'architecture' => [ + 'title' => '镜像架构', + 'description' => '镜像架构。', + 'type' => 'string', + 'example' => 'x86_64', + ], + ], + ], + ], + 'meta_data' => [ + 'title' => 'Kubernetes版本元数据信息。 ', + 'description' => 'Kubernetes版本元数据信息。 ', + 'type' => 'object', + 'example' => '{'."\n" + .' "KubernetesVersion": "1.31.1-aliyun.1",'."\n" + .' "SubClass": "default",'."\n" + .' "ServiceCIDR": ""'."\n" + .'}', + ], + 'runtimes' => [ + 'title' => '容器运行时详情。 ', + 'description' => '容器运行时配置。 ', + 'type' => 'array', + 'items' => [ + 'description' => '容器运行时配置。 ', + '$ref' => '#/components/schemas/runtime', + ], + ], + 'version' => [ + 'title' => 'Kubernetes版本。 ', + 'description' => 'ACK发布的Kubernetes版本。更多版本信息，请参见[Kubernetes版本发布概览](~~185269~~)。', + 'type' => 'string', + 'example' => '1.31.1-aliyun.1', + ], + 'release_date' => [ + 'title' => 'Kubernetes版本发布时间。', + 'description' => 'Kubernetes版本发布时间。', + 'type' => 'string', + 'example' => '2025-01-30T00:00:00Z', + ], + 'expiration_date' => [ + 'title' => 'Kubernetes版本过期时间。 ', + 'description' => 'Kubernetes版本过期时间。 ', + 'type' => 'string', + 'example' => '2026-01-30T00:00:00Z', + ], + 'creatable' => [ + 'title' => '该版本是否可创建。', + 'description' => 'Kubernetes版本是否可创建。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'upgradable_versions' => [ + 'title' => '可升级的版本列表。', + 'description' => '可升级的版本列表。', + 'type' => 'array', + 'items' => [ + 'title' => '可升级的版本。', + 'description' => '可升级的版本。', + 'type' => 'string', + 'example' => '1.32.1-aliyun.1', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"capabilities\\": {\\n \\"AnyAZ\\": true,\\n \\"ChargeType\\": \\"PostPaid\\"\\n },\\n \\"images\\": [\\n {\\n \\"image_id\\": \\"aliyun_3_x64_20G_alibase_20241218.vhd\\",\\n \\"image_name\\": \\"Alibaba Cloud Linux 3.2104\\",\\n \\"platform\\": \\"AliyunLinux\\",\\n \\"os_version\\": \\"3.2104\\",\\n \\"image_type\\": \\"AliyunLinux3\\",\\n \\"os_type\\": \\"Linux\\",\\n \\"image_category\\": \\"system\\",\\n \\"architecture\\": \\"x86_64\\"\\n }\\n ],\\n \\"meta_data\\": {\\n \\"KubernetesVersion\\": \\"1.31.1-aliyun.1\\",\\n \\"SubClass\\": \\"default\\",\\n \\"ServiceCIDR\\": \\"\\"\\n },\\n \\"runtimes\\": [\\n {\\n \\"name\\": \\"docker\\",\\n \\"version\\": \\"19.03.5\\"\\n }\\n ],\\n \\"version\\": \\"1.31.1-aliyun.1\\",\\n \\"release_date\\": \\"2025-01-30T00:00:00Z\\",\\n \\"expiration_date\\": \\"2026-01-30T00:00:00Z\\",\\n \\"creatable\\": true,\\n \\"upgradable_versions\\": [\\n \\"1.32.1-aliyun.1\\"\\n ]\\n }\\n]","errorExample":""},{"type":"xml","example":"<DescribeKubernetesVersionMetadataResponse>\\n <images>\\n <image_id>centos_7_9_x64_20G_alibase_20221129.vhd</image_id>\\n <image_name>CentOS 7.9</image_name>\\n <platform>CentOS</platform>\\n <os_version>7.9</os_version>\\n <image_type>CentOS</image_type>\\n <os_type>Linux</os_type>\\n <image_category/>\\n <architecture>x86_64</architecture>\\n </images>\\n <runtimes>\\n <name>containerd</name>\\n <version>1.6.20</version>\\n </runtimes>\\n <version>1.26.3-aliyun.1</version>\\n <release_date>2023-04-30T00:00:00Z</release_date>\\n <expiration_date>2025-04-30T00:00:00Z</expiration_date>\\n <creatable>true</creatable>\\n</DescribeKubernetesVersionMetadataResponse>","errorExample":""}]', + 'title' => '查询Kubernetes版本的详细详情', + ], + 'DescribeUserClusterNamespaces' => [ + 'summary' => '在ACK集群中，可以通过Kubernetes命名空间对集群访问者进行权限和资源的逻辑隔离，只被授予指定命名空间下RBAC权限的用户将无法访问集群其他命名空间内的资源。您可以调用DescribeUserClusterNamespaces接口，查看当前RAM用户或角色在指定的ACK集群内被授予了哪些命名空间内资源的RBAC访问权限。', + 'path' => '/api/v2/k8s/{ClusterId}/namespaces', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '指定的集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '当前用户有权限访问的命名空间列表', + 'description' => 'RAM用户有权限访问的命名空间名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'RAM用户可见的集群命名空间名称列表。', + 'type' => 'string', + 'example' => '[ "default", "kube-node-lease", "kube-public", "kube-system" ]', + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"[\\n \\"[ \\\\\\"default\\\\\\", \\\\\\"kube-node-lease\\\\\\", \\\\\\"kube-public\\\\\\", \\\\\\"kube-system\\\\\\" ]\\"\\n]","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询RAM用户或角色可见的集群命名空间', + ], + 'DescribeClusterLogs' => [ + 'summary' => '您可以调用DescribeClusterLogs接口检索集群的日志数据，以便在出现集群问题时进行根因分析和溯源。', + 'path' => '/clusters/{ClusterId}/logs', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsk0H96CV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c106f377e16f34eb1808d6b9362c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '日志列表。', + 'type' => 'array', + 'items' => [ + 'description' => '日志详情。', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'title' => '日志ID。', + 'description' => '日志ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '73117232145******', + ], + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c23421cfa74454bc8b37163fd19af***', + ], + 'cluster_log' => [ + 'title' => '日志内容。', + 'description' => '日志内容。', + 'type' => 'string', + 'example' => 'start to update cluster status to CREATE_COMPLETE', + ], + 'created' => [ + 'title' => '日志创建时间。', + 'description' => '日志产生时间。', + 'type' => 'string', + 'example' => '2025-04-10T17:54:26+08:00', + ], + 'updated' => [ + 'title' => '日志更新时间。', + 'description' => '日志更新时间。', + 'type' => 'string', + 'example' => '2025-04-10T17:54:26+08:00', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"ID\\": 0,\\n \\"cluster_id\\": \\"c23421cfa74454bc8b37163fd19af***\\",\\n \\"cluster_log\\": \\"start to update cluster status to CREATE_COMPLETE\\",\\n \\"created\\": \\"2025-04-10T17:54:26+08:00\\",\\n \\"updated\\": \\"2025-04-10T17:54:26+08:00\\"\\n }\\n]","errorExample":""},{"type":"xml","example":"<DescribeClusterLogsResponse>\\n <ID>590749245</ID>\\n <cluster_id>c23421cfa74454bc8b37163fd19af***</cluster_id>\\n <cluster_log>start to update cluster status to CREATE_COMPLETE</cluster_log>\\n <created>2020-09-11T10:11:51+08:00</created>\\n <updated>2020-09-11T10:11:51+08:00</updated>\\n</DescribeClusterLogsResponse>","errorExample":""}]', + 'title' => '查询集群日志', + ], + 'DescribeUserQuota' => [ + 'summary' => '您可以调用DescribeUserQuota接口，查询ACK集群、节点池、节点的相关配额。如需扩大配额，请前往配额中心申请。', + 'path' => '/quota', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'amk_cluster_quota' => [ + 'title' => '托管版集群配额。', + 'description' => '托管版集群配额。默认为20。如果超过默认值，需[到配额平台提交申请](https://quotas.console.aliyun.com/products/csk/quotas)扩容。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ask_cluster_quota' => [ + 'title' => 'Serverless集群配额。', + 'description' => 'ASK集群配额，默认为20。如果超过默认值，需[到配额平台提交申请](https://quotas.console.aliyun.com/products/csk/quotas)扩容。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'cluster_nodepool_quota' => [ + 'title' => '集群节点池配额。', + 'description' => '单集群节点池配额，默认值为20。如果超过默认值，需[到配额平台提交申请](https://quotas.console.aliyun.com/products/csk/quotas)扩容', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'cluster_quota' => [ + 'title' => '专有版集群托管版集群的总配额。', + 'description' => '单账户总集群配额，默认为50。如果超过默认值，需[到配额平台提交申请](https://quotas.console.aliyun.com/products/csk/quotas)扩容。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'node_quota' => [ + 'title' => '单集群的节点配额。', + 'description' => '单集群节点数配额，默认为100。如果超过默认值，需[到配额平台提交申请](https://quotas.console.aliyun.com/products/csk/quotas)扩容。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'quotas' => [ + 'description' => '新配额项，如存在该字段，则以该字段为准。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'quota' => [ + 'type' => 'string', + 'example' => '1', + 'description' => '配额值，如果超过配额，需到[配额平台](https://quotas.console.aliyun.com/products/csk/quotas)提交申请扩容。', + ], + 'operation_code' => [ + 'type' => 'string', + 'description' => '配额码。', + 'example' => 'q_Kubernetes_Cluster', + ], + 'adjustable' => [ + 'type' => 'boolean', + 'description' => '是否可调整。', + 'example' => 'true', + ], + 'unit' => [ + 'type' => 'string', + 'example' => 'Cluster', + 'description' => '单位。', + ], + ], + 'description' => '配额项。', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"amk_cluster_quota\\": 20,\\n \\"ask_cluster_quota\\": 3,\\n \\"cluster_nodepool_quota\\": 10,\\n \\"cluster_quota\\": 50,\\n \\"node_quota\\": 100,\\n \\"edge_improved_nodepool_quota\\": {\\n \\"bandwidth\\": 10,\\n \\"count\\": 3,\\n \\"period\\": 3\\n },\\n \\"quotas\\": {\\n \\"key\\": {\\n \\"quota\\": \\"1\\",\\n \\"operation_code\\": \\"q_Kubernetes_Cluster\\",\\n \\"adjustable\\": true,\\n \\"unit\\": \\"Cluster\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeUserQuotaResponse>\\n <amk_cluster_quota>20</amk_cluster_quota>\\n <ask_cluster_quota>3</ask_cluster_quota>\\n <cluster_nodepool_quota>10</cluster_nodepool_quota>\\n <cluster_quota>50</cluster_quota>\\n <node_quota>100</node_quota>\\n <edge_improved_nodepool_quota>\\n <bandwidth>10</bandwidth>\\n <count>3</count>\\n <period>3</period>\\n </edge_improved_nodepool_quota>\\n <quotas>\\n <key>\\n <quota>1</quota>\\n <operation_code>q_Kubernetes_Cluster</operation_code>\\n <adjustable>true</adjustable>\\n <unit>Cluster</unit>\\n </key>\\n </quotas>\\n</DescribeUserQuotaResponse>","errorExample":""}]', + 'title' => '查询集群配额', + ], + 'MigrateCluster' => [ + 'summary' => 'ACK集群Pro版是在ACK集群基础版的基础上发展而来的集群类型，继承了原托管版集群的所有优势，例如控制面托管、控制面高可用等。同时，ACK集群Pro版进一步增强了集群的可靠性、安全性和调度性，并且支持赔付标准的SLA，适合生产环境下有着大规模业务，对稳定性和安全性有高要求的企业客户。您可以调用MigrateCluster接口将ACK集群基础版迁移至ACK集群Pro版。', + 'path' => '/clusters/{cluster_id}/migrate', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c21e0591548ba4c10bdb535d6572b****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体。', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'oss_bucket_name' => [ + 'title' => 'bucket名称。', + 'description' => 'Bucket名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'bucket-****', + ], + 'oss_bucket_endpoint' => [ + 'title' => 'bucket访问端点。', + 'description' => 'Bucket访问端点。', + 'type' => 'string', + 'required' => false, + 'example' => '*******.oss-cn-hangzhou.aliyuncs.com', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应体', + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c21e0591548ba4c10bdb535d657******', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E43******', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-62ccd14aacb8db06ca******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"cluster_id\\": \\"c21e0591548ba4c10bdb535d657******\\",\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E43******\\",\\n \\"task_id\\": \\"T-62ccd14aacb8db06ca******\\"\\n}","errorExample":""},{"type":"xml","example":"<MigrateClusterResponse>\\n <cluster_id>c8155823d057948c69a****</cluster_id>\\n <request_id>20758A-585D-4A41-A9B2-28DA8F4F534F</request_id>\\n <task_id>T-62ccd14aacb8db06ca00****</task_id>\\n</MigrateClusterResponse>","errorExample":""}]', + 'title' => '迁移基础版集群至Pro版', + 'description' => 'ACK托管集群基础版迁移至ACK托管集群Pro版后，将新增[集群管理费用](~~462278~~)（由ACK收取），其他云资源计费保持不变。', + ], + 'DescribeClusterUserKubeconfig' => [ + 'summary' => 'KubeConfig用于在客户端配置ACK集群的访问凭据，包含访问目标集群的身份和认证数据等信息。使用kubectl管理集群时，需要先通过KubeConfig来连接集群，您可以调用DescribeClusterUserKubeconfig接口查询指定集群的KubeConfig。', + 'path' => '/k8s/{ClusterId}/user_config', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '396', + 'abilityTreeNodes' => [ + 'FEATUREcsk7DKI2D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => [ + 'title' => 'ApiServer是否为内网地址。', + 'description' => '是否获取内网连接配置。取值：'."\n" + .'- `true`：仅获取内网连接凭据。'."\n" + .'- `false`：仅获取公网连接凭据。 '."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TemporaryDurationMinutes', + 'in' => 'query', + 'schema' => [ + 'title' => '临时kubeconfig有效期，单位：分钟。 最小值：15（15分钟） 最大值：4320（3天）。', + 'description' => '临时KubeConfig有效期，单位：分钟。取值范围：15（15分钟）～4320（3天）。'."\n" + .'>当不设置该参数时，将由系统自动确定一个更长的有效期，具体过期时间通过返回的`expiration`字段的值确定。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '15', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'config' => [ + 'title' => 'kubeconfig内容。', + 'description' => '集群的KubeConfig。', + 'type' => 'string', + 'example' => 'apiVersion: v1\\nclusters:\\n- cluster:\\n server: https://114.55.xx.xx:6443\\n certificate-authority-data: LS0tLS****', + ], + 'expiration' => [ + 'title' => 'kubeconfig过期时间。格式：RFC3339 格式的 UTC 时间。', + 'description' => 'KubeConfig的过期时间。格式：RFC3339格式的UTC时间。', + 'type' => 'string', + 'example' => '2024-03-10T09:56:17Z', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"config\\": \\"apiVersion: v1\\\\\\\\nclusters:\\\\\\\\n- cluster:\\\\\\\\n server: https://114.55.xx.xx:6443\\\\\\\\n certificate-authority-data: LS0tLS****\\",\\n \\"expiration\\": \\"2024-03-10T09:56:17Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterUserKubeconfigResponse>\\n <config>apiVersion: v1****</config>\\n <expiration>2024-03-10T09:56:17Z</expiration>\\n</DescribeClusterUserKubeconfigResponse>","errorExample":""}]', + 'title' => '查询集群KubeConfig', + 'description' => '- KubeConfig签发证书的默认有效期为3年。在临近过期180天内，您可以通过容器服务管理控制台或获取集群KubeConfig接口获取轮转后刷新的KubeConfig，新KubeConfig证书的有效期仍为3年，老的KubeConfig凭据在证书过期前仍然有效，请您根据控制台显示或接口返回的KubeConfig过期时间及时获取轮转凭据。'."\n" + ."\n" + .'- 请妥善管理集群的KubeConfig凭据，并在无需使用凭据时及时完成吊销，避免KubeConfig泄露带来的数据泄露等安全风险。', + ], + 'DescribeSubaccountK8sClusterUserConfig' => [ + 'summary' => '作为集群权限管理者，您可以使用阿里云账号（主账号）为账号内指定RAM用户或RAM角色签发包含其身份信息的KubeConfig凭证，用于连接ACK集群。您可以调用DescribeSubaccountK8sClusterUserConfig接口，签发或获取账号内任意RAM用户或角色的KubeConfig。', + 'path' => '/k8s/{ClusterId}/users/{Uid}/user_config', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '162217', + 'abilityTreeNodes' => [ + 'FEATUREcsk7DKI2D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8f****', + ], + ], + [ + 'name' => 'Uid', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云账号内指定的RAM用户或RAM角色ID。', + 'type' => 'string', + 'required' => true, + 'example' => '26562443851650****', + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '是否获取内网连接配置。取值：'."\n" + .'- `true`：仅获取内网连接的KubeConfig凭证。'."\n" + .'- `false`：仅获取公网连接的KubeConfig凭证。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'TemporaryDurationMinutes', + 'in' => 'query', + 'schema' => [ + 'description' => '临时KubeConfig有效期，单位：分钟。'."\n" + ."\n" + .'取值范围：[15, 4320]，即最长3天。'."\n" + .'> 当不设置该参数时，将由系统自动确定一个更长的有效期，具体过期时间通过返回的expiration字段的值确定。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '15', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'config' => [ + 'description' => '集群的KubeConfig。', + 'type' => 'string', + 'required' => true, + 'example' => 'apiVersion: v1\\nclusters:\\n- cluster:\\n server: https://114.55.xx.xx:6443\\n certificate-authority-data: LS0tLS****', + ], + 'expiration' => [ + 'description' => 'KubeConfig的过期时间。格式：RFC3339格式的UTC时间。', + 'type' => 'string', + 'example' => '2028-04-09T06:20:47Z', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"config\\": \\"apiVersion: v1\\\\\\\\nclusters:\\\\\\\\n- cluster:\\\\\\\\n server: https://114.55.xx.xx:6443\\\\\\\\n certificate-authority-data: LS0tLS****\\",\\n \\"expiration\\": \\"2028-04-09T06:20:47Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeSubaccountK8sClusterUserConfigResponse>\\n <config>apiVersion: v1****</config>\\n <expiration>2024-03-10T09:56:17Z</expiration>\\n</DescribeSubaccountK8sClusterUserConfigResponse>","errorExample":""}]', + 'title' => '使用阿里云账号获取指定RAM用户或角色的集群KubeConfig', + 'description' => '该接口只允许被阿里云账号（主账号）调用。', + ], + 'ListUserKubeConfigStates' => [ + 'summary' => '如果您需要查看当前用户各个集群KubeConfig的下发情况，您可以调用ListUserKubeConfigStates接口来获取当前用户所有集群的KubeConfig状态列表。', + 'path' => '/users/{Uid}/kubeconfig/states', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '203488', + 'abilityTreeNodes' => [ + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云账号内指定RAM用户或RAM角色ID。', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'206945240368******', + ], + ], + [ + 'name' => 'page_number', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页数。'."\n" + ."\n" + .'- 取值范围：大于等于1。'."\n" + ."\n" + .'- 默认值：1。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'page_size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回的结果数。'."\n" + ."\n" + .'- 取值范围：1-100。'."\n" + ."\n" + .'- 默认值：50。', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => false, + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'states' => [ + 'description' => '用户KubeConfig状态详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****'."\n", + ], + 'cert_expire_time' => [ + 'description' => 'KubeConfig证书过期时间。格式：RFC3339格式的UTC时间。', + 'type' => 'string', + 'example' => '2028-04-09T06:20:47Z', + ], + 'cert_state' => [ + 'description' => 'KubeConfig证书当前状态。'."\n" + .'包含以下状态：'."\n" + ."\n" + .'- Expired: 证书已过期'."\n" + .'- Unexpired: 证书未过期'."\n" + .'- Unissued: 证书未颁发'."\n" + .'- Unknown: 未知状态'."\n" + ."\n" + .'- Removed: 已清除（证书存在颁发记录）', + 'type' => 'string', + 'example' => 'Unissued', + ], + 'cluster_state' => [ + 'description' => '集群运行状态，取值：'."\n" + ."\n" + .'- `initial`：集群创建中。'."\n" + .'- `failed`：集群创建失败。'."\n" + .'- `running`：集群运行中。'."\n" + .'- `updating`：集群升级中。'."\n" + .'- `updating_failed`：集群升级失败。'."\n" + .'- `scaling`：集群扩缩容中。'."\n" + .'- `stopped`：集群已经停止运行。'."\n" + .'- `deleting`：集群删除中。'."\n" + .'- `deleted`：集群已经被删除。'."\n" + .'- `delete_failed`：集群删除失败。', + 'type' => 'string', + 'example' => 'running', + ], + 'cluster_name' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'cluster-demo', + ], + ], + ], + ], + 'page' => [ + 'description' => '分页参数。', + 'type' => 'object', + 'properties' => [ + 'page_number' => [ + 'description' => '当前页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'page_size' => [ + 'description' => '每页返回的记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'total_count' => [ + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"states\\": [\\n {\\n \\"cluster_id\\": \\"c5b5e80b0b64a4bf6939d2d8fbbc5****\\\\n\\",\\n \\"cert_expire_time\\": \\"2028-04-09T06:20:47Z\\",\\n \\"cert_state\\": \\"Unissued\\",\\n \\"cluster_state\\": \\"running\\",\\n \\"cluster_name\\": \\"cluster-demo\\"\\n }\\n ],\\n \\"page\\": {\\n \\"page_number\\": 1,\\n \\"page_size\\": 10,\\n \\"total_count\\": 100\\n }\\n}","type":"json"}]', + 'title' => '获取指定用户所有集群的 KubeConfig 状态列表', + 'description' => '> 使用该接口需要拥有管理容器服务（CS）的权限（AliyunCSFullAccess）', + ], + 'ListClusterKubeconfigStates' => [ + 'summary' => '如果您需要查看当前集群的访问控制情况，您可以调用ListClusterKubeconfigStates接口来获取当前集群已下发用户KubeConfig的列表以及状态。', + 'path' => '/clusters/{ClusterId}/kubeconfig/states', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200813', + 'abilityTreeNodes' => [ + 'FEATUREcsk01W1JN', + 'FEATUREcskD83BWV', + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。'."\n" + ."\n" + .'- 取值范围：大于等于1'."\n" + ."\n" + .'- 默认值：1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录数。'."\n" + .'- 取值范围：1-50'."\n" + ."\n" + .'- 默认值：10', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'cloudServiceKubeConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '是否查询集群内云产品服务角色 KubeConfig 列表'."\n" + ."\n" + .'- true: 查询集群内云产品服务角色 KubeConfig 列表'."\n" + .'- false: 查询集群内RAM用户/角色 KubeConfig 列表', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体参数。', + 'type' => 'object', + 'properties' => [ + 'states' => [ + 'description' => '集群关联的KubeConfig状态列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'account_id' => [ + 'title' => '账号ID', + 'description' => '阿里云账号、RAM用户或角色ID。', + 'type' => 'string', + 'example' => '22855*****************', + ], + 'account_name' => [ + 'title' => '账号名称', + 'description' => 'RAM用户登录名称或角色名称。', + 'type' => 'string', + 'example' => 'tom', + ], + 'account_display_name' => [ + 'title' => '账号显示名称', + 'description' => 'RAM用户显示名称或角色名称。', + 'type' => 'string', + 'example' => 'tom', + ], + 'account_type' => [ + 'title' => '账号类型', + 'description' => '账号类型。'."\n" + ."\n" + .'- RootAccount: 阿里云账号'."\n" + .'- RamUser: RAM用户'."\n" + .'- RamRole:RAM角色', + 'type' => 'string', + 'example' => 'RamUser', + ], + 'account_state' => [ + 'title' => '账号状态', + 'description' => '账号状态。'."\n" + ."\n" + .'- Active: 当前账号状态为活跃'."\n" + ."\n" + .'- InActive: 当前账号状态为冻结'."\n" + ."\n" + .'- Deleted：当前账号状态为已删除', + 'type' => 'string', + 'example' => 'Active', + ], + 'cert_expire_time' => [ + 'title' => '证书过期时间', + 'description' => 'KubeConfig客户端证书过期时间。', + 'type' => 'string', + 'example' => '2027-07-15T01:32:20Z', + ], + 'cert_state' => [ + 'title' => '证书状态', + 'description' => 'KubeConfig客户端证书状态。'."\n" + ."\n" + .'- Unexpired: 未过期'."\n" + ."\n" + .'- Expired：已过期'."\n" + ."\n" + .'- Unknown: 未知（异常状态）', + 'type' => 'string', + 'example' => 'Expired', + ], + 'revokable' => [ + 'title' => '证书是否可吊销', + 'description' => 'KubeConfig客户端证书是否可吊销。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cloud_service_name' => [ + 'description' => '云产品名称', + 'type' => 'string', + 'example' => 'cs/ecs/sls', + ], + 'cloud_service_roles' => [ + 'description' => '集群云产品服务角色关联的集群角色列表', + 'type' => 'array', + 'items' => [ + 'description' => '集群云产品服务角色关联的集群角色信息', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => '集群云产品服务角色关联的集群角色类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'Role' => 'Role', + 'ClusterRole' => 'ClusterRole', + ], + 'example' => 'ClusterRole', + ], + 'role_name' => [ + 'description' => '集群云产品服务角色关联的集群角色名称', + 'type' => 'string', + 'example' => 'cluster-admin', + ], + 'role_namespace' => [ + 'description' => '集群云产品服务角色关联的集群角色命名空间', + 'type' => 'string', + 'example' => 'kube-system', + ], + 'is_default_template' => [ + 'description' => '内容是否与默认的集群角色模板一致'."\n" + ."\n" + .'- true: 一致'."\n" + .'- false: 不一致', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + 'page' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'page_number' => [ + 'title' => '页码', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'page_size' => [ + 'title' => '每页包含的最大记录数量', + 'description' => '每页包含的最大记录数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'total_count' => [ + 'title' => '结果总数', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"states\\": [\\n {\\n \\"account_id\\": \\"22855*****************\\",\\n \\"account_name\\": \\"tom\\",\\n \\"account_display_name\\": \\"tom\\",\\n \\"account_type\\": \\"RamUser\\",\\n \\"account_state\\": \\"Active\\",\\n \\"cert_expire_time\\": \\"2027-07-15T01:32:20Z\\",\\n \\"cert_state\\": \\"Expired\\",\\n \\"revokable\\": true,\\n \\"cloud_service_name\\": \\"cs/ecs/sls\\",\\n \\"cloud_service_roles\\": [\\n {\\n \\"type\\": \\"ClusterRole\\",\\n \\"role_name\\": \\"cluster-admin\\",\\n \\"role_namespace\\": \\"kube-system\\",\\n \\"is_default_template\\": true\\n }\\n ]\\n }\\n ],\\n \\"page\\": {\\n \\"page_number\\": 1,\\n \\"page_size\\": 10,\\n \\"total_count\\": 5\\n }\\n}","type":"json"}]', + 'title' => '获取指定集群已颁发的KubeConfig列表', + 'description' => '> - 使用该接口需要拥有ram:ListUsers和ram:ListRoles权限'."\n" + .'> - 使用该接口需要拥有管理容器服务（CS）的权限（AliyunCSFullAccess）', + ], + 'UpdateK8sClusterUserConfigExpire' => [ + 'summary' => 'ACK集群下发的KubeConfig过期时间默认为3年。您可以使用阿里云账号（主账号）自定义配置，调用UpdateK8sClusterUserConfigExpire接口指定RAM用户或角色在ACK集群中下发的KubeConfig的过期时间（1～876000小时）。', + 'path' => '/k8s/{ClusterId}/user_config/expire', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'expire_hour' => [ + 'title' => 'kubeconfig过期小时', + 'description' => '用户指定的过期时间。单位：小时。'."\n" + ."\n" + .'取值范围：[1, 876000]，即最长为100年。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '876000', + 'minimum' => '0', + 'example' => '720', + ], + 'user' => [ + 'title' => '指定用户id', + 'description' => 'RAM用户ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => '206945240368******', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '更新用户自定义配置的过期时间', + 'description' => '- 该接口只允许被主账号调用。'."\n" + .'- 如果吊销了您在该集群上使用的KubeConfig凭证，设置在该集群KubeConfig自定义过期时间也会被重置，您需要调用该接口重新设置。', + ], + 'RevokeK8sClusterKubeConfig' => [ + 'summary' => '如果您希望吊销当前登录的阿里云账号/RAM用户所拥有的集群KubeConfig凭证，您可以调用RevokeK8sClusterKubeConfig接口进行吊销。吊销成功后，集群会生成新的KubeConfig，原来的KubeConfig会失效。', + 'path' => '/k8s/{ClusterId}/certs', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '161583', + 'abilityTreeNodes' => [ + 'FEATUREcsk01W1JN', + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"type":"json","example":"{}","errorExample":""},{"type":"xml","example":"<RevokeK8sClusterKubeConfigResponse>\\n <config>apiVersion: v1****</config>\\n <expiration>2024-03-10T09:56:17Z</expiration>\\n</RevokeK8sClusterKubeConfigResponse>","errorExample":""}]', + 'title' => '吊销当前登录用户KubeConfig', + ], + 'CleanClusterUserPermissions' => [ + 'summary' => '如果您想针对部分有安全风险的KubeConfig进行清理和解除授权，您可以调用CleanClusterUserPermissions清理指定用户在指定集群已下发的KubeConfig凭据和RBAC权限。', + 'path' => '/cluster/{ClusterId}/user/{Uid}/permissions', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsk01W1JN', + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****'."\n", + ], + ], + [ + 'name' => 'Uid', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云账号内指定RAM用户或RAM角色ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2xxxxxxxxxxxxxxxxxx'."\n", + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制删除指定的KubeConfig，取值：'."\n" + .'- false（默认值）：删除KubeConfig前校验是否在七天内存在相关的集群访问记录，如果存在或无法查找集群访问记录，则不允许删除。'."\n" + .'- true：强制删除KubeConfig，不检查集群访问记录。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '清理指定用户在指定集群已下发KubeConfig凭据和RBAC权限', + 'description' => '> 1. 需要拥有管理容器服务（CS）的权限（AliyunCSFullAccess） '."\n" + .'> 2. 不支持清除阿里云账号权限'."\n" + .'> 3. 不支持清除操作用户本身的权限', + 'responseParamsDescription' => '无返回参数', + ], + 'CleanUserPermissions' => [ + 'summary' => '如果您想针对部分风险用户（已离职、账号冻结等）的KubeConfig进行清理并解除授权，您可以调用CleanUserPermissions清理指定用户已下发的KubeConfig凭据和RBAC权限。', + 'path' => '/users/{Uid}/permissions', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201666', + 'abilityTreeNodes' => [ + 'FEATUREcskM5ADAN', + ], + ], + 'parameters' => [ + [ + 'name' => 'Uid', + 'in' => 'path', + 'schema' => [ + 'description' => '阿里云账号内指定RAM用户或RAM角色ID。', + 'type' => 'string', + 'required' => true, + 'example' => '26562443851650****', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'description' => '是否强制删除指定的KubeConfig，取值：'."\n" + .'- false（默认值）：删除KubeConfig前校验是否在七天内存在相关的集群访问记录，如果存在或无法查找集群访问记录，则不允许删除。'."\n" + .'- true：强制删除KubeConfig，不检查集群访问记录。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => '集群ID列表。如指定了该列表，则仅清除当前用户在列表内集群的KubeConfig和RBAC权限。', + 'type' => 'array', + 'items' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cd53c3a9ee12a494c9a0451e2ffc11c65', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4314****', + ], + 'task_id' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'clean-user-permissions-2085266204********-6694c16e6ae07***********', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4314****\\",\\n \\"task_id\\": \\"clean-user-permissions-2085266204********-6694c16e6ae07***********\\"\\n}","type":"json"}]', + 'title' => '清理指定用户在所有集群已下发KubeConfig凭据和RBAC权限', + 'description' => '>- 需要拥有管理容器服务（CS）的权限（AliyunCSFullAccess）'."\n" + .'>- 不支持清除阿里云账号权限'."\n" + .'>- 不支持清除操作用户本身的权限', + ], + 'CreateClusterNodePool' => [ + 'summary' => '节点池是具有相同属性的一组节点的逻辑集合，允许对节点进行统一的管理和运维，例如节点升级、弹性伸缩等。您可以进一步使用节点池的自动化运维能力，使用OS CVE漏洞自动修复、故障节点自动恢复、kubelet和containerd版本自动升级等功能，降低运维成本。您可以调用CreateClusterNodePool为集群创建节点池。', + 'path' => '/clusters/{ClusterId}/nodepools', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '553', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c61da77e8bfbc4c4c999af2b51b65****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数。', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'nodepool_info' => [ + 'title' => '节点池配置', + 'description' => '节点池配置。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '节点池名称', + 'description' => '节点池名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'nodepool-test', + ], + 'type' => [ + 'title' => '节点池类型，对于边缘节点池来说，类型为"edge"', + 'description' => '节点池类型，取值范围：'."\n" + ."\n" + .'- `ess`：普通节点池（包含托管功能和自动弹性伸缩功能）。'."\n" + .'- `edge`：边缘节点池。'."\n" + .'- `lingjun`：灵骏节点池。'."\n" + .'- `hybrid`：混合云节点池。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'lingjun' => '灵骏节点池', + 'edge' => '边缘节点池', + 'ess' => '普通节点池', + ], + 'example' => 'ess', + ], + 'resource_group_id' => [ + 'title' => '资源组ID。', + 'description' => '节点池的资源组ID，节点池弹出的实例将属于该资源组内。'."\n" + ."\n" + .'一个资源只能归属于一个资源组。根据不同的业务场景，您可以将资源组映射为项目、应用或组织等概念。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyvw3wjmb****', + ], + ], + 'required' => false, + ], + 'auto_scaling' => [ + 'title' => '自动伸缩节点池配置。', + 'description' => '自动弹性伸缩配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启自动伸缩。', + 'description' => '是否启用自动伸缩，取值：'."\n" + ."\n" + .'- `true`：开启节点池自动伸缩功能。当集群的容量规划无法满足应用Pod调度时，ACK会根据配置的最小和最大实例数自动扩缩节点资源。1.24及以上版本的集群默认启用节点即时弹性；'."\n" + .'1.24以下版本的集群默认启用节点自动伸缩。更多信息，请参见[节点伸缩](~~2746785~~)。'."\n" + ."\n" + .'- `false`：不开启自动伸缩，ACK会根据配置的期望节点数调整节点池中的节点数，将节点数始终维持在期望节点数。'."\n" + ."\n" + .'当取值为false时，`auto_scaling`内的其他配置参数将不生效。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'type' => [ + 'title' => '扩容节点类型。', + 'description' => '自动弹性伸缩实例类型。仅当`enable=true`生效，取值：'."\n" + ."\n" + .'- `cpu`：普通实例型。'."\n" + ."\n" + .'- `gpu`：GPU实例型。'."\n" + ."\n" + .'- `gpushare`：GPU共享型。'."\n" + ."\n" + .'- `spot`：抢占式实例型。'."\n" + ."\n" + .'默认值：`cpu`。'."\n" + .'><notice>节点池创建后，该字段不支持修改。></notice>', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'spot' => '抢占式实例型', + 'cpu' => '普通实例型', + 'gpushare' => 'GPU共享型', + 'gpu' => 'GPU实例型', + ], + 'example' => 'cpu', + ], + 'max_instances' => [ + 'title' => '最大实例数。', + 'description' => '节点池中可伸缩的最大实例数，不包含您已有的实例。仅当`enable=true`生效。'."\n" + ."\n" + .'取值范围[min_instances, 2000]，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'min_instances' => [ + 'title' => '最小实例数。', + 'description' => '节点池中可伸缩的最小实例数，不包含您已有的实例。仅当`enable=true`生效。'."\n" + ."\n" + .'取值范围[0, max_instances]，默认值为0。'."\n" + ."\n" + .'> - 最小实例数不为0时，伸缩组生效后，将自动创建对应数量的ECS实例。'."\n" + .'> - 建议设置的最大实例数不要小于当前节点池中的节点数，否则弹性伸缩功能生效后会直接导致节点池的节点缩容。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'is_bond_eip' => [ + 'title' => '【该字段已废弃】'."\n" + .'是否绑定EIP。', + 'description' => '【该字段已废弃】该字段已废弃，请使用internet_charge_type和internet_max_bandwidth_out替代。'."\n" + ."\n" + .'是否绑定EIP。取值：'."\n" + ."\n" + .'- `true`：绑定EIP。'."\n" + ."\n" + .'- `false`：不绑定EIP。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'eip_internet_charge_type' => [ + 'title' => '【该字段已废弃】请使用internet_charge_type代替'."\n" + .'EIP实例规格。', + 'description' => '【该字段已废弃】请使用internet_charge_type和internet_max_bandwidth_out替代。'."\n" + ."\n" + .'EIP计费类型。取值：'."\n" + .'- `PayByBandwidth`：按固定带宽计费。'."\n" + .'- `PayByTraffic`：按使用流量计费。'."\n" + ."\n" + .'默认值：`PayByBandwidth`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'eip_bandwidth' => [ + 'title' => '【该字段已废弃】请使用internet_max_bandwidth_out代替'."\n" + .'带宽峰值。', + 'description' => '【该字段已废弃】请使用internet_charge_type和internet_max_bandwidth_out替代。'."\n" + ."\n" + .'EIP带宽峰值。单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + ], + 'required' => false, + ], + 'management' => [ + 'title' => '托管节点池配置。', + 'description' => '节点池托管功能配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否启用托管节点池。', + 'description' => '是否开启节点池的托管功能，取值：'."\n" + ."\n" + .'- `true`：开启托管功能。'."\n" + ."\n" + .'- `false`：不开启托管功能，只有当enable=true时，其他相关配置才生效。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'auto_repair' => [ + 'title' => '是否启用自动修复。', + 'description' => '是否自动修复节点，仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：自动修复'."\n" + ."\n" + .'- `false`：不自动修复'."\n" + ."\n" + .'默认值为`true`', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_repair_policy' => [ + 'title' => '自动修复节点策略。', + 'description' => '自动修复节点策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点，仅当`auto_repair=true`时生效。取值：'."\n" + ."\n" + .'- `true`：允许重启节点'."\n" + .'- `false`：不允许重启节点'."\n" + ."\n" + .'默认值为`true`', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true'."\n", + ], + 'approval_required' => [ + 'title' => '节点修复是否需要人工审批。', + 'description' => '节点修复是否需要人工审批。', + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + ], + 'auto_vul_fix' => [ + 'title' => '是否自动修复CVE。', + 'description' => '是否自动修复CVE漏洞，仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：允许自动修复CVE。'."\n" + .'- `false`：不允许自动修复CVE。'."\n" + ."\n" + .'默认值为`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_vul_fix_policy' => [ + 'title' => '自动修复CVE策略。', + 'description' => '自动修复CVE策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点，仅当`auto_vul_fix=true`时生效。取值：'."\n" + .'- `true`：允许重启节点'."\n" + .'- `false`：不允许重启节点'."\n" + ."\n" + .'默认值为`true`', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'vul_level' => [ + 'title' => '允许自动修复的漏洞级别，以逗号分隔。', + 'description' => '允许自动修复的漏洞级别，以英文逗号分隔，例如：`asap,later`。支持的漏洞级别：'."\n" + ."\n" + .'- `asap`：高'."\n" + .'- `later`：中'."\n" + .'- `nntf`：低'."\n" + ."\n" + .'默认值为`asap`。', + 'type' => 'string', + 'required' => false, + 'example' => 'asap,nntf', + ], + 'exclude_packages' => [ + 'title' => '指定在漏洞修复过程中应排除的包名。', + 'description' => '指定在漏洞修复过程中应排除的包。'."\n" + ."\n" + .'默认值为`kernel`。', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'auto_upgrade' => [ + 'title' => '是否自动升级。', + 'description' => '是否自动升级节点，仅当`enable=true`时生效。'."\n" + .'- `true`：启用自动升级。'."\n" + .'- `false`：不启用自动升级。'."\n" + ."\n" + .'默认值为`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true'."\n", + ], + 'auto_upgrade_policy' => [ + 'title' => '自动升级策略。', + 'description' => '自动升级节点策略。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade_kubelet' => [ + 'title' => '是否允许自动升级kubelet。', + 'description' => '是否允许自动升级kubelet，仅当`auto_upgrade=true`时生效。取值：'."\n" + .'- `true`：允许自动升级kubelet。'."\n" + .'- `false`：不允许自动升级kubelet。'."\n" + ."\n" + .'默认值为`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true'."\n", + ], + 'auto_upgrade_runtime' => [ + 'title' => '是否允许自动升级运行时。', + 'description' => '是否允许自动升级运行时，仅当`auto_upgrade=true`时生效。取值：'."\n" + .'- `true`：允许自动升级运行时。'."\n" + .'- `false`：不允许自动升级运行时。'."\n" + ."\n" + .'默认值为`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'auto_upgrade_os' => [ + 'title' => '是否允许自动升级操作系统。', + 'description' => '是否允许自动升级操作系统，仅当`auto_upgrade=true`时生效。取值：'."\n" + .'- `true`：允许自动升级操作系统。'."\n" + .'- `false`：不允许自动升级操作系统。'."\n" + ."\n\n" + .'默认值为`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'upgrade_config' => [ + 'title' => '自动升级配置。', + 'description' => '【该字段已废弃】请使用上层的`auto_upgrade`参数替代。'."\n" + ."\n" + .'自动升级配置，仅当`enable=true`时生效。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade' => [ + 'title' => '【该字段已废弃】请使用上层的auto_upgrade替代'."\n" + .'是否启用自动升级', + 'description' => '【该字段已废弃】请使用上层的`auto_upgrade`参数替代。'."\n" + ."\n" + .'是否启用自动升级，取值：'."\n" + ."\n" + .'- `true`：启用自动升级。'."\n" + ."\n" + .'- `false`：不启用自动升级。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'surge' => [ + 'title' => '额外节点数量。', + 'description' => '额外节点数量。和`surge_percentage`二选一。'."\n" + ."\n" + .'升级的时候节点会不可用，您可以创建额外节点补偿集群的负载。'."\n" + ."\n" + .'> 建议创建的额外节点不超过当前的节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'surge_percentage' => [ + 'title' => '额外节点比例。和surge二选一。', + 'description' => '额外节点数的百分比，和`surge`二选一。'."\n" + ."\n" + .'额外节点数=额外节点数比例×节点数，例如，设置额外节点数比例为50%，存在的节点数为6，那么将产生的额外节点数=50%×6，也就是将产生3个额外节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'max_unavailable' => [ + 'title' => '最大不可用节点数量。', + 'description' => '最大不可用节点数量。'."\n" + .'取值范围：\\[1,1000\\]'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + 'deprecated' => true, + 'required' => false, + ], + ], + 'required' => false, + ], + 'scaling_group' => [ + 'title' => '伸缩组配置', + 'description' => '节点池伸缩组配置。', + 'type' => 'object', + 'properties' => [ + 'vswitch_ids' => [ + 'title' => '虚拟交换机ID。', + 'description' => '虚拟交换机ID列表，取值范围：\\[1,8\\]。'."\n" + ."\n" + .'> 为保证高可用性，建议选择不同可用区的虚拟交换机。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-wz9mfnhmssud6eicu****', + ], + 'required' => true, + ], + 'instance_types' => [ + 'title' => '实例规格。', + 'description' => '节点池节点实例规格列表，节点池弹出节点时，将从指定的实例规格列表中，挑选出符合要求的实例规格弹出实例。'."\n" + ."\n" + .'支持的实例规格数量范围：[1,10]'."\n" + ."\n\n" + .'> 为保证高可用性，建议选择多个实例规格。', + 'type' => 'array', + 'items' => [ + 'description' => '实例规格。请参见[实例规格族](~~25378~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.d1ne.2xlarge', + ], + 'required' => true, + ], + 'instance_charge_type' => [ + 'title' => '节点付费类型', + 'description' => '节点池节点付费类型，取值：'."\n" + .' '."\n" + .'- `PrePaid`：预付费实例。'."\n" + ."\n" + .'- `PostPaid`：按量付费实例。'."\n" + ."\n" + .'默认值：`PostPaid`。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'PostPaid' => '按量付费实例', + 'PrePaid' => '预付费实例', + ], + 'example' => 'PostPaid', + ], + 'period' => [ + 'title' => '节点包年包月时长。', + 'description' => '节点池节点包年包月时长，仅当`instance_charge_type`取值为`PrePaid`时生效，且为必选值。'."\n" + ."\n" + .'- 当`period_unit=Week`时，`period`取值范围：{ 1、2、3、4}。'."\n" + .'- 当`period_unit=Month`时，`period` 取值范围：{1、2、3、4、5、6、7、8、9、12、24、36、48、60}。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'period_unit' => [ + 'title' => '节点包年包月周期。', + 'description' => '节点池节点付费周期，仅当`instance_charge_type`取值为`PrePaid`时生效，且为必选值。'."\n" + ."\n" + .'- `Month`：以月为计时单位。'."\n" + .'- `Week`：以周为计算单位。'."\n" + ."\n" + .'默认值：`Month`。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + 'auto_renew' => [ + 'title' => '节点是否开启自动续费', + 'description' => '节点池节点是否开启自动续费，当`instance_charge_type`取值为`PrePaid`时才生效。取值：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_renew_period' => [ + 'title' => '节点自动续费周期', + 'description' => '单次自动续费的续费时长。取值范围：'."\n" + .'- PeriodUnit=Week 时：1、2、3。'."\n" + .'- PeriodUnit=Month 时：1、2、3、6、12、24、36、48、60。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'spot_strategy' => [ + 'title' => '抢占式实例类型', + 'description' => '抢占式实例类型。取值：'."\n" + ."\n" + .'- `NoSpot`：非抢占式实例。'."\n" + ."\n" + .'- `SpotWithPriceLimit`：设置抢占实例价格上限。'."\n" + ."\n" + .'- `SpotAsPriceGo`：系统自动出价，跟随当前市场实际价格。'."\n" + ."\n" + .'更多信息，请参见[抢占式实例](~~165053~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'NoSpot', + ], + 'spot_price_limit' => [ + 'title' => '抢占实例价格上限配置。', + 'description' => '当前单台抢占式实例规格市场价格区间配置。', + 'type' => 'array', + 'items' => [ + 'description' => '抢占实例市场价格区间配置，可为不同实例规格设置不同的价格区间。', + 'type' => 'object', + 'properties' => [ + 'instance_type' => [ + 'title' => '抢占实例规格。', + 'description' => '抢占式实例规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c6.large', + ], + 'price_limit' => [ + 'title' => '抢占实例单价。', + 'description' => '单台实例上限价格。'."\n" + .'<props="china">单位：元/小时。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">单位：美元/小时。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '0.39', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'image_type' => [ + 'title' => '操作系统发行版类型，推荐使用该字段指定节点操作系统。取值：CentOS、AliyunLinux、AliyunLinux Qboot、AliyunLinuxUEFI、AliyunLinux3、Windows、WindowsCore、AliyunLinux3Arm64、ContainerOS。', + 'description' => '操作系统镜像类型，取值范围：'."\n" + ."\n" + .'- `AliyunLinux`：Alinux2镜像。'."\n" + .'- `AliyunLinuxSecurity`：Alinux2镜像UEFI版。'."\n" + .'- `AliyunLinux3`：Alinux3镜像。'."\n" + .'- `AliyunLinux3Arm64`：Alinux3镜像ARM版。'."\n" + .'- `AliyunLinux3Security`：Alinux3镜像UEFI版。'."\n" + .'- `CentOS`：CentOS镜像。'."\n" + .'- `Windows`：Windows镜像。'."\n" + .'- `WindowsCore`：WindowsCore镜像。'."\n" + .'- `ContainerOS`：容器优化镜像。'."\n" + .'- `AliyunLinux3ContainerOptimized`: Alinux3镜像容器优化版。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunLinux3', + ], + 'image_id' => [ + 'title' => '自定义镜像。', + 'description' => '自定义镜像ID，默认使用系统提供的镜像。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_2_1903_x64_20G_alibase_20200529.vhd', + ], + 'system_disk_category' => [ + 'title' => '节点系统盘类型。', + 'description' => '节点系统盘类型，取值：'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL 云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。'."\n" + ."\n" + .'默认值：`cloud_efficiency`。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'system_disk_categories' => [ + 'title' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。取值范围：cloud：普通云盘。cloud_efficiency：高效云盘。cloud_ssd：SSD云盘。cloud_essd：ESSD云盘。', + 'description' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。', + 'type' => 'array', + 'items' => [ + 'title' => '节点系统盘类型', + 'description' => '节点的多系统盘类型。'."\n" + ."\n" + .'取值范围：'."\n" + ."\n" + .'- `cloud`：普通云盘。'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + 'enum' => [], + ], + 'required' => false, + 'maxItems' => 10, + ], + 'system_disk_size' => [ + 'title' => '节点系统盘大小。', + 'description' => '节点系统盘大小，单位：GiB。'."\n" + ."\n" + .'取值范围：\\[20,2048\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '120', + ], + 'system_disk_performance_level' => [ + 'title' => '节点系统盘磁盘性能，只针对ESSD磁盘生效', + 'description' => '节点系统盘磁盘性能，只对ESSD磁盘生效。磁盘性能等级和磁盘大小有关。更多信息，请参见[ESSD云盘](~~122389~~)。'."\n" + .'- PL0：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL1：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL2：并发极限I/O性能较高，读写时延稳定。'."\n" + .'- PL3：并发极限I/O性能极高，读写时延极稳定。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'system_disk_encrypted' => [ + 'title' => '是否加密系统盘。取值范围：true：加密。false：不加密。', + 'description' => '是否加密系统盘。取值范围：'."\n" + ."\n" + .'- true：加密。'."\n" + ."\n" + .'- false：不加密。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'system_disk_kms_key_id' => [ + 'title' => '系统盘使用的KMS密钥ID。', + 'description' => '系统盘使用的KMS密钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'system_disk_encrypt_algorithm' => [ + 'title' => '系统盘采用的加密算法。取值范围：aes-256。', + 'description' => '系统盘采用的加密算法。取值范围：aes-256。', + 'type' => 'string', + 'required' => false, + 'example' => 'aes-256', + 'enum' => [], + ], + 'system_disk_bursting_enabled' => [ + 'title' => '节点系统盘是否开启Burst（性能突发），磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘是否开启Burst（性能突发）。 取值：'."\n" + .'- true：是。'."\n" + .'- false：否。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'system_disk_provisioned_iops' => [ + 'title' => '节点系统盘预配置的读写IOPS，磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘预配置的读写IOPS。'."\n" + ."\n" + .'可能值：0~min{50,000, 1000\\*容量-基准性能}。 基准性能=min{1,800+50\\*容量, 50000}。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'data_disks' => [ + 'title' => '数据盘配置。', + 'description' => '节点池节点数据盘配置。', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘配置。', + 'required' => false, + '$ref' => '#/components/schemas/data_disk', + ], + 'required' => false, + ], + 'disk_init' => [ + 'title' => '块设备初始化配置。', + 'description' => '块设备初始化配置。', + 'type' => 'array', + 'items' => [ + 'required' => false, + '$ref' => '#/components/schemas/DiskInit', + ], + 'required' => false, + ], + 'security_group_ids' => [ + 'title' => '多安全组ID', + 'description' => '安全组ID列表，与`security_group_id`二选一，推荐使用`security_group_ids`，当同时指定`security_group_id`和`security_group_ids`将优先使用`security_group_ids`。', + 'type' => 'array', + 'items' => [ + 'description' => '安全组ID列表，与`security_group_id`二选一，推荐使用`security_group_ids`，当同时指定`security_group_id`和`security_group_ids`将优先使用`security_group_ids`。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-wz9a8g2mt6x5ll******', + ], + 'required' => false, + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。', + 'description' => '免密登录密钥对名称，和`login_password`二选一。'."\n" + ."\n" + .'>如果节点池选择ContainerOS操作系统，则只支持`key_pair`。', + 'type' => 'string', + 'required' => false, + 'example' => 'np-key-name', + ], + 'login_password' => [ + 'title' => 'SSH登录密码。', + 'description' => 'SSH登录密码，和`key_pair`二选一。密码规则为8~30个字符，且至少同时包含三项（大小写字母、数字和特殊符号）。', + 'type' => 'string', + 'required' => false, + 'example' => '****', + ], + 'login_as_non_root' => [ + 'title' => '弹出的ECS实例是否使用以非root用户登陆。', + 'description' => '弹出的ECS实例是否使用以非root用户登录。'."\n" + .' '."\n" + .'- true：以非root用户（ecs-user）登录。'."\n" + ."\n" + .'- false：以root用户登录。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'cis_enabled' => [ + 'title' => '【已废弃】请使用security_hardening_os参数代替', + 'description' => '【已废弃】请使用参数security_hardening_os替代。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'soc_enabled' => [ + 'title' => '是否开启等保加固，仅当系统镜像选择Alibaba Cloud Linux 2或Alibaba Cloud Linux 3时，可为节点开启等保加固。阿里云为Alibaba Cloud Linux 2和Alibaba Cloud Linux 3等保2.0三级版镜像提供等保合规的基线检查标准和扫描程序。', + 'description' => '是否开启等保加固，仅当系统镜像选择Alibaba Cloud Linux 2或Alibaba Cloud Linux 3时，可为节点开启等保加固。阿里云为Alibaba Cloud Linux 2和Alibaba Cloud Linux 3等保2.0三级版镜像提供等保合规的基线检查标准和扫描程序。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'security_hardening_os' => [ + 'title' => '是否开启阿里云OS安全加固。', + 'description' => '阿里云OS安全加固。取值：'."\n" + ."\n" + .'- `true`：开启阿里云OS安全加固。'."\n" + .'- `false`：不开启阿里云OS安全加固。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'internet_charge_type' => [ + 'title' => '节点公网IP网络计费类型', + 'description' => '公网IP收费类型。取值：'."\n" + ."\n" + .'- PayByBandwidth：按固定带宽计费。'."\n" + .'- PayByTraffic：按使用流量计费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayByTraffic', + ], + 'internet_max_bandwidth_out' => [ + 'title' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：1~100', + 'description' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：\\[1,100\\]', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'tags' => [ + 'title' => 'ECS标签', + 'description' => '仅为ECS实例添加标签。'."\n" + ."\n" + .'标签键不可以重复，最大长度为128个字符；标签键和标签值都不能以“aliyun”、“acs:”开头，或包含“https://”、“http://”。', + 'type' => 'array', + 'items' => [ + 'description' => '节点标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => 'key', + 'description' => '标签的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'node-k-1', + ], + 'value' => [ + 'title' => 'value', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'node-v-1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'desired_size' => [ + 'title' => '节点池期望节点数', + 'description' => '节点池期望节点数量。'."\n" + ."\n" + .'节点池应该维持的总节点数量，建议至少配置2个节点，以确保集群组件正常运行。您可以通过调整期望节点数，达到扩容或缩容节点池的目的。'."\n" + ."\n" + .'如无需创建节点，可填写为0，后续再手动调整，增加节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'multi_az_policy' => [ + 'title' => '多可用区伸缩组ECS实例扩缩容策略', + 'description' => '多可用区伸缩组ECS实例扩缩容策略。取值：'."\n" + ."\n" + .'- `PRIORITY`：根据您定义的虚拟交换机（VSwitchIds.N）扩缩容。当优先级较高的虚拟交换机所在可用区无法创建ECS实例时，自动使用下一优先级的虚拟交换机创建ECS实例。'."\n" + ."\n" + .'- `COST_OPTIMIZED`：按vCPU单价从低到高进行尝试创建。当伸缩配置设置了抢占式计费方式的多实例规格时，优先创建对应抢占式实例。您可以继续通过`CompensateWithOnDemand`参数指定当抢占式实例由于库存等原因无法创建时，是否自动尝试以按量付费的方式创建。'."\n" + ."\n" + .' >`COST_OPTIMIZED`仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。'."\n" + ."\n" + .'- `BALANCE`：在伸缩组指定的多可用区之间均匀分配ECS实例。如果由于库存不足等原因可用区之间变得不平衡，您可以通过API [RebalanceInstances](~~71516~~)平衡资源。'."\n" + ."\n" + .'默认值：`PRIORITY`。', + 'type' => 'string', + 'required' => false, + 'example' => 'COST_OPTIMIZED', + ], + 'scaling_policy' => [ + 'title' => '自动伸缩。', + 'description' => '伸缩组模式，取值：'."\n" + ."\n" + .'- `release`：标准模式，根据申请资源值的使用量，通过创建、释放ECS的方式进行伸缩。'."\n" + .'- `recycle`：极速模式，通过创建、停机、启动的方式进行伸缩，提高再次伸缩的速度（停机时计算资源不收费，只收取存储费用，本地盘机型除外）。'."\n" + ."\n" + .'默认值：`release`。', + 'type' => 'string', + 'required' => false, + 'example' => 'release', + ], + 'on_demand_base_capacity' => [ + 'title' => '伸缩组所需要按量实例个数的最小值，取值范围：0~1000。当按量实例个数少于该值时，将优先创建按量实例。', + 'description' => '伸缩组所需要按量实例个数的最小值，取值范围：\\[0,1000\\]。当按量实例个数少于该值时，将优先创建按量实例。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'on_demand_percentage_above_base_capacity' => [ + 'title' => '伸缩组满足最小按量实例数（OnDemandBaseCapacity）要求后，超出的实例中按量实例应占的比例，取值范围：0～100。', + 'description' => '伸缩组满足最小按量实例数（`on_demand_base_capacity`）要求后，超出的实例中按量实例应占的比例。取值范围：\\[0,100\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'spot_instance_pools' => [ + 'title' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：1~10。', + 'description' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：\\[1,10\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'spot_instance_remedy' => [ + 'title' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。', + 'description' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。取值：'."\n" + ."\n" + .'- `true`：开启补齐抢占式实例。'."\n" + .'- `false`：不开启补齐抢占式实例。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'compensate_with_on_demand' => [ + 'title' => '当MultiAZPolicy取值为COST_OPTIMIZED时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值范围：true：允许。false：不允许。默认值：true', + 'description' => '当`multi_az_policy`取值为`COST_OPTIMIZED`时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值：'."\n" + ."\n" + .'- `true`：允许自动尝试创建按量实例满足ECS实例数量要求。'."\n" + .'- `false`：不允许自动尝试创建按量实例满足ECS实例数量要求。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'deploymentset_id' => [ + 'title' => '部署集ID。', + 'description' => '部署集ID。您可以使用部署集将节点池弹出的ECS实例分散部署在不同的物理服务器上，以保证业务的高可用性和底层容灾能力。在部署集内创建ECS实例时，根据事先设置的部署策略，分散启动指定地域下的ECS实例。'."\n" + ."\n\n" + .'><notice>选择部署集后，节点池内最大节点数会受限。部署集默认支持节点上限为20 * 可用区数量（可用区数量由虚拟交换机决定）。请谨慎选择，确保部署集内配额充足，避免节点弹出失败。></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1d19mmbsv3jf6xxxxx', + ], + 'rds_instances' => [ + 'title' => 'RDS实例列表。', + 'description' => 'RDS实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'RDS实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds-****', + ], + 'required' => false, + ], + 'private_pool_options' => [ + 'title' => '私有池选项。', + 'description' => '私有节点池配置。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '私有池ID。即弹性保障服务ID或容量预定服务ID。', + 'description' => '私有节点池ID。当`match_criteria`为`Target`时，需要进一步指定私有池ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'eap-bp67acfmxazb4****', + ], + 'match_criteria' => [ + 'title' => '实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值范围： Open：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。该模式下无需设置PrivatePoolOptions.Id参数。 Target：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。该模式下必须指定私有池ID，即PrivatePoolOptions.Id参数为必填项。 None：不使用模式。实例启动将不使用私有池容量。', + 'description' => '私有节点池类型，实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值：'."\n" + .'- `Open`：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。'."\n" + .'- `Target`：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。'."\n" + .'- `None`：不使用模式。实例启动将不使用私有池容量。', + 'type' => 'string', + 'required' => false, + 'example' => 'Target', + ], + ], + 'required' => false, + ], + 'security_group_id' => [ + 'title' => '【该字段已废弃】请使用security_group_ids替代'."\n" + .'安全组ID。', + 'description' => '节点池安全组ID，与`security_group_ids`二选一，推荐使用`security_group_ids`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'sg-wz9a8g2mt6x5llu0****', + ], + 'platform' => [ + 'title' => '【该字段已废弃】请使用image_type替代'."\n" + .'操作系统发行版，和image_type二选一', + 'description' => '【该字段已废弃】请使用`image_type`参数代替。'."\n" + ."\n" + .'操作系统发行版。取值：'."\n" + .'- `CentOS`'."\n" + .'- `AliyunLinux`'."\n" + .'- `Windows`'."\n" + .'- `WindowsCore`'."\n" + ."\n" + .'默认值：`AliyunLinux`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'instance_patterns' => [ + 'title' => '实例属性', + 'description' => '实例属性配置。', + 'type' => 'array', + 'items' => [ + 'title' => '实例属性', + 'description' => '实例属性。', + 'required' => false, + '$ref' => '#/components/schemas/instance_patterns', + ], + 'required' => false, + ], + 'ram_role_name' => [ + 'title' => 'Worker RAM角色名称。为空时，将使用集群默认创建的Worker RAM角色。仅支持1.22及以上版本的ACK托管版集群。', + 'description' => 'Worker RAM角色名称。'."\n" + ."\n" + .'* 为空时，将使用集群默认创建的Worker RAM角色。'."\n" + .'* 不为空时，指定的RAM角色必须是一个**普通服务角色**，并且它的**可信服务**配置必须是**云服务器**，更多信息，请参见[创建普通服务角色](~~116800~~)。当指定的RAM角色不是集群默认创建的Worker RAM角色时，角色的名称不能以`KubernetesMasterRole-`或`KubernetesWorkerRole-`开头。'."\n" + ."\n" + .'><notice>仅1.22及以上版本的ACK托管集群支持该参数></notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'example-role', + ], + 'instance_metadata_options' => [ + 'title' => 'ECS 实例的元数据访问配置。该参数目前仅白名单开放，如需使用，请提交工单申请。', + 'description' => 'ECS 实例元数据访问配置。', + 'required' => false, + '$ref' => '#/components/schemas/InstanceMetadataOptions', + ], + 'resource_pool_options' => [ + 'title' => '创建实例时使用的资源池及资源池策略。当您设置该参数后，需要注意：'."\n" + .'该参数只在创建按量付费实例时生效。'."\n" + .'该参数不能与private_pool_options.match_criteria、private_pool_options.id同时设置。', + 'description' => '创建实例时使用的资源池及资源池策略。当您设置该参数后，需要注意：'."\n" + .'该参数只在创建按量付费实例时生效。'."\n" + .'该参数不能与private_pool_options.match_criteria、private_pool_options.id同时设置。', + 'type' => 'object', + 'properties' => [ + 'strategy' => [ + 'title' => '创建实例时使用的资源池策略。资源池包括弹性保障服务或容量预定服务生效后生成的私有池以及公共池，供实例启动时选择。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。选择此种策略时， 当指定了 resouce_pool_options.private_pool_ids，优先使用指定的私有池。如果未指定私有池或指定的私有池容量不足，将自动匹配开放类型的私有池。如果没有符合条件的私有池，则使用公共池创建实例。'."\n" + .'PrivatePoolOnly：仅限私有池。选择此种策略时，必须指定 resouce_pool_options.private_pool_ids。如果指定的私有池容量不足，则实例会启动失败。'."\n" + .'None：不使用资源池策略。'."\n" + .'默认值：None。', + 'description' => '创建实例时使用的资源池策略。资源池包括弹性保障服务或容量预定服务生效后生成的私有池以及公共池，供实例启动时选择。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。选择此种策略时， 当指定了 resouce_pool_options.private_pool_ids，优先使用指定的私有池。如果未指定私有池或指定的私有池容量不足，将自动匹配开放类型的私有池。如果没有符合条件的私有池，则使用公共池创建实例。'."\n" + .'PrivatePoolOnly：仅限私有池。选择此种策略时，必须指定 resouce_pool_options.private_pool_ids。如果指定的私有池容量不足，则实例会启动失败。'."\n" + .'None：不使用资源池策略。'."\n" + .'默认值：None。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrivatePoolFirst', + 'enum' => [ + 'PrivatePoolOnly', + 'PrivatePoolFirst', + 'None', + ], + ], + 'private_pool_ids' => [ + 'title' => '私有池 ID列表。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。N 的取值范围：1~20。', + 'description' => '私有池 ID列表。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。N 的取值范围：1~20。', + 'type' => 'array', + 'items' => [ + 'title' => '私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。', + 'description' => '私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'eap-bp67acfmxazb4****', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'system_disk_snapshot_policy_id' => [ + 'title' => '系统盘快照策略', + 'description' => '系统盘快照策略', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'node_config' => [ + 'title' => '节点配置', + 'description' => '节点配置。', + 'type' => 'object', + 'properties' => [ + 'kubelet_configuration' => [ + 'title' => 'Kubelet参数配置。', + 'description' => 'Kubelet参数配置。', + 'required' => false, + '$ref' => '#/components/schemas/kubelet_config', + ], + ], + 'required' => false, + ], + 'kubernetes_config' => [ + 'title' => '集群配置', + 'description' => '集群相关配置。', + 'type' => 'object', + 'properties' => [ + 'labels' => [ + 'title' => '节点标签。', + 'description' => '节点标签，为Kubernetes集群节点添加标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签配置。', + 'required' => false, + '$ref' => '#/components/schemas/tag', + ], + 'required' => false, + ], + 'taints' => [ + 'title' => '污点信息。', + 'description' => '污点配置。', + 'type' => 'array', + 'items' => [ + 'description' => '污点配置集合。', + 'required' => false, + '$ref' => '#/components/schemas/taint', + ], + 'required' => false, + ], + 'runtime' => [ + 'title' => '容器运行时。', + 'description' => '容器运行时名称，ACK 支持以下三种容器运行时。'."\n" + ."\n" + .'- containerd：推荐使用，支持所有集群版本。'."\n" + .'- Sandboxed-Container.runv：安全沙箱容器，提供更高的隔离性，支持 1.31 及以下版本集群。'."\n" + .'- docker：已停止维护，支持1.22及以下版本集群。'."\n" + ."\n" + .'默认值：containerd。', + 'type' => 'string', + 'required' => false, + 'example' => 'containerd', + ], + 'runtime_version' => [ + 'title' => '容器运行时版本。', + 'description' => '容器运行时版本。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1.6.38', + ], + 'cpu_policy' => [ + 'title' => 'CPU管理策略。', + 'description' => '节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略：'."\n" + ."\n" + .'- `static`：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + .'- `none`：表示启用现有的默认CPU亲和性方案。'."\n" + ."\n" + .'默认值：`none`。', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + 'user_data' => [ + 'title' => '节点自定义数据。', + 'description' => '实例自定义数据。节点加入集群后，将运行您指定的实例自定义数据脚本。请参见[User-Data脚本](~~49121~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'dGhpcyBpcyBhIGV4YW1wbGU=', + ], + 'unschedulable' => [ + 'title' => '扩容后的节点是否可调度。', + 'description' => '扩容后的节点是否不可调度。'."\n" + ."\n" + .'- true：不可调度。'."\n" + ."\n" + .'- false：可调度。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'cms_enabled' => [ + 'title' => '是否开启云监控。', + 'description' => '是否在ECS节点上安装云监控，安装后可以在云监控控制台查看所创建ECS实例的监控信息，推荐开启。取值：'."\n" + ."\n" + .'- `true`：在ECS节点上安装云监控。'."\n" + ."\n" + .'- `false`：不在ECS节点上安装云监控。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'node_name_mode' => [ + 'title' => '自定义节点名称', + 'description' => '自定义节点名称。自定义节点名称后，将同时更改节点名称、ECS实例名称、ECS实例Hostname。'."\n" + .'> 对于开启自定义节点名称的Windows实例，其Hostname固定为IP地址，使用-代替IP地址中的.，且不包含前缀和后缀。 '."\n" + ."\n" + .'节点名称由前缀、节点IP地址及后缀三部分组成：'."\n" + ."\n" + .'- 总长度为2-64个字符。节点名称首尾必须为小写字母和数字。'."\n" + ."\n" + .'- 前缀和后缀允许使用大小写字母、数字、连字符（-）和点号（.）。必须以大小写字母开头，不能以连字符（-）或点号（.）开头或结尾。不能连续使用连字符（-）或点号（.）。'."\n" + .'- 前缀必选（ECS限制），后缀可选。'."\n" + .'- 节点 IP为完整的节点私网 IP 地址。'."\n" + ."\n" + .'例如：节点IP地址为192.XX.YY.55，指定前缀为aliyun.com，后缀为test。'."\n" + ."\n" + .'- 如果节点为Linux节点，则节点名称、ECS实例、ECS实例Hostname均为aliyun.com192.XX.YY.55test。'."\n" + ."\n" + .'- 如果节点为Windows节点，则ECS实例Hostname为192-XX-YY-55，节点名称、ECS实例名称均为aliyun.com192.XX.YY.55test。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun.com192.XX.YY.55test', + ], + 'pre_user_data' => [ + 'description' => '实例预自定义数据。节点加入集群前，将运行您指定的实例预自定义数据脚本。请参见[User-Data脚本](~~49121~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'dGhpcyBpcyBhIGV4YW1wbGU', + ], + ], + 'required' => false, + ], + 'tee_config' => [ + 'title' => '加密计算节点池配置。', + 'description' => '加密计算集群配置。', + 'type' => 'object', + 'properties' => [ + 'tee_enable' => [ + 'title' => '是否为加密计算节点池。', + 'description' => '是否开启加密计算集群。'."\n" + ."\n" + .'- true：开启加密计算。'."\n" + ."\n" + .'- false：不开启加密计算。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'interconnect_config' => [ + 'title' => '【该字段已废弃】'."\n" + .'边缘节点池网络相关的配置。该值只对edge类型的节点池有意义', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘节点池配置。', + 'type' => 'object', + 'properties' => [ + 'cen_id' => [ + 'title' => '边缘增强型节点池绑定的云企业网实例ID(CENID)', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云企业网实例ID(CENID)。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'ccn_id' => [ + 'title' => '边缘增强型节点池绑定的云连接网实例ID(CCNID)', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云连接网实例ID(CCNID)。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'ccn_region_id' => [ + 'title' => '边缘增强型节点池绑定的云连接网实例所属的区域', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云连接网实例所属的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'bandwidth' => [ + 'title' => '边缘增强型节点池的网络带宽，单位M。', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池的网络带宽，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'null', + ], + 'improved_period' => [ + 'title' => '边缘增强型节点池的购买时长，单位月', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池的购买时长，单位：月。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + 'deprecated' => true, + 'required' => false, + ], + 'count' => [ + 'title' => '【该字段已废弃】请使用desired_size替代'."\n" + .'节点池节点数量。', + 'description' => '【该字段已废弃】请使用desired_size代替。'."\n" + ."\n" + .'节点池节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'max_nodes' => [ + 'title' => '【该字段已废弃】'."\n" + .'边缘节点池允许容纳的最大节点数量. 节点池内可以容纳的最大节点数量，该参数大于等于0。0表示无额外限制(仅受限于集群整体可以容纳的节点数，节点池本身无额外限制)。边缘节点池该参数值往往大于0；ess类型节点池和默认的edge类型节点池该参数值为0', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘节点池允许容纳的最大节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'interconnect_mode' => [ + 'title' => '边缘节点池的网络类型。basic：基础型；improved：增强型。该值只对edge类型的节点池有意义。', + 'description' => '边缘节点池的网络类型，该参数仅对`type`为`edge`类型的节点池生效，取值范围：'."\n" + ."\n" + .'- `basic`：公网。节点池内的节点通过公网与云端节点进行交互，节点池内应用不能直接访问云端VPC内网。'."\n" + .'- `private`：专用网络。节点池内的节点通过专线、VPN或CEN等方式实现云上与云下网络打通，拥有更高的云边通信质量，提供更有效的安全保障。', + 'type' => 'string', + 'required' => false, + 'example' => 'basic', + ], + 'host_network' => [ + 'title' => '边缘节点池内的Pod是否都采用主机网络模式部署。', + 'description' => 'Pod网络模式是否采用主机网络模式。'."\n" + .'- `true`：主机网络。Pod直接使用主机的网络栈，与主机共享IP地址和端口。'."\n" + .'- `false`：容器网络。Pod拥有独立的网络栈，不占用主机网络端口。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'intranet' => [ + 'title' => '边缘节点池内的所有节点在三层网络上是否互通。', + 'description' => '边缘节点池内，节点之间是否三层网络互通。'."\n" + .'- `true`：互通。该节点池内的所有节点之间三层网络互通。'."\n" + .'- `false`：不互通。该节点池内的所有主机之间三层网络不互通。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'eflo_node_group' => [ + 'title' => '灵骏节点池配置。', + 'description' => '灵骏节点池配置。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '创建灵骏节点池时需要关联的灵骏集群ID。', + 'description' => '创建灵骏节点池时需要关联的灵骏集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i1169130516633730****', + ], + 'group_id' => [ + 'title' => '创建灵骏节点池时需要关联的灵骏集群的灵骏分组ID。', + 'description' => '创建灵骏节点池时需要关联的灵骏集群的灵骏分组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ng-ec3c96ff0aa****', + ], + ], + 'required' => false, + ], + 'auto_mode' => [ + 'title' => '智能托管配置。', + 'description' => '节点池智能托管配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => '是否开启智能托管模式。'."\n" + .'取值：'."\n" + .'- true：开启智能托管模式，仅当集群开启智能托管模式时可以开启。'."\n" + .'- false：不开启智能托管模式。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'node_components' => [ + 'title' => '节点组件列表。', + 'description' => '节点组件列表。', + 'type' => 'array', + 'items' => [ + 'title' => '节点组件。', + 'description' => '节点组件。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '节点组件名称。', + 'description' => '节点组件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'kubelet', + ], + 'version' => [ + 'title' => '节点组件版本。', + 'description' => '节点组件版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.33.3-aliyun.1', + ], + 'config' => [ + 'title' => '节点组件配置。', + 'description' => '节点组件配置。', + 'type' => 'object', + 'properties' => [ + 'custom_config' => [ + 'title' => '节点组件自定义配置。', + 'description' => '节点组件自定义配置。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'cpuManagerPolicy', + ], + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '节点池配置。', + 'type' => 'object', + 'properties' => [ + 'nodepool_id' => [ + 'title' => '节点池ID', + 'description' => '节点池ID。', + 'type' => 'string', + 'example' => 'np31da1b38983f4511b490fc62108a****', + ], + 'task_id' => [ + 'title' => '任务ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-613b19bbd160ad492800****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0527ac9a-c899-4341-a21a-****', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"nodepool_id\\": \\"np31da1b38983f4511b490fc62108a****\\",\\n \\"task_id\\": \\"T-613b19bbd160ad492800****\\",\\n \\"request_id\\": \\"0527ac9a-c899-4341-a21a-****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateClusterNodePoolResponse>\\n <nodepool_id>np31da1b38983f4511b490fc62108a****</nodepool_id>\\n</CreateClusterNodePoolResponse>","errorExample":""}]', + 'title' => '创建节点池', + ], + 'DeleteClusterNodepool' => [ + 'summary' => '您可以调用DeleteClusterNodepool接口删除不再使用的节点池。节点池删除时所有节点上的Pod将会被删除，并可能触发重调度，如无法调度可能影响业务，请确保集群有足够的资源进行重调度。', + 'path' => '/clusters/{ClusterId}/nodepools/{NodepoolId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '554', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c61da77e8bfbc4c4c999af2b51b65****', + ], + ], + [ + 'name' => 'NodepoolId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np30db56bcac7843dca90b999c8928****', + ], + ], + [ + 'name' => 'force', + 'in' => 'query', + 'schema' => [ + 'title' => '是否强制删除。', + 'description' => '是否强制删除。'."\n" + ."\n" + .'- true：强制删除。节点池中有存量节点时，会强制删除已有的节点。'."\n" + ."\n" + .'- false：不强制删除。节点池中有存量节点时，禁止删除节点池，接口调用会返回报错。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '7263C978-3DBD-4E06-B319-793B38******', + ], + 'task_id' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'T-655ace947e0e6603af******', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"request_id\\": \\"7263C978-3DBD-4E06-B319-793B38******\\",\\n \\"task_id\\": \\"T-655ace947e0e6603af******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteClusterNodepoolResponse>\\n <request_id>7263C978-3DBD-4E06-B319-793B38A2F388</request_id>\\n</DeleteClusterNodepoolResponse>","errorExample":""}]', + 'title' => '删除节点池', + ], + 'DescribeClusterNodePoolDetail' => [ + 'summary' => '您可以根据节点池ID，调用DescribeClusterNodePoolDetail接口查询集群中目标节点池的配置。', + 'path' => '/clusters/{ClusterId}/nodepools/{NodepoolId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '527', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c23421cfa74454bc8b37163fd19af****', + ], + ], + [ + 'name' => 'NodepoolId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np31da1b38983f4511b490fc62108a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '节点池详情。', + 'type' => 'object', + 'properties' => [ + 'nodepool_info' => [ + 'title' => '节点池详情。', + 'description' => '节点池配置。', + 'type' => 'object', + 'properties' => [ + 'nodepool_id' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'example' => 'np615c0e0966124216a0412e10afe0****', + ], + 'name' => [ + 'title' => '节点池名称。', + 'description' => '节点池名称。', + 'type' => 'string', + 'example' => 'default-nodepool', + ], + 'type' => [ + 'title' => '节点池类型。', + 'description' => '节点池类型。'."\n" + .'- `ess`：普通节点池（包含托管功能和自动弹性伸缩功能）。'."\n" + .'- `edge`：边缘节点池。'."\n" + .'- `lingjun`：灵骏节点池。', + 'type' => 'string', + 'example' => 'ess', + ], + 'is_default' => [ + 'title' => '是否为默认节点池。', + 'description' => '是否为默认节点池，通常一个集群仅有一个默认节点池。取值：'."\n" + ."\n" + .'- `true`：默认节点池。'."\n" + .'- `false`：非默认节点池。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'resource_group_id' => [ + 'title' => '节点池所属资源组ID。', + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyvw3wjmb****', + ], + 'region_id' => [ + 'title' => '节点池所属地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'created' => [ + 'title' => '节点池创建时间。', + 'description' => '节点池创建时间。', + 'type' => 'string', + 'example' => '2025-04-10T14:25:37.285530433+08:00', + ], + 'updated' => [ + 'title' => '节点池更新时间。', + 'description' => '节点池更新时间。', + 'type' => 'string', + 'example' => '2025-04-15T15:39:45.41+08:00', + ], + ], + ], + 'status' => [ + 'title' => '节点池状态。', + 'description' => '节点池状态。', + 'type' => 'object', + 'properties' => [ + 'state' => [ + 'title' => '节点池状态。', + 'description' => '节点池状态，取值：'."\n" + ."\n" + .'- `active`：已激活。'."\n" + .'- `scaling`：伸缩中。'."\n" + .'- `removing`：节点移除中。'."\n" + .'- `deleting`：删除中。'."\n" + .'- `updating`：更新中。', + 'type' => 'string', + 'example' => 'active', + ], + 'healthy_nodes' => [ + 'title' => '处于健康状态节点数。', + 'description' => '健康节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'initial_nodes' => [ + 'title' => '正在初始化节点数。', + 'description' => '正在创建节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'failed_nodes' => [ + 'title' => '失败节点数。', + 'description' => '失败节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'offline_nodes' => [ + 'title' => '离线节点数量。', + 'description' => '离线节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'removing_nodes' => [ + 'title' => '正在被移除节点数。', + 'description' => '正在被移除节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'serving_nodes' => [ + 'title' => '工作节点数量。', + 'description' => '工作中节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'total_nodes' => [ + 'title' => '总节点数。', + 'description' => '节点池内总节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'conditions' => [ + 'title' => '节点池现状，表示节点池不同维度的状态信息。', + 'description' => '节点池现状，表示节点池不同维度的状态信息。', + 'type' => 'array', + 'items' => [ + 'title' => '单个状态属性。', + 'description' => '单个状态属性。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '类型。', + 'description' => '类型。', + 'type' => 'string', + ], + 'status' => [ + 'title' => '状态。', + 'description' => '状态。', + 'type' => 'string', + ], + 'reason' => [ + 'title' => '原因。', + 'description' => '原因。', + 'type' => 'string', + ], + 'message' => [ + 'title' => '详细信息。', + 'description' => '详细信息。', + 'type' => 'string', + ], + 'last_transition_time' => [ + 'title' => '上一次状态转换时间。', + 'description' => '上一次状态转换时间。', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'auto_scaling' => [ + 'title' => '节点池自动伸缩信息。', + 'description' => '自动伸缩节点池配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否启用自动伸缩。', + 'description' => '是否启用自动伸缩，取值：'."\n" + ."\n" + .'- `true`：开启节点池自动伸缩功能。当集群的容量规划无法满足应用Pod调度时，ACK会根据配置的最小和最大实例数自动扩缩节点资源。1.24及以上版本的集群默认启用节点即时弹性；'."\n" + .'1.24以下版本的集群默认启用节点自动伸缩。更多信息，请参见[节点伸缩](~~2746785~~)。'."\n" + ."\n" + .'- `false`：不开启自动伸缩，ACK会根据配置的期望节点数调整节点池中的节点数，将节点数始终维持在期望节点数。'."\n" + ."\n" + .'当取值为false时，`auto_scaling`内的其他配置参数将不生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'type' => [ + 'title' => '扩容组类型', + 'description' => '自动伸缩类型，按照自动伸缩实例类型划分。取值：'."\n" + ."\n" + .'- `cpu`：普通实例型。'."\n" + .'- `gpu`：GPU实例型。'."\n" + .'- `gpushare`：GPU共享型。'."\n" + .'- `spot`：抢占式实例型。'."\n", + 'type' => 'string', + 'example' => 'cpu', + ], + 'max_instances' => [ + 'title' => '最大实例数。', + 'description' => '节点池中可伸缩的最大实例数，不包含您已有的实例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'min_instances' => [ + 'title' => '最小实例数。', + 'description' => '节点池中可伸缩的最小实例数，不包含您已有的实例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'eip_internet_charge_type' => [ + 'title' => 'EIP实例付费类型。', + 'description' => 'EIP计费类型，取值：'."\n" + ."\n" + .'- `PayByBandwidth`：按固定带宽计费。'."\n" + .'- `PayByTraffic`：按使用流量计费。'."\n", + 'type' => 'string', + 'example' => 'PayByBandwidth', + ], + 'is_bond_eip' => [ + 'title' => '是否绑定EIP。', + 'description' => '是否绑定EIP，取值：'."\n" + ."\n" + .'- `true`：绑定EIP。'."\n" + .'- `false`：不绑定EIP。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'eip_bandwidth' => [ + 'title' => 'EIP带宽峰值。', + 'description' => 'EIP带宽峰值。'."\n" + ."\n" + .'取值范围：[1,100]，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + 'management' => [ + 'title' => '托管版节点池配置。', + 'description' => '托管节点池配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启托管版节点池。', + 'description' => '是否开启托管版节点池，取值：'."\n" + ."\n" + .'- `true`：开启托管节点池。'."\n" + .'- `false`：不开启托管节点池，只有当`enable=true`时，其他相关配置才生效。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_repair' => [ + 'title' => '自动修复。', + 'description' => '自动修复，仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：自动修复。'."\n" + .'- `false`：不自动修复。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_repair_policy' => [ + 'title' => '自动修复节点策略。', + 'description' => '自动修复节点策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点。仅当`auto_repair=true`时生效。'."\n" + ."\n" + .'- `true`：允许重启节点。'."\n" + .'- `false`：不允许重启节点。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'approval_required' => [ + 'title' => '节点修复是否需要人工审批。', + 'description' => '节点修复是否需要人工审批。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'auto_repair_policy_id' => [ + 'title' => '自动修复策略ID', + 'description' => '自动修复策略ID', + 'type' => 'string', + 'example' => 'r-xxxxxxxxxx', + ], + ], + ], + 'auto_vul_fix' => [ + 'title' => '是否自动修复CVE。', + 'description' => '是否自动修复CVE。仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：允许自动修复CVE。'."\n" + .'- `false`：不允许自动修复CVE。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_vul_fix_policy' => [ + 'title' => '自动修复CVE策略。', + 'description' => '自动修复CVE策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点，仅当`auto_vul_fix=true`时生效。取值：'."\n" + .'- `true`：允许重启节点。'."\n" + .'- `false`：不允许重启节点。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'vul_level' => [ + 'title' => '允许自动修复的漏洞级别，以逗号分隔。', + 'description' => '允许自动修复的漏洞级别，以逗号分隔。'."\n" + ."\n" + .'- `asap`：高'."\n" + .'- `later`：中'."\n" + .'- `nntf`：低', + 'type' => 'string', + 'example' => 'asap,nntf', + ], + 'exclude_packages' => [ + 'type' => 'string', + ], + ], + ], + 'auto_upgrade' => [ + 'title' => '是否自动升级。', + 'description' => '是否自动升级节点，仅当`enable=true`时生效。'."\n" + .'- `true`：启用自动升级。'."\n" + .'- `false`：不启用自动升级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_upgrade_policy' => [ + 'title' => '自动升级策略。', + 'description' => '自动升级策略。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade_kubelet' => [ + 'title' => '是否允许自动升级kubelet。', + 'description' => '是否允许自动升级kubelet，仅当`auto_upgrade=true`时生效。取值：'."\n" + .'- `true`：允许自动升级kubelet。'."\n" + .'- `false`：不允许自动升级kubelet。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'upgrade_config' => [ + 'title' => '自动升级配置。', + 'description' => '自动升级配置，仅当`enable=true`时生效。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade' => [ + 'title' => '是否启用自动升级，自修复。', + 'description' => '是否启用自动升级，取值：'."\n" + ."\n" + .'- `true`：启用自动升级。'."\n" + .'- `false`：不启用自动升级。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'surge' => [ + 'title' => '额外节点数量。', + 'description' => '额外节点数量。和surge_percentage二选一。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'surge_percentage' => [ + 'title' => '额外节点比例， 和surge 二选一。', + 'description' => '额外节点数的百分比，和`surge`二选一。'."\n" + ."\n" + .'额外节点数=额外节点数比例×节点数，例如，设置额外节点数比例为50%，存在的节点数为6，那么将产生的额外节点数=50%×6，也就是将产生3个额外节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'max_unavailable' => [ + 'title' => '最大不可用节点数量。', + 'description' => '最大不可用节点数量，取值范围：\\[1,1000\\]。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'scaling_group' => [ + 'title' => '节点池扩容组信息。', + 'description' => '节点池伸缩组配置。', + 'type' => 'object', + 'properties' => [ + 'scaling_group_id' => [ + 'title' => '扩容组ID ', + 'description' => '伸缩组ID。', + 'type' => 'string', + 'example' => 'asg-2zeieod8giqmov7z****', + ], + 'vswitch_ids' => [ + 'title' => '虚拟交换机ID。', + 'description' => '虚拟交换机ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-2ze3ds0mdip0hdz8i****', + ], + ], + 'instance_types' => [ + 'title' => '实例规格。', + 'description' => '节点实例规格列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点实例规格。', + 'type' => 'string', + 'example' => 'ecs.n4.large', + ], + ], + 'instance_charge_type' => [ + 'title' => '节点付费类型', + 'description' => '节点池节点付费类型，取值：'."\n" + ."\n" + .'- `PrePaid`：预付费。'."\n" + .'- `PostPaid`：按量付费。'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'period' => [ + 'title' => '节点包年包月时长。', + 'description' => '节点包年包月时长，当`instance_charge_type`取值为`PrePaid`时才生效且为必选值。'."\n" + ."\n" + .'- 当`period_unit=Week`时，`period`取值范围：{ 1、2、3、4}。'."\n" + .'- 当`period_unit=Month`时，`period` 取值范围：{1、2、3、4、5、6、7、8、9、12、24、36、48、60}。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'period_unit' => [ + 'title' => '节点包年包月周期。', + 'description' => '节点付费周期，当`instance_charge_type`取值为`PrePaid`时时候需要指定周期。'."\n" + ."\n" + .'- `Month`：以月为计时单位。'."\n" + .'- `Week`：以周为计算单位。', + 'type' => 'string', + 'example' => 'Month', + ], + 'auto_renew' => [ + 'title' => '节点是否开启自动续费', + 'description' => '节点是否开启自动续费，当`instance_charge_type`取值为`PrePaid`时才生效，取值：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'auto_renew_period' => [ + 'title' => '节点自动续费周期', + 'description' => '单次自动续费的续费时长。取值范围：'."\n" + .'- PeriodUnit=Week 时：1、2、3。'."\n" + .'- PeriodUnit=Month 时：1、2、3、6、12、24、36、48、60。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'spot_strategy' => [ + 'title' => '抢占式实例类型', + 'description' => '抢占式实例类型，取值：'."\n" + .'- NoSpot：非抢占式实例。'."\n" + .'- SpotWithPriceLimit：设置抢占实例价格上限。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。'."\n" + ."\n" + .'更多信息，请参见[抢占式实例](~~157759~~)。'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'spot_price_limit' => [ + 'title' => '抢占实例价格上限配置。', + 'description' => '抢占实例市场价格区间配置。', + 'type' => 'array', + 'items' => [ + 'description' => '抢占实例市场价格区间配置，可为不同实例规格设置不同的价格区间。', + 'type' => 'object', + 'properties' => [ + 'instance_type' => [ + 'title' => '抢占实例规格。', + 'description' => '抢占式实例规格。', + 'type' => 'string', + 'example' => 'ecs.c6.large', + ], + 'price_limit' => [ + 'title' => '抢占实例单价。', + 'description' => '单台实例市场价格。'."\n" + ."\n" + .'<props="china">单位：元/时。'."\n" + ."\n" + .'</props>'."\n" + ."\n\n" + .'<props="intl">单位：美元/时。</props>'."\n", + 'type' => 'string', + 'example' => '0.39', + ], + ], + ], + ], + 'image_type' => [ + 'title' => '操作系统发行版类型，推荐使用该字段指定节点操作系统。取值：CentOS、AliyunLinux、AliyunLinux Qboot、AliyunLinuxUEFI、AliyunLinux3、Windows、WindowsCore、AliyunLinux3Arm64、ContainerOS。', + 'description' => '操作系统镜像类型。'."\n" + .'- `AliyunLinux`：Alinux2镜像。'."\n" + .'- `AliyunLinuxSecurity`：Alinux2镜像UEFI版。'."\n" + .'- `AliyunLinux3`：Alinux3镜像。'."\n" + .'- `AliyunLinux3Arm64`：Alinux3镜像ARM版。'."\n" + .'- `AliyunLinux3Security`：Alinux3镜像UEFI版。'."\n" + .'- `CentOS`：CentOS镜像。'."\n" + .'- `Windows`：Windows镜像。'."\n" + .'- `WindowsCore`：WindowsCore镜像。'."\n" + .'- `ContainerOS`：容器优化镜像。'."\n" + .'- `AliyunLinux3ContainerOptimized`: Alinux3镜像容器优化版。', + 'type' => 'string', + 'example' => 'AliyunLinux3', + ], + 'image_id' => [ + 'title' => '自定义镜像。', + 'description' => '自定义镜像ID。', + 'type' => 'string', + 'example' => 'aliyun_3_x64_20G_alibase_20241218.vhd', + ], + 'system_disk_category' => [ + 'title' => '节点系统盘类型。', + 'description' => '节点系统盘类型，取值：'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL 云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'system_disk_categories' => [ + 'title' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。取值范围：cloud：普通云盘。cloud_efficiency：高效云盘。cloud_ssd：SSD云盘。cloud_essd：ESSD云盘。', + 'description' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。', + 'type' => 'array', + 'items' => [ + 'title' => '节点系统盘类型', + 'description' => '节点系统盘类型。'."\n" + ."\n" + .'取值：'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL 云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。', + 'type' => 'string', + 'example' => 'cloud_essd', + 'enum' => [], + ], + 'required' => false, + 'maxItems' => 10, + ], + 'system_disk_size' => [ + 'title' => '节点系统盘大小。', + 'description' => '节点系统盘大小，单位为GiB。'."\n" + ."\n" + .'取值范围：\\[20,2048\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'system_disk_performance_level' => [ + 'title' => '节点系统盘磁盘性能，只针对ESSD磁盘生效', + 'description' => '节点系统盘磁盘性能，只对ESSD磁盘生效。磁盘性能等级和磁盘大小有关。更多信息，请参见[ESSD云盘](~~122389~~)。'."\n" + .'- PL0：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL1：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL2：并发极限I/O性能较高，读写时延稳定。'."\n" + .'- PL3：并发极限I/O性能极高，读写时延极稳定。', + 'type' => 'string', + 'example' => 'PL1', + ], + 'system_disk_encrypted' => [ + 'title' => '是否加密系统盘。取值范围：true：加密。false：不加密。', + 'description' => '是否加密系统盘。取值：'."\n" + .'- `true`：加密。'."\n" + .'- `false`：不加密。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'system_disk_kms_key_id' => [ + 'title' => '系统盘使用的KMS密钥ID。', + 'description' => '系统盘使用的KMS密钥ID。', + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'system_disk_encrypt_algorithm' => [ + 'title' => '系统盘采用的加密算法。取值范围：aes-256。', + 'description' => '系统盘采用的加密算法。取值范围：aes-256。', + 'type' => 'string', + 'example' => 'aes-256', + 'enum' => [], + ], + 'system_disk_bursting_enabled' => [ + 'title' => '节点系统盘是否开启Burst（性能突发），磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘是否开启Burst（性能突发）。 取值：'."\n" + .'- true：开启。开启后，波动性业务面临突发的数据读写压力时，云盘会根据业务实际情况临时提升云盘性能，直至业务恢复至平稳状态。'."\n" + .'- false：不开启。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'system_disk_provisioned_iops' => [ + 'title' => '节点系统盘预配置的读写IOPS，磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘预配置的读写IOPS。'."\n" + ."\n" + .'可能值：0~min{50,000, 1000\\*容量-基准性能}。 基准性能=min{1,800+50\\*容量, 50000}。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'data_disks' => [ + 'title' => '数据盘配置。', + 'description' => '节点数据盘类型、大小等配置的组合。', + 'type' => 'array', + 'items' => [ + 'description' => '节点数据盘配置。', + '$ref' => '#/components/schemas/data_disk', + ], + ], + 'disk_init' => [ + 'title' => '块设备初始化配置。', + 'description' => '块设备初始化配置。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/DiskInit', + ], + ], + 'security_group_ids' => [ + 'title' => '多安全组ID', + 'description' => '节点池安全组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点池安全组ID。', + 'type' => 'string', + 'example' => 'sg-2ze60ockeekspl3d****', + ], + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。', + 'description' => '密钥对名称，和`login_password`二选一。当节点池为托管版节点池时，只支持`key_pair`。', + 'type' => 'string', + 'example' => 'pro-nodepool', + ], + 'login_password' => [ + 'title' => 'SSH登录密码。', + 'description' => 'SSH登录密码，和`key_pair`二选一。密码规则为8~30个字符，且至少同时包含三项（大小写字母、数字和特殊符号）。'."\n" + ."\n" + .'出于安全性考虑，密码查询结果经过加密处理。', + 'type' => 'string', + 'example' => '********', + ], + 'login_as_non_root' => [ + 'title' => '弹出的ECS实例是否使用以非root用户登陆。', + 'description' => '弹出的ECS实例是否使用以非root用户登录。'."\n" + ."\n" + .'- true：以非root用户（ecs-user）登录。'."\n" + ."\n" + .'- false：以root用户登录。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cis_enabled' => [ + 'title' => '【已废弃】请使用security_hardening_os参数代替', + 'description' => '【该字段已废弃】请使用参数security_hardening_os替代。', + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'false', + ], + 'soc_enabled' => [ + 'title' => '是否开启等保加固，仅当系统镜像选择Alibaba Cloud Linux 2或Alibaba Cloud Linux 3时，可为节点开启等保加固。阿里云为Alibaba Cloud Linux 2和Alibaba Cloud Linux 3等保2.0三级版镜像提供等保合规的基线检查标准和扫描程序。', + 'description' => '是否开启等保加固，仅当系统镜像选择Alibaba Cloud Linux 2或Alibaba Cloud Linux 3时，可为节点开启等保加固。阿里云为Alibaba Cloud Linux 2和Alibaba Cloud Linux 3等保2.0三级版镜像提供等保合规的基线检查标准和扫描程序。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'security_hardening_os' => [ + 'title' => '是否开启阿里云OS安全加固。', + 'description' => '阿里云OS安全加固。取值：'."\n" + ."\n" + .'- `true`：开启阿里云OS安全加固。'."\n" + .'- `false`：不开启阿里云OS安全加固。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'internet_charge_type' => [ + 'title' => '节点公网IP网络计费类型', + 'description' => '节点公网IP网络计费类型。'."\n" + ."\n" + .'- PayByBandwidth：按固定带宽计费。'."\n" + .'- PayByTraffic：按使用流量计费。', + 'type' => 'string', + 'example' => 'PayByBandwidth', + ], + 'internet_max_bandwidth_out' => [ + 'title' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：1~100', + 'description' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：1~100。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'tags' => [ + 'title' => 'ECS标签', + 'description' => 'ECS实例标签。', + 'type' => 'array', + 'items' => [ + 'description' => '节点标签。', + '$ref' => '#/components/schemas/tag', + ], + ], + 'desired_size' => [ + 'title' => '节点池期望节点数', + 'description' => '节点池期望节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'multi_az_policy' => [ + 'title' => '多可用区伸缩组ECS实例扩缩容策略', + 'description' => '多可用区伸缩组ECS实例扩缩容策略。取值：'."\n" + ."\n" + .'- `PRIORITY`：根据您定义的虚拟交换机（VSwitchIds.N）扩缩容。当优先级较高的虚拟交换机所在可用区无法创建ECS实例时，自动使用下一优先级的虚拟交换机创建ECS实例。'."\n" + ."\n" + .'- `COST_OPTIMIZED`：按vCPU单价从低到高进行尝试创建。当伸缩配置设置了抢占式计费方式的多实例规格时，优先创建对应抢占式实例。您可以继续通过`CompensateWithOnDemand`参数指定当抢占式实例由于库存等原因无法创建时，是否自动尝试以按量付费的方式创建。'."\n" + ."\n" + .' >`COST_OPTIMIZED`仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。'."\n" + ."\n" + .'- `BALANCE`：在伸缩组指定的多可用区之间均匀分配ECS实例。如果由于库存不足等原因可用区之间变得不平衡，您可以通过API RebalanceInstances平衡资源。更多信息，请参见[RebalanceInstances](~~71516~~)。'."\n" + ."\n" + .'默认值：`PRIORITY`。', + 'type' => 'string', + 'example' => 'BALANCE', + ], + 'scaling_policy' => [ + 'title' => '扩容策略。', + 'description' => '伸缩组模式，取值：'."\n" + ."\n" + .'- `release`：标准模式，根据申请资源值的使用量，通过创建、释放ECS的方式进行伸缩。'."\n" + .'- `recycle`：极速模式，通过创建、停机、启动的方式进行伸缩，提高再次伸缩的速度（停机时计算资源不收费，只收取存储费用，本地盘机型除外）。', + 'type' => 'string', + 'example' => 'release', + ], + 'on_demand_base_capacity' => [ + 'title' => '伸缩组所需要按量实例个数的最小值，取值范围：0~1000。当按量实例个数少于该值时，将优先创建按量实例。', + 'description' => '伸缩组所需要按量实例个数的最小值，取值范围：\\[0,1000\\]。当按量实例个数少于该值时，将优先创建按量实例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'on_demand_percentage_above_base_capacity' => [ + 'title' => '伸缩组满足最小按量实例数（OnDemandBaseCapacity）要求后，超出的实例中按量实例应占的比例，取值范围：0～100。', + 'description' => '伸缩组满足最小按量实例数（`on_demand_base_capacity`）要求后，超出的实例中按量实例应占的比例。取值范围：\\[0,100\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'spot_instance_pools' => [ + 'title' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：1~10。', + 'description' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：\\[1,10\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'spot_instance_remedy' => [ + 'title' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。', + 'description' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。取值：'."\n" + ."\n" + .'- `true`：开启补齐抢占式实例。'."\n" + .'- `false`：不开启补齐抢占式实例。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'compensate_with_on_demand' => [ + 'title' => '当MultiAZPolicy取值为COST_OPTIMIZED时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值范围：true：允许。false：不允许。默认值：true', + 'description' => '当`multi_az_policy`取值为`COST_OPTIMIZED`时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值：'."\n" + ."\n" + .'- `true`：允许自动尝试创建按量实例满足ECS实例数量要求。'."\n" + .'- `false`：不允许自动尝试创建按量实例满足ECS实例数量要求。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'deploymentset_id' => [ + 'title' => '部署集ID。', + 'description' => '部署集ID。', + 'type' => 'string', + 'example' => 'ds-bp1d19mmbsv3jf6xxxxx', + ], + 'rds_instances' => [ + 'title' => 'RDS实例列表。', + 'description' => '如果指定了RDS实例列表，集群节点ECS会自动加入RDS访问白名单。', + 'type' => 'array', + 'items' => [ + 'description' => 'RDS实例。', + 'type' => 'string', + 'example' => 'rm-xxx', + ], + ], + 'private_pool_options' => [ + 'title' => '私有池选项。', + 'description' => '私有节点池配置。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '私有池ID。即弹性保障服务ID或容量预定服务ID。', + 'description' => '私有节点池ID。', + 'type' => 'string', + 'example' => 'eap-bp67acfmxazb4****', + ], + 'match_criteria' => [ + 'title' => '实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值范围： Open：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。该模式下无需设置PrivatePoolOptions.Id参数。 Target：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。该模式下必须指定私有池ID，即PrivatePoolOptions.Id参数为必填项。 None：不使用模式。实例启动将不使用私有池容量。', + 'description' => '私有节点池类型，实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值：'."\n" + ."\n" + .'- `Open`：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。'."\n" + ."\n" + .'- `Target`：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。'."\n" + ."\n" + .'- `None`：不使用模式。实例启动将不使用私有池容量。', + 'type' => 'string', + 'example' => 'Open', + ], + ], + ], + 'security_group_id' => [ + 'title' => '【该字段已废弃】请使用security_group_ids替代'."\n" + .'安全组ID。', + 'description' => '节点池安全组ID，当节点池绑定了多个安全组时，为`security_group_ids`中的第一个值。', + 'type' => 'string', + 'example' => 'sg-2ze60ockeekspl3d****', + ], + 'platform' => [ + 'title' => '【该字段已废弃】请使用image_type替代'."\n" + .'操作系统发行版，和image_type二选一', + 'description' => '操作系统发行版。取值：'."\n" + ."\n" + .'- `CentOS`'."\n" + .'- `AliyunLinux`'."\n" + .'- `Windows`'."\n" + .'- `WindowsCore`', + 'type' => 'string', + 'example' => 'AliyunLinux', + ], + 'ram_policy' => [ + 'title' => '该字段已废弃，请改为使用 ram_role_name 字段。', + 'description' => '【该字段已废弃】请使用ram_role_name替代。', + 'type' => 'string', + 'example' => 'KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****', + ], + 'instance_patterns' => [ + 'title' => '实例属性', + 'description' => '实例属性配置。', + 'type' => 'array', + 'items' => [ + 'title' => '实例属性', + 'description' => '实例属性。', + '$ref' => '#/components/schemas/instance_patterns', + ], + ], + 'ram_role_name' => [ + 'title' => 'Worker RAM角色名称。', + 'description' => 'Worker RAM角色名称。', + 'type' => 'string', + 'example' => 'KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****', + ], + 'instance_metadata_options' => [ + 'title' => 'ECS 实例的元数据访问配置。', + 'description' => 'ECS 实例的元数据访问配置。', + '$ref' => '#/components/schemas/InstanceMetadataOptions', + ], + 'resource_pool_options' => [ + 'title' => '创建实例时使用的资源池及资源池策略。', + 'description' => '创建实例时使用的资源池及资源池策略。', + 'type' => 'object', + 'properties' => [ + 'private_pool_ids' => [ + 'title' => '私有池 ID列表。', + 'description' => '私有池 ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '私有池 ID。', + 'description' => '私有池 ID。', + 'type' => 'string', + ], + ], + 'strategy' => [ + 'title' => '创建实例时使用的资源池策略。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。'."\n" + .'PrivatePoolOnly：仅限私有池。'."\n" + .'None：不使用资源池策略。', + 'description' => '创建实例时使用的资源池策略。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。'."\n" + .'PrivatePoolOnly：仅限私有池。'."\n" + .'None：不使用资源池策略。', + 'type' => 'string', + 'example' => 'PrivatePoolFirst', + 'enum' => [ + 'PrivatePoolFirst', + 'PrivatePoolOnly', + 'None', + ], + ], + ], + ], + 'system_disk_snapshot_policy_id' => [ + 'title' => '系统盘快照策略', + 'description' => '系统盘快照策略', + 'type' => 'string', + ], + ], + ], + 'node_config' => [ + 'title' => '节点配置', + 'description' => '节点配置。', + 'type' => 'object', + 'properties' => [ + 'kubelet_configuration' => [ + 'title' => 'Kubelet参数配置。', + 'description' => 'Kubelet参数配置。', + '$ref' => '#/components/schemas/kubelet_config', + ], + 'node_os_config' => [ + 'type' => 'object', + 'properties' => [ + 'hugepage' => [ + '$ref' => '#/components/schemas/Hugepage', + ], + ], + ], + ], + ], + 'kubernetes_config' => [ + 'title' => '集群配置', + 'description' => '集群相关配置。', + 'type' => 'object', + 'properties' => [ + 'labels' => [ + 'title' => '节点标签。', + 'description' => '节点标签。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS标签。', + '$ref' => '#/components/schemas/tag', + ], + ], + 'taints' => [ + 'title' => '污点信息。', + 'description' => '节点污点信息。污点和容忍度（Toleration）相互配合，可以用来避免Pod被分配到不合适的节点上。更多信息，请参见[taint-and-toleration](https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/)。', + 'type' => 'array', + 'items' => [ + 'description' => '节点污点配置。', + '$ref' => '#/components/schemas/taint', + ], + ], + 'runtime' => [ + 'title' => '容器运行时。', + 'description' => '容器运行时名称，ACK 支持以下三种容器运行时。'."\n" + ."\n" + .'- containerd：推荐使用，支持所有集群版本。'."\n" + .'- Sandboxed-Container.runv：安全沙箱容器，提供更高的隔离性，支持 1.31 及以下版本集群。'."\n" + .'- docker：已停止维护，支持1.22及以下版本集群。', + 'type' => 'string', + 'example' => 'containerd', + ], + 'runtime_version' => [ + 'title' => '容器运行时版本。', + 'description' => '容器运行时版本。', + 'type' => 'string', + 'example' => '1.6.38', + ], + 'cpu_policy' => [ + 'title' => 'CPU管理策略。', + 'description' => '节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略：'."\n" + ."\n" + .'- `static`：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + .'- `none`：表示启用现有的默认CPU亲和性方案。', + 'type' => 'string', + 'example' => 'none', + ], + 'user_data' => [ + 'title' => '节点自定义数据。', + 'description' => '节点池自定义数据，即运行于节点初始化之后的脚本。更多详情，请参见[生成实例自定义数据](~~49121~~)。', + 'type' => 'string', + 'example' => 'IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi', + ], + 'unschedulable' => [ + 'title' => '扩容后的节点是否可调度。', + 'description' => '扩容后的节点是否不可调度。'."\n" + ."\n" + .'- true：不可调度。'."\n" + ."\n" + .'- false：可调度。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cms_enabled' => [ + 'title' => '是否开启云监控。', + 'description' => '是否在ECS节点上安装云监控，安装后可以在云监控控制台查看所创建ECS实例的监控信息，推荐开启。取值：'."\n" + ."\n" + .'- `true`：在ECS节点上安装云监控。'."\n" + .'- `false`：不在ECS节点上安装云监控。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'node_name_mode' => [ + 'title' => '自定义节点名称', + 'description' => '自定义节点名称。'."\n" + ."\n" + .'节点名称由三部分组成：前缀 \\+ 节点 IP 地址子串 \\+ 后缀：'."\n" + .' '."\n" + .'- 前缀和后缀均可由“.”分隔的一个或多个部分构成，每个部分可以使用小写字母、数字和“-”，节点名称首尾必须为小写字母和数字。'."\n" + .'- IP 地址段长度指截取节点 IP 地址末尾的位数，取值范围 5-12。'."\n" + .' '."\n" + .'例如，节点 IP 地址为：192.168.0.55，指定前缀为 aliyun.com，IP 地址段长度为 5，后缀为 test，则节点名称为aliyun.com00055test。', + 'type' => 'string', + 'example' => 'aliyun.com192.XX.YY.55test', + ], + 'pre_user_data' => [ + 'description' => '节点池预自定义数据，即运行于节点初始化之前的脚本。更多详情，请参见[生成实例自定义数据](~~49121~~)。', + 'type' => 'string', + 'example' => 'dGhpcyBpcyBhIGV4YW1wbGU'."\n", + ], + ], + ], + 'tee_config' => [ + 'title' => '加密计算节点池信息。', + 'description' => '加密计算节集群配置。', + 'type' => 'object', + 'properties' => [ + 'tee_enable' => [ + 'title' => '是否为加密计算节点池。', + 'description' => '是否开启加密计算集群，取值：'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：不开启。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'interconnect_config' => [ + 'title' => '边缘节点池网络相关的配置。该值只对edge类型的节点池有意义', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘节点池网络相关的配置。该值只对edge类型的节点池有意义。', + 'type' => 'object', + 'properties' => [ + 'cen_id' => [ + 'title' => '边缘增强型节点池绑定的云企业网实例ID(CENID)', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云企业网实例ID (CENID)。', + 'type' => 'string', + 'example' => 'cen-ey9k9nfhz0f*******', + ], + 'ccn_id' => [ + 'title' => '边缘增强型节点池绑定的云连接网实例ID(CCNID)', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云连接网实例ID (CCNID)。', + 'type' => 'string', + 'example' => 'ccn-qm5i0i0q9yi*******', + ], + 'ccn_region_id' => [ + 'title' => '边缘增强型节点池绑定的云连接网实例所属的区域', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云连接网实例所属的区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'bandwidth' => [ + 'title' => '边缘增强型节点池的网络带宽，单位M', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池的网络带宽，单位为Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'improved_period' => [ + 'title' => '边缘增强型节点池的购买时长，单位月', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池的购买时长，单位为月。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'max_nodes' => [ + 'title' => '边缘节点池允许容纳的最大节点数量. 节点池内可以容纳的最大节点数量，该参数大于等于0。0表示无额外限制(仅受限于集群整体可以容纳的节点数，节点池本身无额外限制)。边缘节点池该参数值往往大于0；ess类型节点池和默认的edge类型节点池该参数值为0', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘节点池允许容纳的最大节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'interconnect_mode' => [ + 'title' => '边缘节点池的网络类型。basic：基础型；improved：增强型。该值只对edge类型的节点池有意义', + 'description' => '边缘节点池的网络类型，该参数仅对`type`为`edge`类型的节点池生效，取值范围：'."\n" + ."\n" + .'- `basic`：公网。节点池内的节点通过公网与云端节点进行交互，节点池内应用不能直接访问云端VPC内网。'."\n" + .'- `private`：专用网络。节点池内的节点通过专线、VPN或CEN等方式实现云上与云下网络打通，拥有更高的云边通信质量，提供更有效的安全保障。', + 'type' => 'string', + 'example' => 'basic', + ], + 'host_network' => [ + 'title' => '边缘节点池内的Pod是否都采用主机网络模式部署。', + 'description' => 'Pod网络模式是否采用主机网络模式。'."\n" + .'- `true`：主机网络。Pod直接使用主机的网络栈，与主机共享IP地址和端口。'."\n" + .'- `false`：容器网络。Pod拥有独立的网络栈，不占用主机网络端口。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'intranet' => [ + 'title' => '边缘节点池内的所有节点在三层网络上是否互通。', + 'description' => '边缘节点池内，节点之间是否三层网络互通。'."\n" + .'- `true`：互通。该节点池内的所有节点之间三层网络互通。'."\n" + .'- `false`：不互通。该节点池内的所有主机之间三层网络不互通。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_mode' => [ + 'title' => '智能托管配置。', + 'description' => '智能托管配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启智能托管。', + 'description' => '是否开启', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'node_components' => [ + 'title' => '节点组件列表。', + 'description' => '节点组件列表。', + 'type' => 'array', + 'items' => [ + 'title' => '节点组件。', + 'description' => '节点组件。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '节点组件名称。', + 'description' => '节点组件名称。', + 'type' => 'string', + 'example' => 'kubelet', + ], + 'version' => [ + 'title' => '节点组件版本。', + 'description' => '节点组件版本。', + 'type' => 'string', + 'example' => '1.33.3-aliyun.1', + ], + 'config' => [ + 'title' => '节点组件配置。', + 'description' => '节点组件配置。', + 'type' => 'object', + 'properties' => [ + 'custom_config' => [ + 'title' => '节点组件自定义配置。', + 'description' => '节点组件自定义配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'cpuManagerPolicy', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"nodepool_info\\": {\\n \\"nodepool_id\\": \\"np615c0e0966124216a0412e10afe0****\\",\\n \\"name\\": \\"default-nodepool\\",\\n \\"type\\": \\"ess\\",\\n \\"is_default\\": true,\\n \\"resource_group_id\\": \\"rg-acfmyvw3wjmb****\\",\\n \\"region_id\\": \\"cn-beijing\\",\\n \\"created\\": \\"2025-04-10T14:25:37.285530433+08:00\\",\\n \\"updated\\": \\"2025-04-15T15:39:45.41+08:00\\"\\n },\\n \\"status\\": {\\n \\"state\\": \\"active\\",\\n \\"healthy_nodes\\": 3,\\n \\"initial_nodes\\": 0,\\n \\"failed_nodes\\": 0,\\n \\"offline_nodes\\": 0,\\n \\"removing_nodes\\": 0,\\n \\"serving_nodes\\": 3,\\n \\"total_nodes\\": 3,\\n \\"conditions\\": [\\n {\\n \\"type\\": \\"\\",\\n \\"status\\": \\"\\",\\n \\"reason\\": \\"\\",\\n \\"message\\": \\"\\",\\n \\"last_transition_time\\": \\"\\"\\n }\\n ]\\n },\\n \\"auto_scaling\\": {\\n \\"enable\\": true,\\n \\"type\\": \\"cpu\\",\\n \\"max_instances\\": 10,\\n \\"min_instances\\": 1,\\n \\"eip_internet_charge_type\\": \\"PayByBandwidth\\",\\n \\"is_bond_eip\\": true,\\n \\"eip_bandwidth\\": 5\\n },\\n \\"management\\": {\\n \\"enable\\": true,\\n \\"auto_repair\\": true,\\n \\"auto_repair_policy\\": {\\n \\"restart_node\\": true,\\n \\"approval_required\\": false,\\n \\"auto_repair_policy_id\\": \\"r-xxxxxxxxxx\\"\\n },\\n \\"auto_vul_fix\\": true,\\n \\"auto_vul_fix_policy\\": {\\n \\"restart_node\\": true,\\n \\"vul_level\\": \\"asap,nntf\\",\\n \\"exclude_packages\\": \\"\\"\\n },\\n \\"auto_upgrade\\": true,\\n \\"auto_upgrade_policy\\": {\\n \\"auto_upgrade_kubelet\\": true\\n },\\n \\"upgrade_config\\": {\\n \\"auto_upgrade\\": true,\\n \\"surge\\": 5,\\n \\"surge_percentage\\": 50,\\n \\"max_unavailable\\": 1\\n }\\n },\\n \\"scaling_group\\": {\\n \\"scaling_group_id\\": \\"asg-2zeieod8giqmov7z****\\",\\n \\"vswitch_ids\\": [\\n \\"vsw-2ze3ds0mdip0hdz8i****\\"\\n ],\\n \\"instance_types\\": [\\n \\"ecs.n4.large\\"\\n ],\\n \\"instance_charge_type\\": \\"PostPaid\\",\\n \\"period\\": 0,\\n \\"period_unit\\": \\"Month\\",\\n \\"auto_renew\\": false,\\n \\"auto_renew_period\\": 1,\\n \\"spot_strategy\\": \\"NoSpot\\",\\n \\"spot_price_limit\\": [\\n {\\n \\"instance_type\\": \\"ecs.c6.large\\",\\n \\"price_limit\\": \\"0.39\\"\\n }\\n ],\\n \\"image_type\\": \\"AliyunLinux3\\",\\n \\"image_id\\": \\"aliyun_3_x64_20G_alibase_20241218.vhd\\",\\n \\"system_disk_category\\": \\"cloud_efficiency\\",\\n \\"system_disk_categories\\": [\\n \\"cloud_essd\\"\\n ],\\n \\"system_disk_size\\": 120,\\n \\"system_disk_performance_level\\": \\"PL1\\",\\n \\"system_disk_encrypted\\": false,\\n \\"system_disk_kms_key_id\\": \\"0e478b7a-4262-4802-b8cb-00d3fb40****\\",\\n \\"system_disk_encrypt_algorithm\\": \\"aes-256\\",\\n \\"system_disk_bursting_enabled\\": true,\\n \\"system_disk_provisioned_iops\\": 1000,\\n \\"data_disks\\": [\\n {\\n \\"category\\": \\"cloud_ssd\\",\\n \\"size\\": 40,\\n \\"encrypted\\": \\"true\\",\\n \\"kms_key_id\\": \\"0e478b7a-4262-4802-b8cb-00d3fb40****\\",\\n \\"auto_snapshot_policy_id\\": \\"sp-2zej1nogjvovnz4z****\\",\\n \\"performance_level\\": \\"PL1\\",\\n \\"provisioned_iops\\": 1000,\\n \\"bursting_enabled\\": true,\\n \\"auto_format\\": true,\\n \\"file_system\\": \\"ext4\\",\\n \\"mount_target\\": \\"/mnt/path1\\",\\n \\"disk_name\\": \\"DataDiskName\\",\\n \\"device\\": \\"/dev/xvdb\\",\\n \\"snapshot_id\\": \\"s-280s7****\\"\\n }\\n ],\\n \\"disk_init\\": [\\n {\\n \\"disk_name\\": \\"disk0\\",\\n \\"mkfs_type\\": \\"ext4\\",\\n \\"mount_target\\": \\"/mnt/disk0\\",\\n \\"mount_for_runtime\\": true,\\n \\"local_disk\\": true\\n }\\n ],\\n \\"security_group_ids\\": [\\n \\"sg-2ze60ockeekspl3d****\\"\\n ],\\n \\"key_pair\\": \\"pro-nodepool\\",\\n \\"login_password\\": \\"********\\",\\n \\"login_as_non_root\\": true,\\n \\"cis_enabled\\": false,\\n \\"soc_enabled\\": false,\\n \\"security_hardening_os\\": false,\\n \\"internet_charge_type\\": \\"PayByBandwidth\\",\\n \\"internet_max_bandwidth_out\\": 10,\\n \\"tags\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ],\\n \\"desired_size\\": 2,\\n \\"multi_az_policy\\": \\"BALANCE\\",\\n \\"scaling_policy\\": \\"release\\",\\n \\"on_demand_base_capacity\\": 0,\\n \\"on_demand_percentage_above_base_capacity\\": 20,\\n \\"spot_instance_pools\\": 5,\\n \\"spot_instance_remedy\\": false,\\n \\"compensate_with_on_demand\\": true,\\n \\"deploymentset_id\\": \\"ds-bp1d19mmbsv3jf6xxxxx\\",\\n \\"rds_instances\\": [\\n \\"rm-xxx\\"\\n ],\\n \\"private_pool_options\\": {\\n \\"id\\": \\"eap-bp67acfmxazb4****\\",\\n \\"match_criteria\\": \\"Open\\"\\n },\\n \\"security_group_id\\": \\"sg-2ze60ockeekspl3d****\\",\\n \\"platform\\": \\"AliyunLinux\\",\\n \\"ram_policy\\": \\"KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****\\",\\n \\"instance_patterns\\": [\\n {\\n \\"cores\\": 4,\\n \\"memory\\": 8,\\n \\"instance_family_level\\": \\"EnterpriseLevel\\",\\n \\"excluded_instance_types\\": [\\n \\"ecs.c6.large\\"\\n ],\\n \\"min_cpu_cores\\": 4,\\n \\"max_cpu_cores\\": 8,\\n \\"min_memory_size\\": 8,\\n \\"max_memory_size\\": 16,\\n \\"instance_categories\\": [\\n \\"General-purpose\\"\\n ],\\n \\"cpu_architectures\\": [\\n \\"X86\\"\\n ],\\n \\"core\\": 4,\\n \\"max_price\\": 2,\\n \\"architectures\\": [\\n \\"X86\\"\\n ],\\n \\"burst_performance_option\\": \\"Exclude\\",\\n \\"instance_type_families\\": [\\n \\"\\"\\n ],\\n \\"minimum_eni_quantity\\": 0,\\n \\"minimum_eni_private_ip_address_quantity\\": 0,\\n \\"minimum_eni_ipv6_address_quantity\\": 0,\\n \\"maximum_gpu_amount\\": 0\\n }\\n ],\\n \\"ram_role_name\\": \\"KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****\\",\\n \\"instance_metadata_options\\": {\\n \\"http_tokens\\": \\"optional\\"\\n },\\n \\"resource_pool_options\\": {\\n \\"private_pool_ids\\": [\\n \\"\\"\\n ],\\n \\"strategy\\": \\"PrivatePoolFirst\\"\\n },\\n \\"system_disk_snapshot_policy_id\\": \\"\\"\\n },\\n \\"node_config\\": {\\n \\"kubelet_configuration\\": {\\n \\"registryPullQPS\\": 5,\\n \\"registryBurst\\": 10,\\n \\"eventRecordQPS\\": 5,\\n \\"eventBurst\\": 10,\\n \\"kubeAPIQPS\\": 5,\\n \\"kubeAPIBurst\\": 10,\\n \\"serializeImagePulls\\": true,\\n \\"cpuManagerPolicy\\": \\"none\\",\\n \\"evictionHard\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"evictionSoft\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"evictionSoftGracePeriod\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"systemReserved\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"kubeReserved\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"readOnlyPort\\": 0,\\n \\"maxPods\\": 110,\\n \\"containerLogMaxSize\\": \\"10Mi\\",\\n \\"containerLogMaxFiles\\": 5,\\n \\"featureGates\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"allowedUnsafeSysctls\\": [\\n \\"\\"\\n ],\\n \\"reservedMemory\\": [\\n {\\n \\"numaNode\\": 0,\\n \\"limits\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"memoryManagerPolicy\\": \\"none\\",\\n \\"cpuCFSQuota\\": true,\\n \\"cpuCFSQuotaPeriod\\": \\"100ms\\",\\n \\"imageGCHighThresholdPercent\\": 85,\\n \\"imageGCLowThresholdPercent\\": 80,\\n \\"podPidsLimit\\": -1,\\n \\"topologyManagerPolicy\\": \\"restricted\\",\\n \\"clusterDNS\\": [\\n \\"\\"\\n ],\\n \\"tracing\\": {\\n \\"endpoint\\": \\"localhost:4317\\",\\n \\"samplingRatePerMillion\\": 0\\n },\\n \\"containerLogMaxWorkers\\": 1,\\n \\"containerLogMonitorInterval\\": \\"10s\\",\\n \\"serverTLSBootstrap\\": true\\n },\\n \\"node_os_config\\": {\\n \\"hugepage\\": {\\n \\"transparentEnabled\\": \\"\\",\\n \\"transparentDefrag\\": \\"\\",\\n \\"khugepagedDefrag\\": 0,\\n \\"khugepagedAllocSleepMillisecs\\": 0,\\n \\"khugepagedScanSleepMillisecs\\": 0,\\n \\"khugepagedPagesToScan\\": 0\\n }\\n }\\n },\\n \\"kubernetes_config\\": {\\n \\"labels\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ],\\n \\"taints\\": [\\n {\\n \\"key\\": \\"key\\",\\n \\"value\\": \\"value\\",\\n \\"effect\\": \\"NoSchedule\\"\\n }\\n ],\\n \\"runtime\\": \\"containerd\\",\\n \\"runtime_version\\": \\"1.6.38\\",\\n \\"cpu_policy\\": \\"none\\",\\n \\"user_data\\": \\"IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi\\",\\n \\"unschedulable\\": true,\\n \\"cms_enabled\\": true,\\n \\"node_name_mode\\": \\"aliyun.com192.XX.YY.55test\\",\\n \\"pre_user_data\\": \\"dGhpcyBpcyBhIGV4YW1wbGU\\\\n\\"\\n },\\n \\"tee_config\\": {\\n \\"tee_enable\\": false\\n },\\n \\"interconnect_config\\": {\\n \\"cen_id\\": \\"cen-ey9k9nfhz0f*******\\",\\n \\"ccn_id\\": \\"ccn-qm5i0i0q9yi*******\\",\\n \\"ccn_region_id\\": \\"cn-shanghai\\",\\n \\"bandwidth\\": 10,\\n \\"improved_period\\": \\"1\\"\\n },\\n \\"max_nodes\\": 10,\\n \\"interconnect_mode\\": \\"basic\\",\\n \\"host_network\\": true,\\n \\"intranet\\": true,\\n \\"auto_mode\\": {\\n \\"enable\\": false\\n },\\n \\"node_components\\": [\\n {\\n \\"name\\": \\"kubelet\\",\\n \\"version\\": \\"1.33.3-aliyun.1\\",\\n \\"config\\": {\\n \\"custom_config\\": {\\n \\"key\\": \\"cpuManagerPolicy\\"\\n }\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterNodePoolDetailResponse>\\n <auto_scaling>\\n <eip_bandwidth>5</eip_bandwidth>\\n <eip_internet_charge_type>PayByBandwidth</eip_internet_charge_type>\\n <enable>true</enable>\\n <is_bond_eip>true</is_bond_eip>\\n <max_instances>10</max_instances>\\n <min_instances>1</min_instances>\\n <type>cpu</type>\\n </auto_scaling>\\n <kubernetes_config>\\n <cms_enabled>true</cms_enabled>\\n <cpu_policy>none</cpu_policy>\\n <labels>\\n <key>env</key>\\n <value>prod</value>\\n </labels>\\n <runtime>docker</runtime>\\n <runtime_version>19.03.5</runtime_version>\\n <taints>\\n <key>key</key>\\n <value>value</value>\\n <effect>NoSchedule</effect>\\n </taints>\\n <user_data>IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFDSyEi</user_data>\\n <node_name_mode>customized,test.,5,.com</node_name_mode>\\n </kubernetes_config>\\n <nodepool_info>\\n <created>2020-09-27T19:14:09.156823496+08:00</created>\\n <is_default>true</is_default>\\n <name>default-nodepool</name>\\n <nodepool_id>np615c0e0966124216a0412e10afe0****</nodepool_id>\\n <region_id>cn-beijing</region_id>\\n <resource_group_id>rg-acfmyvw3wjmb****</resource_group_id>\\n <type>ess</type>\\n <updated>2020-09-27T20:37:46+08:00</updated>\\n </nodepool_info>\\n <scaling_group>\\n <auto_renew>false</auto_renew>\\n <auto_renew_period>1</auto_renew_period>\\n <data_disks>\\n <category>cloud_ssd</category>\\n <size>40</size>\\n <encrypted>true</encrypted>\\n <auto_snapshot_policy_id>sp-2zej1nogjvovnz4z****</auto_snapshot_policy_id>\\n <performance_level>PL1</performance_level>\\n <provisioned_iops>1000</provisioned_iops>\\n <bursting_enabled>true</bursting_enabled>\\n <auto_format>true</auto_format>\\n <file_system>ext4</file_system>\\n <mount_target>/mnt/path1</mount_target>\\n </data_disks>\\n <image_id>aliyun_2_1903_x64_20G_alibase_20200529.vhd</image_id>\\n <instance_charge_type>PostPaid</instance_charge_type>\\n <instance_types>ecs.n4.large</instance_types>\\n <multi_az_policy>BALANCE</multi_az_policy>\\n <on_demand_base_capacity>0</on_demand_base_capacity>\\n <on_demand_percentage_above_base_capacity>20</on_demand_percentage_above_base_capacity>\\n <spot_instance_pools>5</spot_instance_pools>\\n <spot_instance_remedy>false</spot_instance_remedy>\\n <compensate_with_on_demand>true</compensate_with_on_demand>\\n <period>0</period>\\n <period_unit>Month</period_unit>\\n <platform>AliyunLinux</platform>\\n <ram_policy>KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****</ram_policy>\\n <spot_strategy>NoSpot</spot_strategy>\\n <spot_price_limit>\\n <instance_type>ecs.c6.large</instance_type>\\n <price_limit>0.39</price_limit>\\n </spot_price_limit>\\n <rds_instances>rm-xxx</rds_instances>\\n <scaling_group_id>asg-2zeieod8giqmov7z****</scaling_group_id>\\n <scaling_policy>release</scaling_policy>\\n <security_group_id>sg-2ze60ockeekspl3d****</security_group_id>\\n <security_group_ids>sg-2ze60ockeekspl3d****</security_group_ids>\\n <system_disk_category>cloud_efficiency</system_disk_category>\\n <system_disk_size>120</system_disk_size>\\n <system_disk_performance_level>PL1</system_disk_performance_level>\\n <tags>\\n <key>env</key>\\n <value>prod</value>\\n </tags>\\n <vswitch_ids>vsw-2ze3ds0mdip0hdz8i****</vswitch_ids>\\n <login_password>********</login_password>\\n <key_pair>pro-nodepool</key_pair>\\n <internet_charge_type>PayByBandwidth</internet_charge_type>\\n <internet_max_bandwidth_out>10</internet_max_bandwidth_out>\\n <deploymentset_id>ds-bp1d19mmbsv3jf6xxxxx</deploymentset_id>\\n <desired_size>2</desired_size>\\n <private_pool_options>\\n <id>eap-bp67acfmxazb4****</id>\\n <match_criteria>Open</match_criteria>\\n </private_pool_options>\\n </scaling_group>\\n <status>\\n <failed_nodes>0</failed_nodes>\\n <healthy_nodes>3</healthy_nodes>\\n <initial_nodes>0</initial_nodes>\\n <offline_nodes>0</offline_nodes>\\n <removing_nodes>0</removing_nodes>\\n <serving_nodes>3</serving_nodes>\\n <state>active</state>\\n <total_nodes>3</total_nodes>\\n </status>\\n <tee_config>\\n <tee_enable>false</tee_enable>\\n </tee_config>\\n <management>\\n <enable>true</enable>\\n <auto_repair>true</auto_repair>\\n <upgrade_config>\\n <auto_upgrade>true</auto_upgrade>\\n <surge>5</surge>\\n <surge_percentage>50</surge_percentage>\\n <max_unavailable>1</max_unavailable>\\n </upgrade_config>\\n <auto_repair_policy>\\n <restart_node>true</restart_node>\\n </auto_repair_policy>\\n <auto_vul_fix>true</auto_vul_fix>\\n <auto_vul_fix_policy>\\n <restart_node>true</restart_node>\\n <vul_level>asap,nntf</vul_level>\\n </auto_vul_fix_policy>\\n <auto_upgrade>true</auto_upgrade>\\n <auto_upgrade_policy>\\n <auto_upgrade_kubelet>true</auto_upgrade_kubelet>\\n </auto_upgrade_policy>\\n </management>\\n <interconnect_config>\\n <cen_id>cen-ey9k9nfhz0f*******</cen_id>\\n <ccn_id>ccn-qm5i0i0q9yi*******</ccn_id>\\n <ccn_region_id>cn-shanghai</ccn_region_id>\\n <bandwidth>10</bandwidth>\\n <improved_period>1</improved_period>\\n </interconnect_config>\\n <interconnect_mode>basic</interconnect_mode>\\n <max_nodes>10</max_nodes>\\n <node_config>\\n <kubelet_configuration>\\n <registryPullQPS>5</registryPullQPS>\\n <registryBurst>10</registryBurst>\\n <eventRecordQPS>5</eventRecordQPS>\\n <eventBurst>10</eventBurst>\\n <kubeAPIQPS>5</kubeAPIQPS>\\n <kubeAPIBurst>10</kubeAPIBurst>\\n <serializeImagePulls>true</serializeImagePulls>\\n <cpuManagerPolicy>none</cpuManagerPolicy>\\n <readOnlyPort>0</readOnlyPort>\\n <maxPods>110</maxPods>\\n <containerLogMaxSize>10Mi</containerLogMaxSize>\\n <containerLogMaxFiles>5</containerLogMaxFiles>\\n </kubelet_configuration>\\n </node_config>\\n</DescribeClusterNodePoolDetailResponse>","errorExample":""}]', + 'title' => '查询节点池配置', + ], + 'DescribeClusterNodePools' => [ + 'summary' => '查询集群内所有节点池列表。', + 'path' => '/clusters/{ClusterId}/nodepools', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '556', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc0f87de0b8fb403f86e10e204f83****', + ], + ], + [ + 'name' => 'NodepoolName', + 'in' => 'query', + 'schema' => [ + 'description' => '节点池名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'nodepool-test'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体', + 'description' => '节点池详情。', + 'type' => 'object', + 'properties' => [ + 'nodepools' => [ + 'title' => '节点池列表', + 'description' => '节点池实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点池实例详情。', + 'type' => 'object', + 'properties' => [ + 'nodepool_info' => [ + 'title' => '节点池详情。', + 'description' => '节点池信息。', + 'type' => 'object', + 'properties' => [ + 'nodepool_id' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'example' => 'np615c0e0966124216a0412e10afe0****', + ], + 'name' => [ + 'title' => '节点池名称。', + 'description' => '节点池名称。', + 'type' => 'string', + 'example' => 'default-nodepool', + ], + 'type' => [ + 'title' => '节点池类型。', + 'description' => '节点池类型。取值：'."\n" + ."\n" + .'- `ess`：普通节点池（包含托管功能和自动弹性伸缩功能）。'."\n" + .'- `edge`：边缘节点池。'."\n" + .'- `lingjun`：灵骏节点池。', + 'type' => 'string', + 'example' => 'ess', + ], + 'is_default' => [ + 'title' => '是否为默认节点池。', + 'description' => '是否为默认节点池，通常一个集群仅有一个默认节点池。取值：'."\n" + ."\n" + .'- `true`：默认节点池。'."\n" + .'- `false`：非默认节点池。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'resource_group_id' => [ + 'title' => '节点池所属资源组ID。', + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyvw3wjm****', + ], + 'region_id' => [ + 'title' => '节点池所属地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'created' => [ + 'title' => '节点池创建时间。', + 'description' => '节点池创建时间。', + 'type' => 'string', + 'example' => '2025-04-15T16:33:29.362888807+08:00', + ], + 'updated' => [ + 'title' => '节点池更新时间。', + 'description' => '节点池更新时间。', + 'type' => 'string', + 'example' => '2025-04-15T16:33:32.823+08:00', + ], + ], + ], + 'status' => [ + 'title' => '节点池状态。', + 'description' => '节点池状态。', + 'type' => 'object', + 'properties' => [ + 'state' => [ + 'title' => '节点池状态。', + 'description' => '节点池状态，取值：'."\n" + ."\n" + .'- `active`：已激活。'."\n" + .'- `scaling`：伸缩中。'."\n" + .'- `removing`：节点移除中。'."\n" + .'- `deleting`：删除中。'."\n" + .'- `updating`：更新中。', + 'type' => 'string', + 'example' => 'active', + ], + 'healthy_nodes' => [ + 'title' => '处于健康状态节点数。', + 'description' => '处于健康状态实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'initial_nodes' => [ + 'title' => '正在初始化节点数。', + 'description' => '正在创建的节点数。 ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'failed_nodes' => [ + 'title' => '失败节点数。', + 'description' => '失败实例数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'offline_nodes' => [ + 'title' => '离线节点数量。', + 'description' => '离线节点数。 ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'removing_nodes' => [ + 'title' => '正在被移除节点数。', + 'description' => '正在被移除的节点数。 ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'serving_nodes' => [ + 'title' => '工作节点数量。', + 'description' => '处于工作状态的节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'total_nodes' => [ + 'title' => '总节点数。', + 'description' => '节点池内节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + 'auto_scaling' => [ + 'title' => '节点池自动伸缩信息。', + 'description' => '自动伸缩配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否启用自动伸缩。', + 'description' => '是否启用自动伸缩，取值：'."\n" + ."\n" + .'- `true`：开启节点池自动伸缩功能。当集群的容量规划无法满足应用Pod调度时，ACK会根据配置的最小和最大实例数自动扩缩节点资源。1.24及以上版本的集群默认启用节点即时弹性；'."\n" + .'1.24以下版本的集群默认启用节点自动伸缩。更多信息，请参见[节点伸缩](~~2746785~~)。'."\n" + ."\n" + .'- `false`：不开启自动伸缩，ACK会根据配置的期望节点数调整节点池中的节点数，将节点数始终维持在期望节点数。'."\n" + ."\n" + .'当取值为false时，`auto_scaling`内的其他配置参数将不生效。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'type' => [ + 'title' => '扩容组类型', + 'description' => '自动伸缩类型，按照自动伸缩实例类型划分。取值：'."\n" + ."\n" + .'- `cpu`：普通实例型。'."\n" + .'- `gpu`：GPU实例型。'."\n" + .'- `gpushare`：GPU共享型。'."\n" + .'- `spot`：抢占式实例型。'."\n", + 'type' => 'string', + 'example' => 'cpu', + ], + 'max_instances' => [ + 'title' => '最大实例数。', + 'description' => '节点池中可伸缩的最大实例数，不包含您已有的实例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'min_instances' => [ + 'title' => '最小实例数。', + 'description' => '节点池中可伸缩的最小实例数，不包含您已有的实例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'eip_internet_charge_type' => [ + 'title' => 'EIP实例付费类型。', + 'description' => 'EIP计费类型，取值：'."\n" + ."\n" + .'- `PayByBandwidth`：按固定带宽计费。'."\n" + .'- `PayByTraffic`：按使用流量计费。'."\n", + 'type' => 'string', + 'example' => 'PayByBandwidth', + ], + 'is_bond_eip' => [ + 'title' => '是否绑定EIP。', + 'description' => '是否绑定EIP，取值：'."\n" + ."\n" + .'- `true`：绑定EIP。'."\n" + .'- `false`：不绑定EIP。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'eip_bandwidth' => [ + 'title' => 'EIP带宽峰值。', + 'description' => 'EIP带宽峰值。'."\n" + ."\n" + .'取值范围：[1,100]，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + 'management' => [ + 'title' => '托管版节点池配置。', + 'description' => '托管节点池配置，当前只在专业托管集群中生效。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启托管版节点池。', + 'description' => '是否开启托管版节点池，取值：'."\n" + ."\n" + .'- `true`：开启托管节点池。'."\n" + .'- `false`：不开启托管节点池，只有当`enable=true`时，其他相关配置才生效。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_repair' => [ + 'title' => '自动修复。', + 'description' => '自动修复，仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：自动修复。'."\n" + .'- `false`：不自动修复。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_repair_policy' => [ + 'title' => '自动修复节点策略。', + 'description' => '自动修复节点策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点。仅当`auto_repair=true`时生效。'."\n" + ."\n" + .'- `true`：允许重启节点。'."\n" + .'- `false`：不允许重启节点。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'approval_required' => [ + 'title' => '节点修复是否需要人工审批。', + 'description' => '节点修复是否需要人工审批。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'auto_repair_policy_id' => [ + 'title' => '自动修复策略的ID', + 'description' => '自动修复策略的ID', + 'type' => 'string', + 'example' => 'r-xxxxxxxxx', + ], + ], + ], + 'auto_vul_fix' => [ + 'title' => '是否自动修复CVE。', + 'description' => '是否自动修复CVE。仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：允许自动修复CVE。'."\n" + .'- `false`：不允许自动修复CVE。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_vul_fix_policy' => [ + 'title' => '自动修复CVE策略。', + 'description' => '自动修复CVE策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点，仅当`auto_vul_fix=true`时生效。取值：'."\n" + .'- `true`：允许重启节点。'."\n" + .'- `false`：不允许重启节点。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'vul_level' => [ + 'title' => '允许自动修复的漏洞级别，以逗号分隔。', + 'description' => '允许自动修复的漏洞级别，以逗号分隔。'."\n" + ."\n" + .'- `asap`：高'."\n" + .'- `later`：中'."\n" + .'- `nntf`：低', + 'type' => 'string', + 'example' => 'asap,nntf', + ], + 'exclude_packages' => [ + 'title' => '指定在漏洞修复过程中应排除的包。', + 'description' => '指定在漏洞修复过程中应排除的包。', + 'type' => 'string', + ], + ], + ], + 'auto_upgrade' => [ + 'title' => '是否自动升级。', + 'description' => '是否自动升级节点，仅当`enable=true`时生效。'."\n" + .'- `true`：启用自动升级。'."\n" + .'- `false`：不启用自动升级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'auto_upgrade_policy' => [ + 'title' => '自动升级策略。', + 'description' => '自动升级策略。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade_kubelet' => [ + 'title' => '是否允许自动升级kubelet。', + 'description' => '是否允许自动升级kubelet，仅当`auto_upgrade=true`时生效。取值：'."\n" + .'- `true`：允许自动升级kubelet。'."\n" + .'- `false`：不允许自动升级kubelet。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'upgrade_config' => [ + 'title' => '自动升级配置。', + 'description' => '自动升级配置，仅当`enable=true`时生效。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade' => [ + 'title' => '是否启用自动升级，自修复。', + 'description' => '是否启用自动升级，取值：'."\n" + ."\n" + .'- `true`：启用自动升级。'."\n" + .'- `false`：不启用自动升级。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'surge' => [ + 'title' => '额外节点数量。', + 'description' => '额外节点数量。和`surge_percentage`二选一。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'surge_percentage' => [ + 'title' => '额外节点比例， 和surge 二选一。', + 'description' => '额外节点数的百分比，和`surge`二选一。'."\n" + ."\n" + .'额外节点数=额外节点数比例×节点数，例如，设置额外节点数比例为50%，存在的节点数为6，那么将产生的额外节点数=50%×6，也就是将产生3个额外节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'max_unavailable' => [ + 'title' => '最大不可用节点数量。', + 'description' => '最大不可用节点数量，取值范围：\\[1,1000\\]'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'scaling_group' => [ + 'title' => '节点池扩容组信息。', + 'description' => '节点池伸缩组配置。', + 'type' => 'object', + 'properties' => [ + 'scaling_group_id' => [ + 'title' => '扩容组ID ', + 'description' => '伸缩组ID。', + 'type' => 'string', + 'example' => 'asg-2ze8n5qw4atggut8****', + ], + 'vswitch_ids' => [ + 'title' => '虚拟交换机ID。', + 'description' => '虚拟交换机ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'example' => 'vsw-2ze3ds0mdip0hdz8i****', + ], + ], + 'instance_types' => [ + 'title' => '实例规格。', + 'description' => '节点实例规格列表，您可以选择多个实例规格作为备选，每个节点创建时，将从第一个规格开始尝试购买，直到创建成功。最终购买的实例规格可能随库存变化而不同。', + 'type' => 'array', + 'items' => [ + 'description' => '节点实例规格。', + 'type' => 'string', + 'example' => 'ecs.n4.large', + ], + 'example' => 'ecs.n4.large', + ], + 'instance_charge_type' => [ + 'title' => '节点付费类型', + 'description' => '节点池节点付费类型，取值：'."\n" + ."\n" + .'- `PrePaid`：预付费。'."\n" + .'- `PostPaid`：按量付费。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'period' => [ + 'title' => '节点包年包月时长。', + 'description' => '节点包年包月时长，当`instance_charge_type`取值为`PrePaid`时才生效且为必选值。'."\n" + ."\n" + .'- 当`period_unit=Week`时，`period`取值范围：{ 1、2、3、4}。'."\n" + .'- 当`period_unit=Month`时，`period` 取值范围：{1、2、3、4、5、6、7、8、9、12、24、36、48、60}。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'period_unit' => [ + 'title' => '节点包年包月周期。', + 'description' => '节点付费周期，当`instance_charge_type`取值为`PrePaid`时时候需要指定周期。'."\n" + ."\n" + .'- `Month`：以月为计时单位。'."\n" + .'- `Week`：以周为计算单位。', + 'type' => 'string', + 'example' => 'Month', + ], + 'auto_renew' => [ + 'title' => '节点是否开启自动续费', + 'description' => '节点是否开启自动续费，当`instance_charge_type`取值为`PrePaid`时才生效，取值：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'auto_renew_period' => [ + 'title' => '节点自动续费周期', + 'description' => '单次自动续费的续费时长。取值范围：'."\n" + .'- PeriodUnit=Week 时：1、2、3。'."\n" + .'- PeriodUnit=Month 时：1、2、3、6、12、24、36、48、60。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'spot_strategy' => [ + 'title' => '抢占式实例类型', + 'description' => '抢占式实例类型，取值：'."\n" + .'- NoSpot：非抢占式实例。'."\n" + .'- SpotWithPriceLimit：设置抢占实例价格上限。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。'."\n" + ."\n" + .'更多信息，请参见[抢占式实例](~~157759~~)。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + 'spot_price_limit' => [ + 'title' => '抢占实例价格上限配置。', + 'description' => '抢占式实例市场价格区间配置。', + 'type' => 'array', + 'items' => [ + 'description' => '抢占实例市场价格区间配置，可为不同实例规格设置不同的价格区间。', + 'type' => 'object', + 'properties' => [ + 'instance_type' => [ + 'title' => '抢占实例规格。', + 'description' => '抢占式实例规格。', + 'type' => 'string', + 'example' => 'ecs.c6.large', + ], + 'price_limit' => [ + 'title' => '抢占实例单价。', + 'description' => '单台实例市场价格区间。'."\n" + ."\n" + .'<props="china">单位：元/时。</props>'."\n" + ."\n" + .'<props="intl">单位：美元/时。</props>'."\n", + 'type' => 'string', + 'example' => '0.39', + ], + ], + ], + ], + 'image_type' => [ + 'title' => '操作系统发行版类型，推荐使用该字段指定节点操作系统。取值：CentOS、AliyunLinux、AliyunLinux Qboot、AliyunLinuxUEFI、AliyunLinux3、Windows、WindowsCore、AliyunLinux3Arm64、ContainerOS。', + 'description' => '操作系统镜像类型。'."\n" + .'- `AliyunLinux`：Alinux2镜像。'."\n" + .'- `AliyunLinuxSecurity`：Alinux2镜像UEFI版。'."\n" + .'- `AliyunLinux3`：Alinux3镜像。'."\n" + .'- `AliyunLinux3Arm64`：Alinux3镜像ARM版。'."\n" + .'- `AliyunLinux3Security`：Alinux3镜像UEFI版。'."\n" + .'- `CentOS`：CentOS镜像。'."\n" + .'- `Windows`：Windows镜像。'."\n" + .'- `WindowsCore`：WindowsCore镜像。'."\n" + .'- `ContainerOS`：容器优化镜像。'."\n" + .'- `AliyunLinux3ContainerOptimized`: Alinux3镜像容器优化版。', + 'type' => 'string', + 'example' => 'AliyunLinux3', + ], + 'image_id' => [ + 'title' => '自定义镜像。', + 'description' => '自定义镜像ID，可通过`DescribeKubernetesVersionMetadata`查询系统支持的镜像。'."\n", + 'type' => 'string', + 'example' => 'aliyun_3_x64_20G_alibase_20241218.vhd', + ], + 'system_disk_category' => [ + 'title' => '节点系统盘类型。', + 'description' => '节点系统盘类型，取值：'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL 云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。', + 'type' => 'string', + 'example' => 'cloud_efficiency', + ], + 'system_disk_categories' => [ + 'title' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。取值范围：cloud：普通云盘。cloud_efficiency：高效云盘。cloud_ssd：SSD云盘。cloud_essd：ESSD云盘。', + 'description' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。', + 'type' => 'array', + 'items' => [ + 'title' => '节点系统盘类型', + 'description' => '节点系统盘类型。'."\n" + ."\n" + .'取值：'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL 云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。', + 'type' => 'string', + 'example' => 'EESSD云盘', + 'enum' => [], + ], + 'required' => false, + 'maxItems' => 10, + ], + 'system_disk_size' => [ + 'title' => '节点系统盘大小。', + 'description' => '节点系统盘大小，单位为GiB。'."\n" + ."\n" + .'取值范围：\\[20,2048\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'system_disk_performance_level' => [ + 'title' => '节点系统盘磁盘性能，只针对ESSD磁盘生效', + 'description' => '节点系统盘磁盘性能，只对ESSD磁盘生效。磁盘性能等级和磁盘大小有关。更多信息，请参见[ESSD云盘](~~122389~~)。'."\n" + .'- PL0：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL1：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL2：并发极限I/O性能较高，读写时延稳定。'."\n" + .'- PL3：并发极限I/O性能极高，读写时延极稳定。', + 'type' => 'string', + 'example' => 'PL1', + ], + 'system_disk_encrypted' => [ + 'title' => '是否加密系统盘。取值范围：true：加密。false：不加密。', + 'description' => '是否加密系统盘。取值：'."\n" + ."\n" + .'- true：加密。'."\n" + .'- false：不加密。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'system_disk_kms_key_id' => [ + 'title' => '系统盘使用的KMS密钥ID。', + 'description' => '系统盘使用的KMS密钥ID。', + 'type' => 'string', + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'system_disk_encrypt_algorithm' => [ + 'title' => '系统盘采用的加密算法。取值范围：aes-256。', + 'description' => '系统盘采用的加密算法。取值范围：aes-256。', + 'type' => 'string', + 'example' => 'aes-256', + 'enum' => [], + ], + 'system_disk_bursting_enabled' => [ + 'title' => '节点系统盘是否开启Burst（性能突发），磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘是否开启Burst（性能突发）。 取值：'."\n" + .'- true：开启。开启后，波动性业务面临突发的数据读写压力时，云盘会根据业务实际情况临时提升云盘性能，直至业务恢复至平稳状态。'."\n" + .'- false：不开启。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'system_disk_provisioned_iops' => [ + 'title' => '节点系统盘预配置的读写IOPS，磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘预配置的读写IOPS，磁盘类型为cloud_auto时配置。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'data_disks' => [ + 'title' => '数据盘配置。', + 'description' => '节点数据盘类型、大小等配置的组合。', + 'type' => 'array', + 'items' => [ + 'description' => '节点数据盘配置。', + '$ref' => '#/components/schemas/data_disk', + ], + ], + 'disk_init' => [ + 'title' => '块设备初始化配置。', + 'description' => '块设备初始化配置。', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/DiskInit', + ], + ], + 'security_group_ids' => [ + 'title' => '多安全组ID', + 'description' => '节点池安全组ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点池安全组ID列表。', + 'type' => 'string', + 'example' => 'sg-2ze1iuk12m2sb4c4****', + ], + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。', + 'description' => '密钥对名称，和`login_password`二选一。'."\n" + ."\n" + .'当节点池为托管版节点池时，只支持`key_pair`。', + 'type' => 'string', + 'example' => 'pro-nodepool', + ], + 'login_password' => [ + 'title' => 'SSH登录密码。', + 'description' => 'SSH登录密码，和`key_pair`二选一。密码规则为8~30个字符，且至少同时包含三项（大小写字母、数字和特殊符号）。'."\n" + ."\n" + .'出于安全性考虑，密码查询结果经过加密处理。', + 'type' => 'string', + 'example' => '******', + ], + 'login_as_non_root' => [ + 'title' => '弹出的ECS实例是否使用以非root用户登陆。', + 'description' => '弹出的ECS实例是否使用以非root用户登录。'."\n" + ."\n" + .'- true：以非root用户（ecs-user）登录。'."\n" + ."\n" + .'- false：以root用户登录。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cis_enabled' => [ + 'title' => '【已废弃】请使用security_hardening_os参数代替', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'请使用参数security_hardening_os替代。', + 'type' => 'boolean', + 'deprecated' => true, + 'example' => 'false', + ], + 'soc_enabled' => [ + 'title' => '是否开启等保加固，仅当系统镜像选择Alibaba Cloud Linux 2或Alibaba Cloud Linux 3时，可为节点开启等保加固。阿里云为Alibaba Cloud Linux 2和Alibaba Cloud Linux 3等保2.0三级版镜像提供等保合规的基线检查标准和扫描程序。', + 'description' => '是否开启等保加固，仅当系统镜像选择Alibaba Cloud Linux 2或Alibaba Cloud Linux 3时，可为节点开启等保加固。阿里云为Alibaba Cloud Linux 2和Alibaba Cloud Linux 3等保2.0三级版镜像提供等保合规的基线检查标准和扫描程序。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'security_hardening_os' => [ + 'title' => '是否开启阿里云OS安全加固。', + 'description' => '阿里云OS安全加固。取值：'."\n" + ."\n" + .'- `true`：开启阿里云OS安全加固。'."\n" + .'- `false`：不开启阿里云OS安全加固。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'internet_charge_type' => [ + 'title' => '节点公网IP网络计费类型', + 'description' => '节点公网IP网络计费类型。'."\n" + ."\n" + .'- PayByBandwidth：按固定带宽计费。'."\n" + .'- PayByTraffic：按使用流量计费。', + 'type' => 'string', + 'example' => 'PayByBandwidth', + ], + 'internet_max_bandwidth_out' => [ + 'title' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：1~100', + 'description' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：1~100。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'tags' => [ + 'title' => 'ECS标签', + 'description' => 'ECS实例标签。', + 'type' => 'array', + 'items' => [ + 'description' => '节点标签。', + '$ref' => '#/components/schemas/tag', + ], + ], + 'desired_size' => [ + 'title' => '节点池期望节点数', + 'description' => '节点池期望节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'multi_az_policy' => [ + 'title' => '多可用区伸缩组ECS实例扩缩容策略', + 'description' => '多可用区伸缩组ECS实例扩缩容策略。取值：'."\n" + ."\n" + .'- `PRIORITY`：根据您定义的虚拟交换机（VSwitchIds.N）扩缩容。当优先级较高的虚拟交换机所在可用区无法创建ECS实例时，自动使用下一优先级的虚拟交换机创建ECS实例。'."\n" + ."\n" + .'- `COST_OPTIMIZED`：按vCPU单价从低到高进行尝试创建。当伸缩配置设置了抢占式计费方式的多实例规格时，优先创建对应抢占式实例。您可以继续通过`CompensateWithOnDemand`参数指定当抢占式实例由于库存等原因无法创建时，是否自动尝试以按量付费的方式创建。'."\n" + ."\n" + .' >`COST_OPTIMIZED`仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。'."\n" + ."\n" + .'- `BALANCE`：在伸缩组指定的多可用区之间均匀分配ECS实例。如果由于库存不足等原因可用区之间变得不平衡，您可以通过API `RebalanceInstances`平衡资源。更多信息，请参见[RebalanceInstances](~~71516~~)。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'COST_OPTIMIZED', + ], + 'scaling_policy' => [ + 'title' => '扩容策略。', + 'description' => '伸缩组模式，取值：'."\n" + ."\n" + .'- `release`：标准模式，根据申请资源值的使用量，通过创建、释放ECS的方式进行伸缩。'."\n" + .'- `recycle`：极速模式，通过创建、停机、启动的方式进行伸缩，提高再次伸缩的速度（停机时计算资源不收费，只收取存储费用，本地盘机型除外）。', + 'type' => 'string', + 'example' => 'release', + ], + 'on_demand_base_capacity' => [ + 'title' => '伸缩组所需要按量实例个数的最小值，取值范围：0~1000。当按量实例个数少于该值时，将优先创建按量实例。', + 'description' => '伸缩组所需要按量实例个数的最小值，取值范围：\\[0,1000\\]。当按量实例个数少于该值时，将优先创建按量实例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'on_demand_percentage_above_base_capacity' => [ + 'title' => '伸缩组满足最小按量实例数（OnDemandBaseCapacity）要求后，超出的实例中按量实例应占的比例，取值范围：0～100。', + 'description' => '伸缩组满足最小按量实例数（`on_demand_base_capacity`）要求后，超出的实例中按量实例应占的比例。取值范围：\\[0,100\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'spot_instance_pools' => [ + 'title' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：1~10。', + 'description' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：\\[1,10\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'spot_instance_remedy' => [ + 'title' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。', + 'description' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。取值：'."\n" + ."\n" + .'- `true`：开启补齐抢占式实例。'."\n" + .'- `false`：不开启补齐抢占式实例。'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'compensate_with_on_demand' => [ + 'title' => '当MultiAZPolicy取值为COST_OPTIMIZED时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值范围：true：允许。false：不允许。默认值：true', + 'description' => '当`multi_az_policy`取值为`COST_OPTIMIZED`时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值：'."\n" + ."\n" + .'- `true`：允许自动尝试创建按量实例满足ECS实例数量要求。'."\n" + .'- `false`：不允许自动尝试创建按量实例满足ECS实例数量要求。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'deploymentset_id' => [ + 'title' => '部署集ID。', + 'description' => '部署集ID。', + 'type' => 'string', + 'example' => 'ds-bp1d19mmbsv3jf6xxxxx', + ], + 'rds_instances' => [ + 'title' => 'RDS实例列表。', + 'description' => '如果指定了RDS实例列表，集群节点ECS会自动加入RDS访问白名单。', + 'type' => 'array', + 'items' => [ + 'description' => 'RDS实例。', + 'type' => 'string', + 'example' => 'rm-xxx', + ], + ], + 'private_pool_options' => [ + 'title' => '私有池选项。', + 'description' => '私有池选项。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '私有池ID。即弹性保障服务ID或容量预定服务ID。', + 'description' => '私有池ID。即弹性保障服务ID或容量预定服务ID。', + 'type' => 'string', + 'example' => 'eap-bp67acfmxazb4****', + ], + 'match_criteria' => [ + 'title' => '实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值范围： Open：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。该模式下无需设置PrivatePoolOptions.Id参数。 Target：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。该模式下必须指定私有池ID，即PrivatePoolOptions.Id参数为必填项。 None：不使用模式。实例启动将不使用私有池容量。', + 'description' => '私有节点池类型，实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值：'."\n" + ."\n" + .'- `Open`：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。'."\n" + ."\n" + .'- `Target`：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。'."\n" + ."\n" + .'- `None`：不使用模式。实例启动将不使用私有池容量。', + 'type' => 'string', + 'example' => 'Open', + ], + ], + ], + 'security_group_id' => [ + 'title' => '【该字段已废弃】请使用security_group_ids替代'."\n" + .'安全组ID。', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'节点池安全组ID，当节点池绑定多个安全组时，为`security_group_ids`中的第一个值。', + 'type' => 'string', + 'example' => 'sg-2ze1iuk12m2sb4c4****', + ], + 'platform' => [ + 'title' => '【该字段已废弃】请使用image_type替代'."\n" + .'操作系统发行版，和image_type二选一', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'操作系统发行版。取值：'."\n" + ."\n" + .'- `CentOS`'."\n" + .'- `AliyunLinux`'."\n" + .'- `Windows`'."\n" + .'- `WindowsCore`', + 'type' => 'string', + 'example' => 'AliyunLinux', + ], + 'ram_policy' => [ + 'title' => '该字段已废弃，请改为使用 ram_role_name 字段。', + 'description' => '该字段已废弃，请使用ram_role_name替代。', + 'type' => 'string', + 'example' => 'KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****', + ], + 'instance_patterns' => [ + 'title' => '实例属性', + 'description' => '实例属性配置。', + 'type' => 'array', + 'items' => [ + 'title' => '实例属性', + 'description' => '实例属性。', + '$ref' => '#/components/schemas/instance_patterns', + ], + ], + 'ram_role_name' => [ + 'title' => 'Worker RAM角色名称。', + 'description' => 'Worker RAM角色名称。', + 'type' => 'string', + 'example' => 'KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****', + ], + 'resource_pool_options' => [ + 'title' => '创建实例时使用的资源池及资源池策略。', + 'description' => '创建实例时使用的资源池及资源池策略。', + 'type' => 'object', + 'properties' => [ + 'strategy' => [ + 'title' => '创建实例时使用的资源池策略。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。'."\n" + .'PrivatePoolOnly：仅限私有池。'."\n" + .'None：不使用资源池策略。', + 'description' => '创建实例时使用的资源池策略。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。'."\n" + .'PrivatePoolOnly：仅限私有池。'."\n" + .'None：不使用资源池策略。', + 'type' => 'string', + 'example' => 'PrivatePoolFirst', + 'enum' => [ + 'PrivatePoolFirst', + 'PrivatePoolOnly', + 'None', + ], + ], + 'private_pool_ids' => [ + 'title' => '私有池 ID列表。', + 'description' => '私有池 ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '私有池 ID。', + 'description' => '私有池 ID。', + 'type' => 'string', + ], + ], + ], + ], + 'system_disk_snapshot_policy_id' => [ + 'title' => '系统盘快照策略', + 'description' => '系统盘快照策略', + 'type' => 'string', + ], + ], + ], + 'node_config' => [ + 'title' => '节点配置', + 'description' => '节点配置。', + 'type' => 'object', + 'properties' => [ + 'kubelet_configuration' => [ + 'title' => 'Kubelet参数配置。', + 'description' => 'Kubelet参数配置。', + '$ref' => '#/components/schemas/kubelet_config', + ], + 'node_os_config' => [ + 'type' => 'object', + 'properties' => [ + 'hugepage' => [ + '$ref' => '#/components/schemas/Hugepage', + ], + ], + ], + ], + ], + 'kubernetes_config' => [ + 'title' => '集群配置', + 'description' => '集群相关配置。', + 'type' => 'object', + 'properties' => [ + 'labels' => [ + 'title' => '节点标签。', + 'description' => '节点标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签配置。', + '$ref' => '#/components/schemas/tag', + ], + ], + 'taints' => [ + 'title' => '污点信息。', + 'description' => '节点污点信息。污点和容忍度（Toleration）相互配合，可以用来避免Pod被分配到不合适的节点上。更多信息，请参见[taint-and-toleration](https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/)。', + 'type' => 'array', + 'items' => [ + 'description' => '节点污点信息。', + '$ref' => '#/components/schemas/taint', + ], + ], + 'runtime' => [ + 'title' => '容器运行时。', + 'description' => '容器运行时名称，ACK 支持以下三种容器运行时。'."\n" + ."\n" + .'- containerd：推荐使用，支持所有集群版本。'."\n" + .'- Sandboxed-Container.runv：安全沙箱容器，提供更高的隔离性，支持 1.31 及以下版本集群。'."\n" + .'- docker：已停止维护，支持1.22及以下版本集群。', + 'type' => 'string', + 'example' => 'containerd', + ], + 'runtime_version' => [ + 'title' => '容器运行时版本。', + 'description' => '容器运行时版本。', + 'type' => 'string', + 'example' => '1.6.38', + ], + 'cpu_policy' => [ + 'title' => 'CPU管理策略。', + 'description' => '节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略：'."\n" + ."\n" + .'- `static`：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + .'- `none`：表示启用现有的默认CPU亲和性方案。', + 'type' => 'string', + 'example' => 'none', + ], + 'user_data' => [ + 'title' => '节点自定义数据。', + 'description' => '节点池自定义数据，即运行于节点初始化之后的脚本。更多详情，请参见[生成实例自定义数据](~~49121~~)。', + 'type' => 'string', + 'example' => 'IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****', + ], + 'unschedulable' => [ + 'title' => '扩容后的节点是否可调度。', + 'description' => '扩容后的节点是否不可调度。'."\n" + ."\n" + .'- true：不可调度。'."\n" + ."\n" + .'- false：可调度。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'cms_enabled' => [ + 'title' => '是否开启云监控。', + 'description' => '是否在ECS节点上安装云监控，安装后可以在云监控控制台查看所创建ECS实例的监控信息，推荐开启。取值：'."\n" + ."\n" + .'- `true`：在ECS节点上安装云监控。'."\n" + .'- `false`：不在ECS节点上安装云监控'."\n" + ."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'node_name_mode' => [ + 'title' => '自定义节点名称', + 'description' => '自定义节点名称。'."\n" + ."\n" + .'节点名称由三部分组成：前缀 \\+ 节点 IP 地址子串 \\+ 后缀：'."\n" + .' '."\n" + .'- 前缀和后缀均可由“.”分隔的一个或多个部分构成，每个部分可以使用小写字母、数字和“-”，节点名称首尾必须为小写字母和数字。'."\n" + .'- IP 地址段长度指截取节点 IP 地址末尾的位数，取值范围 5-12。'."\n" + .' '."\n" + .'例如，节点 IP 地址为：192.168.0.55，指定前缀为 aliyun.com，IP 地址段长度为 5，后缀为 test，则节点名称为aliyun.com00055test。', + 'type' => 'string', + 'example' => 'aliyun.com192.XX.YY.55test', + ], + 'pre_user_data' => [ + 'description' => '节点池预自定义数据，即运行于节点初始化之前的脚本。更多详情，请参见[生成实例自定义数据](~~49121~~)。', + 'type' => 'string', + 'example' => 'IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD', + ], + ], + ], + 'tee_config' => [ + 'title' => '加密计算节点池信息。', + 'description' => '加密计算配置。 ', + 'type' => 'object', + 'properties' => [ + 'tee_enable' => [ + 'title' => '是否为加密计算节点池。', + 'description' => '是否开启加密计算集群，取值：'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：不开启。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'interconnect_config' => [ + 'title' => '边缘节点池网络相关的配置。该值只对edge类型的节点池有意义', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘节点池网络相关的配置。该值只对edge类型的节点池有意义。', + 'type' => 'object', + 'properties' => [ + 'cen_id' => [ + 'title' => '边缘增强型节点池绑定的云企业网实例ID(CENID)', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云企业网实例ID(CENID)。', + 'type' => 'string', + 'example' => 'cen-ey9k9nfhz0f*******', + ], + 'ccn_id' => [ + 'title' => '边缘增强型节点池绑定的云连接网实例ID(CCNID)', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云连接网实例ID(CCNID)。', + 'type' => 'string', + 'example' => 'ccn-qm5i0i0q9yi*******', + ], + 'ccn_region_id' => [ + 'title' => '边缘增强型节点池绑定的云连接网实例所属的区域', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池绑定的云连接网实例所属的区域。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'bandwidth' => [ + 'title' => '边缘增强型节点池的网络带宽，单位M', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池的网络带宽，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'improved_period' => [ + 'title' => '边缘增强型节点池的购买时长，单位月', + 'description' => '【该字段已废弃】'."\n" + ."\n" + .'边缘增强型节点池的购买时长，单位：月。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'max_nodes' => [ + 'title' => '边缘节点池允许容纳的最大节点数量. 节点池内可以容纳的最大节点数量，该参数大于等于0。0表示无额外限制(仅受限于集群整体可以容纳的节点数，节点池本身无额外限制)。边缘节点池该参数值往往大于0；ess类型节点池和默认的edge类型节点池该参数值为0', + 'description' => '边缘节点池允许容纳的最大节点数量. 节点池内可以容纳的最大节点数量，该参数大于等于0。0表示无额外限制（仅受限于集群整体可以容纳的节点数，节点池本身无额外限制）。边缘节点池该参数值往往大于0；ess类型节点池和默认的edge类型节点池该参数值为0', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'interconnect_mode' => [ + 'title' => '边缘节点池的网络类型。basic：基础型；improved：增强型。该值只对edge类型的节点池有意义', + 'description' => '边缘节点池的网络类型，该参数仅对`type`为`edge`类型的节点池生效，取值范围：'."\n" + ."\n" + .'- `basic`：公网。节点池内的节点通过公网与云端节点进行交互，节点池内应用不能直接访问云端VPC内网。'."\n" + .'- `private`：专用网络。节点池内的节点通过专线、VPN或CEN等方式实现云上与云下网络打通，拥有更高的云边通信质量，提供更有效的安全保障。', + 'type' => 'string', + 'example' => 'basic', + ], + 'auto_mode' => [ + 'title' => '智能托管配置。', + 'description' => '智能托管配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启智能托管。', + 'description' => '是否开启智能托管。', + 'type' => 'boolean', + ], + ], + ], + 'node_components' => [ + 'title' => '节点组件列表。', + 'description' => '节点组件列表。', + 'type' => 'array', + 'items' => [ + 'title' => '节点组件。', + 'description' => '节点组件。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '节点组件名称。', + 'description' => '节点组件名称。', + 'type' => 'string', + 'example' => 'kubelet', + ], + 'version' => [ + 'title' => '节点组件版本。', + 'description' => '节点组件版本。', + 'type' => 'string', + 'example' => '1.33.3-aliyun.1', + ], + 'config' => [ + 'title' => '节点组件配置。', + 'description' => '节点组件配置。', + 'type' => 'object', + 'properties' => [ + 'custom_config' => [ + 'title' => '节点组件自定义配置。', + 'description' => '节点组件自定义配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'cpuManagerPolicy', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"nodepools\\": [\\n {\\n \\"nodepool_info\\": {\\n \\"nodepool_id\\": \\"np615c0e0966124216a0412e10afe0****\\",\\n \\"name\\": \\"default-nodepool\\",\\n \\"type\\": \\"ess\\",\\n \\"is_default\\": true,\\n \\"resource_group_id\\": \\"rg-acfmyvw3wjm****\\",\\n \\"region_id\\": \\"cn-beijing\\",\\n \\"created\\": \\"2025-04-15T16:33:29.362888807+08:00\\",\\n \\"updated\\": \\"2025-04-15T16:33:32.823+08:00\\"\\n },\\n \\"status\\": {\\n \\"state\\": \\"active\\",\\n \\"healthy_nodes\\": 3,\\n \\"initial_nodes\\": 0,\\n \\"failed_nodes\\": 0,\\n \\"offline_nodes\\": 0,\\n \\"removing_nodes\\": 0,\\n \\"serving_nodes\\": 3,\\n \\"total_nodes\\": 3\\n },\\n \\"auto_scaling\\": {\\n \\"enable\\": true,\\n \\"type\\": \\"cpu\\",\\n \\"max_instances\\": 10,\\n \\"min_instances\\": 2,\\n \\"eip_internet_charge_type\\": \\"PayByBandwidth\\",\\n \\"is_bond_eip\\": true,\\n \\"eip_bandwidth\\": 5\\n },\\n \\"management\\": {\\n \\"enable\\": true,\\n \\"auto_repair\\": true,\\n \\"auto_repair_policy\\": {\\n \\"restart_node\\": true,\\n \\"approval_required\\": false,\\n \\"auto_repair_policy_id\\": \\"r-xxxxxxxxx\\"\\n },\\n \\"auto_vul_fix\\": true,\\n \\"auto_vul_fix_policy\\": {\\n \\"restart_node\\": true,\\n \\"vul_level\\": \\"asap,nntf\\",\\n \\"exclude_packages\\": \\"\\"\\n },\\n \\"auto_upgrade\\": true,\\n \\"auto_upgrade_policy\\": {\\n \\"auto_upgrade_kubelet\\": true\\n },\\n \\"upgrade_config\\": {\\n \\"auto_upgrade\\": true,\\n \\"surge\\": 5,\\n \\"surge_percentage\\": 50,\\n \\"max_unavailable\\": 1\\n }\\n },\\n \\"scaling_group\\": {\\n \\"scaling_group_id\\": \\"asg-2ze8n5qw4atggut8****\\",\\n \\"vswitch_ids\\": [\\n \\"vsw-2ze3ds0mdip0hdz8i****\\"\\n ],\\n \\"instance_types\\": [\\n \\"ecs.n4.large\\"\\n ],\\n \\"instance_charge_type\\": \\"PostPaid\\",\\n \\"period\\": 1,\\n \\"period_unit\\": \\"Month\\",\\n \\"auto_renew\\": false,\\n \\"auto_renew_period\\": 0,\\n \\"spot_strategy\\": \\"NoSpot\\",\\n \\"spot_price_limit\\": [\\n {\\n \\"instance_type\\": \\"ecs.c6.large\\",\\n \\"price_limit\\": \\"0.39\\"\\n }\\n ],\\n \\"image_type\\": \\"AliyunLinux3\\",\\n \\"image_id\\": \\"aliyun_3_x64_20G_alibase_20241218.vhd\\",\\n \\"system_disk_category\\": \\"cloud_efficiency\\",\\n \\"system_disk_categories\\": [\\n \\"EESSD云盘\\"\\n ],\\n \\"system_disk_size\\": 120,\\n \\"system_disk_performance_level\\": \\"PL1\\",\\n \\"system_disk_encrypted\\": false,\\n \\"system_disk_kms_key_id\\": \\"0e478b7a-4262-4802-b8cb-00d3fb40****\\",\\n \\"system_disk_encrypt_algorithm\\": \\"aes-256\\",\\n \\"system_disk_bursting_enabled\\": true,\\n \\"system_disk_provisioned_iops\\": 1000,\\n \\"data_disks\\": [\\n {\\n \\"category\\": \\"cloud_ssd\\",\\n \\"size\\": 40,\\n \\"encrypted\\": \\"true\\",\\n \\"kms_key_id\\": \\"0e478b7a-4262-4802-b8cb-00d3fb40****\\",\\n \\"auto_snapshot_policy_id\\": \\"sp-2zej1nogjvovnz4z****\\",\\n \\"performance_level\\": \\"PL1\\",\\n \\"provisioned_iops\\": 1000,\\n \\"bursting_enabled\\": true,\\n \\"auto_format\\": true,\\n \\"file_system\\": \\"ext4\\",\\n \\"mount_target\\": \\"/mnt/path1\\",\\n \\"disk_name\\": \\"DataDiskName\\",\\n \\"device\\": \\"/dev/xvdb\\",\\n \\"snapshot_id\\": \\"s-280s7****\\"\\n }\\n ],\\n \\"disk_init\\": [\\n {\\n \\"disk_name\\": \\"disk0\\",\\n \\"mkfs_type\\": \\"ext4\\",\\n \\"mount_target\\": \\"/mnt/disk0\\",\\n \\"mount_for_runtime\\": true,\\n \\"local_disk\\": true\\n }\\n ],\\n \\"security_group_ids\\": [\\n \\"sg-2ze1iuk12m2sb4c4****\\"\\n ],\\n \\"key_pair\\": \\"pro-nodepool\\",\\n \\"login_password\\": \\"******\\",\\n \\"login_as_non_root\\": true,\\n \\"cis_enabled\\": false,\\n \\"soc_enabled\\": false,\\n \\"security_hardening_os\\": false,\\n \\"internet_charge_type\\": \\"PayByBandwidth\\",\\n \\"internet_max_bandwidth_out\\": 10,\\n \\"tags\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ],\\n \\"desired_size\\": 2,\\n \\"multi_az_policy\\": \\"COST_OPTIMIZED\\",\\n \\"scaling_policy\\": \\"release\\",\\n \\"on_demand_base_capacity\\": 0,\\n \\"on_demand_percentage_above_base_capacity\\": 20,\\n \\"spot_instance_pools\\": 5,\\n \\"spot_instance_remedy\\": false,\\n \\"compensate_with_on_demand\\": true,\\n \\"deploymentset_id\\": \\"ds-bp1d19mmbsv3jf6xxxxx\\",\\n \\"rds_instances\\": [\\n \\"rm-xxx\\"\\n ],\\n \\"private_pool_options\\": {\\n \\"id\\": \\"eap-bp67acfmxazb4****\\",\\n \\"match_criteria\\": \\"Open\\"\\n },\\n \\"security_group_id\\": \\"sg-2ze1iuk12m2sb4c4****\\",\\n \\"platform\\": \\"AliyunLinux\\",\\n \\"ram_policy\\": \\"KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****\\",\\n \\"instance_patterns\\": [\\n {\\n \\"cores\\": 4,\\n \\"memory\\": 8,\\n \\"instance_family_level\\": \\"EnterpriseLevel\\",\\n \\"excluded_instance_types\\": [\\n \\"ecs.c6.large\\"\\n ],\\n \\"min_cpu_cores\\": 4,\\n \\"max_cpu_cores\\": 8,\\n \\"min_memory_size\\": 8,\\n \\"max_memory_size\\": 16,\\n \\"instance_categories\\": [\\n \\"General-purpose\\"\\n ],\\n \\"cpu_architectures\\": [\\n \\"X86\\"\\n ],\\n \\"core\\": 4,\\n \\"max_price\\": 2,\\n \\"architectures\\": [\\n \\"X86\\"\\n ],\\n \\"burst_performance_option\\": \\"Exclude\\",\\n \\"instance_type_families\\": [\\n \\"\\"\\n ],\\n \\"minimum_eni_quantity\\": 0,\\n \\"minimum_eni_private_ip_address_quantity\\": 0,\\n \\"minimum_eni_ipv6_address_quantity\\": 0,\\n \\"maximum_gpu_amount\\": 0\\n }\\n ],\\n \\"ram_role_name\\": \\"KubernetesWorkerRole-4a4fa089-80c1-48a5-b3c6-9349311f****\\",\\n \\"resource_pool_options\\": {\\n \\"strategy\\": \\"PrivatePoolFirst\\",\\n \\"private_pool_ids\\": [\\n \\"\\"\\n ]\\n },\\n \\"system_disk_snapshot_policy_id\\": \\"\\"\\n },\\n \\"node_config\\": {\\n \\"kubelet_configuration\\": {\\n \\"registryPullQPS\\": 5,\\n \\"registryBurst\\": 10,\\n \\"eventRecordQPS\\": 5,\\n \\"eventBurst\\": 10,\\n \\"kubeAPIQPS\\": 5,\\n \\"kubeAPIBurst\\": 10,\\n \\"serializeImagePulls\\": true,\\n \\"cpuManagerPolicy\\": \\"none\\",\\n \\"evictionHard\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"evictionSoft\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"evictionSoftGracePeriod\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"systemReserved\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"kubeReserved\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"readOnlyPort\\": 0,\\n \\"maxPods\\": 110,\\n \\"containerLogMaxSize\\": \\"10Mi\\",\\n \\"containerLogMaxFiles\\": 5,\\n \\"featureGates\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"allowedUnsafeSysctls\\": [\\n \\"\\"\\n ],\\n \\"reservedMemory\\": [\\n {\\n \\"numaNode\\": 0,\\n \\"limits\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"memoryManagerPolicy\\": \\"none\\",\\n \\"cpuCFSQuota\\": true,\\n \\"cpuCFSQuotaPeriod\\": \\"100ms\\",\\n \\"imageGCHighThresholdPercent\\": 85,\\n \\"imageGCLowThresholdPercent\\": 80,\\n \\"podPidsLimit\\": -1,\\n \\"topologyManagerPolicy\\": \\"restricted\\",\\n \\"clusterDNS\\": [\\n \\"\\"\\n ],\\n \\"tracing\\": {\\n \\"endpoint\\": \\"localhost:4317\\",\\n \\"samplingRatePerMillion\\": 0\\n },\\n \\"containerLogMaxWorkers\\": 1,\\n \\"containerLogMonitorInterval\\": \\"10s\\",\\n \\"serverTLSBootstrap\\": true\\n },\\n \\"node_os_config\\": {\\n \\"hugepage\\": {\\n \\"transparentEnabled\\": \\"\\",\\n \\"transparentDefrag\\": \\"\\",\\n \\"khugepagedDefrag\\": 0,\\n \\"khugepagedAllocSleepMillisecs\\": 0,\\n \\"khugepagedScanSleepMillisecs\\": 0,\\n \\"khugepagedPagesToScan\\": 0\\n }\\n }\\n },\\n \\"kubernetes_config\\": {\\n \\"labels\\": [\\n {\\n \\"key\\": \\"env\\",\\n \\"value\\": \\"prod\\"\\n }\\n ],\\n \\"taints\\": [\\n {\\n \\"key\\": \\"key\\",\\n \\"value\\": \\"value\\",\\n \\"effect\\": \\"NoSchedule\\"\\n }\\n ],\\n \\"runtime\\": \\"containerd\\",\\n \\"runtime_version\\": \\"1.6.38\\",\\n \\"cpu_policy\\": \\"none\\",\\n \\"user_data\\": \\"IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****\\",\\n \\"unschedulable\\": true,\\n \\"cms_enabled\\": true,\\n \\"node_name_mode\\": \\"aliyun.com192.XX.YY.55test\\",\\n \\"pre_user_data\\": \\"IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD\\"\\n },\\n \\"tee_config\\": {\\n \\"tee_enable\\": false\\n },\\n \\"interconnect_config\\": {\\n \\"cen_id\\": \\"cen-ey9k9nfhz0f*******\\",\\n \\"ccn_id\\": \\"ccn-qm5i0i0q9yi*******\\",\\n \\"ccn_region_id\\": \\"cn-shanghai\\",\\n \\"bandwidth\\": 10,\\n \\"improved_period\\": \\"1\\"\\n },\\n \\"max_nodes\\": 10,\\n \\"interconnect_mode\\": \\"basic\\",\\n \\"auto_mode\\": {\\n \\"enable\\": true\\n },\\n \\"node_components\\": [\\n {\\n \\"name\\": \\"kubelet\\",\\n \\"version\\": \\"1.33.3-aliyun.1\\",\\n \\"config\\": {\\n \\"custom_config\\": {\\n \\"key\\": \\"cpuManagerPolicy\\"\\n }\\n }\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterNodePoolsResponse>\\n <nodepools>\\n <auto_scaling>\\n <eip_bandwidth>5</eip_bandwidth>\\n <is_bond_eip>true</is_bond_eip>\\n <eip_internet_charge_type>PayByBandwidth</eip_internet_charge_type>\\n <enable>true</enable>\\n <max_instances>10</max_instances>\\n <min_instances>2</min_instances>\\n <type>cpu</type>\\n </auto_scaling>\\n <kubernetes_config>\\n <cms_enabled>true</cms_enabled>\\n <cpu_policy>none</cpu_policy>\\n <labels>\\n <key>env</key>\\n <value>prod</value>\\n </labels>\\n <runtime>docker</runtime>\\n <runtime_version>19.03.5</runtime_version>\\n <taints>\\n <key>key</key>\\n <value>value</value>\\n <effect>NoSchedule</effect>\\n </taints>\\n <user_data>IyEvYmluL3NoCmVjaG8gIkhlbGxvIEFD****</user_data>\\n </kubernetes_config>\\n <nodepool_info>\\n <created>2020-09-27T19:14:09.156823496+08:00</created>\\n <is_default>true</is_default>\\n <name>default-nodepool</name>\\n <nodepool_id>np615c0e0966124216a0412e10afe0****</nodepool_id>\\n <region_id>cn-beijing</region_id>\\n <resource_group_id>rg-acfmyvw3wjm****</resource_group_id>\\n <type>ess</type>\\n <updated>2020-09-27T20:37:46+08:00</updated>\\n </nodepool_info>\\n <scaling_group>\\n <auto_renew>false</auto_renew>\\n <auto_renew_period>0</auto_renew_period>\\n <data_disks>\\n <category>cloud_ssd</category>\\n <size>40</size>\\n <encrypted>true</encrypted>\\n <auto_snapshot_policy_id>sp-2zej1nogjvovnz4z****</auto_snapshot_policy_id>\\n </data_disks>\\n <image_id>aliyun_2_1903_x64_20G_alibase_20200529.vhd</image_id>\\n <instance_charge_type>PostPaid</instance_charge_type>\\n <instance_types>ecs.n4.large</instance_types>\\n <multi_az_policy>COST_OPTIMIZED</multi_az_policy>\\n <on_demand_base_capacity>0</on_demand_base_capacity>\\n <on_demand_percentage_above_base_capacity>20</on_demand_percentage_above_base_capacity>\\n <spot_instance_pools>5</spot_instance_pools>\\n <spot_instance_remedy>false</spot_instance_remedy>\\n <compensate_with_on_demand>true</compensate_with_on_demand>\\n <period>0</period>\\n <period_unit>Month</period_unit>\\n <platform>AliyunLinux</platform>\\n <ram_policy>KubernetesWorkerRole-021dc54f-929b-437a-8ae0-34c24d3e****</ram_policy>\\n <spot_strategy>NoSpot</spot_strategy>\\n <spot_price_limit>\\n <instance_type>ecs.c6.large</instance_type>\\n <price_limit>0.39</price_limit>\\n </spot_price_limit>\\n <rds_instances>rm-xxx</rds_instances>\\n <scaling_group_id>asg-2ze8n5qw4atggut8****</scaling_group_id>\\n <scaling_policy>release</scaling_policy>\\n <security_group_id>sg-2ze1iuk12m2sb4c4****</security_group_id>\\n <security_group_ids>sg-2ze1iuk12m2sb4c4****</security_group_ids>\\n <system_disk_category>cloud_efficiency</system_disk_category>\\n <system_disk_size>120</system_disk_size>\\n <tags>\\n <key>env</key>\\n <value>prod</value>\\n </tags>\\n <vswitch_ids>vsw-2ze3ds0mdip0hdz8i****</vswitch_ids>\\n <login_password>******</login_password>\\n <key_pair>pro-nodepool</key_pair>\\n <internet_charge_type>PayByBandwidth</internet_charge_type>\\n <internet_max_bandwidth_out>10</internet_max_bandwidth_out>\\n </scaling_group>\\n <status>\\n <failed_nodes>0</failed_nodes>\\n <healthy_nodes>3</healthy_nodes>\\n <initial_nodes>0</initial_nodes>\\n <offline_nodes>0</offline_nodes>\\n <removing_nodes>0</removing_nodes>\\n <serving_nodes>3</serving_nodes>\\n <state>active</state>\\n <total_nodes>3</total_nodes>\\n </status>\\n <tee_config>\\n <tee_enable>false</tee_enable>\\n </tee_config>\\n <management>\\n <enable>true</enable>\\n <auto_repair>true</auto_repair>\\n <upgrade_config>\\n <auto_upgrade>true</auto_upgrade>\\n <surge>5</surge>\\n <surge_percentage>50</surge_percentage>\\n <max_unavailable>1</max_unavailable>\\n </upgrade_config>\\n </management>\\n </nodepools>\\n</DescribeClusterNodePoolsResponse>","errorExample":""}]', + 'title' => '查询节点池列表', + ], + 'DescribeNodePoolVuls' => [ + 'summary' => '您可以根据节点池ID调用DescribeNodePoolVuls接口查看节点池的安全漏洞详细信息，包括漏洞名称、漏洞等级等。建议您定期扫描节点池的安全漏洞，提高集群安全性。', + 'path' => '/clusters/{cluster_id}/nodepools/{nodepool_id}/vuls', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '119077', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c17e742cee942410486f237293d66****', + ], + ], + [ + 'name' => 'nodepool_id', + 'in' => 'path', + 'schema' => [ + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np38f32fdbc60e4a1e957ffde77846****', + ], + ], + [ + 'name' => 'necessity', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的漏洞修复必要性等级。多个等级之间使用半角逗号（,）分隔。取值：'."\n" + ."\n" + .'- `asap`：高'."\n" + .'- `later`：中'."\n" + .'- `nntf`：低', + 'type' => 'string', + 'required' => false, + 'example' => 'asap', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'vul_records' => [ + 'description' => '节点池漏洞列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点池漏洞列表。', + 'type' => 'object', + 'properties' => [ + 'instance_id' => [ + 'description' => '节点实例ID。', + 'type' => 'string', + 'example' => 'i-t4n2qolb0wtzt0pz****', + ], + 'vul_list' => [ + 'description' => '漏洞列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞信息。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'oval:com.redhat.rhsa:def:20193197', + ], + 'alias_name' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'RHSA-2019:3197-Important: sudo security update', + ], + 'necessity' => [ + 'description' => '漏洞等级。', + 'type' => 'string', + 'enumValueTitles' => [ + 'nntf' => '暂可不修复', + 'later' => '可延后修复', + 'asap' => '需尽快修复', + ], + 'example' => 'asap', + ], + 'cve_list' => [ + 'description' => '漏洞对应的CVE列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'CVE名称。', + 'type' => 'string', + 'example' => 'CVE-2017-10268', + ], + ], + 'need_reboot' => [ + 'title' => '是否需要重启。', + 'description' => '是否需要重启。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'package_list' => [ + 'title' => '漏洞涉及的包列表', + 'description' => '漏洞涉及的包列表', + 'type' => 'array', + 'items' => [ + 'title' => '包信息', + 'description' => '包信息', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '包名称', + 'description' => '包名称', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'node_name' => [ + 'description' => '节点名称，集群内节点标识。', + 'type' => 'string', + 'example' => 'cn-hangzhou.192.168.x.x', + ], + ], + ], + ], + 'vuls_fix_service_purchased' => [ + 'title' => '是否已购买云安全CVE修复服务', + 'description' => '是否已购买云安全CVE修复服务。'."\n" + ."\n" + .'- true：已购买。'."\n" + ."\n" + .'- false：未购买。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"vul_records\\": [\\n {\\n \\"instance_id\\": \\"i-t4n2qolb0wtzt0pz****\\",\\n \\"vul_list\\": [\\n {\\n \\"name\\": \\"oval:com.redhat.rhsa:def:20193197\\",\\n \\"alias_name\\": \\"RHSA-2019:3197-Important: sudo security update\\",\\n \\"necessity\\": \\"asap\\",\\n \\"cve_list\\": [\\n \\"CVE-2017-10268\\"\\n ],\\n \\"need_reboot\\": false,\\n \\"package_list\\": [\\n {\\n \\"name\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"node_name\\": \\"cn-hangzhou.192.168.x.x\\"\\n }\\n ],\\n \\"vuls_fix_service_purchased\\": false\\n}","type":"json"}]', + 'title' => '查询节点池漏洞', + ], + 'ModifyClusterNodePool' => [ + 'summary' => '您可以根据节点池ID，调用ModifyClusterNodePool接口更新目标节点池的配置。', + 'path' => '/clusters/{ClusterId}/nodepools/{NodepoolId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeCode' => '528', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c23421cfa74454bc8b37163fd19af****', + ], + ], + [ + 'name' => 'NodepoolId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'p31da1b38983f4511b490fc62108a****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数。', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'nodepool_info' => [ + 'title' => '节点池配置。', + 'description' => '节点池配置。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '节点池名称。', + 'description' => '节点池名称。'."\n" + ."\n" + .'命名规则：由数字、汉字、英文字符或短划线（-）组成，长度范围1~63个字符，且不能以短划线（-）开头。', + 'type' => 'string', + 'required' => false, + 'example' => 'default-nodepool', + ], + 'resource_group_id' => [ + 'title' => '资源组ID。', + 'description' => '节点池的资源组ID，节点池弹出的实例将属于该资源组内。'."\n" + ."\n" + .'一个资源只能归属于一个资源组。根据不同的业务场景，您可以将资源组映射为项目、应用或组织等概念。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmyvw3wjm****', + ], + ], + 'required' => false, + ], + 'auto_scaling' => [ + 'title' => '自动伸缩节点池配置。', + 'description' => '自动伸缩配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否开启自动伸缩。', + 'description' => '是否启用自动伸缩，取值：'."\n" + ."\n" + .'- `true`：开启节点池自动伸缩功能。当集群的容量规划无法满足应用Pod调度时，ACK会根据配置的最小和最大实例数自动扩缩节点资源。1.24及以上版本的集群默认启用节点即时弹性；'."\n" + .'1.24以下版本的集群默认启用节点自动伸缩。更多信息，请参见[节点伸缩](~~2746785~~)。'."\n" + ."\n" + .'- `false`：不开启自动伸缩，ACK会根据配置的期望节点数调整节点池中的节点数，将节点数始终维持在期望节点数。'."\n" + ."\n" + .'当取值为false时，`auto_scaling`内的其他配置参数将不生效。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'type' => [ + 'title' => '自动伸缩节点类型。', + 'description' => '自动伸缩类型，按照自动伸缩实例类型划分。取值：'."\n" + ."\n" + .'- `cpu`：普通实例型。'."\n" + .'- `gpu`：GPU实例型。'."\n" + .'- `gpushare`：GPU共享型。'."\n" + .'- `spot`：抢占式实例型。'."\n" + ."\n" + .'默认值：`cpu`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cpu', + ], + 'max_instances' => [ + 'title' => '最大实例数。', + 'description' => '节点池中可伸缩的最大实例数，不包含您已有的实例。仅当`enable=true`生效。'."\n" + ."\n" + .'取值范围[min_instances, 2000]，默认值为0。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'min_instances' => [ + 'title' => '最小实例数。', + 'description' => '节点池中可伸缩的最小实例数，不包含您已有的实例。仅当`enable=true`生效。'."\n" + ."\n" + .'取值范围[0, max_instances]，默认值为0。'."\n" + ."\n" + .'> - 最小实例数不为0时，伸缩组生效后，将自动创建对应数量的ECS实例。'."\n" + .'> - 建议设置的最大实例数不要小于当前节点池中的节点数，否则弹性伸缩功能生效后会直接导致节点池的节点缩容。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'is_bond_eip' => [ + 'title' => '是否绑定EIP。', + 'description' => '【该字段已废弃】该字段已废弃，请使用internet_charge_type和internet_max_bandwidth_out替代。'."\n" + ."\n" + .'- `true`：绑定EIP。'."\n" + .'- `false`：不绑定EIP。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'eip_internet_charge_type' => [ + 'title' => 'EIP计费类型。', + 'description' => '【该字段已废弃】请使用internet_charge_type和internet_max_bandwidth_out替代。'."\n" + ."\n" + .'EIP计费类型，取值：'."\n" + ."\n" + .'- `PayByBandwidth`：按固定带宽计费。'."\n" + .'- `PayByTraffic`：按使用流量计费。'."\n" + ."\n" + .'默认值：`PayByBandwidth`。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'eip_bandwidth' => [ + 'title' => '带宽峰值。', + 'description' => '【该字段已废弃】请使用internet_charge_type和internet_max_bandwidth_out替代。'."\n" + .'EIP带宽峰值。'."\n" + ."\n" + .'取值范围：[1,100]，单位：Mbps。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + ], + 'required' => false, + ], + 'management' => [ + 'title' => '托管版节点池配置。', + 'description' => '托管节点池配置。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'title' => '是否启用托管节点池。', + 'description' => '是否开启托管节点池，取值：'."\n" + ."\n" + .'- `true`：开启托管节点池。'."\n" + .'- `false`：不开启托管节点池，只有当`enable=true`时，其他相关配置才生效。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_repair' => [ + 'title' => '是否开启自动修复。', + 'description' => '是否自动修复节点，仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：自动修复。'."\n" + ."\n" + .'- `false`：不自动修复。'."\n" + ."\n" + .'默认值为`true`', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_repair_policy' => [ + 'title' => '自动修复节点策略。', + 'description' => '自动修复节点策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点，仅当`auto_repair=true`时生效。取值：'."\n" + ."\n" + .'- `true`：允许重启节点。'."\n" + .'- `false`：不允许重启节点。'."\n" + ."\n" + .'默认值为`true`', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'approval_required' => [ + 'title' => '节点修复是否需要人工审批。', + 'description' => '节点修复是否需要人工审批。', + 'type' => 'boolean', + 'required' => false, + ], + 'auto_repair_policy_id' => [ + 'title' => '自动修复策略ID', + 'description' => '自动修复策略ID', + 'type' => 'string', + 'required' => false, + 'example' => 'r-xxxxxxxxxx', + ], + ], + 'required' => false, + ], + 'auto_vul_fix' => [ + 'title' => '是否自动修复CVE。', + 'description' => '是否自动修复CVE漏洞，仅当`enable=true`时生效。'."\n" + ."\n" + .'- `true`：允许自动修复CVE。'."\n" + .'- `false`：不允许自动修复CVE。'."\n" + ."\n" + .'默认值为`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_vul_fix_policy' => [ + 'title' => '自动修复CVE策略。', + 'description' => '自动修复CVE策略。', + 'type' => 'object', + 'properties' => [ + 'restart_node' => [ + 'title' => '是否允许重启节点。', + 'description' => '是否允许重启节点，仅当`auto_vul_fix=true`时生效。取值：'."\n" + .'- `true`：允许重启节点。'."\n" + .'- `false`：不允许重启节点。'."\n" + ."\n" + .'默认值为`true`', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'vul_level' => [ + 'title' => '允许自动修复的漏洞级别，以逗号分隔。', + 'description' => '允许自动修复的漏洞级别，以英文逗号分隔，例如：`asap,later`。支持的漏洞级别：'."\n" + ."\n" + .'- `asap`：高'."\n" + .'- `later`：中'."\n" + .'- `nntf`：低'."\n" + ."\n" + .'默认值为`asap`。', + 'type' => 'string', + 'required' => false, + 'example' => 'asap,nntf', + ], + 'exclude_packages' => [ + 'title' => '指定在漏洞修复过程中应排除的包。', + 'description' => '指定在漏洞修复过程中应排除的包。'."\n" + ."\n" + .'默认值为`kernel`。', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'auto_upgrade' => [ + 'title' => '是否自动升级。', + 'description' => '是否自动升级节点，仅当`enable=true`时生效。'."\n" + .'- `true`：启用自动升级。'."\n" + .'- `false`：不启用自动升级。'."\n" + ."\n" + .'默认值为`true`', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_upgrade_policy' => [ + 'title' => '自动升级策略。', + 'description' => '自动升级策略。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade_kubelet' => [ + 'title' => '是否允许自动升级kubelet。', + 'description' => '是否允许自动升级kubelet，仅当`auto_upgrade=true`时生效。取值：'."\n" + .'- `true`：允许自动升级kubelet。'."\n" + .'- `false`：不允许自动升级kubelet。'."\n" + ."\n" + .'默认值为`true`', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_upgrade_runtime' => [ + 'title' => '是否允许自动升级运行时。', + 'description' => '是否允许自动升级运行时，仅当`auto_upgrade=true`时生效。取值：'."\n" + .'- `true`：允许自动升级运行时。'."\n" + .'- `false`：不允许自动升级运行时。'."\n" + ."\n" + .'默认值为`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'auto_upgrade_os' => [ + 'title' => '是否允许自动升级操作系统。', + 'description' => '是否允许自动升级操作系统，仅当`auto_upgrade=true`时生效。取值：'."\n" + .'- `true`：允许自动升级操作系统。'."\n" + .'- `false`：不允许自动升级操作系统。'."\n" + ."\n" + .'默认值为`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'upgrade_config' => [ + 'title' => '自动升级配置。', + 'description' => '【该字段已废弃】请使用上层的`auto_upgrade`参数替代。'."\n" + ."\n" + .'自动升级配置，仅当`enable=true`时生效。', + 'type' => 'object', + 'properties' => [ + 'auto_upgrade' => [ + 'title' => '是否启用自动升级，自修复。', + 'description' => '【该字段已废弃】请使用上层的`auto_upgrade`参数替代。'."\n" + ."\n" + .'是否启用自动升级：'."\n" + ."\n" + .'- true：启用。'."\n" + .'- false：不启用。'."\n" + ."\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + 'surge' => [ + 'title' => '额外节点数量。', + 'description' => '额外节点数量。和`surge_percentage`二选一。'."\n" + ."\n" + .'升级的时候节点会不可用，您可以创建额外节点补偿集群的负载。'."\n" + ."\n" + .'> 建议创建的额外节点不超过当前的节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'surge_percentage' => [ + 'title' => '额外节点比例， 和surge 二选一。', + 'description' => '额外节点数的百分比，和`surge`二选一。'."\n" + ."\n" + .'额外节点数=额外节点数比例×节点数，例如，设置额外节点数比例为50%，存在的节点数为6，那么将产生的额外节点数=50%×6，也就是将产生3个额外节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'max_unavailable' => [ + 'title' => '最大不可用节点数量。', + 'description' => '最大不可用节点数量。'."\n" + ."\n" + .'取值范围：\\[1,1000\\]'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + 'deprecated' => true, + 'required' => false, + ], + ], + 'required' => false, + ], + 'scaling_group' => [ + 'title' => '扩容组配置。', + 'description' => '节点池伸缩组配置。', + 'type' => 'object', + 'properties' => [ + 'vswitch_ids' => [ + 'title' => '节点使用的虚拟交换机ID。', + 'description' => '虚拟交换机ID列表，取值范围\\[1,8\\]。'."\n" + ."\n" + .'> 为保证高可用性，建议选择不同可用区的虚拟交换机。', + 'type' => 'array', + 'items' => [ + 'description' => '虚拟交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-wz9uwxhawmtzg7u9h****', + ], + 'required' => false, + ], + 'instance_types' => [ + 'title' => '节点实例规格。', + 'description' => '节点实例规格列表，您可以选择多个实例规格作为备选，每个节点创建时，将从第一个规格开始尝试购买，直到创建成功。最终购买的实例规格可能随库存变化而不同。'."\n" + ."\n" + .'支持的实例规格数量范围：[1,10]', + 'type' => 'array', + 'items' => [ + 'description' => '实例规格。请参见[实例规格族](~~25378~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c6.large', + ], + 'required' => false, + ], + 'instance_charge_type' => [ + 'title' => '节点付费类型。', + 'description' => '节点池节点付费类型，取值：'."\n" + ."\n" + .'- `PrePaid`：预付费'."\n" + .'- `PostPaid`：按量付费'."\n" + ."\n" + .'默认值：`PostPaid`。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + ], + 'period' => [ + 'title' => '包年包月时长', + 'description' => '节点池节点包年包月时长，仅当`instance_charge_type`取值为`PrePaid`时生效，且为必选值。'."\n" + ."\n" + .'- 当`period_unit=Week`时，`period`取值范围：{ 1、2、3、4}。'."\n" + .'- 当`period_unit=Month`时，`period` 取值范围：{1、2、3、4、5、6、7、8、9、12、24、36、48、60}。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'period_unit' => [ + 'title' => '付费周期', + 'description' => '节点池节点付费周期，仅当`instance_charge_type`取值为`PrePaid`时生效，且为必选值。'."\n" + ."\n" + .'- `Month`：以月为计时单位。'."\n" + .'- `Week`：以周为计算单位。'."\n" + ."\n" + .'默认值：`Month`。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + 'auto_renew' => [ + 'title' => '节点池节点是启用自动续费', + 'description' => '节点是否开启自动续费，当`instance_charge_type`取值为`PrePaid`时才生效。取值：'."\n" + ."\n" + .'- `true`：自动续费。'."\n" + .'- `false`：不自动续费。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'auto_renew_period' => [ + 'title' => '节点池节点自动续费周期', + 'description' => '单次自动续费的续费时长。取值范围：'."\n" + .'- PeriodUnit=Week 时：1、2、3。'."\n" + .'- PeriodUnit=Month 时：1、2、3、6、12、24、36、48、60。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'spot_strategy' => [ + 'title' => '抢占式实例类型', + 'description' => '抢占式实例类型，取值：'."\n" + ."\n" + .'- `NoSpot`：非抢占式实例。'."\n" + .'- `SpotWithPriceLimit`：设置抢占实例价格上限。'."\n" + .'- `SpotAsPriceGo`：系统自动出价，跟随当前市场实际价格。'."\n" + ."\n" + .'更多信息，请参见[抢占式实例](~~157759~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'SpotWithPriceLimit', + ], + 'spot_price_limit' => [ + 'title' => '抢占实例价格上限配置', + 'description' => '抢占实例市场价格区间配置。', + 'type' => 'array', + 'items' => [ + 'description' => '抢占实例市场价格区间配置。', + 'type' => 'object', + 'properties' => [ + 'instance_type' => [ + 'title' => '抢占式实例规格', + 'description' => '抢占式实例规格。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs.c6.large', + ], + 'price_limit' => [ + 'title' => '单台实例上限价格，单位：元/小时。', + 'description' => '单台实例上限价格。'."\n" + ."\n" + .'<props="china">单位：元/小时。'."\n" + ."\n" + .'</props>'."\n" + ."\n" + .'<props="intl">单位：美元/小时。</props>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0.39', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'image_type' => [ + 'title' => '操作系统发行版类型，推荐使用该字段指定节点操作系统。取值：CentOS、AliyunLinux、AliyunLinux Qboot、AliyunLinuxUEFI、AliyunLinux3、Windows、WindowsCore、AliyunLinux3Arm64、ContainerOS。', + 'description' => '操作系统发行版类型，推荐使用该字段指定节点操作系统。取值：'."\n" + ."\n" + .'- `AliyunLinux`：Alinux2镜像。'."\n" + .'- `AliyunLinuxSecurity`：Alinux2镜像UEFI版。'."\n" + .'- `AliyunLinux3`：Alinux3镜像。'."\n" + .'- `AliyunLinux3Arm64`：Alinux3镜像ARM版。'."\n" + .'- `AliyunLinux3Security`：Alinux3镜像UEFI版。'."\n" + .'- `CentOS`：CentOS镜像。'."\n" + .'- `Windows`：Windows镜像。'."\n" + .'- `WindowsCore`：WindowsCore镜像。'."\n" + .'- `ContainerOS`：容器优化镜像。'."\n" + .'- `AliyunLinux3ContainerOptimized`: Alinux3镜像容器优化版。', + 'type' => 'string', + 'required' => false, + 'example' => 'AliyunLinux3', + ], + 'image_id' => [ + 'title' => '自定义镜像', + 'description' => '自定义镜像ID。可通过`DescribeKubernetesVersionMetadata`查询系统支持的镜像，默认使用系统最新镜像。', + 'type' => 'string', + 'required' => false, + 'example' => "\n" + .'aliyun_3_x64_20G_alibase_20241218.vhd', + ], + 'system_disk_category' => [ + 'title' => '节点系统盘类型。', + 'description' => '节点系统盘类型，取值：'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL 云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry 云盘。'."\n" + ."\n" + .'默认值：`cloud_efficiency`。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_efficiency', + ], + 'system_disk_categories' => [ + 'title' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。取值范围：cloud：普通云盘。cloud_efficiency：高效云盘。cloud_ssd：SSD云盘。cloud_essd：ESSD云盘。', + 'description' => '系统盘的多磁盘类型。当无法使用高优先级的磁盘类型时，自动尝试下一优先级的磁盘类型创建系统盘。', + 'type' => 'array', + 'items' => [ + 'title' => '节点系统盘类型', + 'description' => '节点的多系统盘类型。'."\n" + ."\n" + .'取值范围：'."\n" + .'- `cloud_efficiency`：高效云盘。'."\n" + .'- `cloud_ssd`：SSD云盘。'."\n" + .'- `cloud_essd`：ESSD云盘。'."\n" + .'- `cloud_auto`：ESSD AutoPL云盘。'."\n" + .'- `cloud_essd_entry`：ESSD Entry云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + 'enum' => [], + ], + 'required' => false, + 'maxItems' => 10, + ], + 'system_disk_size' => [ + 'title' => '节点系统盘大小。', + 'description' => '节点系统盘大小，单位为GiB。'."\n" + ."\n" + .'取值范围：\\[20,2048\\]。'."\n" + ."\n" + .'该参数的取值必须大于或者等于max{20, ImageSize}。'."\n" + ."\n" + .'默认值：max{40, 参数ImageId对应的镜像大小}。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '120', + ], + 'system_disk_performance_level' => [ + 'title' => '节点系统盘磁盘性能，只针对ESSD磁盘生效', + 'description' => '节点系统盘磁盘性能，只对ESSD磁盘生效。磁盘性能等级和磁盘大小有关。更多信息，请参见[ESSD云盘](~~122389~~)。'."\n" + .'- PL0：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL1：并发极限I/O性能中等，读写时延较为稳定。'."\n" + .'- PL2：并发极限I/O性能较高，读写时延稳定。'."\n" + .'- PL3：并发极限I/O性能极高，读写时延极稳定。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'system_disk_encrypted' => [ + 'title' => '是否加密系统盘。取值范围：true：加密。false：不加密。', + 'description' => '是否加密系统盘。取值范围：'."\n" + ."\n" + .'- true：加密。'."\n" + ."\n" + .'- false：不加密。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'system_disk_kms_key_id' => [ + 'title' => '系统盘使用的KMS密钥ID。', + 'description' => '系统盘使用的KMS密钥ID。', + 'type' => 'string', + 'required' => false, + 'example' => '0e478b7a-4262-4802-b8cb-00d3fb40****', + ], + 'system_disk_encrypt_algorithm' => [ + 'title' => '系统盘采用的加密算法。取值范围：aes-256。', + 'description' => '系统盘采用的加密算法。取值范围：aes-256。', + 'type' => 'string', + 'required' => false, + 'example' => 'aes-256', + 'enum' => [], + ], + 'system_disk_provisioned_iops' => [ + 'title' => '节点系统盘预配置的读写IOPS，磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘预配置的读写IOPS。'."\n" + ."\n" + .'可能值：0~min{50,000, 1000\\*容量-基准性能}。 基准性能=min{1,800+50\\*容量, 50000}。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'system_disk_bursting_enabled' => [ + 'title' => '节点系统盘是否开启Burst（性能突发），磁盘类型为cloud_auto时配置。', + 'description' => '节点系统盘是否开启Burst（性能突发）。 取值：'."\n" + .'- true：开启。开启后，波动性业务面临突发的数据读写压力时，云盘会根据业务实际情况临时提升云盘性能，直至业务恢复至平稳状态。'."\n" + .'- false：不开启。'."\n" + ."\n" + .'当`system_disk_category`取值为`cloud_auto`时才支持设置该参数。更多信息，请参见[ESSD AutoPL云盘](~~368372~~)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'data_disks' => [ + 'title' => '数据盘配置。', + 'description' => '节点数据盘配置，取值范围\\[0,10\\]。最多支持添加10块数据盘。', + 'type' => 'array', + 'items' => [ + 'description' => '节点数据盘配置。', + 'required' => false, + '$ref' => '#/components/schemas/data_disk', + ], + 'required' => false, + ], + 'disk_init' => [ + 'title' => '块设备初始化配置。', + 'description' => '块设备初始化配置。', + 'type' => 'array', + 'items' => [ + 'description' => '块设备初始化配置。', + 'required' => false, + '$ref' => '#/components/schemas/DiskInit', + ], + 'required' => false, + ], + 'key_pair' => [ + 'title' => '密钥对名称，和login_password二选一。', + 'description' => '密钥对名称，和`login_password`二选一。当节点池为托管版节点池时，只支持`key_pair`。', + 'type' => 'string', + 'required' => false, + 'example' => 'pro-nodepool', + ], + 'login_password' => [ + 'title' => 'SSH登录密码，和key_pari二选一。', + 'description' => 'SSH登录密码，和`key_pair`二选一。密码规则为8~30个字符，且至少同时包含三项（大小写字母、数字和特殊符号）。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hello1234', + ], + 'internet_charge_type' => [ + 'title' => '节点公网IP网络计费类型', + 'description' => '公网IP收费类型。取值：'."\n" + ."\n" + .'- `PayByBandwidth`：按固定带宽计费。'."\n" + .'- `PayByTraffic`：按使用流量计费。', + 'type' => 'string', + 'required' => false, + 'example' => 'PayByBandwidth', + ], + 'internet_max_bandwidth_out' => [ + 'title' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：1~100', + 'description' => '节点公网IP出带宽最大值，单位为Mbps（Mega bit per second），取值范围：\\[1,100\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'tags' => [ + 'title' => 'ECS标签。', + 'description' => '仅为ECS实例添加标签。'."\n" + ."\n" + .'标签键不可以重复，最大长度为128个字符；标签键和标签值都不能以“aliyun”、“acs:”开头，或包含“https://”、“http://”。', + 'type' => 'array', + 'items' => [ + 'description' => 'ECS实例标签。', + 'required' => false, + '$ref' => '#/components/schemas/tag', + ], + 'required' => false, + ], + 'desired_size' => [ + 'title' => '节点池期望节点数', + 'description' => '节点池期望节点数量。'."\n" + ."\n" + .'节点池应该维持的总节点数量，建议至少配置2个节点，以确保集群组件正常运行。您可以通过调整期望节点数，达到扩容或缩容节点池的目的。'."\n" + ."\n" + .'如无需创建节点，可填写为0，后续再手动调整，增加节点数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'multi_az_policy' => [ + 'title' => '多可用区伸缩组ECS实例扩缩容策略', + 'description' => '多可用区伸缩组ECS实例扩缩容策略。取值：'."\n" + ."\n" + .'- `PRIORITY`：根据您定义的虚拟交换机（VSwitchIds.N）扩缩容。当优先级较高的虚拟交换机所在可用区无法创建ECS实例时，自动使用下一优先级的虚拟交换机创建ECS实例。'."\n" + ."\n" + .'- `COST_OPTIMIZED`：按vCPU单价从低到高进行尝试创建。当伸缩配置设置了抢占式计费方式的多实例规格时，优先创建对应抢占式实例。您可以继续通过`CompensateWithOnDemand`参数指定当抢占式实例由于库存等原因无法创建时，是否自动尝试以按量付费的方式创建。'."\n" + ."\n" + .' > `COST_OPTIMIZED`仅在伸缩配置设置了多实例规格或者选用了抢占式实例的情况下生效。'."\n" + ."\n" + .'- `BALANCE`：在伸缩组指定的多可用区之间均匀分配ECS实例。如果由于库存不足等原因可用区之间变得不平衡，您可以通过API `RebalanceInstances`平衡资源。更多信息，请参见[RebalanceInstances](~~71516~~)。'."\n" + ."\n" + .'默认值：`PRIORITY`。', + 'type' => 'string', + 'required' => false, + 'example' => 'BALANCE', + ], + 'scaling_policy' => [ + 'title' => '扩容策略。', + 'description' => '伸缩组模式，取值：'."\n" + ."\n" + .'- `release`：标准模式，根据申请资源值的使用量，通过创建、释放ECS的方式进行伸缩。'."\n" + .'- `recycle`：极速模式，通过创建、停机、启动的方式进行伸缩，提高再次伸缩的速度（停机时计算资源不收费，只收取存储费用，本地盘机型除外）。', + 'type' => 'string', + 'required' => false, + 'example' => 'release', + ], + 'on_demand_base_capacity' => [ + 'title' => '伸缩组所需要按量实例个数的最小值，取值范围：0~1000。当按量实例个数少于该值时，将优先创建按量实例。', + 'description' => '伸缩组所需要按量实例个数的最小值，取值范围：\\[0,1000\\]。当按量实例个数少于该值时，将优先创建按量实例。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'on_demand_percentage_above_base_capacity' => [ + 'title' => '伸缩组满足最小按量实例数（OnDemandBaseCapacity）要求后，超出的实例中按量实例应占的比例，取值范围：0～100。', + 'description' => '伸缩组满足最小按量实例数（`on_demand_base_capacity`）要求后，超出的实例中按量实例应占的比例。取值范围：\\[0,100\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'spot_instance_pools' => [ + 'title' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：1~10。', + 'description' => '指定可用实例规格的个数，伸缩组将按成本最低的多个规格均衡创建抢占式实例。取值范围：\\[1,10\\]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'spot_instance_remedy' => [ + 'title' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。', + 'description' => '是否开启补齐抢占式实例。开启后，当收到抢占式实例将被回收的系统消息时，伸缩组将尝试创建新的实例，替换掉将被回收的抢占式实例。取值：'."\n" + ."\n" + .'- `true`：开启补齐抢占式实例。'."\n" + .'- `false`：不开启补齐抢占式实例。'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'compensate_with_on_demand' => [ + 'title' => '当MultiAZPolicy取值为COST_OPTIMIZED时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值范围：true：允许。false：不允许。默认值：true', + 'description' => '当`multi_az_policy`取值为`COST_OPTIMIZED`时，如果因价格、库存等原因无法创建足够的抢占式实例，是否允许自动尝试创建按量实例满足ECS实例数量要求。取值：'."\n" + ."\n" + .'- `true`：允许自动尝试创建按量实例满足ECS实例数量要求。'."\n" + .'- `false`：不允许自动尝试创建按量实例满足ECS实例数量要求。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'rds_instances' => [ + 'title' => 'RDS实例列表。', + 'description' => 'RDS实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'RDS实例ID。如果指定了RDS实例列表，集群节点ECS会自动加入RDS访问白名单。', + 'type' => 'string', + 'required' => false, + 'example' => 'rds-xxx', + ], + 'required' => false, + ], + 'private_pool_options' => [ + 'title' => '私有池选项。', + 'description' => '私有节点池配置。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '私有池ID。即弹性保障服务ID或容量预定服务ID。', + 'description' => '私有节点池ID。当`match_criteria`为`Target`时，需要进一步指定私有池ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'eap-bp67acfmxazb4****', + ], + 'match_criteria' => [ + 'title' => '实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值范围： Open：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。该模式下无需设置PrivatePoolOptions.Id参数。 Target：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。该模式下必须指定私有池ID，即PrivatePoolOptions.Id参数为必填项。 None：不使用模式。实例启动将不使用私有池容量。', + 'description' => '私有节点池类型，实例启动的私有池容量选项。弹性保障服务或容量预定服务在生效后会生成私有池容量，供实例启动时选择。取值：'."\n" + .'- `Open`：开放模式。将自动匹配开放类型的私有池容量。如果没有符合条件的私有池容量，则使用公共池资源启动。'."\n" + .'- `Target`：指定模式。使用指定的私有池容量启动实例，如果该私有池容量不可用，则实例会启动失败。'."\n" + .'- `None`：不使用模式。实例启动将不使用私有池容量。', + 'type' => 'string', + 'required' => false, + 'example' => 'Open', + ], + ], + 'required' => false, + ], + 'platform' => [ + 'title' => '操作系统发行版。', + 'description' => '【该字段已废弃】请使用`image_type`参数代替。'."\n" + ."\n" + .'操作系统平台。取值：'."\n" + ."\n" + .'- `AliyunLinux`'."\n" + .'- `CentOS`'."\n" + .'- `Windows`'."\n" + .'- `WindowsCore`', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'AliyunLinux', + ], + 'instance_patterns' => [ + 'title' => '实例属性', + 'description' => '实例属性配置。', + 'type' => 'array', + 'items' => [ + 'title' => '实例属性', + 'description' => '实例属性。', + 'required' => false, + '$ref' => '#/components/schemas/instance_patterns', + ], + 'required' => false, + ], + 'deploymentset_id' => [ + 'description' => '节点池弹出ECS所属的部署集，仅对增量节点生效，存量节点的部署集不会变更。', + 'type' => 'string', + 'required' => false, + 'example' => 'ds-bp1d19mmbsv3jf6xxxxx', + ], + 'security_group_ids' => [ + 'title' => '节点池多安全组配置', + 'description' => '安全组ID列表。', + 'type' => 'array', + 'items' => [ + 'title' => '安全组id', + 'description' => '安全组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-wz9a8g2mt6x5ll******', + ], + 'required' => false, + ], + 'resource_pool_options' => [ + 'title' => '创建实例时使用的资源池及资源池策略。当您设置该参数后，需要注意：'."\n" + .'该参数只在创建按量付费实例时生效。'."\n" + .'该参数不能与private_pool_options.match_criteria、private_pool_options.id同时设置。', + 'description' => '创建实例时使用的资源池及资源池策略。当您设置该参数后，需要注意：'."\n" + .'该参数只在创建按量付费实例时生效。'."\n" + .'该参数不能与private_pool_options.match_criteria、private_pool_options.id同时设置。', + 'type' => 'object', + 'properties' => [ + 'strategy' => [ + 'title' => '创建实例时使用的资源池策略。资源池包括弹性保障服务或容量预定服务生效后生成的私有池以及公共池，供实例启动时选择。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。选择此种策略时， 当指定了 resouce_pool_options.private_pool_ids，优先使用指定的私有池。如果未指定私有池或指定的私有池容量不足，将自动匹配开放类型的私有池。如果没有符合条件的私有池，则使用公共池创建实例。'."\n" + .'PrivatePoolOnly：仅限私有池。选择此种策略时，必须指定 resouce_pool_options.private_pool_ids。如果指定的私有池容量不足，则实例会启动失败。'."\n" + .'None：不使用资源池策略。'."\n" + .'默认值：None。', + 'description' => '创建实例时使用的资源池策略。资源池包括弹性保障服务或容量预定服务生效后生成的私有池以及公共池，供实例启动时选择。取值范围：'."\n" + .'PrivatePoolFirst：私有池优先。选择此种策略时， 当指定了 resouce_pool_options.private_pool_ids，优先使用指定的私有池。如果未指定私有池或指定的私有池容量不足，将自动匹配开放类型的私有池。如果没有符合条件的私有池，则使用公共池创建实例。'."\n" + .'PrivatePoolOnly：仅限私有池。选择此种策略时，必须指定 resouce_pool_options.private_pool_ids。如果指定的私有池容量不足，则实例会启动失败。'."\n" + .'None：不使用资源池策略。'."\n" + .'默认值：None。', + 'type' => 'string', + 'required' => false, + 'example' => 'PrivatePoolFirst', + 'enum' => [ + 'PrivatePoolFirst', + 'PrivatePoolOnly', + 'None', + ], + ], + 'private_pool_ids' => [ + 'title' => '私有池 ID列表。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。N 的取值范围：1~20。', + 'description' => '私有池 ID列表。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。N 的取值范围：1~20。', + 'type' => 'array', + 'items' => [ + 'title' => '私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。', + 'description' => '私有池 ID。即弹性保障服务 ID 或容量预定服务 ID。该参数只能传入 Target 模式私有池 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'eap-bp67acfmxazb4****', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'system_disk_snapshot_policy_id' => [ + 'title' => '系统盘磁盘快照策略', + 'description' => '系统盘磁盘快照策略', + 'type' => 'string', + 'required' => false, + ], + ], + 'required' => false, + ], + 'kubernetes_config' => [ + 'title' => '集群配置。', + 'description' => '集群相关配置。', + 'type' => 'object', + 'properties' => [ + 'labels' => [ + 'title' => '节点标签。', + 'description' => '节点标签，为Kubernetes集群节点添加标签。标签定义规则：'."\n" + ."\n" + .'- 标签由区分大小写的键值对组成，您最多可以设置20个标签。'."\n" + .'- 标签键不可以重复，最长为64个字符；标签值可以为空，最长为128个字符。标签键和标签值都不能以`aliyun`、`acs:`、`https://`或`http://`开头。更多信息，请参见[Labels and Selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。', + 'type' => 'array', + 'items' => [ + 'description' => '节点标签。', + 'required' => false, + '$ref' => '#/components/schemas/tag', + ], + 'required' => false, + ], + 'taints' => [ + 'title' => '污点配置。', + 'description' => '节点污点配置。', + 'type' => 'array', + 'items' => [ + 'description' => '节点污点配置。', + 'required' => false, + '$ref' => '#/components/schemas/taint', + ], + 'required' => false, + ], + 'runtime' => [ + 'title' => '容器运行时。', + 'description' => '容器运行时名称，ACK 支持以下三种容器运行时。'."\n" + ."\n" + .'- containerd：推荐使用，支持所有集群版本。'."\n" + .'- Sandboxed-Container.runv：安全沙箱容器，提供更高的隔离性，支持 1.31 及以下版本集群。'."\n" + .'- docker：已停止维护，支持1.22及以下版本集群。'."\n" + ."\n" + .'默认值：containerd。', + 'type' => 'string', + 'required' => false, + 'example' => 'containerd', + ], + 'runtime_version' => [ + 'title' => '容器运行时版本。', + 'description' => '容器运行时版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.6.38', + ], + 'cpu_policy' => [ + 'title' => 'CPU管理策略。', + 'description' => '节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略：'."\n" + ."\n" + .'- `static`：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + .'- `none`：表示启用现有的默认CPU亲和性方案。'."\n" + ."\n" + .'默认值：`none`。', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + 'unschedulable' => [ + 'description' => '扩容后的节点是否不可调度。'."\n" + ."\n" + .'- true：不可调度。'."\n" + ."\n" + .'- false：可调度。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'user_data' => [ + 'title' => '实例自定义数据。', + 'description' => '实例自定义数据。节点加入集群后，将运行您指定的实例自定义数据脚本。请参见[User-Data脚本](~~49121~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi', + ], + 'cms_enabled' => [ + 'title' => '是否开启云监控。', + 'description' => '是否在ECS节点上安装云监控，安装后可以在云监控控制台查看所创建ECS实例的监控信息，推荐开启。取值：'."\n" + ."\n" + .'- `true`：在ECS节点上安装云监控。'."\n" + .'- `false`：不在ECS节点上安装云监控。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'pre_user_data' => [ + 'description' => '实例预自定义数据。节点加入集群前，将运行您指定的实例预自定义数据脚本。请参见[User-Data脚本](~~49121~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi', + ], + 'node_name_mode' => [ + 'title' => '自定义节点名称格式。', + 'description' => '自定义节点名称参数。节点名称由三部分组成：前缀 + 节点 IP + 后缀'."\n" + ."\n" + .'前缀和后缀均可由“.”分隔的一个或多个部分构成，每个部分可以使用小写字母、数字和“-”，节点名称首尾必须为小写字母和数字；节点 IP 为完整的节点私网 IP 地址；'."\n" + ."\n" + .'传参包含四个部分，由逗号分隔，例如：参数传入"customized,aliyun,ip,com"字符串（其中“customized”和"ip"为固定的字符串，aliyun 为前缀，com 为后缀），则节点的名称为：aliyun.192.168.xxx.xxx.com。', + 'type' => 'string', + 'required' => false, + 'example' => 'customized,aliyun,ip,com', + ], + ], + 'required' => false, + ], + 'tee_config' => [ + 'title' => '加密计算配置。', + 'description' => '加密计算集群配置。', + 'type' => 'object', + 'properties' => [ + 'tee_enable' => [ + 'title' => '是否为加密计算节点池。', + 'description' => '是否开启加密计算集群，取值：'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：不开启。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'update_nodes' => [ + 'title' => '是否同步更新节点标签及污点。', + 'description' => '同步更新节点标签及污点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'concurrency' => [ + 'title' => '是否并发。', + 'description' => '是否并发。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据。', + 'description' => '返回体数据。', + 'type' => 'object', + 'properties' => [ + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5fd211e924e1d00787000293', + ], + 'nodepool_id' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'example' => 'np737c3ac1ac684703b9e10673aa2c****', + ], + 'request_id' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4314****', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"task_id\\": \\"T-5fd211e924e1d00787000293\\",\\n \\"nodepool_id\\": \\"np737c3ac1ac684703b9e10673aa2c****\\",\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4314****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyClusterNodePoolResponse>\\n <task_id>T-5fd211e924e1d00787000293</task_id>\\n <nodepool_id>np737c3ac1ac684703b9e10673aa2c****</nodepool_id>\\n</ModifyClusterNodePoolResponse>","errorExample":""}]', + 'title' => '修改节点池配置', + ], + 'ScaleClusterNodePool' => [ + 'summary' => '您可以调用ScaleClusterNodePool对节点进行扩容，以保证节点数量足够支撑业务运行。', + 'path' => '/clusters/{ClusterId}/nodepools/{NodepoolId}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c23421cfa74454bc8b37163fd19af****', + ], + ], + [ + 'name' => 'NodepoolId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np31da1b38983f4511b490fc62108a****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '扩容配置', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'count' => [ + 'title' => '扩容节点数量', + 'description' => '扩容节点数量。例如，当前节点池已有2个节点，这里扩容2个后将变成4个节点。受当前集群节点配额限制，单次操作最多扩容500个节点。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回结构体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5faa48fb31b6b8078d00****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"task_id\\": \\"T-5faa48fb31b6b8078d00****\\"\\n}","errorExample":""},{"type":"xml","example":"<task_id>T-5faa48fb31b6b8078d00****</task_id>","errorExample":""}]', + 'title' => '扩容节点池', + ], + 'AttachInstancesToNodePool' => [ + 'summary' => '如果需要将已有ECS实例添加到ACK集群中作为Worker节点，或移除Worker节点后需将节点实例重新加入节点池，您可以调用AttachInstancesToNodePool将已有节点添加到节点池。', + 'path' => '/clusters/{ClusterId}/nodepools/{NodepoolId}/attach', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'NodepoolId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np31da1b38983f4511b490fc62108a****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'instances' => [ + 'description' => '待添加的ECS实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待添加的ECS实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2zed0sswuau6o89b****', + ], + 'required' => false, + ], + 'password' => [ + 'description' => '待添加实例的SSH登录密码。', + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + 'format_disk' => [ + 'description' => '是否将容器数据和镜像存储在数据盘中。取值：'."\n" + ."\n" + .'- `true`：将容器数据和镜像存储在数据盘。'."\n" + ."\n" + .'- `false`：不将容器数据和镜像存储在数据盘。'."\n" + ."\n" + .'默认值：`false`。'."\n" + ."\n\n" + .'数据盘挂载规则：'."\n" + ."\n" + .'- 如果ECS已挂载数据盘，且最后一块数据盘的文件系统未初始化，系统会自动将该数据盘格式化为EXT4，用来存放内容/var/lib/docker、/var/lib/kubelet。'."\n" + .'- 如果ECS未挂载数据盘，则不会挂载新的数据盘。'."\n" + .'>当选择将数据存储至数据盘并且ECS已挂载数据盘，数据盘内原有数据将丢失，请注意备份数据。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'keep_instance_name' => [ + 'description' => '是否保留原实例名称。取值：'."\n" + ."\n" + .'- `true`：保留实例名称。'."\n" + ."\n" + .'- `false`：不保留实例名称。'."\n" + ."\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D7631D83-6E98-1949-B665-766A62xxxxxx', + ], + 'task_id' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5a54309c80282e39eaxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"D7631D83-6E98-1949-B665-766A62xxxxxx\\",\\n \\"task_id\\": \\"T-5a54309c80282e39eaxxxxxx\\"\\n}","type":"json"}]', + 'title' => '添加已有节点到节点池', + ], + 'RemoveNodePoolNodes' => [ + 'summary' => '当您不再需要集群节点继续工作时，可以调用RemoveNodePoolNodes接口将集群中的节点移出节点池，并同时调整期望节点数。移除节点时，您可以选择是否同时释放ECS、是否自动排空节点。移除节点会涉及Pod迁移，可能会影响业务，请在业务低峰期操作并提前做好相关的数据备份。', + 'path' => '/clusters/{ClusterId}/nodepools/{NodepoolId}/nodes', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c23421cfa74454bc8b37163fd19af****', + ], + ], + [ + 'name' => 'NodepoolId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np97de2cfb1ba042398dd8f5504c94****', + ], + ], + [ + 'name' => 'release_node', + 'in' => 'query', + 'schema' => [ + 'title' => '是否释放节点。', + 'description' => '是否释放节点。可选值：'."\n" + .'- true：释放。'."\n" + .'- false：不释放。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'drain_node', + 'in' => 'query', + 'schema' => [ + 'title' => '是否排水节点。', + 'description' => '是否排水节点。可选值：'."\n" + .'- true：排水。'."\n" + .'- false：不排水。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'nodes', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '【该字段已废弃】请使用instance_ids参数代替'."\n" + .'移除节点列表。', + 'description' => '【该参数已废弃】'."\n" + ."\n" + .'移除节点列表。'."\n" + ."\n" + .'><danger>该参数已废弃，请使用`instance_ids`代替。</danger>', + 'type' => 'array', + 'items' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou.172.16.xxx.xxx', + ], + 'deprecated' => true, + 'required' => false, + ], + ], + [ + 'name' => 'instance_ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '移除实例列表。', + 'description' => '待移除的实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待移除的实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-bp1c70fqbv1nlu9xxxxx', + ], + 'required' => false, + ], + ], + [ + 'name' => 'concurrency', + 'in' => 'query', + 'schema' => [ + 'title' => '是否并发移除。', + 'description' => '是否并发移除。'."\n" + ."\n" + .'- true：节点将并发从伸缩组中被移除。'."\n" + ."\n" + .'- false：节点将顺序从伸缩组中被移除。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应体。', + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A9891419-D125-4D89-AFCA-68846675****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-62a944794ee141074400****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"request_id\\": \\"A9891419-D125-4D89-AFCA-68846675****\\",\\n \\"task_id\\": \\"T-62a944794ee141074400****\\"\\n}","errorExample":""},{"type":"xml","example":"<RemoveNodePoolNodesResponse>\\n <request_id>A9891419-D125-4D89-AFCA-68846675E2F7</request_id>\\n <task_id>T-62a944794ee141074400****</task_id>\\n</RemoveNodePoolNodesResponse>","errorExample":""}]', + 'title' => '移除节点池节点', + 'description' => '- 移除节点涉及Pod迁移，可能会影响业务，请在业务低峰期操作。'."\n" + .'- 操作过程中可能存在非预期风险，请提前做好相关的数据备份。'."\n" + .'- 操作过程中，后台会把当前节点设置为不可调度状态。'."\n" + .'- 移除节点仅移除Worker节点，不会移除Master节点。'."\n" + .' - 即使选择了释放节点（即`release_node`为`true`的节点），包年包月的节点也不会释放。需要您在移除节点后，通过[ECS控制台](https://ecs.console.aliyun.com/)操作释放。', + ], + 'UpgradeClusterNodepool' => [ + 'summary' => '您可以调用UpgradeClusterNodepool接口升级指定集群节点池的kubelet版本（建议与控制面版本一致）、操作系统版本或容器运行时版本。', + 'path' => '/clusters/{ClusterId}/nodepools/{NodepoolId}/upgrade', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c106f377e16f34eb1808d6b9362c9****', + ], + ], + [ + 'name' => 'NodepoolId', + 'in' => 'path', + 'schema' => [ + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'np31da1b38983f4511b490fc62108a****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'image_id' => [ + 'title' => '节点系统镜像ID。', + 'description' => '节点系统镜像ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_3_x64_20G_container_optimized_20241226.vhd', + ], + 'runtime_version' => [ + 'title' => '节点运行时版本。', + 'description' => '节点运行时版本。您可以调用[DescribeKubernetesVersionMetadata](~~2667899~~)在runtime中获取运行时版本信息。', + 'type' => 'string', + 'required' => false, + 'example' => '1.6.36', + ], + 'kubernetes_version' => [ + 'title' => '节点Kubernetes版本。', + 'description' => '节点Kubernetes版本。您可以调用[DescribeKubernetesVersionMetadata](~~2667899~~)在`KubernetesVersion`中获取当前集群版本信息。', + 'type' => 'string', + 'required' => false, + 'example' => '1.32.1-aliyun.1', + ], + 'runtime_type' => [ + 'description' => '运行时类型。您可以调用[DescribeKubernetesVersionMetadata](~~2667899~~)在runtime中获取运行时信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'containerd', + ], + 'use_replace' => [ + 'description' => '是否使用替盘升级。取值：'."\n" + .'- true：使用，即通过替换节点系统盘的方式升级节点池，ACK将按照节点池当前的配置（例如节点登录方式、标签、污点、操作系统镜像、运行时版本）重新初始化节点。'."\n" + .'- false：不使用。'."\n" + ."\n" + .'默认值：false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'rolling_policy' => [ + 'title' => '变更策略。', + 'description' => '轮转配置。', + 'type' => 'object', + 'properties' => [ + 'pause_policy' => [ + 'title' => '暂停策略。可取值：'."\n" + .'- FirstBatch：第一批完成后暂停'."\n" + .'- EveryBatch：每批完成后暂停'."\n" + .'- NotPause： 不暂停', + 'description' => '节点升级过程中的自动暂停策略。取值：'."\n" + .'- FirstBatch：第一批完成后暂停。'."\n" + .'- EveryBatch：每批完成后暂停。'."\n" + .'- NotPause： 不暂停。', + 'type' => 'string', + 'required' => false, + 'example' => 'NotPause', + 'default' => 'NotPause', + 'enum' => [ + 'FirstBatch', + 'EveryBatch', + 'NotPause', + ], + ], + 'batch_interval' => [ + 'title' => '批次之间的升级间隔时间，仅在暂停策略为NotPause时生效，单位为分钟，取值范围5-120分钟。', + 'description' => '批次之间的升级间隔时间。该参数仅在暂停策略为`NotPause`时生效。'."\n" + ."\n" + .'取值范围：[5,120]，单位：分钟。'."\n" + ."\n" + .'该参数支持设置为0，表示不设置间隔时间。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + 'default' => '0', + ], + 'max_parallelism' => [ + 'title' => '升级时的最大并发节点数。', + 'description' => '节点池内的节点更新分批次执行，该参数定义每批次最大并行更新的节点数。'."\n" + ."\n" + .'取值范围：[1,10]。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + 'default' => '10', + ], + ], + 'required' => false, + ], + 'node_names' => [ + 'title' => '指定升级的节点列表。未指定时默认升级节点池内所有节点。', + 'description' => '指定升级的节点列表。未指定时默认升级节点池内所有节点。', + 'type' => 'array', + 'items' => [ + 'title' => '节点名称。', + 'description' => '节点名称，集群内节点标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing.10.180.xx.xx', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF518944****', + ], + 'task_id' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5fd211e924e1d0078700****', + ], + ], + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF518944****\\",\\n \\"task_id\\": \\"T-5fd211e924e1d0078700****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpgradeClusterNodepoolResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF518944****</RequestId>\\n <task_id>T-5fd211e924e1d0078700xxxx</task_id>\\n</UpgradeClusterNodepoolResponse>","errorExample":""}]', + 'title' => '升级节点池', + 'description' => '通过UpgradeClusterNodepool可升级指定集群节点池内节点的Kubernetes版本、操作系统版本或容器运行时版本。成功调用UpgradeClusterNodepool接口后，该API将返回此次升级任务的`task_id`，您可以通过调用任务API管理该操作任务：'."\n" + ."\n" + .'- [调用DescribeTaskInfo查询任务详情](~~2667985~~)'."\n" + .'- [调用PauseTask暂停正在运行中的任务](~~2667986~~)'."\n" + .'- [调用ResumeTask恢复运行已暂停的任务](~~2667987~~)'."\n" + .'- [调用CancelTask取消运行中的任务](~~2667988~~)', + ], + 'RepairClusterNodePool' => [ + 'summary' => '修复集群节点池。', + 'path' => '/clusters/{cluster_id}/nodepools/{nodepool_id}/repair', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '89346', + 'abilityTreeNodes' => [ + 'FEATUREcskRXV8J4', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c2273b7f4a30d4ef6b43e0926cd******', + ], + ], + [ + 'name' => 'nodepool_id', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np613940c3593c4bea96faa8600c******', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'title' => '节点列表，如果不指定则表示当前节点池内所有节点', + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点名称，集群内节点标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing.10.0.xx.xx', + ], + 'required' => false, + ], + 'auto_restart' => [ + 'title' => '是否重启节点。', + 'description' => '【该字段已废弃】是否允许重启实例。', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'null', + ], + 'operations' => [ + 'title' => '要执行的修复操作，未指定时默认执行全部修复操作，一般场景下无需指定。', + 'description' => '要执行的修复操作，未指定时默认执行全部修复操作，一般场景下无需指定。', + 'type' => 'array', + 'items' => [ + 'title' => '修复操作。', + 'description' => '修复操作。', + 'type' => 'object', + 'properties' => [ + 'operation_id' => [ + 'title' => '修复操作ID。', + 'description' => '修复操作ID。参数取值如下：'."\n" + ."\n" + .'- restart.kubelet：重启kubelet。'."\n" + .'- restart.docker：重启Docker。'."\n" + .'- restart.containerd：重启Containerd。'."\n" + .'- restart.ntp：重启ntpd或chronyd。'."\n" + .'- remove.containerdContainerInSandbox：删除Containerd下指定的Sandbox容器。'."\n" + .'- remove.dockerContainerInSandbox：删除Docker下指定的Sandbox容器。'."\n" + .'- remove.containerdContainer：删除Containerd下指定容器。'."\n" + .'- remove.dockerContainer：删除Docker下指定容器。', + 'type' => 'string', + 'required' => false, + 'example' => 'remove.containerdContainer', + ], + 'args' => [ + 'title' => '修复操作参数列表。', + 'description' => '修复操作参数列表。', + 'type' => 'array', + 'items' => [ + 'title' => '修复操作参数。', + 'description' => '修复操作参数。'."\n" + ."\n" + .'- `operation_id`取值为`remove.containerdContainerInSandbox`时：本参数设置为Containerd下指定的Sandbox容器ID。'."\n" + .'- `operation_id`取值为`remove.dockerContainerInSandbox`时：本参数设置为Docker下指定的Sandbox容器ID。'."\n" + .'- `operation_id`取值为`remove.containerdContainer`时：本参数取值为Containerd下指定的容器ID。'."\n" + .'- `operation_id`取值为`remove.dockerContainer`时：本参数取值为Docker下指定的容器ID。'."\n" + .'- `operation_id`取值为其他时，本参数无需设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'containerd:// 67e109e9410049549695c6e64a******', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'db82195b-75a8-40e5-9be4-16f182******', + ], + 'task_id' => [ + 'title' => '任务ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-613b19bbd160ad2800******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"request_id\\": \\"db82195b-75a8-40e5-9be4-16f182******\\",\\n \\"task_id\\": \\"T-613b19bbd160ad2800******\\"\\n}","errorExample":""},{"type":"xml","example":"<RepairClusterNodePoolResponse>\\n <request_id>db82195b-75a8-40e5-9be4-16f1829dc624</request_id>\\n <task_id>T-613b19bbd160ad4928000001</task_id>\\n</RepairClusterNodePoolResponse>","errorExample":""}]', + 'title' => '修复节点池节点', + ], + 'FixNodePoolVuls' => [ + 'summary' => '阿里云云安全产品会定期扫描ECS节点上的安全漏洞，并提供对应的修复建议与方法。某些CVE的修复可能需要重启节点，请确保集群有充足的节点用于排水操作。您可以调用FixNodePoolVuls接口修复指定集群节点池的节点漏洞，提高集群节点的安全性。', + 'path' => '/clusters/{cluster_id}/nodepools/{nodepool_id}/vuls/fix', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'abilityTreeCode' => '119060', + 'abilityTreeNodes' => [ + 'FEATUREcskRXV8J4', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cf62854ac2130470897be7a27ed1f****', + ], + ], + [ + 'name' => 'nodepool_id', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np31da1b38983f4511b490fc62108a****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'vuls' => [ + 'title' => '待修复的漏洞名称列表', + 'description' => '漏洞列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'oval:com.redhat.rhsa:def:20170574', + ], + 'required' => false, + ], + 'nodes' => [ + 'title' => '待修复的节点名称列表', + 'description' => '待修复的节点名称列表，未指定则默认修复节点池内所有节点。', + 'type' => 'array', + 'items' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing.10.0.xx.xx', + ], + 'required' => false, + ], + 'rollout_policy' => [ + 'title' => '轮转修复策略', + 'description' => '轮转修复策略。', + 'type' => 'object', + 'properties' => [ + 'max_parallelism' => [ + 'title' => '轮转修复时的最大并行度', + 'description' => '节点池内的节点的CVE修复分批次执行，该参数定义每批次最大并行修复的节点数。'."\n" + ."\n" + .'取值范围：最小值为1，最大为节点池节点数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'auto_restart' => [ + 'title' => '修复完成后是否自动重启节点。', + 'description' => '是否允许重启节点。'."\n" + ."\n" + .'- true：允许重启节点。'."\n" + ."\n" + .'- false：不允许重启节点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'task_id' => [ + 'title' => '修复任务ID', + 'description' => '修复任务ID。', + 'type' => 'string', + 'example' => 'T-60fea8ad2e277f087900****', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"task_id\\": \\"T-60fea8ad2e277f087900****\\"\\n}","type":"json"}]', + 'title' => '修复节点池漏洞', + 'description' => '- CVE的兼容性由云安全中心保证，请确保已开通云安全中心旗舰版或[已购买漏洞修复（按量付费）](~~42308~~)。'."\n" + .'- 部分CVE修复需要重启节点，容器服务会在节点重启前执行本节点的排水工作，请确保集群有足够的节点空余资源用于排水，例如提前扩容节点池。'."\n" + .'- 请关注应用与CVE的兼容性。CVE修复分批次进行。CVE修复过程中，任务支持暂停或者取消。暂停或取消后，已经下发了修复任务的批次会继续执行直到完成，未下发的批次会被暂停任务下发或取消任务下发。', + ], + 'ModifyNodePoolNodeConfig' => [ + 'summary' => '您可以调用ModifyNodePoolNodeConfig接口修改集群节点池中节点配置信息，例如kubelet配置、节点轮转配置等。修改节点配置会按批次变更节点配置并重启kubelet, 可能会对节点运行和工作负载运行产生一定影响，请在业务低峰期操作。', + 'path' => '/clusters/{ClusterId}/nodepools/{NodepoolId}/node_config', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '152296', + 'abilityTreeNodes' => [ + 'FEATUREcskRXV8J4', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c23421cfa74454bc8b37163fd19af****', + ], + ], + [ + 'name' => 'NodepoolId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'np8d8c9c2cd0f64e89884f82a5fbcd****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体。', + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'kubelet_config' => [ + 'description' => 'kubelet参数配置。', + 'required' => false, + '$ref' => '#/components/schemas/kubelet_config', + ], + 'rolling_policy' => [ + 'title' => '轮转配置。', + 'description' => '轮转配置。', + 'type' => 'object', + 'properties' => [ + 'max_parallelism' => [ + 'title' => '最大不可用节点数。', + 'description' => '节点池内的节点更新分批次执行，该参数定义每批次最大并行更新的节点数。'."\n" + ."\n" + .'取值范围：[1,10]。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + 'os_config' => [ + 'description' => '操作系统参数配置。', + 'type' => 'object', + 'properties' => [ + 'sysctl' => [ + 'description' => '自定义sysctl参数配置。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => 'sysctl参数配置，请参见[自定义节点池OS参数](~~2806184~~)。', + 'example' => 'fs.aio-max-nr: '."\n" + .'65536', + ], + ], + 'hugepage' => [ + 'required' => false, + '$ref' => '#/components/schemas/Hugepage', + ], + ], + 'required' => false, + ], + 'containerd_config' => [ + 'description' => 'Containerd运行时配置。', + 'required' => false, + '$ref' => '#/components/schemas/containerd_config', + ], + 'node_names' => [ + 'title' => '指定升级的节点列表', + 'type' => 'array', + 'items' => [ + 'title' => '指定升级的节点', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou.xxx', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应体。', + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D7631D83-6E98-1949-B665-766A62****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5fd211e924e1d00787****', + ], + 'nodepool_id' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'example' => 'np737c3ac1ac684703b9e10673aa2c****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"request_id\\": \\"D7631D83-6E98-1949-B665-766A62****\\",\\n \\"task_id\\": \\"T-5fd211e924e1d00787****\\",\\n \\"nodepool_id\\": \\"np737c3ac1ac684703b9e10673aa2c****\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyNodePoolNodeConfigResponse>\\n <request_id>D7631D83-6E98-1949-B665-766A62****</request_id>\\n <task_id>T-5fd211e924e1d00787****</task_id>\\n <nodepool_id>np737c3ac1ac684703b9e10673aa2c****</nodepool_id>\\n</ModifyNodePoolNodeConfigResponse>","errorExample":""}]', + 'title' => '修改节点池节点配置', + 'description' => '> ACK支持修改节点池内节点的kubelet配置。修改完成后，节点池的节点会自动生效，节点池新增节点也将使用新的配置。', + ], + 'SyncClusterNodePool' => [ + 'summary' => '您可以调用SyncClusterNodePool接口同步集群节点池，包含节点池元数据、节点池内节点信息等。', + 'path' => '/clusters/{ClusterId}/sync_nodepools', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c905d1364c2dd4b6284a3f41790c4****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF51894XXXXX', + ], + ], + ], + ], + '5XX' => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF51894XXXXX\\"\\n}","type":"json"}]', + 'title' => '同步节点池', + ], + 'DescribeClusterAttachScripts' => [ + 'summary' => '如果需要将已有ECS实例添加到ACK集群中作为Worker节点，或移除Worker节点后需将节点实例重新加入节点池，ACK支持手动将已有节点到节点池。您可以调用DescribeClusterAttachScripts接口获取添加已有节点的脚本。', + 'path' => '/clusters/{ClusterId}/attachscript', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '401', + 'abilityTreeNodes' => [ + 'FEATUREcsk4JRUSW', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ca375a93a30474552ad2a0ebe183e****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'nodepool_id' => [ + 'title' => '节点池ID。将节点加入指定节点池。', + 'description' => '节点池ID，添加节点时可以将该节点添加到指定的节点池中。'."\n" + ."\n" + .'> 如果不指定节点池ID，默认将节点添加至默认节点池。', + 'type' => 'string', + 'required' => false, + 'example' => 'np1c9229d9be2d432c93f77a88fca0****', + ], + 'format_disk' => [ + 'title' => '数据盘挂载', + 'description' => '手动添加已有实例到集群时，是否对该实例进行数据盘挂载，将容器和镜像存储在数据盘上。取值：'."\n" + ."\n" + .'- `true`：对实例进行数据盘挂载，数据盘内原有数据将丢失，请注意备份数据。'."\n" + .'- `false`：不对实例进行数据盘挂载。'."\n" + ."\n" + .'默认值：`false`。'."\n" + ."\n" + .'数据挂载规则：'."\n" + ."\n" + .'- 如果 ECS 已挂载数据盘，且最后一块数据盘的文件系统未初始化，系统会自动将该数据盘格式化为 ext4，用来存放内容/var/lib/docker、/var/lib/kubelet 。'."\n" + .'- 如果 ECS 未挂载数据盘，则不会挂载新的数据盘。'."\n" + ."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'keep_instance_name' => [ + 'title' => '保留实例名称', + 'description' => '添加已有实例到集群时，是否保留实例名称。如果不保留，则实例名称格式为`worker-k8s-for-cs-<clusterid>`。取值：'."\n" + ."\n" + .'- `true`：保留实例名称。'."\n" + .'- `false`：不保留实例名称，会用系统规则进行替换。'."\n" + ."\n" + .'默认值：`true`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'rds_instances' => [ + 'title' => 'RDS白名单', + 'description' => '如果指定了RDS实例列表，集群节点ECS会自动加入RDS访问白名单。', + 'type' => 'array', + 'items' => [ + 'description' => 'RDS实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-xxx', + ], + 'required' => false, + ], + 'arch' => [ + 'title' => '节点CPU架构,支持amd64、arm、arm64。边缘托管集群专有字段。', + 'description' => '节点CPU架构。支持的CPU架构包括`amd64`、`arm`、`arm64`。'."\n" + ."\n" + .'默认值：`amd64`。'."\n" + ."\n" + .'> 当集群类型为边缘托管版时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'amd64', + ], + 'options' => [ + 'title' => '边缘托管版集群节点的接入配置。', + 'description' => '节点的接入配置参数。'."\n" + ."\n" + .'> 当集群类型为边缘托管版时必填。', + 'type' => 'string', + 'required' => false, + 'example' => '{"enableIptables": true,"manageRuntime": true,"quiet": true,"allowedClusterAddons": ["kube-proxy","flannel","coredns"]}', + ], + 'expired' => [ + 'title' => '描述生成的token的过期时间，格式为Unix时间戳，如1739980800表示2025-02-20 00:00:00。', + 'description' => '描述生成的 token 的过期时间，格式为 Unix 时间戳，如示例的1739980800 表示 2025-02-20 00:00:00。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1740037333', + ], + 'one_time_token' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + 'required' => false, + 'example' => 'amd64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '添加节点脚本。', + 'description' => '节点接入脚本。', + 'type' => 'string', + 'example' => '"wget http://***.oss-cn-hangzhou.aliyuncs.com/***"', + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"\\"\\\\\\"wget http://***.oss-cn-hangzhou.aliyuncs.com/***\\\\\\"\\"","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '查询添加已有节点到集群节点池的脚本', + ], + 'CreateAutoscalingConfig' => [ + 'summary' => '您可以创建自动弹性伸缩配置，让系统能够按照配置的伸缩规则自动增加或减少计算资源，满足您的集群工作负载的需求。创建过程中，您可以指定扩缩容的度量指标和阈值、扩容顺序、静默时间等。', + 'path' => '/cluster/{ClusterId}/autoscale/config/', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '37485', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cdde1f21ae22e483ebcb068a6eb7f****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体数据', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'cool_down_duration' => [ + 'title' => '静默时间，扩容出的节点，在静默时间过后，方可进入缩容判断', + 'description' => '缩容触发时延，从检测到有缩容需求（达到缩容阈值）到实际执行缩容操作（缩容Pod数量）之间的时间间隔。'."\n" + ."\n" + .'取值范围：[1,60]，单位：分钟。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'unneeded_duration' => [ + 'title' => '缩容触发时延，节点缩容时需要连续满足触发时延所设定的时间，方可进行缩容', + 'description' => '静默时间。距离最近一次扩容完成后，弹性组件不执行缩容的时间间隔。'."\n" + .'扩容出的节点，在静默时间过后，才能进入缩容判断。'."\n" + ."\n" + .'取值范围：[1,60]，单位：分钟。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'utilization_threshold' => [ + 'title' => '缩容阈值，节点上 Request 的资源与总资源量的比值', + 'description' => '缩容阈值，节点上Request的资源与总资源量的比值。'."\n" + ."\n" + .'仅当该比值低于配置的阈值时，即节点的CPU和内存资源利用率均低于缩容阈值时，节点才有可能被缩容。'."\n" + ."\n" + .'取值范围：[0.1~1]。'."\n" + ."\n" + .'默认值：0.5，即50%。', + 'type' => 'string', + 'required' => false, + 'example' => '0.5', + ], + 'gpu_utilization_threshold' => [ + 'title' => 'GPU缩容阈值，节点上 Request 的资源与总资源量的比值', + 'description' => 'GPU缩容阈值，节点上Request的资源与总资源量的比值。'."\n" + ."\n" + .'仅当该比值低于配置的阈值时，即节点的CPU、内存和GPU资源利用率均低于GPU 缩容阈值时，GPU节点才有可能被缩容。'."\n" + ."\n" + .'取值范围：[0.1~1]。'."\n" + ."\n" + .'默认值：0.3，即30%。', + 'type' => 'string', + 'required' => false, + 'example' => '0.3', + ], + 'scan_interval' => [ + 'title' => '弹性灵敏度，判断伸缩的间隔时间', + 'description' => '弹性灵敏度，用于调整系统判断伸缩的间隔时间。'."\n" + ."\n" + .'取值范围：15，30，60，120，180，300。单位：秒。'."\n" + ."\n" + .'默认值：60。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'scale_down_enabled' => [ + 'title' => '是否允许缩容', + 'description' => '是否允许进行节点缩容。取值：'."\n" + .'- `true`：允许缩容。'."\n" + .'- `false`：禁止缩容。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'expander' => [ + 'title' => '节点池扩容顺序策略', + 'description' => '节点池扩容顺序策略。取值：'."\n" + .'- `least-waste` ：默认策略。如果可扩容节点池有多个，从中选择一个资源浪费最少的节点池进行扩容。'."\n" + .'- `random`：随机策略。如果可扩容节点池有多个，从中任意选择一个节点池进行扩容。'."\n" + .'- `priority `：优先级策略。如果可扩容节点池有多个，会按照您自定义的伸缩组顺序，选择优先级高的节点池进行扩容。节点池优先级通过`priorities`参数定义。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'random' => 'random', + 'least-waste' => 'least-waste', + 'priority' => 'priority', + ], + 'example' => 'least-waste', + ], + 'skip_nodes_with_system_pods' => [ + 'title' => '为true则cluster autoscaler将不会缩容有kube-system命名空间下pods（除了DaemonSet 或 mirror pods）的节点', + 'description' => 'cluster-autoscaler是否缩容运行在kube-system命名空间下的Pod所在的节点，此功能对DaemonSet Pod和Mirror Pod不生效。取值：'."\n" + .'- `true`：不会缩容。'."\n" + .'- `false`：缩容。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'skip_nodes_with_local_storage' => [ + 'title' => '为true则cluster autoscaler将不会缩容有local storage（如EmptyDir 或 HostPath）的pods的节点', + 'description' => 'cluster-autoscaler是否缩容包含本地存储（如EmptyDir或HostPath）的Pod所在的节点。取值：'."\n" + .'- `true`：不会缩容。'."\n" + .'- `false`：缩容。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'daemonset_eviction_for_nodes' => [ + 'title' => '为true则在缩容时驱逐节点上的DaemonSet pods', + 'description' => 'cluster-autoscaler缩容时，是否驱逐节点上的DaemonSet Pods。取值：'."\n" + .'- `true`：驱逐。'."\n" + .'- `false`：不会驱逐。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'max_graceful_termination_sec' => [ + 'title' => 'CA缩容节点时等待节点上pod终止的最长时间（单位：秒）', + 'description' => '缩容场景下，节点排水时cluster-autoscaler等待 Pod 终止的超时时长。'."\n" + ."\n" + .'单位：秒。'."\n" + ."\n" + .'默认值：14400。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '14400', + ], + 'min_replica_count' => [ + 'title' => '考虑缩容时pod应该有的最小副本数', + 'description' => '节点缩容前每个ReplicaSet中允许的Pod最小数量。'."\n" + ."\n" + .'默认值：0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'recycle_node_deletion_enabled' => [ + 'title' => '极速模式节点缩容成功后是否删除其对应的K8s node对象', + 'description' => '极速模式节点缩容成功后，是否删除其对应的K8s Node对象。关于极速模式更多信息，请参见[伸缩模式](~~119099~~) 。默认值：false。取值：'."\n" + ."\n" + .'- `true`：极速模式停机后K8s Node对象也被删除。不建议设置为true，可能导致K8s对象数据不一致的问题。'."\n" + .'- `false`：极速模式停机后K8s Node对象保留。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'scale_up_from_zero' => [ + 'title' => '集群ready节点数为0时，CA是否扩容', + 'description' => '集群Ready节点数为0时，cluster-autoscaler是否执行扩容。默认值：true。取值：'."\n" + ."\n" + .'- `true`：执行扩容。'."\n" + .'- `false`：不执行扩容。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'scaler_type' => [ + 'title' => '弹性组件类型。', + 'description' => '弹性组件类型，集群版本1.24及以上默认为goatscaler，以下默认为cluster-autoscaler。取值：'."\n" + ."\n" + .'- `goatscaler`：即时弹性。'."\n" + ."\n" + .'- `cluster-autoscaler`：自动伸缩。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'goatscaler' => 'goatscaler', + 'cluster-autoscaler' => 'cluster-autoscaler', + ], + 'example' => 'goatscaler', + ], + 'priorities' => [ + 'title' => '自动伸缩节点池优先级配置。', + 'description' => '自动伸缩优先级配置，创建开启了弹性的节点池后，可以通过[启用节点自动伸缩](~~119099~~)选择是否配置优先级策略与优先级配置，为指定的自动伸缩节点池伸缩组配置优先级。'."\n" + ."\n" + .'取值范围为[1, 100]，必须为正整数。数字越大，优先级越高。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'title' => '同一优先级的自动伸缩节点池伸缩组id。', + 'description' => '同一优先级的自动伸缩节点池伸缩组ID。', + 'type' => 'array', + 'items' => [ + 'title' => '自动伸缩节点池伸缩组id。', + 'type' => 'string', + 'example' => 'asg-bp1fe63lqz******', + 'description' => '自动伸缩节点池的伸缩组ID。', + ], + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc212d04dfe184547bffaa596********', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5fd211e924e1d007********', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AF8BE105-C32B-1269-9774-5510********', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"cluster_id\\": \\"cc212d04dfe184547bffaa596********\\",\\n \\"task_id\\": \\"T-5fd211e924e1d007********\\",\\n \\"request_id\\": \\"AF8BE105-C32B-1269-9774-5510********\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '创建弹性伸缩配置', + ], + 'DescribeClusterNodes' => [ + 'summary' => '您可以调用DescribeClusterNodes接口，查询符合条件的节点列表信息。', + 'path' => '/clusters/{ClusterId}/nodes', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsk4JRUSW', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'instanceIds', + 'in' => 'query', + 'schema' => [ + 'title' => '节点实例ID，按照实例ID进行过滤。 节点池ID不为空时会忽略此字段。多节点用逗号分割', + 'description' => '节点实例ID列表，多值使用英文半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '"i-bp11xjhwkj8k966u****,i-bp1dmhc2bu5igkyq****"', + ], + ], + [ + 'name' => 'nodepool_id', + 'in' => 'query', + 'schema' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'npe25633140a7d4fbea56cd0479c******', + ], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => [ + 'title' => '节点状态。默认值：all。', + 'description' => '集群节点状态，按照集群节点运行状态进行过滤，取值：'."\n" + ."\n" + .'- `all`：不按照运行状态进行过滤，查询所有状态的节点。'."\n" + .'- `running`：正在运行的集群节点。'."\n" + .'- `removing`：正在删除的集群节点。'."\n" + .'- `initial`：正在初始化的集群节点。'."\n" + .'- `failed`：创建失败的集群节点。'."\n" + ."\n" + .'默认值：`all`。', + 'type' => 'string', + 'required' => false, + 'example' => 'running', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小。', + 'description' => '每页可显示的最大记录数。取值范围为[1,100]。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页数量', + 'description' => '当前查询的页码数。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'nodes' => [ + 'title' => '节点信息列表。', + 'description' => '节点详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点详情。', + 'type' => 'object', + 'properties' => [ + 'creation_time' => [ + 'title' => '节点创建时间。', + 'description' => '节点创建时间。', + 'type' => 'string', + 'example' => '2025-04-16T07:28:00Z', + ], + 'error_message' => [ + 'title' => '错误信息说明。', + 'description' => '节点创建时错误信息。', + 'type' => 'string', + 'example' => 'error***', + ], + 'expired_time' => [ + 'title' => '节点过期时间。', + 'description' => '节点到期时间。', + 'type' => 'string', + 'example' => '2099-12-31T15:59:00Z', + ], + 'host_name' => [ + 'title' => '节点主机名。', + 'description' => '节点主机名。', + 'type' => 'string', + 'example' => 'iZ2vcckdmxp7u0urj2k****', + ], + 'image_id' => [ + 'title' => '节点使用的镜像ID。', + 'description' => '节点使用的系统镜像ID。', + 'type' => 'string', + 'example' => 'aliyun_3_x64_20G_alibase_20241218.vhd', + ], + 'instance_charge_type' => [ + 'title' => '节点付费类型。', + 'description' => '节点付费类型。取值：'."\n" + ."\n" + .'- `PrePaid`：预付费，包年包月。'."\n" + .'- `PostPaid`：按量付费。', + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'instance_id' => [ + 'title' => '节点实例ID。', + 'description' => '节点实例ID。', + 'type' => 'string', + 'example' => 'i-2vcckdmxp7u0urj2****', + ], + 'instance_name' => [ + 'title' => '节点名称。', + 'description' => '节点在集群中的名称。', + 'type' => 'string', + 'example' => 'worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + 'instance_role' => [ + 'title' => '节点实例角色类型，Master或Worker。', + 'description' => '节点角色类型：'."\n" + ."\n" + .'- Master：集群Master节点。'."\n" + .'- Worker：集群Worker节点。', + 'type' => 'string', + 'example' => 'Worker', + ], + 'instance_status' => [ + 'title' => '节点实例状态，', + 'description' => '节点对应的ECS状态。'."\n" + .'- `Pending`：创建中。'."\n" + ."\n" + .'- `Running`：运行中。'."\n" + ."\n" + .'- `Starting`：启动中。'."\n" + ."\n" + .'- `Stopping`：停止中。'."\n" + ."\n" + .'- `Stopped`：已停止。', + 'type' => 'string', + 'example' => 'Running', + ], + 'instance_type' => [ + 'title' => '节点实例类型。', + 'description' => '节点规格。', + 'type' => 'string', + 'example' => 'ecs.c5.xlarge', + ], + 'instance_type_family' => [ + 'title' => '节点实例所属ECS实例簇名称。', + 'description' => '节点所属ECS规格族名称。', + 'type' => 'string', + 'example' => 'ecs.c5', + ], + 'ip_address' => [ + 'title' => '节点IP地址。', + 'description' => '节点IP地址。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '192.168.xx.xx', + ], + ], + 'is_aliyun_node' => [ + 'title' => '节点是否为aliyun实例。', + 'description' => '是否为阿里云实例。取值：'."\n" + ."\n" + .'- `true`：是阿里云实例。'."\n" + ."\n" + .'- `false`：不是阿里云实例。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'node_name' => [ + 'title' => '节点名称，该名称是k8s专用名称。', + 'description' => '节点名称，集群内节点标识。', + 'type' => 'string', + 'example' => 'cn-chengdu.192.168xx.xx', + ], + 'node_status' => [ + 'title' => '节点状态，是否Ready。', + 'description' => '节点是否就绪。取值：'."\n" + ."\n" + .'- `Ready`：节点已就绪。'."\n" + ."\n" + .'- `NotReady`：节点未就绪。'."\n" + ."\n" + .'- `Unknown`：未知。'."\n" + ."\n" + .'- `Offline`：离线中。', + 'type' => 'string', + 'example' => 'Ready', + ], + 'nodepool_id' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'example' => 'np0794239424a84eb7a95327369d56****', + ], + 'source' => [ + 'title' => '节点通过什么方式创建出来的，例如：ROS。', + 'description' => '节点通过何种方式初始化，例如：手动创建或ROS创建。', + 'type' => 'string', + 'example' => 'ess', + ], + 'state' => [ + 'title' => 'ECS运行状态，例如：Running。', + 'description' => '节点运行状态。取值：'."\n" + ."\n" + .'- `pending`：创建中。'."\n" + ."\n" + .'- `running`：运行中。'."\n" + ."\n" + .'- `starting`：启动中。'."\n" + ."\n" + .'- `stopping`：停止中。'."\n" + ."\n" + .'- `stopped`：已停止。', + 'type' => 'string', + 'example' => 'running', + ], + 'spot_strategy' => [ + 'title' => '抢占时实例类型', + 'description' => '抢占式实例类型，取值：'."\n" + .'- NoSpot：非抢占式实例。'."\n" + .'- SpotWithPriceLimit：设置抢占实例价格上限。'."\n" + .'- SpotAsPriceGo：系统自动出价，跟随当前市场实际价格。'."\n", + 'type' => 'string', + 'example' => 'NoSpot', + ], + ], + ], + ], + 'page' => [ + 'title' => '分页信息。', + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'page_number' => [ + 'title' => '总页数。', + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'page_size' => [ + 'title' => '单页展示结果数量。', + 'description' => '每页可显示的最大记录数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'total_count' => [ + 'title' => '结果总条数。', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"nodes\\": [\\n {\\n \\"creation_time\\": \\"2025-04-16T07:28:00Z\\",\\n \\"error_message\\": \\"error***\\",\\n \\"expired_time\\": \\"2099-12-31T15:59:00Z\\",\\n \\"host_name\\": \\"iZ2vcckdmxp7u0urj2k****\\",\\n \\"image_id\\": \\"aliyun_3_x64_20G_alibase_20241218.vhd\\",\\n \\"instance_charge_type\\": \\"PostPaid\\",\\n \\"instance_id\\": \\"i-2vcckdmxp7u0urj2****\\",\\n \\"instance_name\\": \\"worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****\\",\\n \\"instance_role\\": \\"Worker\\",\\n \\"instance_status\\": \\"Running\\",\\n \\"instance_type\\": \\"ecs.c5.xlarge\\",\\n \\"instance_type_family\\": \\"ecs.c5\\",\\n \\"ip_address\\": [\\n \\"192.168.xx.xx\\"\\n ],\\n \\"is_aliyun_node\\": true,\\n \\"node_name\\": \\"cn-chengdu.192.168xx.xx\\",\\n \\"node_status\\": \\"Ready\\",\\n \\"nodepool_id\\": \\"np0794239424a84eb7a95327369d56****\\",\\n \\"source\\": \\"ess\\",\\n \\"state\\": \\"running\\",\\n \\"spot_strategy\\": \\"NoSpot\\"\\n }\\n ],\\n \\"page\\": {\\n \\"page_number\\": 1,\\n \\"page_size\\": 10,\\n \\"total_count\\": 5\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterNodesResponse>\\n <nodes>\\n <creation_time>2020-08-25T11:25:35+08:00</creation_time>\\n <error_message>error***</error_message>\\n <expired_time>2099-12-31T23:59:00+08:00</expired_time>\\n <host_name>iZ2vcckdmxp7u0urj2k****</host_name>\\n <image_id>aliyun_2_1903_x64_20G_alibase_20200529.vhd</image_id>\\n <instance_charge_type>PostPaid</instance_charge_type>\\n <instance_id>i-2vcckdmxp7u0urj2****</instance_id>\\n <instance_name>worker-k8s-for-cs-c5cdf7e3938bc4f8eb0e44b21a80f****</instance_name>\\n <instance_role>Worker</instance_role>\\n <instance_status>Running</instance_status>\\n <instance_type>ecs.c5.xlarge</instance_type>\\n <instance_type_family>ecs.c5</instance_type_family>\\n <ip_address>192.168.0.36</ip_address>\\n <is_aliyun_node>true</is_aliyun_node>\\n <node_name>cn-chengdu.192.168.0.36</node_name>\\n <node_status>Ready</node_status>\\n <nodepool_id>np0794239424a84eb7a95327369d56****</nodepool_id>\\n <source>ess_attach</source>\\n <state>running</state>\\n <spot_strategy>NoSpot</spot_strategy>\\n </nodes>\\n <page>\\n <page_number>1</page_number>\\n <page_size>10</page_size>\\n <total_count>5</total_count>\\n </page>\\n</DescribeClusterNodesResponse>","errorExample":""}]', + 'title' => '查询集群节点列表', + ], + 'DeleteClusterNodes' => [ + 'summary' => '当您不再需要集群节点继续工作时，可以调用DeleteClusterNodes接口将集群中的节点移出集群。移除节点时，您可以选择是否同时释放ECS、是否自动排空节点。', + 'path' => '/clusters/{ClusterId}/nodes', + 'methods' => [ + 'post', + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c850429a2287b4d968e27e87a4921****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '请求体。', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'drain_node' => [ + 'title' => '是否自动排空节点上的Pod。', + 'description' => '是否自动排空节点上的Pod。取值：'."\n" + .'- `true`：自动排空节点上的Pod。'."\n" + .'- `false`：不自动排空节点上的Pod。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'release_node' => [ + 'title' => '是否同时释放 ECS', + 'description' => '是否同时移除ECS。取值：'."\n" + ."\n" + .'- `true`：同时移除ECS。'."\n" + .'- `false`：保留ECS。'."\n" + ."\n" + .'默认值：`false`。'."\n" + ."\n" + .'> 当节点为包年包月实例时，不支持同时移除ECS。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'nodes' => [ + 'title' => '移除节点列表。', + 'description' => '移除节点列表，节点名称必须是节点在集群中的名称，例如：`cn-hangzhou.192.168.xx.xx`。', + 'type' => 'array', + 'items' => [ + 'description' => '节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou.192.168.xx.xx', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => '返回数据体', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c104d5d5f301c4e2a8ee578c37******', + ], + 'request_id' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A9891419-D125-4D89-AFCA-688466******', + ], + 'task_id' => [ + 'title' => '任务ID', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-60fea8ad2e27000ae9******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"cluster_id\\": \\"c104d5d5f301c4e2a8ee578c37******\\",\\n \\"request_id\\": \\"A9891419-D125-4D89-AFCA-688466******\\",\\n \\"task_id\\": \\"T-60fea8ad2e27000ae9******\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteClusterNodesResponse>\\n <cluster_id>c104d5d5f301c4e2a8ee578c37bc****</cluster_id>\\n <request_id>A9891419-D125-4D89-AFCA-68846675E2F7</request_id>\\n <task_id>T-60fea8ad2e277f0879000ae9</task_id>\\n</DeleteClusterNodesResponse>","errorExample":""}]', + 'title' => '移除集群节点', + 'description' => '- 移除节点时，请通过本接口或[容器服务控制台](https://cs.console.aliyun.com)执行标准化操作。请勿使用`kubectl delete node`方式手动移除节点。'."\n" + ."\n" + .'- 请勿直接在ECS或者ESS控制台（或通过相关API）主动释放节点、移除实例，或因包年包月实例到期而被动释放节点。这些情况下，节点会直接停机，自动从容器服务管理控制台中移除。'."\n" + ."\n" + .'- 如果节点池设置了期望节点数，为了将节点个数始终维持在期望节点数，节点池会根据相应配置自动扩容其他实例。'."\n" + ."\n" + .'- 移除节点涉及Pod的迁移，可能会影响业务，请在业务低峰期操作。操作过程中可能存在非预期风险，请提前做好相关的数据备份。'."\n" + ."\n" + .'- 移除节点时，ACK会执行排水操作，请确保集群其他节点的资源充足，以避免业务Pod无法调度。'."\n" + ."\n" + .'- 需检查待移除节点上的Pod的节点亲和性规则和调度策略，确保Pod不会因为节点移除而无法调度到其他节点。', + ], + 'AttachInstances' => [ + 'summary' => '如果购买ECS实例后需要将该云服务器添加到ACK集群中作为Worker节点，或移除Worker节点后需将节点实例重新加入节点池，您可以调用AttachInstances接口，将已有ECS实例添加到ACK集群。', + 'path' => '/clusters/{ClusterId}/attach', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeNodes' => [ + 'FEATUREcsk4JRUSW', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c106f377e16f34eb1808d6b9362c9****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '请求体', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'instances' => [ + 'title' => '实例列表。', + 'description' => '待添加的ECS实例列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '待添加的ECS实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-2zed0sswuau6o89b****', + ], + 'required' => true, + ], + 'key_pair' => [ + 'title' => 'key_pair名称，与login_password二选一', + 'description' => '待添加实例的密钥对名称。'."\n" + .'key_pair和password参数若要填写时，只需填写其中一个即可，或者两个参数均不填写。'."\n" + .'> 指定`nodepool_id`后，该参数不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'security-key', + ], + 'password' => [ + 'title' => 'password，与key_pair二选一。', + 'description' => '待添加实例的SSH登录密码。key_pair和password参数若要填写时，只需填写其中一个即可，或者两个参数均不填写。'."\n" + ."\n" + .'密码填写规范如下：'."\n" + .'- 长度为8~30个字符'."\n" + .'- 至少同时包含大小写字母、数字和特殊符号'."\n" + .'- 不支持反斜线（\\）和半角双引号（"）两个符号'."\n" + ."\n" + .'出于安全性考虑，密码传输过程中都会进行加密处理。', + 'type' => 'string', + 'required' => false, + 'example' => 'Hello1234', + ], + 'format_disk' => [ + 'title' => '是否格式化数据盘。', + 'description' => '是否将容器数据和镜像存储在数据盘中。取值如下：'."\n" + ."\n" + .'- `true`：将容器数据和镜像存储在数据盘。'."\n" + ."\n" + .'- `false`：不将容器数据和镜像存储在数据盘。'."\n" + ."\n" + .'默认值：`false`。'."\n" + ."\n\n" + .'数据盘挂载规则：'."\n" + ."\n" + .'- 如果ECS已挂载数据盘，且最后一块数据盘的文件系统未初始化，系统会自动将该数据盘格式化为EXT4，用来存放内容/var/lib/docker、/var/lib/kubelet（分别为Docker容器运行时和kubelet组件默认对应的数据目录）。'."\n" + .'- 如果ECS未挂载数据盘，则不会挂载新的数据盘。'."\n" + .'>当选择将数据存储至数据盘并且ECS已挂载数据盘，数据盘内原有数据将丢失，请注意备份数据。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'keep_instance_name' => [ + 'title' => '是否保留实例名称。', + 'description' => '是否保留原实例名称。取值如下：'."\n" + ."\n" + .'- `true`：保留实例名称。'."\n" + ."\n" + .'- `false`：不保留实例名称。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'is_edge_worker' => [ + 'title' => '是否为边缘节点。', + 'description' => '待添加的节点是否为边缘节点，即ENS节点。取值：'."\n" + ."\n" + .'- `true`：表示添加的节点是边缘节点。'."\n" + ."\n" + .'- `false`：表示添加的节点是不是边缘节点。'."\n" + ."\n" + .'默认值：`false`。'."\n" + ."\n" + .'> 如果是边缘节点，取值必须是`true`，用于标识该节点类型为ENS节点。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'nodepool_id' => [ + 'title' => '节点池ID，欲将节点添加到哪个节点池中。。', + 'description' => '节点池ID。如果不指定，则将节点添加到默认节点池中。', + 'type' => 'string', + 'required' => false, + 'example' => 'np615c0e0966124216a0412e10afe0****', + ], + 'image_id' => [ + 'title' => '自定义镜像ID。', + 'description' => '自定义镜像ID。'."\n" + ."\n" + .'- 如果指定自定义镜像ID，实例系统盘镜像将被替换为该自定义镜像。'."\n" + ."\n" + .'- 如果不指定，则使用默认系统镜像。'."\n" + ."\n" + .'> 指定`nodepool_id`后，该参数不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun_2_1903_x64_20G_alibase_20200529.vhd', + ], + 'cpu_policy' => [ + 'title' => 'CPU亲和策略。', + 'description' => '节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略：'."\n" + ."\n" + .'- `static`：允许为节点上具有某些资源特征Pod增强其CPU亲和性和独占性。'."\n" + .'- `none`：表示启用现有的默认CPU亲和性方案。'."\n" + ."\n" + .'默认值：`none`。'."\n" + ."\n" + .'> 指定`nodepool_id`后，该参数不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'none', + ], + 'user_data' => [ + 'title' => '节点自定义数据。', + 'description' => '节点自定义数据。具体详情，请参见[生成实例自定义数据](~~49121~~)。'."\n" + ."\n" + .'> 指定`nodepool_id`后，该参数不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFDSyEi', + ], + 'rds_instances' => [ + 'title' => 'RDS实例列表。', + 'description' => 'RDS实例列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'RDS实例ID。'."\n" + ."\n" + .'> 指定`nodepool_id`后，该参数不支持。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-67yawhau****', + ], + 'required' => false, + ], + 'runtime' => [ + 'description' => '容器运行时。'."\n" + .'> 指定`nodepool_id`后，该参数不支持。'."\n" + ."\n" + .'name：容器运行时名称，ACK支持以下三种容器运行时。'."\n" + ."\n" + .'- containerd：推荐使用，支持所有集群版本。'."\n" + .'- Sandboxed-Container.runv：安全沙箱容器，提供更高的隔离性，支持1.24版本及以下集群。'."\n" + .'- docker：支持1.22版本及以下集群。'."\n" + ."\n" + .'默认值：containerd。'."\n" + ."\n" + .'containerd：容器运行时版本，默认为最新版。'."\n" + ."\n" + .'关于安全沙箱运行时的变更详情，请参见[安全沙箱运行时变更记录](~~160312~~)。', + 'required' => false, + '$ref' => '#/components/schemas/runtime', + ], + 'tags' => [ + 'title' => '节点标签。', + 'description' => '节点标签。标签定义规则：'."\n" + ."\n" + .'- 标签由区分大小写的键值对（key-value）组成，您最多可以设置20个标签。'."\n" + .'- 标签键不可以重复，最长为64个字符；'."\n" + .'- 标签值可以为空，最长为128个字符。'."\n" + .'- 标签键和标签值都不能以\\`aliyun`、`acs:`、`https://`或`http://`开头。'."\n" + ."\n" + .'更多信息，请参见[Labels and Selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。'."\n" + .'> 指定`nodepool_id`后，该参数不支持。', + 'type' => 'array', + 'items' => [ + 'description' => '节点标签。', + 'required' => false, + '$ref' => '#/components/schemas/tag', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体数据。', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'list' => [ + 'title' => '节点信息列表。', + 'description' => '节点添加信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点添加结果详情。', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'title' => '状态码。', + 'description' => '节点添加结果状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'instanceId' => [ + 'title' => '实例ID。', + 'description' => 'ECS实例ID。', + 'type' => 'string', + 'example' => 'i-2ze0lgm3y6iylcbt****', + ], + 'message' => [ + 'title' => '添加结果描述。', + 'description' => '节点添加结果描述信息。', + 'type' => 'string', + 'example' => 'successful', + ], + ], + ], + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5a544aff80282e39ea00****', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"list\\": [\\n {\\n \\"code\\": \\"200\\",\\n \\"instanceId\\": \\"i-2ze0lgm3y6iylcbt****\\",\\n \\"message\\": \\"successful\\"\\n }\\n ],\\n \\"task_id\\": \\"T-5a544aff80282e39ea00****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachInstancesResponse>\\n <list>\\n <code>200</code>\\n <instanceId>i-2ze0lgm3y6iylcbt****</instanceId>\\n <message>successful</message>\\n </list>\\n <task_id>T-5a544aff80282e39ea000039</task_id>\\n</AttachInstancesResponse>","errorExample":""}]', + 'title' => '添加已有ECS实例到集群', + 'description' => '调用本接口前，请仔细阅读[使用限制](~~86919~~)，确保待添加的ECS实例满足条件。', + 'extraInfo' => '除了调用本接口，您还可以通过控制台方式将ECS实例添加到ACK集群。具体操作，请参见[将已有ECS实例添加到ACK集群](~~86919~~)。', + ], + 'InstallClusterAddons' => [ + 'summary' => '为了增强Kubernetes能力，ACK集群支持了多种组件，例如托管的核心组件，应用、日志和监控、网络、存储、安全组件等。您可以调用InstallClusterAddons接口，通过组件名称和版本安装组件。', + 'path' => '/clusters/{ClusterId}/components/install', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'abilityTreeCode' => '486', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'Addon列表。', + 'description' => '请求体参数。', + 'type' => 'array', + 'items' => [ + 'description' => '组件详情。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '组件名称。您可以通过[ListAddons](~~2667939~~)接口查询可用组件的信息，包括组件名称及版本等。', + 'type' => 'string', + 'required' => true, + 'example' => 'storage-operato', + ], + 'version' => [ + 'title' => '组件版本号。', + 'description' => '组件版本。您可以通过[ListAddons](~~2667939~~)接口查询可用组件的信息，包括组件名称及版本等。', + 'type' => 'string', + 'required' => true, + 'example' => 'v1.32.9', + ], + 'config' => [ + 'title' => '组件配置信息。', + 'description' => '组件自定义参数，使用JSON字符串编码。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"IngressDashboardEnabled\\":\\"true\\",\\"sls_project_name\\":\\"your_sls_project_name\\"}', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => 'ags-metrics-collector', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5a54309c80282e39ea0****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4314****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cluster_id\\": \\"c82e6987e2961451182edacd74faf****\\",\\n \\"task_id\\": \\"T-5a54309c80282e39ea0****\\",\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4314****\\"\\n}","type":"json"}]', + 'title' => '安装集群组件', + ], + 'UnInstallClusterAddons' => [ + 'summary' => '当您无需使用集群某些组件时，您可以调用UnInstallClusterAddons接口指定组件名称，删除组件，并选择是否删除关联的阿里云云资源。', + 'path' => '/clusters/{ClusterId}/components/uninstall', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '373', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + ], + [ + 'name' => 'addons', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '卸载组件列表。', + 'description' => '组件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '组件详情。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '待卸载的组件名称。您可以调用[ListClusterAddonInstances](~~2667940~~)接口查询集群中已安装的组件。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-node-problem-detector', + ], + 'cleanup_cloud_resources' => [ + 'title' => '是否清理组件创建的云资源实例。', + 'description' => '卸载组件时是否清理相关的云资源。'."\n" + .'- true：清理。'."\n" + .'- false：保留。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbb******', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-66e39b39c0fdd00132******', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '74D1512F-67DA-54E8-99EA-4D50EB******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cluster_id\\": \\"c5b5e80b0b64a4bf6939d2d8fbb******\\",\\n \\"task_id\\": \\"T-66e39b39c0fdd00132******\\",\\n \\"request_id\\": \\"74D1512F-67DA-54E8-99EA-4D50EB******\\"\\n}","type":"json"}]', + 'title' => '卸载集群组件', + ], + 'ListAddons' => [ + 'summary' => '您可以调用ListAddons接口，根据指定地域、集群类型、集群子类型（profile）、集群版本等参数获取可用组件的列表，并查询组件的详细信息，包括组件托管与否、支持的自定义参数Schema、兼容的操作系统架构等。', + 'path' => '/addons', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190344', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'region_id', + 'in' => 'query', + 'schema' => [ + 'title' => '地域。', + 'description' => '地域。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'cluster_type', + 'in' => 'query', + 'schema' => [ + 'title' => '集群类型。', + 'description' => '集群类型。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'ManagedKubernetes', + ], + ], + [ + 'name' => 'profile', + 'in' => 'query', + 'schema' => [ + 'title' => '集群子类型。', + 'description' => '集群子类型。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'cluster_spec', + 'in' => 'query', + 'schema' => [ + 'title' => '集群规格。', + 'description' => '集群规格。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack.pro.small', + ], + ], + [ + 'name' => 'cluster_version', + 'in' => 'query', + 'schema' => [ + 'title' => '集群版本。', + 'description' => '集群版本。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => '1.32.1-aliyun.1', + ], + ], + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。'."\n" + .'指定集群ID时，查询该集群可用的组件列表，此时其他参数将会被忽略。', + 'type' => 'string', + 'required' => false, + 'example' => 'c02b3e03be10643e8a644a843ffcb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'addons' => [ + 'title' => '可用组件列表。', + 'description' => '可用组件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'arms-prometheus', + ], + 'version' => [ + 'title' => '版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '1.1.9', + ], + 'managed' => [ + 'title' => '是否为托管组件。', + 'description' => '是否为托管组件。'."\n" + ."\n" + .'- true：托管组件。'."\n" + ."\n" + .'- false：非托管组件。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'install_by_default' => [ + 'title' => '是否默认安装。', + 'description' => '是否默认安装。'."\n" + ."\n" + .'- true：创建集群时默认安装该组件。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'category' => [ + 'title' => '组件分类。', + 'description' => '组件分类。'."\n" + ."\n" + .'- core：核心组件。'."\n" + .'- network：网络类型组件。'."\n" + .'- security：安全组件。'."\n" + .'- storage：存储组件。'."\n" + .'- monitor：日志与监控组件。'."\n" + .'- application：应用组件。'."\n" + ."\n" + .'返回内容为空表示组件类型为其他。', + 'type' => 'string', + 'example' => 'monitor', + ], + 'config_schema' => [ + 'title' => '组件自定义参数的schema。', + 'description' => '组件自定义参数的schema。', + 'type' => 'string', + 'example' => '{}', + ], + 'supported_actions' => [ + 'title' => '组件支持的操作，可能的值：'."\n" + .'- Install'."\n" + .'- Upgrade'."\n" + .'- Modify'."\n" + .'- Uninstall', + 'description' => '组件支持的操作。', + 'type' => 'array', + 'items' => [ + 'description' => '组件支持的操作，取值：'."\n" + .'- Install：安装组件。'."\n" + .'- Upgrade：升级组件。'."\n" + .'- Modify：更新组件。'."\n" + .'- Uninstall：卸载组件。', + 'type' => 'string', + 'example' => 'Install', + ], + ], + 'architecture' => [ + 'title' => '组件支持的体系结构，可能的值：'."\n" + .'- amd64'."\n" + .'- arm64', + 'description' => '组件支持的CPU架构。', + 'type' => 'array', + 'items' => [ + 'description' => '组件支持的CPU架构，取值：'."\n" + .'- amd64。'."\n" + .'- arm64。', + 'type' => 'string', + 'example' => 'amd64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"addons\\": [\\n {\\n \\"name\\": \\"arms-prometheus\\",\\n \\"version\\": \\"1.1.9\\",\\n \\"managed\\": false,\\n \\"install_by_default\\": false,\\n \\"category\\": \\"monitor\\",\\n \\"config_schema\\": \\"{}\\",\\n \\"supported_actions\\": [\\n \\"Install\\"\\n ],\\n \\"architecture\\": [\\n \\"amd64\\"\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListAddonsResponse>\\n <addons>\\n <name>aliyun-acr-credential-helper</name>\\n <category>security</category>\\n <install_by_default>false</install_by_default>\\n <managed>false</managed>\\n <version>v21.12.20.0-a6d9879-aliyun</version>\\n <supported_actions>Install</supported_actions>\\n <supported_actions>Upgrade</supported_actions>\\n <supported_actions>Uninstall</supported_actions>\\n <architecture>amd64</architecture>\\n <config_schema/>\\n </addons>\\n <addons>\\n <name>ack-scheduler</name>\\n <category>core</category>\\n <install_by_default>true</install_by_default>\\n <managed>true</managed>\\n <version>v1.26.3-aliyun-5.10-ca3c5b7a</version>\\n <supported_actions>Modify</supported_actions>\\n <supported_actions>Upgrade</supported_actions>\\n <architecture>amd64</architecture>\\n <config_schema>{\\n \\"$schema\\": \\"http://json-schema.org/draft-07/schema#\\",\\n \\"properties\\": {\\n \\"podMaxBackoffSeconds\\": {\\n \\"type\\": \\"integer\\",\\n \\"default\\": 10,\\n \\"minimum\\": 1,\\n \\"maximum\\": 100000,\\n \\"describe\\": \\"PodMaxBackoffSeconds is the max backoff for unschedulable pods.\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.pMBS\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.pMBS\\", \\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.pMBS\\"\\n },\\n \\"binpackEnable\\": {\\n \\"type\\": \\"boolean\\",\\n \\"default\\": false,\\n \\"describe\\": \\"enable the bin packing of resources or not\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.binpackEnable\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.binpackEnable\\", \\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.binpackEnable\\"\\n },\\n \\"binpackPluginWeight\\": {\\n \\"type\\": \\"integer\\",\\n \\"default\\": 100,\\n \\"minimum\\": 1,\\n \\"maximum\\": 100000,\\n \\"describe\\": \\"weight of binpack plugin when scoring\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.binpackPluginWeight\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.binpackPluginWeight\\", \\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.binpackPluginWeight\\"\\n },\\n \\"binpackResourceWeight\\": {\\n \\"type\\": \\"array\\",\\n \\"items\\": {\\n \\"type\\": \\"object\\",\\n \\"properties\\": {\\n \\"resourceName\\": {\\n \\"type\\": \\"string\\",\\n \\"description\\": \\"resource name\\",\\n \\"default\\": \\"\\",\\n \\"pattern\\": \\"^([a-zA-z][a-zA-z0-9\\\\\\\\.\\\\\\\\-\\\\\\\\/]*[a-zA-z0-9])|[a-zA-z]$\\",\\n \\"maxLength\\": 254,\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.binpackResourceWeight.key\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.binpackResourceWeight.key\\", \\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.binpackResourceWeight.key\\"\\n },\\n \\"resourceWeight\\": {\\n \\"type\\": \\"integer\\",\\n \\"description\\": \\"resource weight\\",\\n \\"default\\": 1,\\n \\"minimum\\": 1,\\n \\"maximum\\": 10000,\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.binpackResourceWeight.value\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.binpackResourceWeight.value\\", \\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.binpackResourceWeight.value\\"\\n }\\n }\\n }\\n },\\n \\"connectionQPS\\": {\\n \\"type\\": \\"integer\\",\\n \\"default\\": 50,\\n \\"minimum\\": 1,\\n \\"maximum\\": 10000,\\n \\"describe\\": \\"qps controls the number of queries per second allowed for this connection\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.connectionQPS\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.connectionQPS\\", \\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.connectionQPS\\"\\n },\\n \\"connectionBurst\\": {\\n \\"type\\": \\"integer\\",\\n \\"default\\": 100,\\n \\"minimum\\": 1,\\n \\"maximum\\": 10000,\\n \\"describe\\": \\"burst allows extra queries to accumulate when a client is exceeding its rate\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.connectionBurst\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.connectionBurst\\", \\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.connectionBurst\\"\\n },\\n \\"percentageOfNodesToScore\\": {\\n \\"type\\": \\"integer\\",\\n \\"default\\": 0,\\n \\"minimum\\": 0,\\n \\"maximum\\": 100,\\n \\"describe\\": \\"percentage of nodes to score when schedule\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.percentageOfNodesToScore\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.percentageOfNodesToScore\\", \\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.percentageOfNodesToScore\\"\\n },\\n \\"enableGPUShareScore\\": {\\n \\"type\\": \\"boolean\\",\\n \\"default\\": true,\\n \\"describe\\": \\"enable the score point of gpushare plugin or not\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.enableGPUShareScore\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.description.enableGPUShareScore\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.enableGPUShareScore\\"\\n },\\n \\"loadAwareEnable\\": {\\n \\"type\\": \\"boolean\\",\\n \\"default\\": false,\\n \\"describe\\": \\"enable the loadaware scheduling feature\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.laEnable\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.laEnable\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.laEnable\\"\\n },\\n \\"loadAwareResourceWeight\\": {\\n \\"type\\": \\"array\\",\\n \\"items\\": {\\n \\"type\\": \\"object\\",\\n \\"properties\\": {\\n \\"resourceName\\": {\\n \\"type\\": \\"string\\",\\n \\"description\\": \\"resource name\\",\\n \\"default\\": \\"cpu\\",\\n \\"enum\\": [\\"cpu\\",\\"memory\\"],\\n \\"maxLength\\": 254,\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.laResourceWeight.key\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.laResourceWeight.key\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.laResourceWeight.key\\"\\n },\\n \\"resourceWeight\\": {\\n \\"type\\": \\"integer\\",\\n \\"description\\": \\"resource weight\\",\\n \\"default\\": 1,\\n \\"minimum\\": 1,\\n \\"maximum\\": 10000,\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.laResourceWeight.value\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.laResourceWeight.value\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.laResourceWeight.value\\"\\n }\\n }\\n }\\n },\\n \\"loadAwareAggregatedUsageAggregationType\\": {\\n \\"type\\": \\"string\\",\\n \\"description\\": \\"usage aggregation type\\",\\n \\"default\\": \\"avg\\",\\n \\"enum\\": [\\"p99\\", \\"avg\\", \\"p90\\", \\"p50\\", \\"p95\\"],\\n \\"maxLength\\": 254,\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.ack-scheduler.description.aggregationType.value\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.ack-scheduler.prompt.aggregationType.value\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.ack-scheduler.validation.aggregationType.value\\"\\n }\\n },\\n \\"title\\": \\"Config\\",\\n \\"type\\": \\"object\\"\\n}</config_schema>\\n </addons>\\n <addons>\\n <name>logtail-ds</name>\\n <category>monitor</category>\\n <install_by_default>false</install_by_default>\\n <managed>false</managed>\\n <version>v1.8.2.0-aliyun</version>\\n <supported_actions>Install</supported_actions>\\n <supported_actions>Upgrade</supported_actions>\\n <supported_actions>Modify</supported_actions>\\n <supported_actions>Uninstall</supported_actions>\\n <architecture>amd64</architecture>\\n <architecture>arm64</architecture>\\n <config_schema>{\\n \\"$schema\\": \\"http://json-schema.org/draft-07/schema#\\",\\n \\"properties\\": {\\n \\"LogtailDSLimitCPU\\": {\\n \\"description\\": \\"the cpu limit for Logtail-ds\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"(^[1-9][0-9]*$|^0\\\\\\\\.[1-9]$|^[1-9]\\\\\\\\.[0-9]$)\\",\\n \\"default\\": \\"2\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ds.cpulimit\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ds.cpulimit\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ds.cpulimit\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailDSLimitMemory\\": {\\n \\"description\\": \\"the memory limit for Logtail-ds\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"(^[1-9][0-9]*$)\\",\\n \\"default\\": \\"2048\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ds.memlimit\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ds.memlimit\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ds.memlimit\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailDSMaxBytePerSec\\": {\\n \\"description\\": \\"the Max Byte Per Second for Logtail-ds\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"(^[1-9][0-9]*$)\\",\\n \\"default\\": \\"209715200\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ds.maxbyte\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ds.maxbyte\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ds.maxbyte\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailDSSendRequestConcurrency\\": {\\n \\"description\\": \\"the Send Cocurrency for Logtail-ds\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"(^[1-9][0-9]*$)\\",\\n \\"default\\": \\"40\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ds.cocurrency\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ds.cocurrency\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ds.cocurrency\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailDSProcessThreadCount\\": {\\n \\"description\\": \\"the Process Thread Count for Logtail-ds\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^[1-9][0-9]*$\\",\\n \\"default\\": \\"1\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ds.threadcount\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ds.threadcount\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ds.threadcount\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailDSExternalUserDefineIDs\\": {\\n \\"description\\": \\"the user define ids for Logtail-ds\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^.*$\\",\\n \\"default\\": \\"\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ds.userdefineids\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ds.userdefineids\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ds.userdefineids\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailStatefulsetReplicas\\": {\\n \\"description\\": \\"the Replica for Logtail-StatefulSet\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"(^0$|^[1-9][0-9]*$)\\",\\n \\"default\\": \\"1\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ss.replica\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ss.replica\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ss.replica\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailStatefulsetLimitCPU\\": {\\n \\"description\\": \\"the cpu limit for Logtail-StatefulSet\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"(^[1-9][0-9]*$|^0\\\\\\\\.[1-9]$|^[1-9]\\\\\\\\.[0-9]$)\\",\\n \\"default\\": \\"2\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ss.cpulimit\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ss.cpulimit\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ss.cpulimit\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailStatefulsetLimitMemory\\": {\\n \\"description\\": \\"the memory limit for Logtail-StatefulSet\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"(^[1-9][0-9]*$)\\",\\n \\"default\\": \\"2048\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ss.memlimit\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ss.memlimit\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ss.memlimit\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailStatefulsetMaxBytePerSec\\": {\\n \\"description\\": \\"the Max Byte Per Second for Logtail-StatefulSet\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^[1-9][0-9]*$\\",\\n \\"default\\": \\"209715200\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ss.maxbyte\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ss.maxbyte\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ss.maxbyte\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailStatefulsetSendRequestConcurrency\\": {\\n \\"description\\": \\"the SendCocurrency for Logtail-StatefulSet\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^[1-9][0-9]*$\\",\\n \\"default\\": \\"40\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ss.cocurrency\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ss.cocurrency\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ss.cocurrency\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailStatefulsetProcessThreadCount\\": {\\n \\"description\\": \\"the Process Thread Count for Logtail-StatefulSet\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^[1-9][0-9]*$\\",\\n \\"default\\": \\"1\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ss.threadcount\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ss.threadcount\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ss.threadcount\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"LogtailStatefulsetExternalUserDefineIDs\\": {\\n \\"description\\": \\"the user define ids for Logtail-StatefulSet\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^.*$\\",\\n \\"default\\": \\"\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.ss.userdefineids\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.ss.userdefineids\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.ss.userdefineids\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n },\\n \\"SlsMonitoring\\": {\\n \\"description\\": \\"the switch for sls metric components\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^(true|false)$\\",\\n \\"default\\": \\"false\\",\\n \\"x-ui-description\\": \\"cos.k8s.addon.config.logtail-ds.description.fullstack\\",\\n \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.logtail-ds.prompt.fullstack\\",\\n \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.logtail-ds.validation.fullstack\\",\\n \\"x-ui-additional-tips\\": \\"\\"\\n }\\n },\\n \\"title\\": \\"Config\\",\\n \\"type\\": \\"object\\"\\n}</config_schema>\\n </addons>\\n <addons>\\n <name>storage-operator</name>\\n <category>storage</category>\\n <install_by_default>true</install_by_default>\\n <managed>false</managed>\\n <version>v1.26.2-1de13b6-aliyun</version>\\n <supported_actions>Install</supported_actions>\\n <supported_actions>Upgrade</supported_actions>\\n <architecture>amd64</architecture>\\n <config_schema/>\\n </addons>\\n</ListAddonsResponse>","errorExample":""}]', + 'title' => '查询可用的组件列表', + ], + 'ListClusterAddonInstances' => [ + 'summary' => '您可以调用ListClusterAddonInstances接口获取目标集群已安装的组件实例列表并查询组件实例的相关信息，包括组件版本、状态等。', + 'path' => '/clusters/{cluster_id}/addon_instances', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c02b3e03be10643e8a644a843ffcb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'addons' => [ + 'title' => '已安装的组件实例列表。', + 'description' => '已安装的组件实例列表。', + 'type' => 'array', + 'items' => [ + 'title' => '组件实例信息。', + 'description' => '组件实例信息。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'coredns', + ], + 'state' => [ + 'title' => '组件状态，可能的取值：'."\n" + .'- active：已安装'."\n" + .'- updating：变更中'."\n" + .'- upgrading：升级中'."\n" + .'- deleting：卸载中', + 'description' => '组件状态，可能的取值：'."\n" + .'- active：已安装'."\n" + .'- updating：变更中'."\n" + .'- upgrading：升级中'."\n" + .'- deleting：卸载中', + 'type' => 'string', + 'example' => 'active', + ], + 'version' => [ + 'title' => '组件版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => 'v1.9.3.10-7dfca203-aliyun', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"addons\\": [\\n {\\n \\"name\\": \\"coredns\\",\\n \\"state\\": \\"active\\",\\n \\"version\\": \\"v1.9.3.10-7dfca203-aliyun\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListClusterAddonInstancesResponse>\\n <addons>\\n <name>coredns</name>\\n <state>active</state>\\n <version>v1.9.3.10-7dfca203-aliyun</version>\\n </addons>\\n <addons>\\n <name>alicloud-monitor-controller</name>\\n <state>active</state>\\n <version>v1.8.1-103ddac-aliyun</version>\\n </addons>\\n <addons>\\n <name>ack-scheduler</name>\\n <state>active</state>\\n <version>v1.28.3-aliyun-5.8-89c55520</version>\\n </addons>\\n <addons>\\n <name>cloud-controller-manager</name>\\n <state>active</state>\\n <version>v2.8.1</version>\\n </addons>\\n <addons>\\n <name>storage-operator</name>\\n <state>active</state>\\n <version>v1.26.2-1de13b6-aliyun</version>\\n </addons>\\n <addons>\\n <name>metrics-server</name>\\n <state>active</state>\\n <version>v0.3.9.5-1e8461a-aliyun</version>\\n </addons>\\n <addons>\\n <name>csi-plugin</name>\\n <state>active</state>\\n <version>v1.26.2-327ca15-aliyun</version>\\n </addons>\\n <addons>\\n <name>csi-provisioner</name>\\n <state>active</state>\\n <version>v1.26.2-327ca15-aliyun</version>\\n </addons>\\n <addons>\\n <name>kube-flannel-ds</name>\\n <state>active</state>\\n <version>v0.15.1.22-20a397e6-aliyun</version>\\n </addons>\\n <addons>\\n <name>nginx-ingress-controller</name>\\n <state>active</state>\\n <version>v1.1.2-aliyun.1</version>\\n </addons>\\n <addons>\\n <name>ack-node-local-dns</name>\\n <state>active</state>\\n <version>1.5.3</version>\\n </addons>\\n <addons>\\n <name>kube-controller-manager</name>\\n <state>active</state>\\n <version>v1.28.3-aliyun.1</version>\\n </addons>\\n <addons>\\n <name>kube-apiserver</name>\\n <state>active</state>\\n <version>v1.28.3-aliyun.1</version>\\n </addons>\\n <addons>\\n <name>ack-node-problem-detector</name>\\n <state>active</state>\\n <version>1.2.18</version>\\n </addons>\\n</ListClusterAddonInstancesResponse>","errorExample":""}]', + 'title' => '查询集群已安装的组件实例列表', + ], + 'GetClusterAddonInstance' => [ + 'summary' => '您可以调用GetClusterAddonInstance接口查询集群中目标组件的详细信息，包括目标组件实例的版本、参数配置、日志功能启用状态等。', + 'path' => '/clusters/{cluster_id}/addon_instances/{instance_name}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c02b3e03be10643e8a644a843ffcb****', + ], + ], + [ + 'name' => 'instance_name', + 'in' => 'path', + 'schema' => [ + 'title' => '组件实例名称。', + 'description' => '组件实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack-node-problem-detector', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件实例名称。', + 'description' => '组件实例名称。', + 'type' => 'string', + 'example' => 'ack-node-problem-detector', + ], + 'state' => [ + 'title' => '组件状态，可能的取值：'."\n" + .'- active：已安装'."\n" + .'- updating：变更中'."\n" + .'- upgrading：升级中'."\n" + .'- deleting：卸载中', + 'description' => '组件状态，可能的取值：'."\n" + .'- active：已安装'."\n" + .'- updating：变更中'."\n" + .'- upgrading：升级中'."\n" + .'- deleting：卸载中', + 'type' => 'string', + 'example' => 'active', + ], + 'version' => [ + 'title' => '组件实例版本。', + 'description' => '组件实例版本。', + 'type' => 'string', + 'example' => '1.2.16', + ], + 'config' => [ + 'title' => '组件自定义参数配置。', + 'description' => '组件自定义参数配置。', + 'type' => 'string', + 'example' => '{"sls_project_name":""}', + ], + 'logging' => [ + 'title' => '组件日志功能状态。', + 'description' => '组件日志功能状态。', + 'type' => 'object', + 'properties' => [ + 'capable' => [ + 'title' => '组件是否支持开启日志功能。', + 'description' => '组件是否支持开启日志功能。'."\n" + ."\n" + .'- true：支持。'."\n" + ."\n" + .'- false：不支持。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'enabled' => [ + 'title' => '组件日志功能是否开启。', + 'description' => '组件日志功能是否开启。'."\n" + ."\n" + .'- true：开启。'."\n" + ."\n" + .'- false：未开启。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'log_project' => [ + 'title' => '组件日志功能使用的日志Project。', + 'description' => '组件日志功能使用的日志Project。', + 'type' => 'string', + 'example' => 'k8s-log-c02b3e03be10643e8a644a843ffcb****', + ], + 'logstore' => [ + 'title' => '组件日志功能使用的日志logstore。', + 'description' => '组件日志功能使用的日志logstore。', + 'type' => 'string', + 'example' => 'my-logstore', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"name\\": \\"ack-node-problem-detector\\",\\n \\"state\\": \\"active\\",\\n \\"version\\": \\"1.2.16\\",\\n \\"config\\": \\"{\\\\\\"sls_project_name\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"logging\\": {\\n \\"capable\\": false,\\n \\"enabled\\": false,\\n \\"log_project\\": \\"k8s-log-c02b3e03be10643e8a644a843ffcb****\\",\\n \\"logstore\\": \\"my-logstore\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetClusterAddonInstanceResponse>\\n <name>ack-node-problem-detector</name>\\n <state>active</state>\\n <version>1.2.16</version>\\n <config>{\\"sls_project_name\\":\\"\\"}</config>\\n <logging>\\n <capable>false</capable>\\n <enabled>false</enabled>\\n </logging>\\n</GetClusterAddonInstanceResponse>","errorExample":""}]', + 'title' => '查询集群内指定组件实例信息', + ], + 'DescribeAddon' => [ + 'summary' => '您可以调用DescribeAddon接口，根据指定地域、集群类型、集群子类型（profile）、集群版本、组件名称等参数查询目标组件的信息，包括组件托管与否、组件分类、支持的自定义参数Schema、兼容的操作系统架构、该版本要求的最低集群版本等。', + 'path' => '/addons/{addon_name}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'addon_name', + 'in' => 'path', + 'schema' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'coredns', + ], + ], + [ + 'name' => 'region_id', + 'in' => 'query', + 'schema' => [ + 'title' => '地域。', + 'description' => '地域。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'cluster_type', + 'in' => 'query', + 'schema' => [ + 'title' => '集群类型。', + 'description' => '集群类型。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'ManagedKubernetes', + ], + ], + [ + 'name' => 'profile', + 'in' => 'query', + 'schema' => [ + 'title' => '集群子类型。', + 'description' => '集群子类型。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'cluster_spec', + 'in' => 'query', + 'schema' => [ + 'title' => '集群规格。', + 'description' => '集群规格。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack.pro.small', + ], + ], + [ + 'name' => 'cluster_version', + 'in' => 'query', + 'schema' => [ + 'title' => '集群版本。', + 'description' => '集群版本。'."\n" + .'如果传入了cluster_id，该参数将被忽略。'."\n" + .'region_id、cluster_type、profile、cluster_spec、cluster_version五个参数需要同时传入。', + 'type' => 'string', + 'required' => false, + 'example' => '1.26.3-aliyun.1', + ], + ], + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。'."\n" + .'指定集群ID时，查询该集群可用的组件列表，此时其他参数将会被忽略。', + 'type' => 'string', + 'required' => false, + 'example' => 'c02b3e03be10643e8a644a843ffcb****', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => [ + 'title' => '组件版本。', + 'description' => '组件版本。不指定时，查询该组件可用的最新版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1.9.3.10-7dfca203-aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'coredns', + ], + 'version' => [ + 'title' => '组件版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => 'v1.9.3.6-32932850-aliyun', + ], + 'category' => [ + 'title' => '组件分类。', + 'description' => '组件分类。', + 'type' => 'string', + 'example' => 'network', + ], + 'managed' => [ + 'title' => '是否为托管组件。', + 'description' => '是否为托管组件。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'install_by_default' => [ + 'title' => '是否默认安装。', + 'description' => '是否默认安装。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'config_schema' => [ + 'title' => '组件自定义参数schema。', + 'description' => '组件自定义参数schema。', + 'type' => 'string', + 'example' => '{}', + ], + 'supported_actions' => [ + 'title' => '组件支持的操作，可能的值：'."\n" + .'- Install'."\n" + .'- Upgrade'."\n" + .'- Modify'."\n" + .'- Uninstall', + 'description' => '组件支持的操作。', + 'type' => 'array', + 'items' => [ + 'description' => '组件支持的操作。'."\n" + .'- Install：安装组件。'."\n" + .'- Upgrade：升级组件。'."\n" + .'- Modify：修改组件。'."\n" + .'- Uninstall：卸载组件。', + 'type' => 'string', + 'example' => 'Install', + ], + ], + 'architecture' => [ + 'title' => '组件支持的体系结构，可能的值：'."\n" + .'- amd64'."\n" + .'- arm64', + 'description' => '组件支持的CPU架构。', + 'type' => 'array', + 'items' => [ + 'description' => '组件支持的CPU架构，可能的值：'."\n" + ."\n" + .'- amd64。'."\n" + ."\n" + .'- arm64。', + 'type' => 'string', + 'example' => 'amd64', + ], + ], + 'newer_versions' => [ + 'title' => '组件新版本。', + 'description' => '组件的最新版本信息。', + 'type' => 'array', + 'items' => [ + 'description' => '新版本信息。', + 'type' => 'object', + 'properties' => [ + 'version' => [ + 'title' => '版本号。', + 'description' => '组件的最新版本号。', + 'type' => 'string', + 'example' => 'v1.9.3.10-7dfca203-aliyun', + ], + 'upgradable' => [ + 'title' => '是否可升级到该版本，', + 'description' => '是否可升级到该版本。'."\n" + ."\n" + .'- true：支持升级。'."\n" + ."\n" + .'- false：不支持升级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'minimum_cluster_version' => [ + 'title' => '该版本要求的最低集群版本。', + 'description' => '该组件版本要求的最低集群版本。', + 'type' => 'string', + 'example' => '1.20.4', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"name\\": \\"coredns\\",\\n \\"version\\": \\"v1.9.3.6-32932850-aliyun\\",\\n \\"category\\": \\"network\\",\\n \\"managed\\": false,\\n \\"install_by_default\\": true,\\n \\"config_schema\\": \\"{}\\",\\n \\"supported_actions\\": [\\n \\"Install\\"\\n ],\\n \\"architecture\\": [\\n \\"amd64\\"\\n ],\\n \\"newer_versions\\": [\\n {\\n \\"version\\": \\"v1.9.3.10-7dfca203-aliyun\\",\\n \\"upgradable\\": true,\\n \\"minimum_cluster_version\\": \\"1.20.4\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribeAddonResponse>\\n <architecture>amd64</architecture>\\n <architecture>arm64</architecture>\\n <category>network</category>\\n <config_schema>{ \\"$schema\\": \\"http://json-schema.org/draft-07/schema#\\", \\"properties\\": { \\"MemoryRequest\\": { \\"type\\": \\"string\\", \\"description\\": \\"memory request for coredns\\", \\"pattern\\": \\"^[1-9][0-9]*(\\\\\\\\.\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\", \\"default\\": \\"100Mi\\", \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.memory.request\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.memory.request\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.memory.request\\", \\"x-ui-additional-tips\\": \\"\\" }, \\"CpuRequest\\": { \\"type\\": \\"string\\", \\"description\\": \\"cpu request for coredns\\", \\"pattern\\": \\"^[1-9][0-9]*(m|\\\\\\\\.\\\\\\\\d+)?$\\", \\"default\\": \\"100m\\", \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.cpu.request\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.cpu.request\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.cpu.request\\", \\"x-ui-additional-tips\\": \\"\\" }, \\"MemoryLimit\\": { \\"type\\": \\"string\\", \\"description\\": \\"memory limit for coredns\\", \\"pattern\\": \\"^(|[1-9][0-9]*(\\\\\\\\.\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?)$\\", \\"default\\": \\"2Gi\\", \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.memory.limit\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.memory.limit\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.memory.limit\\", \\"x-ui-additional-tips\\": \\"\\" }, \\"CpuLimit\\": { \\"type\\": \\"string\\", \\"description\\": \\"cpu limit for coredns\\", \\"pattern\\": \\"^(|[1-9][0-9]*(m|\\\\\\\\.\\\\\\\\d+)?)$\\", \\"default\\": \\"\\", \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.cpu.limit\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.cpu.limit\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.cpu.limit\\", \\"x-ui-additional-tips\\": \\"\\" }, \\"NodeSelector\\": { \\"type\\": \\"array\\", \\"items\\": { \\"type\\": \\"object\\", \\"properties\\": { \\"Key\\": { \\"type\\": \\"string\\", \\"description\\": \\"label name\\", \\"default\\": \\"\\", \\"pattern\\": \\"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\\\\\\\/)?([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]$\\", \\"maxLength\\": 254, \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.nodeSelector.key\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.nodeSelector.key\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.nodeSelector.key\\", \\"x-ui-additional-tips\\": \\"\\" }, \\"Value\\": { \\"type\\": \\"string\\", \\"description\\": \\"label value\\", \\"default\\": \\"\\", \\"pattern\\": \\"^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$\\", \\"maxLength\\": 63, \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.nodeSelector.value\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.nodeSelector.value\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.nodeSelector.value\\", \\"x-ui-additional-tips\\": \\"\\" } }, \\"required\\": [ \\"Key\\", \\"Value\\" ] }, \\"description\\": \\"node selector for coredns\\", \\"default\\": [ { \\"Key\\": \\"kubernetes.io/os\\", \\"Value\\": \\"linux\\" } ], \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.nodeSelector\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.nodeSelector\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.nodeSelector\\", \\"x-ui-additional-tips\\": \\"\\" }, \\"Tolerations\\": { \\"type\\": \\"array\\", \\"items\\": { \\"type\\": \\"object\\", \\"description\\": \\"The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.\\", \\"properties\\": { \\"effect\\": { \\"description\\": \\"Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.\\", \\"pattern\\": \\"^(NoSchedule|PreferNoSchedule|NoExecute)$\\", \\"maxLength\\": 254, \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.toleration.effect\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.toleration.effect\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.toleration.effect\\", \\"x-ui-additional-tips\\": \\"\\", \\"type\\": [ \\"string\\", \\"null\\" ] }, \\"key\\": { \\"description\\": \\"Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.\\", \\"pattern\\": \\"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\\\\\\\/)?([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]$\\", \\"maxLength\\": 254, \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.toleration.key\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.toleration.key\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.toleration.key\\", \\"x-ui-additional-tips\\": \\"\\", \\"type\\": [ \\"string\\", \\"null\\" ] }, \\"operator\\": { \\"description\\": \\"Operator represents a key\'s relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.\\", \\"pattern\\": \\"^(Exists|Equal)$\\", \\"maxLength\\": 254, \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.toleration.operator\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.toleration.operator\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.toleration.operator\\", \\"x-ui-additional-tips\\": \\"\\", \\"type\\": [ \\"string\\", \\"null\\" ] }, \\"value\\": { \\"description\\": \\"Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.\\", \\"pattern\\": \\"^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\\\\\\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*\\\\\\\\/)?([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]$\\", \\"maxLength\\": 254, \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.toleration.value\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.toleration.value\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.toleration.value\\", \\"x-ui-additional-tips\\": \\"\\", \\"type\\": [ \\"string\\", \\"null\\" ] } } }, \\"description\\": \\"tolerations for coredns\\", \\"default\\": [], \\"x-ui-description\\": \\"cos.k8s.addon.config.coredns.description.tolerations\\", \\"x-ui-prompt-message\\": \\"cos.k8s.addon.config.coredns.prompt.tolerations\\", \\"x-ui-validation-message\\": \\"cos.k8s.addon.config.coredns.validation.tolerations\\", \\"x-ui-additional-tips\\": \\"\\" } }, \\"title\\": \\"Config\\", \\"type\\": \\"object\\" }</config_schema>\\n <install_by_default>true</install_by_default>\\n <managed>false</managed>\\n <name>coredns</name>\\n <supported_actions>Install</supported_actions>\\n <supported_actions>Upgrade</supported_actions>\\n <supported_actions>Modify</supported_actions>\\n <version>v1.9.3.10-7dfca203-aliyun</version>\\n</DescribeAddonResponse>","errorExample":""}]', + 'title' => '查询指定组件的信息', + ], + 'ModifyClusterAddon' => [ + 'summary' => '您可以调用ModifyClusterAddon配置修改已安装的集群组件实例的配置。修改配置可能会影响业务，请评估影响后在业务低峰期操作并提前做好相关的数据备份。', + 'path' => '/clusters/{cluster_id}/components/{component_id}/config', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c71d616e629ff40d5b42d7bb87770****', + ], + ], + [ + 'name' => 'component_id', + 'in' => 'path', + 'schema' => [ + 'title' => '组件ID', + 'description' => '组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'coredns', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '组件配置', + 'description' => '组件配置。', + 'type' => 'object', + 'properties' => [ + 'config' => [ + 'title' => '自定义参数设置', + 'description' => '自定义参数设置。', + 'type' => 'string', + 'required' => false, + 'example' => '{"CpuRequest":"800m"}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '修改集群组件实例配置', + 'description' => '使用该API可修改普通集群组件的配置以及ACK Pro集群的管控面参数配置：'."\n" + .'- 普通组件可配置参数列表可通过DescribeClusterAddonMetadata'."\n" + .'API 查询，详情参见[查询集群组件版本元数据](~~2667944~~)。'."\n" + .'- ACK Pro集群管控面组件可配置的参数列表，请参见[自定义ACK Pro集群的管控面参数](~~199588~~)。'."\n" + ."\n" + .'修改配置可能会导致组件重新部署和启动，请评估影响后再进行操作。', + 'requestParamsDescription' => '`config`参数值为JSON编码后的组件自定义参数配置。', + ], + 'UpgradeClusterAddons' => [ + 'summary' => '您可以调用UpgradeClusterAddons接口升级集群组件实例的版本，从而享受新版本带来的功能优化体验。', + 'path' => '/clusters/{ClusterId}/components/upgrade', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '493', + 'abilityTreeNodes' => [ + 'FEATUREcsk6XCUME', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cf4299b79b3e34226abfdc80a4bda****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'Request body，类型是对象数组', + 'description' => '请求参数。', + 'type' => 'array', + 'items' => [ + 'description' => '组件信息。', + 'type' => 'object', + 'properties' => [ + 'component_name' => [ + 'title' => '组件名称', + 'description' => '组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'coredns', + ], + 'next_version' => [ + 'title' => '可升级版本', + 'description' => '待升级的目标版本。您可以调用`DescribeAddon`接口查看组件可升级的版本。', + 'type' => 'string', + 'required' => true, + 'example' => 'v1.11.3.5-5321daf49-aliyun', + ], + 'version' => [ + 'title' => '当前版本', + 'description' => '当前组件版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'v1.11.3.2-f57ea7ed6-aliyun', + ], + 'config' => [ + 'title' => '组件自定义参数', + 'description' => '组件自定义参数，使用JSON字符串编码。', + 'type' => 'string', + 'required' => false, + 'example' => '{"CpuRequest":"800m"}', + ], + 'policy' => [ + 'title' => '组件升级策略。', + 'description' => '组件升级策略。可选值：'."\n" + .'- overwrite：覆盖升级。'."\n" + .'- canary：金丝雀升级。', + 'type' => 'string', + 'required' => false, + 'example' => 'canary', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cf4299b79b3e34226abfdc80a4bda****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'bfd12953-31cb-42f1-8a36-7b80ec34****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-62a944794ee141074400****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cluster_id\\": \\"cf4299b79b3e34226abfdc80a4bda****\\",\\n \\"request_id\\": \\"bfd12953-31cb-42f1-8a36-7b80ec34****\\",\\n \\"task_id\\": \\"T-62a944794ee141074400****\\"\\n}","type":"json"}]', + 'title' => '升级集群实例组件', + 'description' => '- 升级集群组件实例版本可能会影响业务，请评估影响后在业务低峰期操作并提前做好相关的数据备份。'."\n" + .'- 升级组件前，请参考[组件发布记录](~~176087~~)了解指定组件的变更内容和变更影响。'."\n" + .'- 请依次逐个组件升级，确认一个组件升级成功后再升级下一个组件。', + ], + 'ListClusterAddonInstanceResources' => [ + 'summary' => '查询已安装的集群组件实例所包含的资源列表，包括Kubernetes集群资源、Helm发布实例等。', + 'path' => '/clusters/{cluster_id}/addon_instances/{instance_name}/resources', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215253', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cb95aa626a47740afbf6aa099b650****', + ], + ], + [ + 'name' => 'instance_name', + 'in' => 'path', + 'schema' => [ + 'title' => '组件实例名称。', + 'description' => '组件实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'terway-eniip', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'kubernetes_objects' => [ + 'title' => '组件包含的Kubernetes对象列表。', + 'description' => '组件包含的Kubernetes对象列表。', + 'type' => 'array', + 'items' => [ + 'title' => 'Kubernetes对象。', + 'description' => 'Kubernetes对象。', + 'type' => 'object', + 'properties' => [ + 'group' => [ + 'title' => '对象归属的Kubernetes API组。', + 'description' => '对象归属的Kubernetes API组。', + 'type' => 'string', + 'example' => 'rbac.authorization.k8s.io', + ], + 'version' => [ + 'title' => '对象归属的Kubernetes API版本。', + 'description' => '对象归属的Kubernetes API版本。', + 'type' => 'string', + 'example' => 'v1', + ], + 'kind' => [ + 'title' => '对象归属的Kubernetes API类型。', + 'description' => '对象归属的Kubernetes API类型。', + 'type' => 'string', + 'example' => 'ClusterRole', + ], + 'name' => [ + 'title' => '对象名称。', + 'description' => '对象名称。', + 'type' => 'string', + 'example' => 'terway-pod-reader', + ], + 'namespace' => [ + 'title' => '对象所属命名空间。', + 'description' => '对象所属命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + ], + ], + ], + 'helm_release' => [ + 'title' => '组件对应的Helm Release实例信息。', + 'description' => '组件对应的Helm Release实例信息。', + 'type' => 'object', + 'properties' => [ + 'release_name' => [ + 'title' => 'Helm Release实例名称。', + 'description' => 'Helm Release实例名称。', + 'type' => 'string', + 'example' => 'ack-node-problem-detector', + ], + 'namespace' => [ + 'title' => '命名空间。', + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'kube-system', + ], + 'chart_name' => [ + 'title' => '组件对应的Helm Chart名称。', + 'description' => '组件对应的Helm Chart名称。', + 'type' => 'string', + 'example' => 'ack-node-problem-detector', + ], + 'chart_version' => [ + 'title' => '组件对应的Helm Chart版本。', + 'description' => '组件对应的Helm Chart版本。', + 'type' => 'string', + 'example' => '1.2.28', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"kubernetes_objects\\": [\\n {\\n \\"group\\": \\"rbac.authorization.k8s.io\\",\\n \\"version\\": \\"v1\\",\\n \\"kind\\": \\"ClusterRole\\",\\n \\"name\\": \\"terway-pod-reader\\",\\n \\"namespace\\": \\"kube-system\\"\\n }\\n ],\\n \\"helm_release\\": {\\n \\"release_name\\": \\"ack-node-problem-detector\\",\\n \\"namespace\\": \\"kube-system\\",\\n \\"chart_name\\": \\"ack-node-problem-detector\\",\\n \\"chart_version\\": \\"1.2.28\\"\\n }\\n}","type":"json"}]', + 'title' => '查询集群组件实例的资源', + ], + 'DescribeUserPermission' => [ + 'summary' => '在ACK集群中，您可以创建并指定不同RAM用户或角色拥有不同的访问权限，从而确保安全访问控制和资源隔离。您可以调用DescribeUserPermission接口查询RAM用户或角色拥有的集群权限详情，包括可访问的资源、权限的作用范围、预置的角色类型、权限来源等。', + 'path' => '/permissions/users/{uid}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'chargeType' => 'free', + 'abilityTreeCode' => '13132', + 'abilityTreeNodes' => [ + 'FEATUREcskM5ADAN', + ], + ], + 'parameters' => [ + [ + 'name' => 'uid', + 'in' => 'path', + 'schema' => [ + 'title' => 'RAM 用户的 UID', + 'description' => '指定RAM用户或RAM角色的ID。'."\n" + ."\n" + .'- 若查询RAM用户权限，则使用RAM用户的UID。'."\n" + ."\n" + .'- 若查询RAM角色权限，则使用RAM角色的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '206945240368******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体参数', + 'description' => '返回体参数。', + 'type' => 'array', + 'items' => [ + 'description' => 'RAM用户集群授权详情。', + 'type' => 'object', + 'properties' => [ + 'resource_id' => [ + 'title' => '集群访问配置', + 'description' => '集群访问配置，格式为：'."\n" + ."\n" + .'- 当是集群维度授权时，格式为：`{cluster_id}`。'."\n" + .'- 当是命名空间维度授权时，格式为：`{cluster_id}/{namespace}`。'."\n" + .'- 当是所有集群授权时，值固定为：`all-clusters`。', + 'type' => 'string', + 'example' => 'c1b542****', + ], + 'resource_type' => [ + 'title' => '授权类型', + 'description' => '授权类型，取值：'."\n" + ."\n" + .'- `cluster`：集群维度。'."\n" + .'- `namespace`：命名空间维度。'."\n" + .'- `console`：所有集群维度的授权。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'role_name' => [ + 'title' => '自定义角色名称', + 'description' => '自定义角色名称，当授权自定义角色时，该字段为指定的自定义集群管理角色名称。', + 'type' => 'string', + 'example' => 'terway-pod-reader', + ], + 'role_type' => [ + 'title' => '预置的角色类型', + 'description' => '预置的角色类型，取值：'."\n" + ."\n" + .'- `admin`：管理员。'."\n" + .'- `ops`：运维人员。'."\n" + .'- `dev`：开发人员。'."\n" + .'- `restricted`：受限用户。'."\n" + .'- `custom`：使用自定义的集群管理角色。', + 'type' => 'string', + 'example' => 'admin', + ], + 'is_owner' => [ + 'title' => '是否为集群 owner 的授权', + 'description' => '是否为集群创建者的授权，取值：'."\n" + ."\n" + .'- `0`：代表不是集群创建者的授权记录。'."\n" + .'- `1`：代表该授权记录为集群创建者的管理员权限。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'is_ram_role' => [ + 'title' => '是否为ram 角色授权', + 'description' => '是否为RAM角色授权，取值：'."\n" + ."\n" + .'- `0`：代表当前记录不是RAM角色授权。'."\n" + .'- `1`：代表当前记录是RAM角色授权。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"resource_id\\": \\"c1b542****\\",\\n \\"resource_type\\": \\"cluster\\",\\n \\"role_name\\": \\"terway-pod-reader\\",\\n \\"role_type\\": \\"admin\\",\\n \\"is_owner\\": 1,\\n \\"is_ram_role\\": 1\\n }\\n]","errorExample":""},{"type":"xml","example":"<0>\\n <resource_id>c1b542**</resource_id>\\n <resource_type>cluster</resource_type>\\n <role_name>view</role_name>\\n <role_type>admin</role_type>\\n <is_owner>1</is_owner>\\n <is_ram_role>1</is_ram_role>\\n</0>","errorExample":""}]', + 'title' => '查询RAM用户或角色的集群授权信息', + 'description' => '**注意事项**：'."\n" + ."\n" + .'- 如果调用该API的账号为RAM用户或RAM角色，则API将仅能返回调用账号有RBAC管理员权限的集群对应的权限。如您需要该API列出所有集群的权限，则调用账号需具备所有集群的RBAC管理员权限。', + 'responseParamsDescription' => '未在参数列表中展示的 parent_id 参数已废弃，请勿使用。', + ], + 'GrantPermissions' => [ + 'summary' => '非集群创建者、没有被授予过所有集群维度权限的RAM用户或角色在集群中默认没有任何RBAC权限。您可以调用GrantPermissions接口，更新RAM用户或角色拥有的RBAC访问权限，包括可访问的资源、权限的作用范围、预置的角色类型等，从而更好地管理集群的安全访问控制。', + 'path' => '/permissions/users/{uid}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'uid', + 'in' => 'path', + 'schema' => [ + 'title' => '指定 RAM 用户的 UID', + 'description' => 'RAM用户或RAM角色的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2367****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数', + 'description' => '请求体参数', + 'type' => 'array', + 'items' => [ + 'description' => '授权详情。', + 'type' => 'object', + 'properties' => [ + 'cluster' => [ + 'title' => '授权目标集群id', + 'description' => '授权目标集群ID。'."\n" + ."\n" + .'- 当`role_type`参数的值是`all-clusters`时，此参数的值传空字符串。', + 'type' => 'string', + 'required' => true, + 'example' => 'c796c60***', + ], + 'is_custom' => [ + 'title' => '该授权是否是自定义授权', + 'description' => '该授权是否是自定义授权（`role_name`使用自定义的ClusterRole名称）。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'role_name' => [ + 'title' => '预置的角色名称', + 'description' => '预置的角色名称，取值：'."\n" + ."\n" + .'- `admin`: 管理员。'."\n" + .'- `admin-view`: 只读管理员。'."\n" + .'- `ops`：运维人员。'."\n" + .'- `dev`：开发人员。'."\n" + .'- `restricted`: 受限用户。'."\n" + .'- 自定义的ClusterRole名称。'."\n" + ."\n" + .'><notice>'."\n" + ."\n" + .'- `admin`、`admin-view`、`ops`：不支持命名空间维度的授予。'."\n" + .'- `admin-view`： 暂不支持所有集群维度的授予。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ops' => 'ops', + 'dev' => 'dev', + 'restricted' => 'restricted', + 'admin-view' => 'admin-view', + 'admin' => 'admin', + ], + 'example' => 'ops', + ], + 'role_type' => [ + 'title' => '授权类型', + 'description' => '授权类型，取值：'."\n" + ."\n" + .'- `cluster`：集群维度。'."\n" + .'- `namespace`: 命名空间维度。'."\n" + .'- `all-clusters`: 所有集群维度。', + 'type' => 'string', + 'required' => true, + 'example' => 'cluster', + ], + 'namespace' => [ + 'title' => '命名空间名称', + 'description' => '命名空间名称，集群维度授权时默认为空。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'is_ram_role' => [ + 'title' => '是否是 RAM 角色授权', + 'description' => '是否是RAM角色授权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '全量更新RAM用户或角色的集群授权信息', + 'description' => '- 如果调用这个API的账号是RAM用户账号，请先确保该账号已拥有修改其他RAM用户或RAM角色集群授权信息的权限，否则API将返回`StatusForbidden`或`ForbiddenGrantPermissions`错误码。具体操作，请参见[子账号如何给其他子账号进行RBAC授权](~~119035~~) 。'."\n" + ."\n" + .'- 全量更新RAM用户或RAM角色集群授权信息操作会覆盖目标RAM用户或RAM角色已有的集群权限，请求时需要包含想要授权给目标RAM用户或RAM角色的所有权限配置。', + ], + 'UpdateUserPermissions' => [ + 'summary' => '在ACK集群中，非集群创建者、RAM用户以及RAM角色在集群中默认没有任何RBAC权限。您可以调用UpdateUserPermissions接口，更新RAM用户或角色拥有的RBAC访问权限，包括可访问的资源、权限的作用范围、预置的角色类型等，从而更好地管理集群的安全访问控制。', + 'path' => '/permissions/users/{uid}/update', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213870', + 'abilityTreeNodes' => [ + 'FEATUREcskM5ADAN', + ], + ], + 'parameters' => [ + [ + 'name' => 'uid', + 'in' => 'path', + 'schema' => [ + 'description' => 'RAM用户或RAM角色的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '2367****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'array', + 'items' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'cluster' => [ + 'description' => '授权目标集群ID。'."\n" + ."\n" + .'当`role_type`参数选择为`all-clusters`时，该参数无需填写。', + 'type' => 'string', + 'required' => false, + 'example' => 'c796c60***', + ], + 'is_custom' => [ + 'description' => '该授权是否是自定义授权（`role_name`使用自定义的ClusterRole名称）。'."\n" + ."\n" + .'- true：授权角色为自定义的集群角色。'."\n" + ."\n" + .'- false：授权角色集群预置角色。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'role_name' => [ + 'description' => '预置的角色名称，取值：'."\n" + ."\n" + .'- `admin`: 管理员。'."\n" + .'- `admin-view`: 只读管理员。'."\n" + .'- `ops`：运维人员。'."\n" + .'- `dev`：开发人员。'."\n" + .'- `restricted`: 受限用户。'."\n" + .'- 自定义的ClusterRole名称。'."\n" + ."\n\n" + .'> - `admin`、`admin-view`、`ops`：不支持**命名空间维度**的授予。'."\n" + .'> - `admin-view`： 暂不支持**所有集群维度**的授予。', + 'type' => 'string', + 'required' => false, + 'example' => 'ops', + ], + 'role_type' => [ + 'description' => '授权类型，取值：'."\n" + ."\n" + .'- `cluster`：集群维度。'."\n" + .'- `namespace`: 命名空间维度。'."\n" + .'- `all-clusters`: 所有集群维度。', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster', + ], + 'namespace' => [ + 'description' => '命名空间名称，集群维度授权时默认为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'is_ram_role' => [ + 'description' => '是否是RAM角色授权。'."\n" + ."\n" + .'- true：为RAM角色授权。'."\n" + ."\n" + .'- false：为RAM用户授权。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'mode', + 'in' => 'query', + 'schema' => [ + 'description' => '授权方式，取值：'."\n" + ."\n" + .'- `apply`：全量更新权限，全量更新RAM用户或RAM角色集群授权信息操作会覆盖目标RAM用户或RAM角色已有的集群权限，请求时需要包含想要授权给目标RAM用户或RAM角色的所有权限配置。'."\n" + .'- `delete`: 删除权限，只会删除请求时包含的集群授权信息，不影响RAM用户或RAM角色的其他集群权限。'."\n" + .'- `patch`: 新增权限，只会新增请求时包含的集群授权信息，不影响RAM用户或RAM角色的其他集群权限。'."\n" + ."\n" + .'默认值：`apply`。', + 'type' => 'string', + 'required' => false, + 'example' => 'apply', + 'enum' => [ + 'delete', + 'patch', + 'apply', + ], + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '更新指定RAM用户/角色的RBAC权限', + 'description' => '对目标RAM用户或RAM角色集群授权信息的更新方式包括全量更新与增量更新。全量更新RAM用户或RAM角色集群授权信息操作会覆盖目标RAM用户或RAM角色已有的集群权限，请求时需要包含想要授权给目标RAM用户或RAM角色的所有权限配置。增量更新RAM用户或RAM角色集群授权信息操作包括新增以及删除操作，只会针对请求时包含的集群授权信息进行权限变更，不影响RAM用户或RAM角色的其他集群权限。', + ], + 'CheckServiceRole' => [ + 'summary' => '检查当前服务账号是否已授予指定的服务角色权限。只有授予对应的角色权限后，容器服务才能正常调用服务角色相关的其他云服务（ECS、OSS、NAS、SLB等）。', + 'path' => '/ram/check-service-role', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215025', + 'abilityTreeNodes' => [ + 'FEATUREcskDQP655', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'roles' => [ + 'title' => '需要检查的角色列表', + 'description' => '需要检查的服务角色列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务角色信息。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '角色名称', + 'description' => '服务角色名称。容器服务ACK包含的服务角色以及权限范围，请参见[容器服务ACK服务角色](~~86483~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'AliyunCSManagedAutoScalerRole', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'roles' => [ + 'title' => '角色检查结果', + 'description' => '服务角色检查结果。', + 'type' => 'array', + 'items' => [ + 'description' => '服务角色列表。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '角色名称', + 'description' => '服务角色名称。', + 'type' => 'string', + 'example' => 'AliyunCSManagedAutoScalerRole', + ], + 'granted' => [ + 'title' => '是否已授权', + 'description' => '是否已授权。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '已授权', + 'false' => '未授权', + ], + 'example' => 'true', + ], + 'message' => [ + 'title' => '未授权时的提示信息', + 'description' => '未授权时的提示信息。', + 'type' => 'string', + 'example' => 'The role does not exist: AliyunCSManagedAutoScalerRole', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"roles\\": [\\n {\\n \\"name\\": \\"AliyunCSManagedAutoScalerRole\\",\\n \\"granted\\": true,\\n \\"message\\": \\"The role does not exist: AliyunCSManagedAutoScalerRole\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '检查服务角色授权状态', + ], + 'ScanClusterVuls' => [ + 'summary' => '您可以调用ScanClusterVuls接口扫描ACK集群中潜在的安全漏洞，包括容器工作负载漏洞、三方软件漏洞、CVE漏洞、WebCMS漏洞、Windows操作系统漏洞等。建议您定期扫描集群的安全漏洞，提高集群安全性。', + 'path' => '/clusters/{cluster_id}/vuls/scan', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c259f563386444ebb8d7****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4******', + ], + 'task_id' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-xascadasd*****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4******\\",\\n \\"task_id\\": \\"T-xascadasd*****\\"\\n}","type":"json"}]', + 'title' => '扫描集群安全漏洞', + ], + 'DescribeClusterVuls' => [ + 'summary' => '您可以根据集群ID调用DescribeClusterVuls接口查看集群的安全漏洞详细信息，包括漏洞名称、漏洞类型、漏洞等级等。建议您定期扫描集群的安全漏洞，提高集群安全性。', + 'path' => '/clusters/{cluster_id}/vuls', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '165070', + 'abilityTreeNodes' => [ + 'FEATUREcsk4JRUSW', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体。', + 'type' => 'object', + 'properties' => [ + 'vul_records' => [ + 'description' => '漏洞列表。', + 'type' => 'array', + 'items' => [ + 'description' => '漏洞信息。', + 'type' => 'object', + 'properties' => [ + 'nodepool_name' => [ + 'description' => '节点池名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'nodepool_id' => [ + 'description' => '节点池ID。', + 'type' => 'string', + 'example' => 'np0156da1082b54fa987e32618dd******', + ], + 'node_count' => [ + 'description' => '具有该漏洞的节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'vul_name' => [ + 'description' => '漏洞名称。', + 'type' => 'string', + 'example' => 'oval:com.redhat.rhsa:def:xxxxxxx', + ], + 'vul_alias_name' => [ + 'description' => '漏洞别名。', + 'type' => 'string', + 'example' => 'CVE-2022-xxxx:rsync 安全漏洞', + ], + 'vul_type' => [ + 'description' => '漏洞类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'app' => '应用漏洞', + 'sca' => '应用漏洞（软件成分分析）', + 'cve' => 'Linux漏洞', + 'cms' => 'WebCMS漏洞', + 'sys' => 'Windows漏洞', + 'emg' => '应急漏洞', + ], + 'example' => 'cve', + ], + 'necessity' => [ + 'description' => '漏洞等级。', + 'type' => 'string', + 'enumValueTitles' => [ + 'nntf' => '低', + 'later' => '中', + 'asap' => '高', + ], + 'example' => 'asap', + ], + 'cve_list' => [ + 'description' => 'CVE列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'CVE信息。', + 'type' => 'string', + 'example' => 'CVE-2022-xxxxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"vul_records\\": [\\n {\\n \\"nodepool_name\\": \\"test\\",\\n \\"nodepool_id\\": \\"np0156da1082b54fa987e32618dd******\\",\\n \\"node_count\\": 1,\\n \\"vul_name\\": \\"oval:com.redhat.rhsa:def:xxxxxxx\\",\\n \\"vul_alias_name\\": \\"CVE-2022-xxxx:rsync 安全漏洞\\",\\n \\"vul_type\\": \\"cve\\",\\n \\"necessity\\": \\"asap\\",\\n \\"cve_list\\": [\\n \\"CVE-2022-xxxxx\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群安全漏洞信息', + ], + 'UpdateResourcesDeleteProtection' => [ + 'summary' => '更新指定资源的删除保护状态，当前支持的资源类型有命名空间和服务。'."\n" + .'通过本接口，您可以为涉及关键业务、敏感数据的命名空间或服务开启删除保护功能，以避免误删除带来的维护成本。', + 'path' => '/clusters/{ClusterId}/resources/protection', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198784', + 'abilityTreeNodes' => [ + 'FEATUREcskCWOUHM', + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '资源所属的集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c850429a2287b4d968e27e87a4921****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '待更新的目标资源。', + 'type' => 'object', + 'properties' => [ + 'namespace' => [ + 'description' => '资源所在的命名空间。'."\n" + ."\n" + .'默认值为default。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'resource_type' => [ + 'description' => '待更新的资源类型。取值如下：'."\n" + ."\n" + .'- namespaces：命名空间。'."\n" + ."\n" + .'- services：服务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'services', + 'enum' => [ + 'services', + 'namespaces', + ], + ], + 'resources' => [ + 'description' => '目标资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '目标资源名称。'."\n" + ."\n" + .'- resource_type选择为namespaces时，本参数需要填写为命名空间名称。'."\n" + .'- resource_type选择为services时，本参数需要填写为服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'required' => false, + ], + 'enable' => [ + 'description' => '是否为资源开启删除保护。取值如下：'."\n" + ."\n" + .'- true：开启删除保护。开启后，您需要先手动关闭资源的删除保护，才能删除指定资源。'."\n" + ."\n" + .'- false：关闭删除保护。'."\n" + ."\n" + .'默认值为false。', + 'type' => 'boolean', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'true', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0527ac9a-c899-4341-a21a-xxxxxxxxx', + ], + 'namespace' => [ + 'description' => '资源所在的命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'resource_type' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'namespaces', + ], + 'resources' => [ + 'description' => '更新删除保护状态的资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '更新删除保护状态的资源名称。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + 'protection' => [ + 'description' => '资源的删除保护状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'enable' => '开启删除保护', + 'disable' => '关闭删除保护', + ], + 'example' => 'enable', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0527ac9a-c899-4341-a21a-xxxxxxxxx\\",\\n \\"namespace\\": \\"default\\",\\n \\"resource_type\\": \\"namespaces\\",\\n \\"resources\\": [\\n \\"test1\\"\\n ],\\n \\"protection\\": \\"enable\\"\\n}","type":"json"}]', + 'title' => '更新指定资源的删除保护状态', + 'description' => '调用本接口前，您需要先为集群安装或升级安全策略组件。具体操作，请参见[启用安全策略管理](~~359818~~)。', + 'extraInfo' => '除了调用本接口，您还可以通过控制台方式更新命名空间或服务的删除保护策略。具体操作，请参见[安全策略管理](~~359818~~)。', + ], + 'DescribeResourcesDeleteProtection' => [ + 'summary' => '查询集群内的指定资源是否开启删除保护，当前支持删除保护的资源包括命名空间和服务。', + 'path' => '/clusters/{ClusterId}/resources/{ResourceType}/protection', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '198785', + 'abilityTreeNodes' => [ + 'FEATUREcskCWOUHM', + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => 'ACK集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'path', + 'schema' => [ + 'description' => '待查询的资源类型。取值如下：'."\n" + ."\n" + .'- namespaces：命名空间。'."\n" + ."\n" + .'- services：服务。', + 'type' => 'string', + 'required' => true, + 'example' => 'namespaces', + 'enum' => [ + 'namespaces', + 'services', + ], + ], + ], + [ + 'name' => 'namespace', + 'in' => 'query', + 'schema' => [ + 'description' => '待查询资源所在的命名空间。'."\n" + ."\n" + .'resource_type选择为services时该参数必须填写，若未填写则默认按照命名空间为default处理。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'resources', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的目标资源名称，多个资源以英文半角逗号（,）分割。'."\n" + ."\n" + .'- resource_type选择为namespaces时，本参数需要填写为命名空间名称。若不填写，则查询集群下所有命名空间的删除保护状态。'."\n" + ."\n" + .'- resource_type选择为services时，本参数必须填写，需要填写为服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test1,test2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '指定资源的删除保护状态列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '查询的资源名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'arms-prom', + ], + 'namespace' => [ + 'description' => '查询资源所在的命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'resource' => [ + 'description' => '查询的资源类型。', + 'type' => 'string', + 'example' => 'namespaces', + ], + 'protection' => [ + 'description' => '是否开启删除保护。'."\n" + .'- true：开启。'."\n" + .'- false：关闭。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'required' => true, + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"name\\": \\"arms-prom\\",\\n \\"namespace\\": \\"default\\",\\n \\"resource\\": \\"namespaces\\",\\n \\"protection\\": false\\n }\\n]","type":"json"}]', + 'title' => '查询指定资源是否开启删除保护', + ], + 'DeployPolicyInstance' => [ + 'summary' => '您可以在ACK集群中选择安全策略类型，配置策略实例的治理动作（告警或拦截）、作用的命名空间范围等，以创建并部署一个策略实例。您可以调用DeployPolicyInstance接口，在指定集群的命名空间中部署策略规则实例。', + 'path' => '/clusters/{cluster_id}/policies/{policy_name}', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '目标集群id', + 'description' => '目标集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c8155823d057948c69a****', + ], + ], + [ + 'name' => 'policy_name', + 'in' => 'path', + 'schema' => [ + 'title' => '策略治理规则名称', + 'description' => '策略治理规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ACKAllowedRepos', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '请求结构。', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'title' => '规则治理动作', + 'description' => '规则治理动作，取值：'."\n" + ."\n" + .'- `deny`：拦截违规部署'."\n" + .'- `warn`：告警', + 'type' => 'string', + 'required' => false, + 'example' => 'deny', + ], + 'namespaces' => [ + 'title' => '限制策略实施的命名空间，为空时表示所有命名空间', + 'description' => '限制策略实施的命名空间，为空时表示所有命名空间。', + 'type' => 'array', + 'items' => [ + 'description' => '限制策略实施的命名空间，为空时表示所有命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + 'required' => false, + ], + 'parameters' => [ + 'title' => '当前规则实例的配置参数', + 'description' => '当前规则实例的参数配置。每个策略治理规则支持的参数以及对应的参数说明，详见 [容器安全策略规则库说明](https://www.alibabacloud.com/help/doc-detail/359819.html) 。', + 'type' => 'object', + 'required' => false, + 'example' => '{ "repos": [ "registry-vpc.cn-hangzhou.aliyuncs.com/acs/", "registry.cn-hangzhou.aliyuncs.com/acs/" ] }', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'instances' => [ + 'title' => '策略实例列表', + 'description' => '策略实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已部署的实例名称列表。', + 'type' => 'string', + 'example' => '[ "allowed-repos-kqxnc" ]', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"instances\\": [\\n \\"[ \\\\\\"allowed-repos-kqxnc\\\\\\" ]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DeployPolicyInstanceResponse>\\n <instances>allowed-repos-kqxnc</instances>\\n</DeployPolicyInstanceResponse>","errorExample":""}]', + 'title' => '部署策略规则实例', + ], + 'ModifyPolicyInstance' => [ + 'summary' => '您可以调用ModifyPolicyInstance接口，在指定集群中更新策略规则实例，调整策略实例的治理动作（告警或拦截）、作用的命名空间范围等。', + 'path' => '/clusters/{cluster_id}/policies/{policy_name}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '目标集群id', + 'description' => '目标集群ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c8155823d057948c69a****', + ], + ], + [ + 'name' => 'policy_name', + 'in' => 'path', + 'schema' => [ + 'title' => '策略治理规则名称', + 'description' => '策略治理规则名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ACKAllowedRepos', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'title' => '规则治理动作', + 'description' => '规则治理动作，取值：'."\n" + ."\n" + .'- `deny`：拦截违规部署'."\n" + .'- `warn`：告警', + 'type' => 'string', + 'required' => false, + 'example' => 'deny', + ], + 'instance_name' => [ + 'title' => '策略规则实例id', + 'description' => '策略规则实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'allowed-repos-cbhhb', + ], + 'namespaces' => [ + 'title' => '限制策略实施的命名空间，为空时表示所有命名空间', + 'description' => '限制策略实施的命名空间，为空时表示所有命名空间', + 'type' => 'array', + 'items' => [ + 'description' => '策略实例实施范围：'."\n" + ."\n" + .'默认""代表集群所有命名空间。'."\n" + ."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["test3","test4"]', + ], + 'required' => false, + ], + 'parameters' => [ + 'title' => '当前规则实例的配置参数', + 'description' => '当前规则实例的配置参数。更多参数配置规则，请参见[容器安全策略规则库说明](~~359819~~)。'."\n" + ."\n", + 'type' => 'object', + 'required' => false, + 'example' => '"restrictedNamespaces": [ "test" ]', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'instances' => [ + 'description' => '已更新的实例列表', + 'type' => 'array', + 'items' => [ + 'description' => '已更新的实例列表', + 'type' => 'string', + 'example' => '[ "allowed-repos-kqxnc" ]', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"instances\\": [\\n \\"[ \\\\\\"allowed-repos-kqxnc\\\\\\" ]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ModifyPolicyInstanceResponse>\\n <instances>[ \\"allowed-repos-kqxnc\\" ]</instances>\\n</ModifyPolicyInstanceResponse>","errorExample":""}]', + 'title' => '更新策略规则实例', + ], + 'DeletePolicyInstance' => [ + 'summary' => '您可以调用DeletePolicyInstance接口，在指定集群中删除策略规则实例。', + 'path' => '/clusters/{cluster_id}/policies/{policy_name}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '目标集群id', + 'description' => '目标集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c8155823d057948c69a****', + ], + ], + [ + 'name' => 'policy_name', + 'in' => 'path', + 'schema' => [ + 'title' => '策略治理规则名称', + 'description' => '策略治理规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'ACKAllowedRepos', + ], + ], + [ + 'name' => 'instance_name', + 'in' => 'query', + 'schema' => [ + 'title' => '策略规则实例id', + 'description' => '策略规则实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'allowed-repos-mqdsf', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'instances' => [ + 'title' => '策略实例列表', + 'description' => '策略实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '已删除的实例列表。', + 'type' => 'string', + 'example' => '[ "allowed-repos-kqxnc" ]', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"instances\\": [\\n \\"[ \\\\\\"allowed-repos-kqxnc\\\\\\" ]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DeletePolicyInstanceResponse>\\n <instances>[ \\"allowed-repos-kqxnc\\" ]</instances>\\n</DeletePolicyInstanceResponse>","errorExample":""}]', + 'title' => '删除策略规则实例', + ], + 'DescribePolicies' => [ + 'summary' => 'ACK集群容器安全策略供了种类丰富的内置规则库，包括Compliance、Infra、K8s-general和PSP，旨在确保容器在生产环境中的安全运行。您可以调用DescribePolicies接口，查询策略治理规则库的列表。', + 'path' => '/policies', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '系统支持的所有策略模板。key为策略类型，value为该策略类型下的所有策略模板名称列表', + 'description' => '规则库列表，key为策略类型，value为该策略类型下的所有策略名称。'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '某个策略类型下的所有策略模板名称列表', + 'description' => '某个策略类型下的所有策略模板名称列表', + 'type' => 'array', + 'items' => [ + 'title' => '策略模板名称', + 'type' => 'string', + 'example' => 'ACKNoEnvVarSecrets', + 'description' => '更多策略规则，请参见[容器安全策略规则库说明](~~359819~~)。', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"key\\": [\\n \\"ACKNoEnvVarSecrets\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<DescribePoliciesResponse>\\n <cis-k8s>ACKNoEnvVarSecrets</cis-k8s>\\n <cis-k8s>ACKPodsRequireSecurityContext</cis-k8s>\\n <cis-k8s>ACKRestrictNamespaces</cis-k8s>\\n <cis-k8s>ACKRestrictRoleBindings</cis-k8s>\\n <infra>ACKBlockProcessNamespaceSharing</infra>\\n <infra>ACKEmptyDirHasSizeLimit</infra>\\n <infra>ACKLocalStorageRequireSafeToEvict</infra>\\n <infra>ACKOSSStorageLocationConstraint</infra>\\n <k8s-general>ACKBlockAutoinjectServiceEnv</k8s-general>\\n <k8s-general>ACKBlockAutomountToken</k8s-general>\\n <k8s-general>ACKBlockLoadBalancer</k8s-general>\\n <k8s-general>ACKBlockNodePort</k8s-general>\\n <k8s-general>ACKContainerLimits</k8s-general>\\n <k8s-general>ACKExternalIPs</k8s-general>\\n <k8s-general>ACKImageDigests</k8s-general>\\n <k8s-general>ACKRequiredLabels</k8s-general>\\n <k8s-general>ACKRequiredProbes</k8s-general>\\n <k8s-general>ACKAllowedRepos</k8s-general>\\n <psp>ACKPSPAllowPrivilegeEscalationContainer</psp>\\n <psp>ACKPSPAllowedUsers</psp>\\n <psp>ACKPSPAppArmor</psp>\\n <psp>ACKPSPCapabilities</psp>\\n <psp>ACKPSPFSGroup</psp>\\n <psp>ACKPSPFlexVolumes</psp>\\n <psp>ACKPSPForbiddenSysctls</psp>\\n <psp>ACKPSPHostFilesystem</psp>\\n <psp>ACKPSPHostNamespace</psp>\\n <psp>ACKPSPHostNetworkingPorts</psp>\\n <psp>ACKPSPPrivilegedContainer</psp>\\n <psp>ACKPSPProcMount</psp>\\n <psp>ACKPSPReadOnlyRootFilesystem</psp>\\n <psp>ACKPSPSELinuxV2</psp>\\n <psp>ACKPSPSeccomp</psp>\\n <psp>ACKPSPVolumeTypes</psp>\\n</DescribePoliciesResponse>","errorExample":""}]', + 'title' => '查询策略治理规则库列表', + ], + 'DescribePolicyDetails' => [ + 'summary' => 'ACK集群容器安全策略供了种类丰富的内置规则库，包括Compliance、Infra、K8s-general和PSP，旨在确保容器在生产环境中的安全运行。您可以调用DescribePolicyDetails接口，查询指定策略治理规则的详细信息，例如规则模板描述、规则治理动作、规则治理等级等。', + 'path' => '/policies/{policy_name}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'policy_name', + 'in' => 'path', + 'schema' => [ + 'title' => '策略治理规则名称', + 'description' => '策略治理规则名称', + 'type' => 'string', + 'required' => true, + 'example' => 'ACKAllowedRepos', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '策略治理规则名称', + 'description' => '策略治理规则名称', + 'type' => 'string', + 'example' => 'ACKAllowedRepos', + ], + 'category' => [ + 'title' => '规则模板类型', + 'description' => '规则模板类型', + 'type' => 'string', + 'example' => 'k8s-general', + ], + 'description' => [ + 'title' => '规则模板描述', + 'description' => '规则模板描述', + 'type' => 'string', + 'example' => 'Requires container images to begin with a repo string from a specified list', + ], + 'action' => [ + 'title' => '规则治理动作 ● enforce: 拦截违规部署 ● inform：告警', + 'description' => '规则治理动作，取值：'."\n" + .'- `enforce`：拦截违规部署'."\n" + .'- `inform`：告警', + 'type' => 'string', + 'example' => 'enforce', + ], + 'severity' => [ + 'title' => '规则治理等级', + 'description' => '规则治理等级，取值：'."\n" + .'* `high`：高危'."\n" + .'* `medium`：中危'."\n" + .'* `low`：低危', + 'type' => 'string', + 'example' => 'high', + ], + 'template' => [ + 'title' => '规则模板详情', + 'description' => '规则模板详情', + 'type' => 'string', + 'example' => '详情请参见请求示例', + ], + 'no_config' => [ + 'title' => '是否需要配置策略： 0表示需要参数配置 1表示无需参数配置', + 'description' => '是否需要配置策略，取值： '."\n" + .'- 0：表示需要参数配置'."\n" + .'- 1：表示无需参数配置', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'is_deleted' => [ + 'title' => '软删除标志：0表示未删除 1表示删除', + 'description' => '是否删除标志，取值：'."\n" + .'- 0：表示未删除。'."\n" + .'- 1：表示删除。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"name\\": \\"ACKAllowedRepos\\",\\n \\"category\\": \\"k8s-general\\",\\n \\"description\\": \\"Requires container images to begin with a repo string from a specified list\\",\\n \\"action\\": \\"enforce\\",\\n \\"severity\\": \\"high\\",\\n \\"template\\": \\"详情请参见请求示例\\",\\n \\"no_config\\": 0,\\n \\"is_deleted\\": 0\\n}","errorExample":""},{"type":"xml","example":"<DescribePolicyDetailsResponse>\\n <name>ACKAllowedRepos</name>\\n <category>k8s-general</category>\\n <description>Requires container images to begin with a repo string from a specified list</description>\\n <action>enforce</action>\\n <severity>high</severity>\\n <template>详情请参见请求示例</template>\\n <no_config>0</no_config>\\n <is_deleted>0</is_deleted>\\n</DescribePolicyDetailsResponse>","errorExample":""}]', + 'title' => '查询指定策略治理规则的详情', + ], + 'DescribePolicyGovernanceInCluster' => [ + 'summary' => 'ACK集群容器安全策略供了种类丰富的内置规则库，包括Compliance、Infra、K8s-general和PSP，旨在确保容器在生产环境中的安全运行。您可以调用DescribePolicyGovernanceInCluster接口，查询目标集群策略治理的详细信息，例如集群当前启用的不同等级策略计数统计、策略治理审计日志、拦截和告警情况等。', + 'path' => '/clusters/{cluster_id}/policygovernance', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '目标集群ID', + 'description' => '目标集群ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c8155823d057948c69a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'on_state' => [ + 'title' => '当前集群中开启的不同等级策略计数统计', + 'description' => '当前集群中开启的不同等级策略计数统计。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'enabled_count' => [ + 'title' => '当前开启的策略种类计数', + 'description' => '当前开启的策略种类计数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'total' => [ + 'title' => '该等级下策略种类总数', + 'description' => '该等级下策略种类总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'severity' => [ + 'title' => '策略治理等级', + 'description' => '策略治理等级。', + 'type' => 'string', + 'example' => 'high', + ], + ], + ], + ], + 'admit_log' => [ + 'title' => '集群当前策略治理审计日志', + 'description' => '集群当前策略治理审计日志。', + 'type' => 'object', + 'properties' => [ + 'progress' => [ + 'title' => '查询结果的状态', + 'description' => '查询结果的状态，取值：'."\n" + .'* `Complete`：查询已经完成，返回结果为完整结果。'."\n" + .'* `Incomplete`：查询已经完成，返回结果为不完整结果，需要重复请求以获得完整结果。', + 'type' => 'string', + 'example' => 'Complete', + ], + 'count' => [ + 'title' => '当前查询到的日志总数', + 'description' => '当前查询到的日志总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'logs' => [ + 'description' => '违反策略的日志信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'hash code', + ], + 'constraint_action' => [ + 'description' => '策略作用动作，包括告警（warn）和拦截（deny)'."\n" + .'- warn: 仅对违反策略的行为进行告警，但是不会实际拦截请求。'."\n" + .'- deny：拦截违反策略的请求。', + 'type' => 'string', + 'example' => 'deny', + ], + 'constraint_api_version' => [ + 'description' => '策略的API版本。', + 'type' => 'string', + 'example' => 'v1beta1', + ], + 'constraint_category' => [ + 'description' => '策略类型。', + 'type' => 'string', + 'example' => 'cis-k8s', + ], + 'constraint_group' => [ + 'description' => '策略的API组。', + 'type' => 'string', + 'example' => 'constraints.gatekeeper.sh', + ], + 'constraint_kind' => [ + 'description' => '对应策略管理中的策略名称。', + 'type' => 'string', + 'example' => 'ACKNamespacesDeleteProtection', + ], + 'constraint_name' => [ + 'description' => '策略实例名称。', + 'type' => 'string', + 'example' => 'namespace-delete-protection-jpjwv', + ], + 'event_msg' => [ + 'description' => '策略作用的详细信息。', + 'type' => 'string', + 'example' => 'Admission webhook \\"validation.gatekeeper.sh\\" denied request, Resource Namespace: , Constraint: namespace-delete-protection-jpjwv, Message: not allow to delete protection namespace test.', + ], + 'event_type' => [ + 'description' => '策略触发事件的类型，例如violation。', + 'type' => 'string', + 'example' => 'violation', + ], + 'request_uid' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'hash code', + ], + 'request_userinfo' => [ + 'description' => '违反策略的请求用户信息。', + 'type' => 'string', + 'example' => 'account id', + ], + 'request_username' => [ + 'description' => '违反策略的请求用户名称。', + 'type' => 'string', + 'example' => 'account user name'."\n", + ], + 'resource_kind' => [ + 'description' => '违反策略的资源类型，例如操作Namespace的请求被驳回，此项的内容为：Namespace。', + 'type' => 'string', + 'example' => 'Namespace', + ], + 'resource_name' => [ + 'description' => '违反策略的资源名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'time' => [ + 'description' => '策略违反时间。', + 'type' => 'string', + 'example' => '2025-10-27T11:31:40Z', + ], + ], + ], + ], + 'log_project' => [ + 'description' => '存储策略作用信息的日志项目。', + 'type' => 'string', + 'example' => 'k8s-log-clusterid', + ], + 'log_store' => [ + 'description' => '存储策略作用信息的日志仓库。', + 'type' => 'string', + 'example' => 'policyadmit-clusterid', + ], + ], + ], + 'Violation' => [ + 'description' => '按严重程度汇总的违反策略信息。', + 'type' => 'object', + 'properties' => [ + 'totalViolations' => [ + 'description' => '汇总信息。', + 'type' => 'object', + 'properties' => [ + 'deny' => [ + 'description' => '拦截记录汇总。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'description' => '严重程度。包括：low，medium，high。', + 'type' => 'string', + 'example' => 'medium', + ], + 'violations' => [ + 'description' => '违反次数。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + 'warn' => [ + 'description' => '告警记录汇总。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'severity' => [ + 'description' => '严重程度汇总。', + 'type' => 'string', + 'example' => 'high', + ], + 'violations' => [ + 'description' => '违反次数汇总。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + 'violations' => [ + 'description' => '按策略名称汇总的违反记录。', + 'type' => 'object', + 'properties' => [ + 'deny' => [ + 'description' => '拦截记录汇总。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'policyDescription' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'example' => 'Prevent specific namespaces from being deleted.', + ], + 'policyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'ACKNamespacesDeleteProtection', + ], + 'severity' => [ + 'description' => '严重程度。', + 'type' => 'string', + 'example' => 'medium', + ], + 'violations' => [ + 'description' => '违反次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'warn' => [ + 'description' => '告警信息汇总。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'policyDescription' => [ + 'description' => '策略描述。', + 'type' => 'string', + ], + 'policyName' => [ + 'description' => '策略名称。', + 'type' => 'string', + ], + 'severity' => [ + 'description' => '严重程度。', + 'type' => 'string', + ], + 'violations' => [ + 'description' => '违反次数。', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"on_state\\": [\\n {\\n \\"enabled_count\\": 3,\\n \\"total\\": 8,\\n \\"severity\\": \\"high\\"\\n }\\n ],\\n \\"admit_log\\": {\\n \\"progress\\": \\"Complete\\",\\n \\"count\\": 100,\\n \\"logs\\": [\\n {\\n \\"cluster_id\\": \\"hash code\\",\\n \\"constraint_action\\": \\"deny\\",\\n \\"constraint_api_version\\": \\"v1beta1\\",\\n \\"constraint_category\\": \\"cis-k8s\\",\\n \\"constraint_group\\": \\"constraints.gatekeeper.sh\\",\\n \\"constraint_kind\\": \\"ACKNamespacesDeleteProtection\\",\\n \\"constraint_name\\": \\"namespace-delete-protection-jpjwv\\",\\n \\"event_msg\\": \\"Admission webhook \\\\\\\\\\\\\\"validation.gatekeeper.sh\\\\\\\\\\\\\\" denied request, Resource Namespace: , Constraint: namespace-delete-protection-jpjwv, Message: not allow to delete protection namespace test.\\",\\n \\"event_type\\": \\"violation\\",\\n \\"request_uid\\": \\"hash code\\",\\n \\"request_userinfo\\": \\"account id\\",\\n \\"request_username\\": \\"account user name\\\\n\\",\\n \\"resource_kind\\": \\"Namespace\\",\\n \\"resource_name\\": \\"test\\",\\n \\"time\\": \\"2025-10-27T11:31:40Z\\"\\n }\\n ],\\n \\"log_project\\": \\"k8s-log-clusterid\\",\\n \\"log_store\\": \\"policyadmit-clusterid\\"\\n },\\n \\"Violation\\": {\\n \\"totalViolations\\": {\\n \\"deny\\": [\\n {\\n \\"severity\\": \\"medium\\",\\n \\"violations\\": \\"2\\"\\n }\\n ],\\n \\"warn\\": [\\n {\\n \\"severity\\": \\"high\\",\\n \\"violations\\": 0\\n }\\n ]\\n },\\n \\"violations\\": {\\n \\"deny\\": [\\n {\\n \\"policyDescription\\": \\"Prevent specific namespaces from being deleted.\\",\\n \\"policyName\\": \\"ACKNamespacesDeleteProtection\\",\\n \\"severity\\": \\"medium\\",\\n \\"violations\\": 1\\n }\\n ],\\n \\"warn\\": [\\n {\\n \\"policyDescription\\": \\"\\",\\n \\"policyName\\": \\"\\",\\n \\"severity\\": \\"\\",\\n \\"violations\\": 0\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribePolicyGovernanceInClusterResponse>\\n <on_state>\\n <enabled_count>0</enabled_count>\\n <total>14</total>\\n <severity>low</severity>\\n </on_state>\\n <on_state>\\n <enabled_count>2</enabled_count>\\n <total>13</total>\\n <severity>high</severity>\\n </on_state>\\n <on_state>\\n <enabled_count>1</enabled_count>\\n <total>8</total>\\n <severity>medium</severity>\\n </on_state>\\n <admit_log>\\n <progress>Complete</progress>\\n <count>75</count>\\n <log>\\n <__source__>192.168.0.188</__source__>\\n <__tag__:__hostname__>iZwz98e621h0kvki3ja****</__tag__:__hostname__>\\n <__tag__:__pack_id__>63DE8FD17599E86****</__tag__:__pack_id__>\\n <__tag__:__path__>/policy_admit_logs/gatekeeper_admit.log</__tag__:__path__>\\n <__tag__:__receive_time__>1631168040</__tag__:__receive_time__>\\n <__tag__:__user_defined_id__>k8s-group-cb36d98a701ef4742b50603866809****</__tag__:__user_defined_id__>\\n <__tag__:_container_ip_>10.102.0.89</__tag__:_container_ip_>\\n <__tag__:_container_name_>manager</__tag__:_container_name_>\\n <__tag__:_image_name_>registry-vpc.cn-shenzhen.aliyuncs.com/acs/gatekeeper:v3.6.0.60-g72c4896-aliyun</__tag__:_image_name_>\\n <__tag__:_namespace_>kube-system</__tag__:_namespace_>\\n <__tag__:_node_ip_>192.168.0.188</__tag__:_node_ip_>\\n <__tag__:_node_name_>cn-shenzhen.192.168.XX.XX</__tag__:_node_name_>\\n <__tag__:_pod_name_>gatekeeper-7648f64cc8-27nd4</__tag__:_pod_name_>\\n <__tag__:_pod_uid_>11083b05-eecd-454c-8d22-81c83ce1****</__tag__:_pod_uid_>\\n <__time__>1631168037</__time__>\\n <__topic__/>\\n <cluster_id>cb36d98a701ef4742b50603866809****</cluster_id>\\n <constraint_action>deny</constraint_action>\\n <constraint_api_version>v1beta1</constraint_api_version>\\n <constraint_group>constraints.gatekeeper.sh</constraint_group>\\n <constraint_kind>ACKAllowedRepos</constraint_kind>\\n <constraint_name>allowed-repos-80970511-c93d-4c40-b692-be18c077****</constraint_name>\\n <event_msg>Admission webhook \\"validation.gatekeeper.sh\\" denied request, Resource Namespace: default, Constraint: allowed-repos-80970511-c93d-4c40-b692-be18c0770382, Message: container <nginx> has an invalid image repo <nginx:1.7.9>, allowed repos are [\\"registry.cn-shanghai.aliyuncs.com/acs/\\", \\"registry.cn-hangzhou.aliyuncs.com/acs/\\"]</event_msg>\\n <event_reason>GatekeeperFailedAdmission</event_reason>\\n <event_type>violation</event_type>\\n <level>info</level>\\n <logger>ack_policy_admit_log_for_sls</logger>\\n <msg>container <nginx> has an invalid image repo <nginx:1.7.9>, allowed repos are [\\"registry.cn-shanghai.aliyuncs.com/acs/\\", \\"registry.cn-hangzhou.aliyuncs.com/acs/\\"]</msg>\\n <process>admission</process>\\n <request_uid>9db8f008-c2e8-4723-a380-18ef358c2827</request_uid>\\n <request_username>system:serviceaccount:kube-system:replicaset-controller</request_username>\\n <resource_api_version>v1</resource_api_version>\\n <resource_group/>\\n <resource_kind>Pod</resource_kind>\\n <resource_name>nginx-deployment-basic2-84ccb74bfc-df22p</resource_name>\\n <resource_namespace>default</resource_namespace>\\n <time>2021-09-09T06:13:57Z</time>\\n <ts>1631168037.444757</ts>\\n </log>\\n <log>\\n <__source__>192.168.XX.XX</__source__>\\n </log>\\n </admit_log>\\n <Violation>\\n <totalViolations>\\n <deny>\\n <severity>high</severity>\\n <violations>75</violations>\\n </deny>\\n <deny>\\n <severity>medium</severity>\\n <violations>0</violations>\\n </deny>\\n <warn>\\n <severity>high</severity>\\n <violations>0</violations>\\n </warn>\\n <warn>\\n <severity>medium</severity>\\n <violations>0</violations>\\n </warn>\\n </totalViolations>\\n <violations>\\n <deny>\\n <policyName>policy-gatekeeper-ackallowedrepos</policyName>\\n <policyDescription>Requires container images to begin with a repo string from a specified list.</policyDescription>\\n <severity>high</severity>\\n <violations>11</violations>\\n </deny>\\n <deny>\\n <policyName>policy-gatekeeper-ackpspcapabilities</policyName>\\n <policyDescription>Controls Linux capabilities.</policyDescription>\\n <severity>high</severity>\\n <violations>81</violations>\\n </deny>\\n </violations>\\n </Violation>\\n</DescribePolicyGovernanceInClusterResponse>","errorExample":""}]', + 'title' => '获取集群策略治理详情', + ], + 'DescribePolicyInstances' => [ + 'summary' => '您可以在ACK集群中选择安全策略类型，配置相关实施动作、作用范围等，创建并部署一个策略实例。您可以调用DescribePolicyInstances接口，获取集群中指定策略规则实例的详细信息，例如策略描述、治理等级等。', + 'path' => '/clusters/{cluster_id}/policies', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '104729', + 'abilityTreeNodes' => [ + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '目标集群ID', + 'description' => '目标集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c8155823d057948c69a****', + ], + ], + [ + 'name' => 'policy_name', + 'in' => 'query', + 'schema' => [ + 'title' => '策略类型', + 'description' => '策略治理规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'ACKPSPCapabilities', + ], + ], + [ + 'name' => 'instance_name', + 'in' => 'query', + 'schema' => [ + 'title' => '策略实例名称', + 'description' => '策略实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'allowed-repos-cz4s2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '策略实例列表', + 'description' => '策略实例列表。', + 'type' => 'array', + 'items' => [ + 'description' => '策略实例。', + 'type' => 'object', + 'properties' => [ + 'ali_uid' => [ + 'title' => '策略实例实施者UID', + 'description' => '策略实例实施者UID。', + 'type' => 'string', + 'example' => '16298168****', + ], + 'cluster_id' => [ + 'title' => '目标集群ID', + 'description' => '目标集群ID。', + 'type' => 'string', + 'example' => 'c8155823d057948c69a****', + ], + 'instance_name' => [ + 'title' => '规则实例名称', + 'description' => '规则实例名称。', + 'type' => 'string', + 'example' => 'no-env-var-secrets-****', + ], + 'policy_name' => [ + 'title' => '策略治理规则名称', + 'description' => '策略治理规则名称。', + 'type' => 'string', + 'example' => 'ACKPSPCapabilities', + ], + 'policy_category' => [ + 'title' => '策略类型名称', + 'description' => '策略类型名称。', + 'type' => 'string', + 'example' => 'k8s-general', + ], + 'policy_description' => [ + 'title' => '规则模板描述', + 'description' => '规则模板描述。', + 'type' => 'string', + 'example' => 'Restricts secrets used in pod envs', + ], + 'policy_parameters' => [ + 'title' => '当前规则实例的配置参数', + 'description' => '当前规则实例的配置参数。', + 'type' => 'string', + 'example' => '"restrictedNamespaces": [ "test" ]', + ], + 'policy_severity' => [ + 'title' => '规则实例治理等级', + 'description' => '规则实例治理等级。', + 'type' => 'string', + 'example' => 'low', + ], + 'policy_scope' => [ + 'title' => '策略实例实施范围： 默认"*"代表集群所有ns 否则返回作用namespaces名称，多个namespaces以逗号分隔', + 'description' => '策略实例实施范围：'."\n" + ."\n" + .'默认"*"代表集群所有命名空间。'."\n" + ."\n" + .'否则返回作用Namespaces名称，多个Namespaces以逗号（,）分隔。', + 'type' => 'string', + 'example' => '*', + ], + 'policy_action' => [ + 'title' => '规则治理动作 deny: 拦截违规部署 warn：告警', + 'description' => '规则治理动作，取值：'."\n" + ."\n" + .'- `deny`：拦截违规部署。'."\n" + ."\n" + .'- `warn`：告警。', + 'type' => 'string', + 'example' => 'deny', + ], + 'Created' => [ + 'title' => '创建时间', + 'description' => '创建时间（已废弃，请勿使用）。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '2024-10-29T18:09:12+08:00', + ], + 'Updated' => [ + 'title' => '更新时间', + 'description' => '更新时间（已废弃，请勿使用）。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '2024-10-29T18:09:12+08:00', + ], + 'resource_id' => [ + 'title' => '资源ID', + 'description' => '资源ID（已废弃，请勿使用）。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '123456***', + ], + 'total_violations' => [ + 'title' => '集群中处理违规计数', + 'description' => '集群中处理违规计数（已废弃，请勿使用）。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '0', + 'default' => '0', + ], + 'is_deleted' => [ + 'title' => '删除状态', + 'description' => '删除状态（已废弃，请勿使用）。', + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '0', + 'default' => '0', + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"ali_uid\\": \\"16298168****\\",\\n \\"cluster_id\\": \\"c8155823d057948c69a****\\",\\n \\"instance_name\\": \\"no-env-var-secrets-****\\",\\n \\"policy_name\\": \\"ACKPSPCapabilities\\",\\n \\"policy_category\\": \\"k8s-general\\",\\n \\"policy_description\\": \\"Restricts secrets used in pod envs\\",\\n \\"policy_parameters\\": \\"\\\\\\"restrictedNamespaces\\\\\\": [ \\\\\\"test\\\\\\" ]\\",\\n \\"policy_severity\\": \\"low\\",\\n \\"policy_scope\\": \\"*\\",\\n \\"policy_action\\": \\"deny\\",\\n \\"Created\\": \\"2024-10-29T18:09:12+08:00\\",\\n \\"Updated\\": \\"2024-10-29T18:09:12+08:00\\",\\n \\"resource_id\\": \\"123456***\\",\\n \\"total_violations\\": 0,\\n \\"is_deleted\\": 0\\n }\\n]","errorExample":""},{"type":"xml","example":"<DescribePolicyInstancesResponse>\\n <ali_uid>16298168****</ali_uid>\\n <cluster_id>c8155823d057948c69a****</cluster_id>\\n <instance_name>no-env-var-secrets-****</instance_name>\\n <policy_name>ACKPSPCapabilities</policy_name>\\n <policy_category>k8s-general</policy_category>\\n <policy_description>Restricts secrets used in pod envs</policy_description>\\n <policy_parameters>\\"restrictedNamespaces\\": [ \\"test\\" ]</policy_parameters>\\n <policy_severity>low</policy_severity>\\n <policy_scope>*</policy_scope>\\n <policy_action>deny</policy_action>\\n</DescribePolicyInstancesResponse>","errorExample":""}]', + 'title' => '查询策略实例列表', + ], + 'DescribePolicyInstancesStatus' => [ + 'summary' => '您可以调用DescribePolicyInstancesStatus接口，查询集群当前不同策略类型对应的实例部署状态，包括每种策略规则对应开启的实例计数，以及不同治理等级下开启的策略种类计数。', + 'path' => '/clusters/{cluster_id}/policies/status', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '目标集群ID', + 'description' => '目标集群ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c8155823d057948c69a****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'policy_instances' => [ + 'title' => '不同策略类型下的策略实例计数列表', + 'description' => '不同策略类型下的策略实例计数列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'policy_category' => [ + 'description' => '策略类型。支持的策略类型和类型说明详见[容器安全策略规则库说明](~~359819~~)。', + 'type' => 'string', + 'example' => 'compliance', + ], + 'policy_name' => [ + 'description' => '策略名称。', + 'type' => 'string', + 'example' => 'ACKRestrictRoleBindings', + ], + 'policy_description' => [ + 'description' => '策略描述。', + 'type' => 'string', + 'example' => 'Restricts use of the cluster-admin role.', + ], + 'policy_severity' => [ + 'description' => '策略治理等级。', + 'type' => 'string', + 'example' => 'medium', + ], + 'policy_instances_count' => [ + 'description' => '已部署的策略实例计数，如果字段为空说明未部署该类型策略实例。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + 'instances_severity_count' => [ + 'description' => '集群中当前部署的不同治理等级的策略实例计数。', + 'type' => 'object', + 'example' => '{ "high": 11, "medium": 1 }', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"policy_instances\\": [\\n {\\n \\"policy_category\\": \\"compliance\\",\\n \\"policy_name\\": \\"ACKRestrictRoleBindings\\",\\n \\"policy_description\\": \\"Restricts use of the cluster-admin role.\\",\\n \\"policy_severity\\": \\"medium\\",\\n \\"policy_instances_count\\": 1\\n }\\n ],\\n \\"instances_severity_count\\": {\\n \\"high\\": 11,\\n \\"medium\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribePolicyInstancesStatusResponse>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKBlockNodePort</policy_name>\\n <policy_description>Disallows all Services with type NodePort.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKExternalIPs</policy_name>\\n <policy_description>Restricts Services from containing externalIPs except those in a provided allowlist.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPHostNamespace</policy_name>\\n <policy_description>Controls usage of host namespaces.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPReadOnlyRootFilesystem</policy_name>\\n <policy_description>Requires the use of a read only root file system.</policy_description>\\n <policy_severity>medium</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPVolumeTypes</policy_name>\\n <policy_description>Controls usage of volume types.</policy_description>\\n <policy_severity>medium</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>infra</policy_category>\\n <policy_name>ACKOSSStorageLocationConstraint</policy_name>\\n <policy_description>Restricts location of oss storage in cluster.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKBlockAutoinjectServiceEnv</policy_name>\\n <policy_description>Disable autoinjecting information about services into pod\'s environment variables.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKImageDigests</policy_name>\\n <policy_description>Requires container images to contain a digest.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPAllowedUsers</policy_name>\\n <policy_description>Controls the user and group IDs of the container.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPHostFilesystem</policy_name>\\n <policy_description>Controls usage of the host filesystem.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>infra</policy_category>\\n <policy_name>ACKBlockProcessNamespaceSharing</policy_name>\\n <policy_description>Restricts shareProcessNamespace used in pod.</policy_description>\\n <policy_severity>high</policy_severity>\\n <policy_instances_count>2</policy_instances_count>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPCapabilities</policy_name>\\n <policy_description>Controls Linux capabilities.</policy_description>\\n <policy_severity>high</policy_severity>\\n <policy_instances_count>5</policy_instances_count>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPForbiddenSysctls</policy_name>\\n <policy_description>Controls the `sysctl` profile used by containers.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPSeccomp</policy_name>\\n <policy_description>Controls the seccomp profile used by containers.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKBlockLoadBalancer</policy_name>\\n <policy_description>Disallows all Services with type LoadBalancer.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPAppArmor</policy_name>\\n <policy_description>Controls the AppArmor profile used by containers.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPPrivilegedContainer</policy_name>\\n <policy_description>Controls running of privileged containers.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPProcMount</policy_name>\\n <policy_description>Controls the allowed `procMount` types for the container.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPSELinuxV2</policy_name>\\n <policy_description>Controls the SELinux context of the container.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>infra</policy_category>\\n <policy_name>ACKEmptyDirHasSizeLimit</policy_name>\\n <policy_description>Requires that emptydir volume must have a `sizelimit` defined.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPAllowPrivilegeEscalationContainer</policy_name>\\n <policy_description>Controls restricting escalation to root privileges.</policy_description>\\n <policy_severity>medium</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPFSGroup</policy_name>\\n <policy_description>Controls allocating an FSGroup that owns the Pod\'s volumes.</policy_description>\\n <policy_severity>medium</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>cis-k8s</policy_category>\\n <policy_name>ACKPodsRequireSecurityContext</policy_name>\\n <policy_description>Requires that Pods must have a `securityContext` defined.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>cis-k8s</policy_category>\\n <policy_name>ACKRestrictNamespaces</policy_name>\\n <policy_description>Restricts resources from using the `default` namespace.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKContainerLimits</policy_name>\\n <policy_description>Requires containers to have memory and CPU limits set and within a specified maximum amount.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPHostNetworkingPorts</policy_name>\\n <policy_description>Controls usage of host networking and ports.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKBlockAutomountToken</policy_name>\\n <policy_description>Disable automounting API credentials.</policy_description>\\n <policy_severity>high</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKRequiredLabels</policy_name>\\n <policy_description>Requires all resources to contain a specified label with a value matching a provided regular expression.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>psp</policy_category>\\n <policy_name>ACKPSPFlexVolumes</policy_name>\\n <policy_description>Controls the allowlist of Flexvolume drivers.</policy_description>\\n <policy_severity>medium</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKAllowedRepos</policy_name>\\n <policy_description>Requires container images to begin with a repo string from a specified list.</policy_description>\\n <policy_severity>high</policy_severity>\\n <policy_instances_count>4</policy_instances_count>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>cis-k8s</policy_category>\\n <policy_name>ACKNoEnvVarSecrets</policy_name>\\n <policy_description>Restricts secrets used in pod envs.</policy_description>\\n <policy_severity>medium</policy_severity>\\n <policy_instances_count>1</policy_instances_count>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>cis-k8s</policy_category>\\n <policy_name>ACKRestrictRoleBindings</policy_name>\\n <policy_description>Restricts use of the cluster-admin role.</policy_description>\\n <policy_severity>medium</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>infra</policy_category>\\n <policy_name>ACKLocalStorageRequireSafeToEvict</policy_name>\\n <policy_description>Restricts safe to evict annotation existing in pod with local storage.</policy_description>\\n <policy_severity>low</policy_severity>\\n </policy_instances>\\n <policy_instances>\\n <policy_category>k8s-general</policy_category>\\n <policy_name>ACKRequiredProbes</policy_name>\\n <policy_description>Requires Pods to have readiness and/or liveness probes.</policy_description>\\n <policy_severity>medium</policy_severity>\\n </policy_instances>\\n <instances_severity_count>\\n <high>11</high>\\n <medium>1</medium>\\n </instances_severity_count>\\n</DescribePolicyInstancesStatusResponse>","errorExample":""}]', + 'title' => '查看策略规则对应的实例部署详情', + ], + 'RunClusterCheck' => [ + 'summary' => '容器智能运维平台提供丰富的Kubernetes集群检查能力，包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。在正式执行升级、迁移或安装操作前，容器智能运维平台会自动触发检查，仅当检查通过后您才可以执行变更操作。您也可以手动调用RunClusterCheck接口执行集群检查。建议您定期对集群进行检查和维护，预防集群安全风险。', + 'path' => '/clusters/{cluster_id}/checks', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197074', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ce0da5a1d627e4e9e9f96cae8ad******', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '检查类型。', + 'description' => '检查类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ClusterMigrate' => '集群迁移', + 'MasterUpgrade' => '集群控制面升级', + 'NodePoolUpgrade' => '节点池升级', + 'ClusterUpgrade' => '集群升级', + ], + 'example' => 'NodePoolUpgrade', + ], + 'target' => [ + 'title' => '检查的对象。', + 'description' => '检查目标。'."\n" + ."\n" + .'当检查类型参数`type`选择为`NodePoolUpgrade`时，本参数必须设置为节点池ID。'."\n" + ."\n" + .'选择其他检查类型时，本参数无需设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'np1f6779297c4444a3a1cdd29be8******', + ], + 'options' => [ + 'title' => '检查选项。', + 'description' => '检查选项。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '检查参数。'."\n" + ."\n" + .'当检查类型参数`type`取值为`MasterUpgrade`和`ClusterUpgrade`时，该参数需要设置为`next_version`，具体参数取值为升级的目标集群版本。'."\n" + ."\n" + .'选择其他检查类型时，本参数无需设置。', + 'example' => 'next_version:1.32.1-aliyun.1', + ], + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回体数据。', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F04DF81D-5C12-1524-B36A-86E025******', + ], + 'check_id' => [ + 'title' => '检查ID。', + 'description' => '检查ID。', + 'type' => 'string', + 'example' => '1697100584236******-ce0da5a1d627e4e9e9f96cae8ad******-clustercheck-lboto', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"F04DF81D-5C12-1524-B36A-86E025******\\",\\n \\"check_id\\": \\"1697100584236******-ce0da5a1d627e4e9e9f96cae8ad******-clustercheck-lboto\\"\\n}","type":"json"}]', + 'title' => '发起集群检查', + ], + 'ListClusterChecks' => [ + 'summary' => '容器智能运维平台提供丰富的Kubernetes集群检查能力，包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。您可以调用ListClusterChecks接口，根据集群ID查询集群检查的列表和检查相关信息，例如检查类型、状态、创建和完成时间等。', + 'path' => '/clusters/{cluster_id}/checks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197075', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ce0da5a1d627e4e9e9f96cae8ad07****', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'title' => '检查类型。', + 'description' => '检查类型。'."\n" + .'- ClusterMigrate：集群迁移。'."\n" + ."\n" + .'- MasterUpgrade：集群控制面升级。'."\n" + ."\n" + .'- NodePoolUpgrade：节点池升级。'."\n" + ."\n" + .'- ClusterUpgrade：集群升级。', + 'type' => 'string', + 'required' => false, + 'example' => 'ClusterUpgrade', + ], + ], + [ + 'name' => 'target', + 'in' => 'query', + 'schema' => [ + 'title' => '筛选指定的检查对象。', + 'description' => '筛选指定的检查对象。', + 'type' => 'string', + 'required' => false, + 'example' => 'ngw-bp19ay6nnvd4cexxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'checks' => [ + 'title' => '检查列表。', + 'description' => '检查列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单次检查信息。', + 'type' => 'object', + 'properties' => [ + 'check_id' => [ + 'title' => '检查ID。', + 'description' => '检查ID。', + 'type' => 'string', + 'example' => '1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto', + ], + 'type' => [ + 'title' => '检查类型。', + 'description' => '检查类型。', + 'type' => 'string', + 'example' => 'ClusterUpgrade', + ], + 'status' => [ + 'title' => '检查状态。', + 'description' => '检查状态。', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'message' => [ + 'title' => '检查状态信息。', + 'description' => '检查状态信息。', + 'type' => 'string', + 'example' => 'task succeed', + ], + 'created_at' => [ + 'title' => '创建时间。', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2025-04-11T02:56:02.565982623Z', + ], + 'finished_at' => [ + 'title' => '完成时间。', + 'description' => '完成时间。', + 'type' => 'string', + 'example' => '2025-04-11T02:56:18.881054031Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"checks\\": [\\n {\\n \\"check_id\\": \\"1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto\\",\\n \\"type\\": \\"ClusterUpgrade\\",\\n \\"status\\": \\"Succeeded\\",\\n \\"message\\": \\"task succeed\\",\\n \\"created_at\\": \\"2025-04-11T02:56:02.565982623Z\\",\\n \\"finished_at\\": \\"2025-04-11T02:56:18.881054031Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询所有集群检查的列表', + ], + 'GetClusterCheck' => [ + 'summary' => '容器智能运维平台提供丰富的Kubernetes集群检查能力，包括集群升级检查、集群迁移检查、组件安装检查、组件升级检查、节点池检查等。您可以调用GetClusterCheck接口，根据集群ID和检查任务ID查看指定检查任务的相关信息，例如检查状态、具体检查项、检查创建和完成时间等。', + 'path' => '/clusters/{cluster_id}/checks/{check_id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197076', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ce0da5a1d627e4e9e9f96cae8ad07****', + ], + ], + [ + 'name' => 'check_id', + 'in' => 'path', + 'schema' => [ + 'title' => '检查ID。', + 'description' => '检查ID。'."\n" + .'您可以调用 [RunClusterCheck](~~2667902~~) 获取该check_id。', + 'type' => 'string', + 'required' => true, + 'example' => '1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'check_id' => [ + 'title' => 'Id of the request', + 'description' => '检查ID。', + 'type' => 'string', + 'example' => '1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto', + ], + 'type' => [ + 'title' => '检查类型。', + 'description' => '检查类型。', + 'type' => 'string', + 'example' => 'ClusterUpgrade', + ], + 'status' => [ + 'title' => '检查状态。', + 'description' => '检查状态。', + 'type' => 'string', + 'example' => 'Succeeded', + ], + 'message' => [ + 'title' => '检查状态信息。', + 'description' => '检查状态信息。', + 'type' => 'string', + 'example' => 'task succeed', + ], + 'created_at' => [ + 'title' => '创建时间。', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-10-16T08:31:20.292030178Z', + ], + 'finished_at' => [ + 'title' => '完成时间。', + 'description' => '完成时间。', + 'type' => 'string', + 'example' => '2023-10-16T08:35:20.292030178Z', + ], + 'check_items' => [ + 'title' => '检查项。', + 'description' => '检查项。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'example' => ' {'."\n" + .' "Group": "ClusterResource",'."\n" + .' "Level": {'."\n" + .' "normal": {'."\n" + .' "Message": "",'."\n" + .' "Targets": ['."\n" + .' {'."\n" + .' "Target": "v1beta1.metrics.k8s.io",'."\n" + .' "Value": "All Available"'."\n" + .' }', + 'description' => '检查项具体属性。', + ], + 'description' => '检查项信息列表。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"check_id\\": \\"1697100584236600453-ce0da5a1d627e4e9e9f96cae8ad07****-clustercheck-lboto\\",\\n \\"type\\": \\"ClusterUpgrade\\",\\n \\"status\\": \\"Succeeded\\",\\n \\"message\\": \\"task succeed\\",\\n \\"created_at\\": \\"2023-10-16T08:31:20.292030178Z\\",\\n \\"finished_at\\": \\"2023-10-16T08:35:20.292030178Z\\",\\n \\"check_items\\": {\\n \\"key\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询指定集群检查的信息', + ], + 'CreateClusterInspectConfig' => [ + 'summary' => '创建集群巡检配置。', + 'path' => '/clusters/{clusterId}/inspectConfig', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261199', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'title' => '是否开启巡检。', + 'description' => '是否开启巡检。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'recurrence' => [ + 'title' => '使用 RFC5545 Recurrence Rule 语法定义的巡检周期。需要指定BYHOUR和BYMINUTE，仅支持FREQ=DAILY，不支持指定 COUNT 或 UNTIL。', + 'description' => '使用 RFC5545 Recurrence Rule 语法定义的巡检周期。需要指定BYHOUR和BYMINUTE，仅支持FREQ=DAILY，不支持指定 COUNT 或 UNTIL。', + 'type' => 'string', + 'required' => true, + 'example' => 'FREQ=DAILY;BYHOUR=10;BYMINUTE=15', + ], + 'disabledCheckItems' => [ + 'title' => '被禁用的巡检项列表。', + 'description' => '被禁用的巡检项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '被禁用的巡检项。', + 'type' => 'string', + 'required' => false, + 'example' => 'NginxIngressServiceAnnotationMultiTargets', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '873DC52C-28AA-5A5C-938C-684D3D4B****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"873DC52C-28AA-5A5C-938C-684D3D4B****\\"\\n}","type":"json"}]', + 'title' => '创建集群巡检配置', + ], + 'UpdateClusterInspectConfig' => [ + 'summary' => '更新集群巡检配置', + 'path' => '/clusters/{clusterId}/inspectConfig', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261198', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体。', + 'type' => 'object', + 'properties' => [ + 'enabled' => [ + 'description' => '是否开启巡检。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'scheduleTime' => [ + 'description' => '使用 RFC5545 Recurrence Rule 语法定义的巡检周期。需要指定BYHOUR和BYMINUTE，仅支持FREQ=DAILY，不支持指定 COUNT 或 UNTIL。', + 'type' => 'string', + 'required' => false, + 'example' => 'FREQ=DAILY;BYHOUR=10;BYMINUTE=15'."\n", + ], + 'disabledCheckItems' => [ + 'description' => '被禁用的巡检项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '被禁用的巡检项。', + 'type' => 'string', + 'required' => false, + 'example' => 'NginxIngressServiceAnnotationMultiTargets', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '49511F2D-D56A-5C24-B9AE-C8491E09B***', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"49511F2D-D56A-5C24-B9AE-C8491E09B***\\"\\n}","type":"json"}]', + 'title' => '更新集群巡检配置', + ], + 'GetClusterInspectConfig' => [ + 'summary' => '获取集群巡检配置', + 'path' => '/clusters/{clusterId}/inspectConfig', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261197', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '49511F2D-D56A-5C24-B9AE-C8491E09B095', + ], + 'enabled' => [ + 'title' => '是否开启巡检。', + 'description' => '是否开启巡检。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'recurrence' => [ + 'title' => '使用 RFC5545 Recurrence Rule 语法定义的巡检周期。需要指定BYHOUR和BYMINUTE，仅支持FREQ=DAILY，不支持指定 COUNT 或 UNTIL。', + 'description' => '使用 RFC5545 Recurrence Rule 语法定义的巡检周期。需要指定BYHOUR和BYMINUTE，仅支持FREQ=DAILY，不支持指定 COUNT 或 UNTIL。', + 'type' => 'string', + 'example' => 'FREQ=DAILY;BYHOUR=10;BYMINUTE=15', + ], + 'disabledCheckItems' => [ + 'title' => '被禁用的巡检项列表。', + 'description' => '被禁用的巡检项列表。', + 'type' => 'array', + 'items' => [ + 'description' => '被禁用的巡检项。', + 'type' => 'string', + 'example' => 'NginxIngressServiceAnnotationMultiTargets', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"49511F2D-D56A-5C24-B9AE-C8491E09B095\\",\\n \\"enabled\\": true,\\n \\"recurrence\\": \\"FREQ=DAILY;BYHOUR=10;BYMINUTE=15\\",\\n \\"disabledCheckItems\\": [\\n \\"NginxIngressServiceAnnotationMultiTargets\\"\\n ]\\n}","type":"json"}]', + 'title' => '获取集群巡检配置', + ], + 'RunClusterInspect' => [ + 'summary' => '发起集群巡检，创建巡检报告。', + 'path' => '/clusters/{clusterId}/inspectReports', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261190', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'clientToken' => [ + 'title' => '幂等Token。', + 'description' => '幂等Token。', + 'type' => 'string', + 'required' => false, + 'example' => 'c82e6987e2961451182edacd74faf', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'reportId' => [ + 'title' => '巡检报告ID。', + 'description' => '巡检报告ID。', + 'type' => 'string', + 'example' => '5d6557c983064c45bed62ab2a2119cc7', + ], + 'taskId' => [ + 'title' => '巡检任务ID。', + 'description' => '巡检任务ID。', + 'type' => 'string', + 'example' => 'T-67d7ec016ce37c0106000***', + ], + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0AB4D067-4DD7-5471-B90A-FCC564BC3337', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"reportId\\": \\"5d6557c983064c45bed62ab2a2119cc7\\",\\n \\"taskId\\": \\"T-67d7ec016ce37c0106000***\\",\\n \\"requestId\\": \\"0AB4D067-4DD7-5471-B90A-FCC564BC3337\\"\\n}","type":"json"}]', + 'title' => '创建集群巡检报告', + ], + 'ListClusterInspectReports' => [ + 'summary' => '获取集群巡检报告列表。', + 'path' => '/clusters/{clusterId}/inspectReports', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261195', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + 'FEATUREcskI1OLEY', + 'FEATUREcskZG2TSX', + 'FEATUREcskDGKERY', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '分页token。', + 'type' => 'string', + 'required' => false, + 'example' => 'AK8uQQrxgFKsI3OiS5TbhUQ9R3kPme4I3', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '最大返回结果数，最大值50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '49511F2D-D56A-5C24-B9AE-C8491E09B***', + ], + 'nextToken' => [ + 'title' => '分页Token。', + 'description' => '分页Token。', + 'type' => 'string', + 'example' => '405b99e5411f9a4e7148506e45', + ], + 'reports' => [ + 'title' => '巡检报告。', + 'description' => '巡检报告。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'reportId' => [ + 'title' => '巡检报告ID。', + 'description' => '巡检报告ID。', + 'type' => 'string', + 'example' => '782df89346054a0000562063a6****', + ], + 'startTime' => [ + 'description' => '巡检报告开始时间。', + 'type' => 'string', + 'example' => '2024-12-18T19:40:16.778333+08:00', + ], + 'endTime' => [ + 'description' => '巡检报告完成时间。', + 'type' => 'string', + 'example' => '2024-12-18T19:40:16.778333+08:00', + ], + 'status' => [ + 'title' => '巡检报告生成状态。', + 'description' => '巡检报告生成状态。', + 'type' => 'string', + 'example' => 'completed', + ], + 'summary' => [ + 'title' => '巡检报告概览。', + 'description' => '巡检报告概览。', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'title' => '检查任务结果状态code。', + 'description' => '检查任务结果状态code。', + 'type' => 'string', + 'example' => 'warning', + ], + 'normalCount' => [ + 'title' => '检查结果为normal的检查项统计。', + 'description' => '检查结果为normal的检查项统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'adviceCount' => [ + 'title' => '检查结果为advice的检查项统计。', + 'description' => '检查结果为advice的检查项统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'warnCount' => [ + 'title' => '检查结果为warning的检查项统计。', + 'description' => '检查结果为warning的检查项统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'errorCount' => [ + 'title' => '检查结果为error的检查项统计。', + 'description' => '检查结果为error的检查项统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"49511F2D-D56A-5C24-B9AE-C8491E09B***\\",\\n \\"nextToken\\": \\"405b99e5411f9a4e7148506e45\\",\\n \\"reports\\": [\\n {\\n \\"reportId\\": \\"782df89346054a0000562063a6****\\",\\n \\"startTime\\": \\"2024-12-18T19:40:16.778333+08:00\\",\\n \\"endTime\\": \\"2024-12-18T19:40:16.778333+08:00\\",\\n \\"status\\": \\"completed\\",\\n \\"summary\\": {\\n \\"code\\": \\"warning\\",\\n \\"normalCount\\": 1,\\n \\"adviceCount\\": 0,\\n \\"warnCount\\": 0,\\n \\"errorCount\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取集群巡检报告列表', + ], + 'GetClusterInspectReportDetail' => [ + 'summary' => '获取集群巡检报告详情', + 'path' => '/clusters/{clusterId}/inspectReports/{reportId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261192', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'reportId', + 'in' => 'path', + 'schema' => [ + 'title' => '巡检报告ID。', + 'description' => '巡检报告ID。', + 'type' => 'string', + 'required' => true, + 'example' => '782df89346054a0000562063a****', + ], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => [ + 'title' => '查询语言。', + 'description' => '查询语言。'."\n" + .'- zh_CN'."\n" + .'- en_US', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + ], + ], + [ + 'name' => 'category', + 'in' => 'query', + 'schema' => [ + 'title' => '巡检项归属领域。', + 'description' => '巡检项归属领域。取值：'."\n" + .'- security：安全合规'."\n" + .'- performance：性能效率 '."\n" + .'- stability：业务稳定'."\n" + .'- limitation：服务限制 '."\n" + .'- cost：成本优化', + 'type' => 'string', + 'required' => false, + 'example' => 'cost', + ], + ], + [ + 'name' => 'targetType', + 'in' => 'query', + 'schema' => [ + 'title' => '巡检对象类型，仅返回符合targetType的检查项。', + 'description' => '巡检对象类型，仅返回符合targetType的检查项。', + 'type' => 'string', + 'required' => false, + 'example' => 'NodePool', + ], + ], + [ + 'name' => 'level', + 'in' => 'query', + 'schema' => [ + 'title' => '巡检项所属级别。', + 'description' => '巡检项所属级别。取值：'."\n" + .'- advice：建议'."\n" + .'- warning：低危'."\n" + .'- error：中危'."\n" + .'- critical：高危', + 'type' => 'string', + 'required' => false, + 'example' => 'error', + ], + ], + [ + 'name' => 'enableFilter', + 'in' => 'query', + 'schema' => [ + 'title' => '检查项过滤，为true仅返回result=true的异常检查项。', + 'description' => '检查项过滤，为true仅返回result=true的异常检查项。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '分页token。', + 'type' => 'string', + 'required' => false, + 'example' => 'bb41e2bcb47b747389dce6c0d2', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'description' => '每页最大条目数，最大值50。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '49511F2D-D56A-5C24-B9AE-C8491E09B***', + ], + 'nextToken' => [ + 'description' => '分页token。', + 'type' => 'string', + 'example' => 'AK8uQQrxgFK8sbARvnCj6w9R3kPme4I3', + ], + 'reportId' => [ + 'title' => '巡检报告ID。', + 'description' => '巡检报告ID。', + 'type' => 'string', + 'example' => '782df89346054a0000562063a****', + ], + 'startTime' => [ + 'description' => '巡检报告开始时间。', + 'type' => 'string', + 'example' => '2024-12-18T19:40:16.778333+08:00', + ], + 'endTime' => [ + 'description' => '巡检报告完成时间。', + 'type' => 'string', + 'example' => '2024-12-18T19:41:12.778433+08:00', + ], + 'status' => [ + 'title' => '巡检报告生成状态。', + 'description' => '巡检报告生成状态。取值：'."\n" + .'- completed：已完成。'."\n" + .'- running：进行中。', + 'type' => 'string', + 'example' => 'completed', + ], + 'summary' => [ + 'title' => '巡检报告概览。', + 'description' => '巡检报告概览。', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'title' => '检查任务结果状态code。', + 'description' => '检查任务结果状态code。', + 'type' => 'string', + 'example' => 'warning', + ], + 'normalCount' => [ + 'title' => '检查结果为normal的检查项统计。', + 'description' => '检查结果为normal的检查项统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'adviceCount' => [ + 'title' => '检查结果为advice的检查项统计。', + 'description' => '检查结果为advice的检查项统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'warnCount' => [ + 'title' => '检查结果为warning的检查项统计。', + 'description' => '检查结果为warning的检查项统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'errorCount' => [ + 'title' => '检查结果为error的检查项统计。', + 'description' => '检查结果为error的检查项统计。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'checkItemResults' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项结果。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '检查项的名称。', + 'type' => 'string', + 'example' => 'API Server CLB 实例状态异常', + ], + 'description' => [ + 'description' => '检查项的描述。', + 'type' => 'string', + 'example' => '集群API Server负载均衡实例异常会影响集群可用性，请检查负载均衡实例状态是否正常。', + ], + 'fix' => [ + 'description' => '修复建议。', + 'type' => 'string', + 'example' => '请提交工单处理。', + ], + 'targets' => [ + 'description' => '检查对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '检查对象。', + 'type' => 'string', + 'example' => 'lb-5tstgwefjvwe1zko7xxx', + ], + ], + 'result' => [ + 'description' => '检查结果。取值：'."\n" + .'- true：检查项异常'."\n" + .'- false：检查项正常'."\n" + .'- disable：检查项未开启', + 'type' => 'string', + 'example' => 'false', + ], + 'targetType' => [ + 'description' => '检查对象的资源类型。', + 'type' => 'string', + 'example' => 'CLB', + ], + 'checkItemUid' => [ + 'description' => '巡检项的唯一标识。', + 'type' => 'string', + 'example' => 'APIServerClbInstanceStatus', + ], + 'category' => [ + 'description' => '巡检项归属领域。取值：'."\n" + .'- security：安全合规'."\n" + .'- performance：性能效率 '."\n" + .'- stability：业务稳定'."\n" + .'- limitation：服务限制 '."\n" + .'- cost：成本优化', + 'type' => 'string', + 'example' => 'stability', + ], + 'level' => [ + 'description' => '巡检项所属级别。取值：'."\n" + .'- advice：建议'."\n" + .'- warning：低危'."\n" + .'- error：中危'."\n" + .'- critical：高危', + 'type' => 'string', + 'example' => 'critical', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"49511F2D-D56A-5C24-B9AE-C8491E09B***\\",\\n \\"nextToken\\": \\"AK8uQQrxgFK8sbARvnCj6w9R3kPme4I3\\",\\n \\"reportId\\": \\"782df89346054a0000562063a****\\",\\n \\"startTime\\": \\"2024-12-18T19:40:16.778333+08:00\\",\\n \\"endTime\\": \\"2024-12-18T19:41:12.778433+08:00\\",\\n \\"status\\": \\"completed\\",\\n \\"summary\\": {\\n \\"code\\": \\"warning\\",\\n \\"normalCount\\": 10,\\n \\"adviceCount\\": 0,\\n \\"warnCount\\": 1,\\n \\"errorCount\\": 0\\n },\\n \\"checkItemResults\\": [\\n {\\n \\"name\\": \\"API Server CLB 实例状态异常\\",\\n \\"description\\": \\"集群API Server负载均衡实例异常会影响集群可用性，请检查负载均衡实例状态是否正常。\\",\\n \\"fix\\": \\"请提交工单处理。\\",\\n \\"targets\\": [\\n \\"lb-5tstgwefjvwe1zko7xxx\\"\\n ],\\n \\"result\\": \\"false\\",\\n \\"targetType\\": \\"CLB\\",\\n \\"checkItemUid\\": \\"APIServerClbInstanceStatus\\",\\n \\"category\\": \\"stability\\",\\n \\"level\\": \\"critical\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取集群巡检报告详情', + ], + 'DeleteClusterInspectConfig' => [ + 'summary' => '删除集群巡检配置', + 'path' => '/clusters/{clusterId}/inspectConfig', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '261200', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '873DC52C-28AA-5A5C-938C-684D3D4B****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"873DC52C-28AA-5A5C-938C-684D3D4B****\\"\\n}","type":"json"}]', + 'title' => '删除集群巡检配置', + ], + 'CreateClusterDiagnosis' => [ + 'summary' => '发起集群诊断。', + 'path' => '/clusters/{cluster_id}/diagnosis', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '211970', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ce0da5a1d627e4e9e9f96cae8ad07****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => '诊断类型。', + 'description' => '诊断类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'node' => 'node', + 'ingress' => 'ingress', + 'memory' => 'memory', + 'pod' => 'pod', + 'service' => 'service', + 'network' => 'network', + ], + 'example' => 'node', + ], + 'target' => [ + 'title' => '用于指定诊断对象的参数。', + 'description' => '用于指定诊断对象的参数。不同诊断类型的参数示例：'."\n" + ."\n" + .'node:'."\n" + .'```'."\n" + .'{"name": "cn-shanghai.10.10.10.107"}'."\n" + .'```'."\n" + ."\n" + .'pod'."\n" + .'```'."\n" + .'{"namespace": "kube-system", "name": "csi-plugin-2cg9f"}'."\n" + .'```'."\n" + ."\n" + .'network'."\n" + .'```'."\n" + .'{"src": "10.10.10.108", "dst": "10.11.247.16", "dport": "80"}'."\n" + .'```'."\n" + ."\n" + .'ingress'."\n" + .'```'."\n" + .'{"url": "https://example.com"}'."\n" + .'```'."\n" + ."\n" + .'memory'."\n" + .'```'."\n" + .'{"node":"cn-hangzhou.172.16.9.240"}'."\n" + .'```'."\n" + ."\n" + .'service'."\n" + .'```'."\n" + .'{"namespace": "kube-system", "name": "nginx-ingress-lb"}'."\n" + .'```', + 'type' => 'object', + 'required' => false, + 'example' => '{"namespace": "kube-system", "name": "csi-plugin-2cg9f"}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + 'diagnosis_id' => [ + 'title' => '诊断ID。', + 'description' => '诊断ID。', + 'type' => 'string', + 'example' => '6f719f23098240818eb26fe3a37d****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4314****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cluster_id\\": \\"c5cdf7e3938bc4f8eb0e44b21a80f****\\",\\n \\"diagnosis_id\\": \\"6f719f23098240818eb26fe3a37d****\\",\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4314****\\"\\n}","type":"json"}]', + 'title' => '发起集群诊断', + ], + 'GetClusterDiagnosisResult' => [ + 'summary' => '获取集群诊断结果。', + 'path' => '/clusters/{cluster_id}/diagnosis/{diagnosis_id}/result', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '211972', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c8155823d057948c69a****', + ], + ], + [ + 'name' => 'diagnosis_id', + 'in' => 'path', + 'schema' => [ + 'title' => '诊断ID。', + 'description' => '诊断ID。', + 'type' => 'string', + 'required' => false, + 'example' => '6f719f23098240818eb26fe3a37d****'."\n", + ], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => [ + 'title' => '查询语言。', + 'description' => '查询语言。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'description' => '诊断结果代码：'."\n" + .'- 0：诊断完成'."\n" + .'- 1：诊断失败', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '0', + '1', + ], + 'example' => '0', + ], + 'created' => [ + 'description' => '诊断发起时间。', + 'type' => 'string', + 'example' => '2024-05-28T11:29Z', + ], + 'diagnosis_id' => [ + 'description' => '诊断ID。', + 'type' => 'string', + 'example' => '6cf6b62e334e4583bdfd26707516****', + ], + 'finished' => [ + 'description' => '诊断完成时间。', + 'type' => 'string', + 'example' => '2024-05-28T11:29Z', + ], + 'message' => [ + 'description' => '诊断状态信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'result' => [ + 'description' => '诊断结果。', + 'type' => 'string', + 'example' => '{"phase":5,"version":"20240101"}', + ], + 'status' => [ + 'description' => '诊断状态：'."\n" + .'- 0：诊断已创建'."\n" + .'- 1：诊断运行中'."\n" + .'- 2：诊断已完成', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '0', + '1', + '2', + ], + 'example' => '2', + ], + 'target' => [ + 'description' => '诊断对象。', + 'type' => 'string', + 'example' => '{"name":"cn-hongkong.10.0.0.246"}', + ], + 'type' => [ + 'description' => '诊断类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'node' => 'node', + 'ingress' => 'ingress', + 'cluster' => 'cluster', + 'memory' => 'memory', + 'pod' => 'pod', + 'service' => 'service', + 'network' => 'network', + ], + 'example' => 'Node', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"code\\": 0,\\n \\"created\\": \\"2024-05-28T11:29Z\\",\\n \\"diagnosis_id\\": \\"6cf6b62e334e4583bdfd26707516****\\",\\n \\"finished\\": \\"2024-05-28T11:29Z\\",\\n \\"message\\": \\"success\\",\\n \\"result\\": \\"{\\\\\\"phase\\\\\\":5,\\\\\\"version\\\\\\":\\\\\\"20240101\\\\\\"}\\",\\n \\"status\\": 2,\\n \\"target\\": \\"{\\\\\\"name\\\\\\":\\\\\\"cn-hongkong.10.0.0.246\\\\\\"}\\",\\n \\"type\\": \\"Node\\"\\n}","type":"json"}]', + 'title' => '查询集群诊断结果', + ], + 'GetClusterDiagnosisCheckItems' => [ + 'summary' => '获取集群诊断检查项。', + 'path' => '/clusters/{cluster_id}/diagnosis/{diagnosis_id}/check_items', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '212434', + 'abilityTreeNodes' => [ + 'FEATUREcskVD3FWR', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cb95aa626a47740afbf6aa099b650****', + ], + ], + [ + 'name' => 'diagnosis_id', + 'in' => 'path', + 'schema' => [ + 'title' => '诊断ID。', + 'description' => '诊断ID。', + 'type' => 'string', + 'required' => false, + 'example' => '6f719f23098240818eb26fe3a37d****', + ], + ], + [ + 'name' => 'language', + 'in' => 'query', + 'schema' => [ + 'title' => '查询语言。', + 'description' => '查询语言。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1DFFD8C6-259E-582B-8B40-002C17DC****', + ], + 'code' => [ + 'description' => '状态代码。', + 'type' => 'string', + 'example' => 'success', + ], + 'is_success' => [ + 'description' => '检查是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'check_items' => [ + 'description' => '检查项。', + 'type' => 'array', + 'items' => [ + 'description' => '检查项。', + 'type' => 'object', + 'properties' => [ + 'desc' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'Check whether the node can access host dns service', + ], + 'display' => [ + 'description' => '显示名称。', + 'type' => 'string', + 'example' => 'HostDNS', + ], + 'group' => [ + 'description' => '检查项分组。', + 'type' => 'string', + 'example' => 'Node', + ], + 'level' => [ + 'description' => '检查项评估结果。', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => 'normal', + 'warning' => 'warning', + 'error' => 'error', + ], + 'example' => 'normal', + ], + 'message' => [ + 'description' => '检查结果信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'name' => [ + 'description' => '检查项名称。', + 'type' => 'string', + 'example' => 'HostDNS', + ], + 'refer' => [ + 'description' => '参考值。', + 'type' => 'string', + 'example' => 'True', + ], + 'value' => [ + 'description' => '检查项值。', + 'type' => 'string', + 'example' => 'True', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"1DFFD8C6-259E-582B-8B40-002C17DC****\\",\\n \\"code\\": \\"success\\",\\n \\"is_success\\": true,\\n \\"check_items\\": [\\n {\\n \\"desc\\": \\"Check whether the node can access host dns service\\",\\n \\"display\\": \\"HostDNS\\",\\n \\"group\\": \\"Node\\",\\n \\"level\\": \\"normal\\",\\n \\"message\\": \\"success\\",\\n \\"name\\": \\"HostDNS\\",\\n \\"refer\\": \\"True\\",\\n \\"value\\": \\"True\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群诊断检查项', + ], + 'CreateTemplate' => [ + 'summary' => '编排模板是对一组Kubernetes集群资源的定义和描述，以声明性方式描述应用应该如何运行或者配置。您可以基于这些模板自动化部署和管理集群中的资源，例如Pods、Services、Deployments、ConfigMaps、PersistentVolumes等。您可以调用CreateTemplate接口创建一个编排模板。', + 'path' => '/templates', + 'methods' => [ + 'post', + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '8528', + 'abilityTreeNodes' => [ + 'FEATUREcskDJFO7P', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数。', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '模板名称。', + 'description' => '模板名称。'."\n" + ."\n" + .'命名规则：由数字、汉字、英文字符或短划线（-）组成，长度范围1~63个字符，且不能以短划线（-）开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'service-account-template', + ], + 'template' => [ + 'title' => 'YAML格式的模板内容。', + 'description' => 'YAML格式的模板内容。', + 'type' => 'string', + 'required' => true, + 'example' => 'apiVersion: v1\\nkind: ServiceAccount\\nmetadata:\\n name: test-sa', + ], + 'tags' => [ + 'title' => '模板标签。', + 'description' => '编排模板标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'description' => [ + 'title' => '模板描述。', + 'description' => '编排模板描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'this is test', + ], + 'template_type' => [ + 'title' => '模板类型。默认值：kubernetes', + 'description' => '模板类型。'."\n" + ."\n" + .'- 当取值为`kubernetes`时将在控制台的编排模板页面展示该模板。'."\n" + ."\n" + .'- 该参数不填写或者取值为其他值时，控制台的编排模板页面将不会展示该模板。'."\n" + ."\n" + .'推荐设置为`kubernetes`。', + 'type' => 'string', + 'required' => false, + 'example' => 'kubernetes', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体参数', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'template_id' => [ + 'title' => '模板ID。', + 'description' => '编排模板ID。', + 'type' => 'string', + 'example' => 'ba1fe77b-b01e-4640-b77e-8f1b80******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"template_id\\": \\"ba1fe77b-b01e-4640-b77e-8f1b80******\\"\\n}","errorExample":""},{"type":"xml","example":"<template_id>ba1fe77b-b01e-4640-b77e-8f1b80e3e3cf</template_id>","errorExample":""}]', + 'title' => '创建编排模板', + ], + 'DescribeTemplateAttribute' => [ + 'summary' => '编排模板是对一组Kubernetes集群资源的定义和描述，以声明性方式描述应用应该如何运行或者配置。您可以调用DescribeTemplateAttribute接口，查询目标编排模板的详细信息，包括访问权限、YAML内容、标签等。', + 'path' => '/templates/{TemplateId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'path', + 'schema' => [ + 'title' => '模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '874ec485-e7e6-4373-8a3b-47bde8a****', + ], + ], + [ + 'name' => 'template_type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型，值为创建部署模板时指定的模板类型。', + 'description' => '模板类型。'."\n" + ."\n" + .'- 当取值为`kubernetes`时将在控制台的编排模板页面展示该模板。'."\n" + ."\n" + .'- 该参数不填写或者取值为其他值时，控制台的编排模板页面将不会展示该模板。'."\n" + ."\n" + .'推荐设置为`kubernetes`。', + 'type' => 'string', + 'required' => false, + 'example' => 'kubernetes', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回参数。', + 'description' => '编排模板详情。', + 'type' => 'array', + 'items' => [ + 'description' => '请求数据体。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '编排模板ID，模板每次修改，这个ID都会改变。 ', + 'description' => '编排模板ID，每次变更都会有一个模板ID。', + 'type' => 'string', + 'example' => '72d20cf8-a533-4ea9-a10d-e7630d3d****', + ], + 'acl' => [ + 'title' => '编排模板权限。取值：private，public，shared。', + 'description' => '编排模板的访问权限，取值：'."\n" + ."\n" + .'- `private`：私有。'."\n" + .'- `public`：公共。'."\n" + .'- `shared`：可共享。', + 'type' => 'string', + 'example' => 'private', + ], + 'name' => [ + 'title' => '编排模板名称。 ', + 'description' => '编排模板名称。', + 'type' => 'string', + 'example' => 'web', + ], + 'template' => [ + 'title' => '编排模板内容。 ', + 'description' => '编排模板YAML内容。', + 'type' => 'string', + 'example' => 'apiVersion: V1\\n***', + ], + 'template_type' => [ + 'title' => '编排模板类型', + 'description' => '模板类型。'."\n" + ."\n" + .'- 当取值为kubernetes时将在控制台的编排模板页面展示该模板。'."\n" + ."\n" + .'- 该参数不填写或者取值为其他值时，控制台的编排模板页面将不会展示该模板。', + 'type' => 'string', + 'example' => 'kubernetes', + ], + 'description' => [ + 'title' => '编排模板描述。', + 'description' => '编排模板描述信息。', + 'type' => 'string', + 'example' => 'test template', + ], + 'tags' => [ + 'title' => '部署模板的标签。', + 'description' => '部署模板的标签。', + 'type' => 'string', + 'example' => 'sa', + ], + 'template_with_hist_id' => [ + 'title' => '编排模板ID，该ID唯一不随更新而改变。 ', + 'description' => '编排模板唯一ID，不随模板更新而改变。', + 'type' => 'string', + 'example' => '874ec485-e7e6-4373-8a3b-47bde8ae****', + ], + 'created' => [ + 'title' => '编排模板创建时间。', + 'description' => '编排模板创建时间。', + 'type' => 'string', + 'example' => '2025-04-25T16:56:33+08:00', + ], + 'updated' => [ + 'title' => '编排模板修改时间。 ', + 'description' => '编排模板更新时间。', + 'type' => 'string', + 'example' => '2025-04-25T16:56:33+08:00', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"id\\": \\"72d20cf8-a533-4ea9-a10d-e7630d3d****\\",\\n \\"acl\\": \\"private\\",\\n \\"name\\": \\"web\\",\\n \\"template\\": \\"apiVersion: V1\\\\\\\\n***\\",\\n \\"template_type\\": \\"kubernetes\\",\\n \\"description\\": \\"test template\\",\\n \\"tags\\": \\"sa\\",\\n \\"template_with_hist_id\\": \\"874ec485-e7e6-4373-8a3b-47bde8ae****\\",\\n \\"created\\": \\"2025-04-25T16:56:33+08:00\\",\\n \\"updated\\": \\"2025-04-25T16:56:33+08:00\\"\\n }\\n]","errorExample":""},{"type":"xml","example":"<DescribeTemplateAttributeResponse>\\n <id>72d20cf8-a533-4ea9-a10d-e7630d3d****</id>\\n <acl>private</acl>\\n <name>web</name>\\n <template>apiVersion: V1\\\\n***</template>\\n <template_type>kubernetes</template_type>\\n <description>test template</description>\\n <tags>sa</tags>\\n <template_with_hist_id>874ec485-e7e6-4373-8a3b-47bde8ae****</template_with_hist_id>\\n <created>2020-09-16T19:21:29+08:00</created>\\n <updated>2020-09-16T19:21:29+08:00</updated>\\n</DescribeTemplateAttributeResponse>","errorExample":""}]', + 'title' => '查询指定编排模板的详情', + ], + 'DescribeTemplates' => [ + 'summary' => '编排模板是对一组Kubernetes集群资源的定义和描述，以声明性方式描述应用应该如何运行或者配置。您可以调用DescribeTemplates接口获取已创建的编排模板的列表，并查询编排模板的详细信息，包括访问权限、YAML内容、标签等。', + 'path' => '/templates', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '391', + 'abilityTreeNodes' => [ + 'FEATUREcskT7MN2U', + 'FEATUREcskDJFO7P', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'template_type', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型，部署模板类型，目前一共有2种类型，取值为：kubernetes或compose。', + 'description' => '模板类型。'."\n" + ."\n" + .'- 当取值为`kubernetes`时将在控制台的编排模板页面展示该模板。'."\n" + ."\n" + .'- 该参数不填写或者取值为其他值时，控制台的编排模板页面将不会展示该模板。'."\n" + ."\n" + .'推荐设置为`kubernetes`。', + 'type' => 'string', + 'required' => false, + 'example' => 'kubernetes', + ], + ], + [ + 'name' => 'page_num', + 'in' => 'query', + 'schema' => [ + 'title' => '对查询结果进行分页处理，指定返回第几页的数据。 默认值为 1', + 'description' => '对查询结果进行分页处理，指定返回第几页的数据。'."\n" + ."\n" + .'默认值： 1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'page_size', + 'in' => 'query', + 'schema' => [ + 'title' => '对查询结果进行分页处理，指定每页包含的数据条数。 默认值为 10', + 'description' => '对查询结果进行分页处理，指定每页包含的数据条数。'."\n" + ."\n" + .'默认值：10。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体数据。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'templates' => [ + 'title' => '模板列表。', + 'description' => '模板列表。', + 'type' => 'array', + 'items' => [ + 'description' => '部署模板详情。', + 'type' => 'object', + 'properties' => [ + 'acl' => [ + 'title' => '模板访问权限，取值为：private、pubilc或shared。。', + 'description' => '用户部署模板的访问权限，取值：'."\n" + ."\n" + .'- `private`：私有。'."\n" + .'- `public`：公共。'."\n" + .'- `shared`：可共享。', + 'type' => 'string', + 'example' => 'private', + ], + 'id' => [ + 'title' => '模板ID。会模板随着更新而变化。', + 'description' => '部署模板ID。', + 'type' => 'string', + 'example' => '874ec485-e7e6-4373-8a3b-47bde8******', + ], + 'name' => [ + 'title' => '模板名称。', + 'description' => '部署模板名称。', + 'type' => 'string', + 'example' => 'webserver', + ], + 'description' => [ + 'title' => '模板描述信息。', + 'description' => '部署模板描述信息。', + 'type' => 'string', + 'example' => 'a web server', + ], + 'tags' => [ + 'title' => '模板标签，如果不显式指定了，默认为模板名称。', + 'description' => '部署模板的标签，如果不显式指定，默认为模板名称。', + 'type' => 'string', + 'example' => 'kubernetes', + ], + 'template' => [ + 'title' => '模板详情。', + 'description' => 'YAML格式的模板内容。', + 'type' => 'string', + 'example' => 'apiVersion: apps/v1\\nkind: Deployment\\nmetadata:\\n name: nginx-deployment-basic\\n labels:\\n app: nginx\\nspec:\\n replicas: 2\\n selector:\\n matchLabels:\\n app: nginx\\n template:\\n metadata:\\n labels:\\n app: nginx\\n spec:\\n containers:\\n - name: nginx\\n image: busybox:latest\\n ports:\\n - containerPort: 80', + ], + 'template_type' => [ + 'title' => '部署模板类型。', + 'description' => '模板类型。'."\n" + ."\n" + .'- 当取值为kubernetes时将在控制台的编排模板页面展示该模板。'."\n" + ."\n" + .'- 该参数不填写或者取值为其他值时，控制台的编排模板页面将不会展示该模板。', + 'type' => 'string', + 'example' => 'kubernetes', + ], + 'created' => [ + 'title' => '模板创建时间。', + 'description' => '部署模板创建时间。', + 'type' => 'string', + 'example' => '2025-04-25T16:56:33+08:00', + ], + 'updated' => [ + 'title' => '模板修改时间。', + 'description' => '部署模板更新时间。', + 'type' => 'string', + 'example' => '2025-04-25T16:56:33+08:00', + ], + 'template_with_hist_id' => [ + 'title' => '模板唯一ID。', + 'description' => '模板关联的父模板ID，用于实现模板多版本功能（同一模板的不同版本拥有相同的`template_with_hist_id`值）。', + 'type' => 'string', + 'example' => 'ad81d115-7c8b-47e7-a222-9c28d7******', + ], + ], + ], + ], + 'page_info' => [ + 'title' => '分页信息。', + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'page_number' => [ + 'title' => '当前页数。', + 'description' => '展示当前页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'page_size' => [ + 'title' => '单页最大数据条数。', + 'description' => '单页最大数据条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'total_count' => [ + 'title' => '结果总数。', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"templates\\": [\\n {\\n \\"acl\\": \\"private\\",\\n \\"id\\": \\"874ec485-e7e6-4373-8a3b-47bde8******\\",\\n \\"name\\": \\"webserver\\",\\n \\"description\\": \\"a web server\\",\\n \\"tags\\": \\"kubernetes\\",\\n \\"template\\": \\"apiVersion: apps/v1\\\\\\\\nkind: Deployment\\\\\\\\nmetadata:\\\\\\\\n name: nginx-deployment-basic\\\\\\\\n labels:\\\\\\\\n app: nginx\\\\\\\\nspec:\\\\\\\\n replicas: 2\\\\\\\\n selector:\\\\\\\\n matchLabels:\\\\\\\\n app: nginx\\\\\\\\n template:\\\\\\\\n metadata:\\\\\\\\n labels:\\\\\\\\n app: nginx\\\\\\\\n spec:\\\\\\\\n containers:\\\\\\\\n - name: nginx\\\\\\\\n image: busybox:latest\\\\\\\\n ports:\\\\\\\\n - containerPort: 80\\",\\n \\"template_type\\": \\"kubernetes\\",\\n \\"created\\": \\"2025-04-25T16:56:33+08:00\\",\\n \\"updated\\": \\"2025-04-25T16:56:33+08:00\\",\\n \\"template_with_hist_id\\": \\"ad81d115-7c8b-47e7-a222-9c28d7******\\"\\n }\\n ],\\n \\"page_info\\": {\\n \\"page_number\\": 20,\\n \\"page_size\\": 3,\\n \\"total_count\\": 50\\n }\\n}","errorExample":""},{"type":"xml","example":"<templates>\\n <acl>private</acl>\\n <id>874ec485-e7e6-4373-8a3b-47bde8ae789f</id>\\n <name>webserver</name>\\n <description>a web server</description>\\n <tags>kubernetes</tags>\\n <template>apiVersion: apps/v1\\\\nkind: Deployment\\\\nmetadata:\\\\n name: nginx-deployment-basic\\\\n labels:\\\\n app: nginx\\\\nspec:\\\\n replicas: 2\\\\n selector:\\\\n matchLabels:\\\\n app: nginx\\\\n template:\\\\n metadata:\\\\n labels:\\\\n app: nginx\\\\n spec:\\\\n containers:\\\\n - name: nginx\\\\n image: busybox:latest\\\\n ports:\\\\n - containerPort: 80</template>\\n <template_type>kubernetes</template_type>\\n <created>2020-06-10T16:30:16+08:00</created>\\n <updated>2020-06-10T16:30:16+08:00</updated>\\n <template_with_hist_id>ad81d115-7c8b-47e7-a222-9c28d7f6e588</template_with_hist_id>\\n</templates>\\n<page_info>\\n <page_number>20</page_number>\\n <page_size>3</page_size>\\n <total_count>50</total_count>\\n</page_info>","errorExample":""}]', + 'title' => '查询所有编排模板', + ], + 'UpdateTemplate' => [ + 'summary' => '编排模板是对一组Kubernetes集群资源的定义和描述，以声明性方式描述应用应该如何运行或者配置。您可以调用UpdateTemplate接口更新编排模板配置。', + 'path' => '/templates/{TemplateId}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'path', + 'schema' => [ + 'title' => '部署模板ID。', + 'description' => '模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '72d20cf8-a533-4ea9-a10d-e7630d******', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '请求体', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'description' => [ + 'title' => '部署模板描述信息。', + 'description' => '部署模板描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'web server cluster', + ], + 'name' => [ + 'title' => '部署模板名称。', + 'description' => '部署模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'webserver01', + ], + 'tags' => [ + 'title' => '部署模板标签', + 'description' => '部署模板标签。', + 'type' => 'string', + 'required' => false, + 'example' => 'web', + ], + 'template' => [ + 'title' => '部署模板yaml。', + 'description' => 'YAML格式的模板内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'apiVersion: apps/v1\\\\nkind: Deployment\\\\nmetadata:\\\\n name: nginx-deployment-basic\\\\n labels:\\\\n app: nginx\\\\nspec:\\\\n replicas: 2\\\\n selector:\\\\n matchLabels:\\\\n app: nginx\\\\n template:\\\\n metadata:\\\\n labels:\\\\n app: nginx\\\\n spec:\\\\n containers:\\\\n - name: nginx\\\\n image: busybox:latest\\\\n ports:\\\\n - containerPort: 8080', + ], + 'template_type' => [ + 'title' => '部署模板类型。', + 'description' => '模板类型。'."\n" + ."\n" + .'- 当取值为`kubernetes`时将在控制台的编排模板页面展示该模板。'."\n" + ."\n" + .'- 该参数不填写或者取值为其他值时，控制台的编排模板页面将不会展示该模板。'."\n" + ."\n" + .'推荐设置为`kubernetes`。', + 'type' => 'string', + 'required' => false, + 'example' => 'kubernetes', + ], + ], + 'required' => false, + 'example' => 'webserver01', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '更新编排模板', + ], + 'DeleteTemplate' => [ + 'summary' => '当您无需使用某些编排模板时，您可以调用DeleteTemplate接口删除编排模板。', + 'path' => '/templates/{TemplateId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'TemplateId', + 'in' => 'path', + 'schema' => [ + 'title' => '模板ID。', + 'description' => '编排模板ID。', + 'type' => 'string', + 'required' => true, + 'example' => '20663627-81ee-4cfe-9b69-c96fcb******', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除编排模板', + ], + 'CreateTrigger' => [ + 'summary' => '您可以为集群应用配置触发器的功能，指定触发器在接收到某些条件时重新部署Pod。', + 'path' => '/clusters/{cluster_id}/triggers', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeNodes' => [ + 'FEATUREcskT7MN2U', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '请求体参数', + 'description' => '请求体参数', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + 'project_id' => [ + 'title' => '项目名称。', + 'description' => '触发器项目名称。'."\n" + ."\n" + .'由应用所在命名空间及应用名称组成，格式为`${namespace}/${name}`。'."\n" + ."\n" + .'取值示例：`default/test-app`。', + 'type' => 'string', + 'required' => true, + 'example' => 'default/test-app', + ], + 'action' => [ + 'title' => '触发器行为', + 'description' => '触发器行为，取值：'."\n" + ."\n" + .'`redeploy`：重新部署`project_id`中定义的资源。', + 'type' => 'string', + 'required' => true, + 'example' => 'redeploy', + ], + 'type' => [ + 'title' => '触发器类型。默认deployment。', + 'description' => '触发器类型。取值：'."\n" + ."\n" + .'- `deployment`：针对无状态应用的触发器。 '."\n" + ."\n" + .'- `application`：针对应用中心应用的触发器。'."\n" + ."\n" + .'默认值：`deployment`。', + 'type' => 'string', + 'required' => false, + 'example' => 'deployment', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c68deb844dc6d480eb775be611fdf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '触发器ID。', + 'description' => '触发器ID。', + 'type' => 'string', + 'example' => '75973497486******', + ], + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c93095129fc41463aa455d89444fd****', + ], + 'project_id' => [ + 'title' => '触发器项目名称。', + 'description' => '触发器项目名称。', + 'type' => 'string', + 'example' => 'default/test-app', + ], + 'type' => [ + 'title' => '触发器类型。默认值为 deployment 。', + 'description' => '触发器类型。', + 'type' => 'string', + 'example' => 'deployment', + ], + 'action' => [ + 'title' => '触发器行为。', + 'description' => '触发器行为。', + 'type' => 'string', + 'example' => 'redeploy', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"id\\": \\"75973497486******\\",\\n \\"cluster_id\\": \\"c93095129fc41463aa455d89444fd****\\",\\n \\"project_id\\": \\"default/test-app\\",\\n \\"type\\": \\"deployment\\",\\n \\"action\\": \\"redeploy\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTriggerResponse>\\n <id>102536</id>\\n <cluster_id>c93095129fc41463aa455d89444fd****</cluster_id>\\n <project_id>default/test-app</project_id>\\n <type>deployment</type>\\n <action>redeploy</action>\\n</CreateTriggerResponse>","errorExample":""}]', + 'title' => '创建触发器', + 'description' => '> 创建触发器仅支持Pod的重新部署。', + ], + 'DeleteTrigger' => [ + 'summary' => '当您不再需要触发器时，可以调用DeleteTrigger删除应用触发器。', + 'path' => '/clusters/{cluster_id}/triggers/{Id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c68deb844dc6d480eb775be611f******', + ], + ], + [ + 'name' => 'Id', + 'in' => 'path', + 'schema' => [ + 'title' => '触发器ID。', + 'description' => '触发器ID。', + 'type' => 'string', + 'required' => true, + 'example' => '759734974868******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除触发器', + ], + 'DescribeTrigger' => [ + 'summary' => '您可以调用DescribeTrigger接口，查询符合条件的触发器。', + 'path' => '/clusters/{cluster_id}/triggers', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属命名空间。', + 'description' => '应用所属命名空间。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '应用类型。', + 'description' => '触发器类型。取值：'."\n" + ."\n" + .'- `deployment`：针对无状态应用的触发器。 '."\n" + ."\n" + .'- `application`：针对应用中心应用的触发器。'."\n" + ."\n" + .'默认值：`deployment`。'."\n" + ."\n" + .'当不指定触发器类型时，查询结果将不过滤触发器类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'deployment', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => '应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'web-server', + ], + ], + [ + 'name' => 'action', + 'in' => 'query', + 'schema' => [ + 'title' => '触发器行为。', + 'description' => '触发器行为，取值：'."\n" + ."\n" + .'`redeploy`：重新部署应用。'."\n" + ."\n" + .'当不指定触发器行为时，查询结果将不过滤触发器行为。', + 'type' => 'string', + 'required' => false, + 'example' => 'redeploy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回参数。', + 'description' => '触发器查询结果详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '触发器详情。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '触发器ID。', + 'description' => '触发器ID。', + 'type' => 'string', + 'example' => '75973497486******', + ], + 'name' => [ + 'title' => '触发器名称。', + 'description' => '触发器名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'cluster_id' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c259f563386444ebb8d7****', + ], + 'project_id' => [ + 'title' => '触发器项目名称', + 'description' => '触发器项目名称。'."\n" + ."\n" + .'由应用所在命名空间及应用名称组成，格式为`${namespace}/${name}`，取值示例：default/test-app。', + 'type' => 'string', + 'example' => 'default/test-app', + ], + 'type' => [ + 'title' => '触发器类型。', + 'description' => '触发器类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- `deployment`：针对无状态应用的触发器。 '."\n" + ."\n" + .'- `application`：针对应用中心应用的触发器。', + 'type' => 'string', + 'example' => 'deployment', + ], + 'action' => [ + 'title' => '触发器行为', + 'description' => '触发器行为，取值：'."\n" + ."\n" + .'`redeploy`: 重新部署应用。', + 'type' => 'string', + 'example' => 'redeploy', + ], + 'token' => [ + 'title' => 'Token', + 'description' => 'Token信息。', + 'type' => 'string', + 'example' => 'eyJhbGci***', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"id\\": \\"75973497486******\\",\\n \\"name\\": \\"test\\",\\n \\"cluster_id\\": \\"c259f563386444ebb8d7****\\",\\n \\"project_id\\": \\"default/test-app\\",\\n \\"type\\": \\"deployment\\",\\n \\"action\\": \\"redeploy\\",\\n \\"token\\": \\"eyJhbGci***\\"\\n }\\n]","errorExample":""},{"type":"xml","example":"<DescribeTriggerResponse>\\n <id>1234</id>\\n <name>test</name>\\n <cluster_id>c259f563386444ebb8d7****</cluster_id>\\n <project_id>default/test-app</project_id>\\n <type>deployment</type>\\n <action>redeploy</action>\\n <token>eyJhbGci***</token>\\n</DescribeTriggerResponse>","errorExample":""}]', + 'title' => '查询触发器', + ], + 'ListTagResources' => [ + 'summary' => '您可以为集群添加标签键值对，让集群开发或运维人员能够更灵活地对集群进行分类管理，更好的支持监控、成本分析、租户隔离等需求。您可以调用ListTagResources接口，获取资源标签的列表并查询标签的详细信息，例如键值对、绑定的集群等。', + 'path' => '/tags', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '579', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'resource_ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '集群ID列表。', + 'description' => '要查询的资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + ."\n" + .'资源类型为`CLUSTER`时，该参数取值为集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c71cf3d796c374bf48644482cb0c3****', + ], + 'required' => true, + 'example' => '["xxxxx","xxxxxx"]', + ], + ], + [ + 'name' => 'resource_type', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型，只支持Cluster', + 'description' => '资源类型。'."\n" + ."\n" + .'CLUSTER：集群。', + 'type' => 'string', + 'required' => true, + 'example' => 'CLUSTER', + ], + ], + [ + 'name' => 'region_id', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '按标签查找。', + 'description' => '要查询的标签列表，限制最多包含20个子项。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'required' => false, + '$ref' => '#/components/schemas/tag', + ], + 'required' => false, + 'example' => '[{\\"key\\":\\"env\\",\\"value\\",\\"dev\\"},{\\"key\\":\\"dev\\", \\"value\\":\\"IT\\"}]', + ], + ], + [ + 'name' => 'next_token', + 'in' => 'query', + 'schema' => [ + 'title' => '下一次查询Token。', + 'description' => '下一个查询开始的令牌。', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'next_token' => [ + 'title' => '下一个查询开始Token，为空说明没有下一个', + 'description' => '下一个查询开始的令牌。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'c374bf4864448****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E368C761-F8F6-4A36-9B58-BD53D5******', + ], + 'tag_resources' => [ + 'title' => '资源标签列表。', + 'description' => '标签资源集。', + 'type' => 'object', + 'properties' => [ + 'tag_resource' => [ + 'title' => '资源标签。', + 'description' => '标签资源。'."\n" + ."\n\n" + ."\n\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '资源详情。', + 'type' => 'object', + 'properties' => [ + 'tag_key' => [ + 'title' => '标签key。', + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'ack.aliyun.com', + ], + 'tag_value' => [ + 'title' => '标签值。', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'c71cf3d796c374bf48644482cb0c3****', + ], + 'resource_id' => [ + 'title' => '资源ID。', + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'c2e39566adf23481fa1164ed510****', + ], + 'resource_type' => [ + 'title' => '资源类型。', + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'ALIYUN::CS::CLUSTER', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"next_token\\": \\"c374bf4864448****\\",\\n \\"request_id\\": \\"E368C761-F8F6-4A36-9B58-BD53D5******\\",\\n \\"tag_resources\\": {\\n \\"tag_resource\\": [\\n {\\n \\"tag_key\\": \\"ack.aliyun.com\\",\\n \\"tag_value\\": \\"c71cf3d796c374bf48644482cb0c3****\\",\\n \\"resource_id\\": \\"c2e39566adf23481fa1164ed510****\\",\\n \\"resource_type\\": \\"ALIYUN::CS::CLUSTER\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<next_token>c374bf4864448****</next_token>\\n<request_id>E368C761-F8F6-4A36-9B58-BD53D5CD0CEB</request_id>\\n<tag_resources>\\n <tag_resource>\\n <tag_key>ack.aliyun.com</tag_key>\\n <tag_value>c71cf3d796c374bf48644482cb0c3****</tag_value>\\n <resource_id>i-xxx</resource_id>\\n <resource_type>CLUSTER</resource_type>\\n </tag_resource>\\n</tag_resources>","errorExample":""}]', + 'title' => '查询集群的标签列表', + ], + 'TagResources' => [ + 'summary' => '您可以为集群添加标签键值对，让集群开发或运维人员能够更灵活地对集群进行分类管理，更好的支持监控、成本分析、租户隔离等需求。您可以调用TagResources接口，为集群绑定标签。', + 'path' => '/tags', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '请求体参数', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'resource_ids' => [ + 'title' => '资源ID列表', + 'description' => '资源ID列表。最多支持添加50个资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + ."\n" + .'资源类型为`CLUSTER`时，该参数取值为集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c1a7bb282fc0d48b****', + ], + 'required' => true, + ], + 'resource_type' => [ + 'title' => '资源类型定义。取值范围： 只支持CLUSTER这一种资源类型', + 'description' => '资源类型。'."\n" + ."\n" + .'CLUSTER：集群。', + 'type' => 'string', + 'required' => true, + 'example' => 'CLUSTER', + ], + 'region_id' => [ + 'title' => '资源所属的地域ID', + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + 'tags' => [ + 'title' => '资源的标签键值对。数组长度范围：1~20。一旦传值，则不允许为空字符串。最多支持128个字符，不能以aliyun和acs:开头，不能包含http://或者https://。', + 'description' => '资源的标签键值对。最多支持添加20组资源的标签键值对。注意：'."\n" + ."\n" + .'- 一旦传值，值不允许为空字符串，最多支持128个字符。'."\n" + .'- 不能以`aliyun`和`acs:`开头。'."\n" + .'- 不能包含`http://`或者`https://`。', + 'type' => 'array', + 'items' => [ + 'description' => '资源标签。', + 'required' => false, + '$ref' => '#/components/schemas/tag', + ], + 'required' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应体。', + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF51894******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF51894******\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF51894XXXXX</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', + 'title' => '为集群绑定标签', + ], + 'UntagResources' => [ + 'summary' => '当您无需使用集群的标签键值对时，您可以调用UntagResources接口，删除资源标签。', + 'path' => '/tags', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'region_id', + 'in' => 'query', + 'schema' => [ + 'title' => '资源所属的地域ID', + 'description' => '资源所属的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'resource_ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源ID。数组长度取值范围为：1~50', + 'description' => '资源ID列表。最多支持添加50个资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。'."\n" + ."\n" + .'资源类型为`CLUSTER`时，该参数取值为集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c1a7bb282fc0d48b593***', + ], + 'required' => true, + ], + ], + [ + 'name' => 'resource_type', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型定义。取值范围： 只支持CLUSTER这一种资源类型', + 'description' => '资源类型。'."\n" + ."\n" + .'CLUSTER：集群。', + 'type' => 'string', + 'required' => true, + 'example' => 'CLUSTER', + ], + ], + [ + 'name' => 'tag_keys', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '资源的标签键。N的取值范围：1~20', + 'description' => '资源的标签键列表。最多支持添加20个资源的标签键。', + 'type' => 'array', + 'items' => [ + 'description' => '资源的标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey1', + ], + 'required' => true, + ], + ], + [ + 'name' => 'all', + 'in' => 'query', + 'schema' => [ + 'title' => '是否删除全部自定义标签，仅当tag_keys为空时生效，取值：[true,false]。', + 'description' => '是否删除全部自定义标签，仅当`tag_keys`为空时生效。取值范围：'."\n" + ."\n" + .'- `true`: 删除全部标签。'."\n" + .'- `false`: 不删除全部标签。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应体。', + 'description' => '响应体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2D69A58F-345C-4FDE-88E4-BF51894******', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2D69A58F-345C-4FDE-88E4-BF51894******\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>2D69A58F-345C-4FDE-88E4-BF51894XXXXX</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => '删除集群标签', + ], + 'ModifyClusterTags' => [ + 'summary' => '您可以为集群添加标签键值对，让集群开发或运维人员能够更灵活地对集群进行分类管理，更好的支持监控、成本分析、租户隔离等需求。您可以调用ModifyClusterTags接口，修改集群标签。', + 'path' => '/clusters/{ClusterId}/tags', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '383', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '汲取ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c106f377e16f34eb1808d6b9362c9****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => '集群标签列表。', + 'description' => '修改数据。', + 'type' => 'array', + 'items' => [ + 'description' => '标签集。', + 'required' => false, + '$ref' => '#/components/schemas/tag', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '全量更新集群标签', + 'description' => '- 该API为全量更新，使用时请注意将完整的目标Tags设定为入参，避免丢失已有Tags。如需增量更新，请使用[TagResources接口为集群绑定标签](~~2667969~~)。', + ], + 'StartAlert' => [ + 'summary' => '启动指定的报警规则。', + 'path' => '/alert/{ClusterId}/alert_rule/start', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '161580', + 'abilityTreeNodes' => [ + 'FEATUREcskNNODXQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。您可以通过调用ListClusters获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c245ff43c717f49****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'alert_rule_group_name' => [ + 'description' => '报警规则组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sample', + ], + 'alert_rule_name' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sample', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'description' => '状态。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'msg' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": true,\\n \\"msg\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '启动报警规则', + ], + 'UpdateContactGroupForAlert' => [ + 'summary' => '您可以调用UpdateContactGroupForAlert接口，为ACK集群中的报警规则集设置指定的联系人分组。', + 'path' => '/alert/{ClusterId}/alert_rule/contact_groups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '125473', + 'abilityTreeNodes' => [ + 'FEATUREcskNNODXQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID，可以调用ListCluster接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ce7d08276f8a6422282c46272a84bxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'alert_rule_group_name' => [ + 'description' => '报警项联系人分组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sample', + ], + 'contact_group_ids' => [ + 'description' => '联系人分组 ID 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人分组 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + 'required' => false, + ], + 'cr_name' => [ + 'description' => 'CR实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sample', + ], + 'namespace' => [ + 'description' => '资源所在的 Namespace。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'description' => '更新结果状态。'."\n" + .'- true：执行成功。'."\n" + .'- false：执行失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'msg' => [ + 'description' => '执行失败时返回信息提示。', + 'type' => 'string', + 'example' => 'contact group illegal.', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": true,\\n \\"msg\\": \\"contact group illegal.\\"\\n}","type":"json"}]', + 'title' => '更新报警项联系人分组', + ], + 'StopAlert' => [ + 'summary' => '停止ACK报警中心中报警规则，停止整个报警规则集分组、单个报警规则。', + 'path' => '/alert/{ClusterId}/alert_rule/stop', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '161581', + 'abilityTreeNodes' => [ + 'FEATUREcskNNODXQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。'."\n" + ."\n" + .'您可以通过调用[ListClusters](~~87116~~)获取集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c7f9c85baee73452883b3299a0107****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'alert_rule_group_name' => [ + 'description' => '告警规则组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sample', + ], + 'alert_rule_name' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'sample', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'description' => '执行结果状态。'."\n" + .'- True：执行成功。'."\n" + .'- False：执行失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'msg' => [ + 'description' => '执行失败时返回信息提示。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"status\\": true,\\n \\"msg\\": \\"Success\\"\\n}","type":"json"}]', + 'title' => '停止报警规则', + ], + 'DeleteAlertContact' => [ + 'summary' => '删除ACK报警联系人', + 'path' => '/alert/contacts', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '125471', + 'abilityTreeNodes' => [ + 'FEATUREcskNNODXQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'contact_ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '删除ACK联系人的id列表', + 'description' => '报警联系人的 ID 列表。', + 'type' => 'array', + 'items' => [ + 'title' => '删除ACK联系人的id', + 'description' => '报警联系人的 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'result' => [ + 'description' => '删除结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '被删除的报警联系人。', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'description' => '删除状态。'."\n" + ."\n" + .'* true: 删除成功。'."\n" + .'* false: 删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'msg' => [ + 'description' => '执行失败时返回信息提示。', + 'type' => 'string', + 'example' => 'Delete contact resource failed.', + ], + 'contact_id' => [ + 'description' => '报警联系人 ID。', + 'type' => 'string', + 'example' => '12345', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"0\\": {\\n \\"status\\": true,\\n \\"msg\\": \\"Delete contact resource failed.\\",\\n \\"contact_id\\": \\"12345\\"\\n },\\n \\"result\\": []\\n}","type":"json"}]', + 'title' => '删除报警联系人', + ], + 'DeleteAlertContactGroup' => [ + 'summary' => '删除ACK报警联系人分组', + 'path' => '/alert/contact_groups', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '125472', + 'abilityTreeNodes' => [ + 'FEATUREcskNNODXQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'contact_group_ids', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '报警联系人分组 ID 列表。', + 'type' => 'array', + 'items' => [ + 'description' => '联系人分组 ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '删除结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '被删除的报警联系人分组。', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'description' => '删除状态。'."\n" + ."\n" + .'* true: 删除成功。'."\n" + .'* false: 删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'msg' => [ + 'description' => '执行失败时返回信息提示。', + 'type' => 'string', + 'example' => 'Delete contact group resource failed.', + ], + 'contact_group_id' => [ + 'description' => '报警联系人分组 ID。', + 'type' => 'string', + 'example' => '12345', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"[\\n {\\n \\"status\\": true,\\n \\"msg\\": \\"Delete contact group resource failed.\\",\\n \\"contact_group_id\\": \\"12345\\"\\n }\\n]","type":"json"}]', + 'title' => '删除报警联系人分组', + ], + 'UpdateControlPlaneLog' => [ + 'summary' => 'ACK托管集群支持收集控制面组件日志并投递到您的SLS Log Project中。控制面组件包括Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Manager等核心组件。您可以调用UpdateControlPlaneLog接口，修改控制面组件日志配置，例如日志保存时间、采集的组件等。', + 'path' => '/clusters/{ClusterId}/controlplanelog', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '165010', + 'abilityTreeNodes' => [ + 'FEATUREcsk0H96CV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body参数。', + 'type' => 'object', + 'properties' => [ + 'log_project' => [ + 'description' => '控制平面组件日志对应存储的SLS Project名称。'."\n" + ."\n" + .'默认值：k8s-log-$集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s-log-c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + 'log_ttl' => [ + 'description' => '日志在SLS logstore里的数据保存时间。取值范围：1~3000，单位：天。'."\n" + ."\n" + .'默认值：30天。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'aliuid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'required' => false, + 'example' => '162981*****', + ], + 'components' => [ + 'description' => '当前开启控制平面日志的组件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当前开启控制平面日志的组件列表。支持的组件列表：'."\n" + .'- `apiserver`'."\n" + .'- `ccm`'."\n" + .'- `scheduler`'."\n" + .'- `kcm`'."\n" + .'- `controlplane-events`'."\n" + .'- `alb`'."\n" + .'- `cluster-autoscaler`'."\n" + .'- `ack-goatscaler`'."\n" + .'- `kuberay-operator`'."\n" + .'- `gatekepper`：仅适用于ACK托管集群（智能托管模式）。'."\n" + .'- `vk`：仅适用于ASK集群。'."\n" + .'- `istio`：仅适用于服务网格集群。'."\n" + .'- `cluster-operator`：仅适用于ACK One分布式云容器平台。'."\n" + .'- `application-controller`：仅适用于ACK One分布式云容器平台。'."\n" + ."\n" + .'控制面组件日志功能默认采集`apiserver`、 `ccm`、`scheduler`、`kcm`、`controlplane-events`、`alb`组件的日志。'."\n" + ."\n" + .'具体组件信息，请参见[控制面组件Logstore说明](~~198268~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '[ "apiserver", "kcm", "scheduler", "ccm", "alb", "controlplane-events", "ack-goatscaler"]', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体数据。', + 'description' => '返回体数据。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cb95aa626a47740afbf6aa099b650****', + ], + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687C5BAA-D103-4993-884B-C35E4314****', + ], + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5a54309c80282e39ea00****', + ], + ], + ], + ], + '5XX' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"cluster_id\\": \\"cb95aa626a47740afbf6aa099b650****\\",\\n \\"request_id\\": \\"687C5BAA-D103-4993-884B-C35E4314****\\",\\n \\"task_id\\": \\"T-5a54309c80282e39ea00****\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => '修改ACK托管集群控制面组件日志配置', + 'requestParamsDescription' => '- UpdateControlPlaneLog支持仅修改日志存储时间（log_ttl），如果您只在请求体中定义log_ttl，后台会判定为仅修改存储时间。'."\n" + .'- UpdateControlPlaneLog支持通过将components字段声明为空列表的方式来关闭所有控制面组件的日志。请在请求体中明确将components字段声明为空列表，如果不定义components，将不会触发关闭控制面组件日志的操作。', + ], + 'CheckControlPlaneLogEnable' => [ + 'summary' => 'ACK托管集群支持收集控制面组件日志并投递到您的SLS Log Project中。控制面组件包括Kube API Server、Kube Scheduler、Kube Controller Manager、Cloud Controller Manager等核心组件。您可以调用CheckControlPlaneLogEnable接口，查询控制面组件当前的日志配置，包括日志保存时间、采集的组件等。', + 'path' => '/clusters/{ClusterId}/controlplanelog', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsk0H96CV', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'log_project' => [ + 'description' => '控制平面组件日志对应存储的SLS Project名称。'."\n" + ."\n" + .'默认值：k8s-log-$集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s-log-c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + 'log_ttl' => [ + 'description' => '日志在SLS logstore里的数据保存时间。单位：天。', + 'type' => 'string', + 'example' => '30', + ], + 'aliuid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '162981*****', + ], + 'components' => [ + 'description' => '当前开启控制平面日志的组件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '当前开启控制平面日志的组件列表。'."\n" + ."\n" + .'控制面组件日志功能默认采集`apiserver`、 `ccm`、`scheduler`、`kcm`、`controlplane-events`、`alb`组件的日志。', + 'type' => 'string', + 'example' => '["apiserver", "ccm", "scheduler", "kcm", "controlplane-events", alb]', + ], + 'required' => true, + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"log_project\\": \\"k8s-log-c5b5e80b0b64a4bf6939d2d8fbbc5****\\",\\n \\"log_ttl\\": \\"30\\",\\n \\"aliuid\\": \\"162981*****\\",\\n \\"components\\": [\\n \\"[\\\\\\"apiserver\\\\\\", \\\\\\"ccm\\\\\\", \\\\\\"scheduler\\\\\\", \\\\\\"kcm\\\\\\", \\\\\\"controlplane-events\\\\\\", alb]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<CheckControlPlaneLogEnableResponse>\\n <log_project>k8s-log-c5b5e80b0b64a4bf6939d2d8fbbc5****</log_project>\\n <log_ttl>30</log_ttl>\\n <aliuid>162981*****</aliuid>\\n <components>[\\"apiserver\\", \\"ccm\\", \\"scheduler\\", \\"kcm\\", \\"controlplane-events\\"]</components>\\n</CheckControlPlaneLogEnableResponse>","errorExample":""}]', + 'title' => '查询ACK托管集群控制面组件日志配置', + ], + 'GetClusterAuditProject' => [ + 'summary' => '您可以调用GetClusterAuditProject查看集群是否开启API Server审计功能以及API Server审计日志对应的SLS Project。', + 'path' => '/clusters/{clusterid}/audit', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '165007', + 'abilityTreeNodes' => [ + 'FEATUREcsk01W1JN', + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterid', + 'in' => 'path', + 'schema' => [ + 'description' => 'ACK集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cad1230511cbb4db4a488e58518******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '集群API Server审计信息。', + 'type' => 'object', + 'properties' => [ + 'sls_project_name' => [ + 'description' => '集群API Server审计日志所在的SLS Project。', + 'type' => 'string', + 'example' => 'k8s-log-cad1230511cbb4db4a488e58518******'."\n", + ], + 'audit_enabled' => [ + 'title' => '当前集群是否已启用API Server审计功能。true：已启用，false：未启用。', + 'description' => '当前集群是否已启用API Server审计功能。'."\n" + ."\n" + .'- `true`：已启用'."\n" + ."\n" + .'- `false`：未启用。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"sls_project_name\\": \\"k8s-log-cad1230511cbb4db4a488e58518******\\\\n\\",\\n \\"audit_enabled\\": true\\n}","type":"json"}]', + 'title' => '获取集群API Server审计日志SLS Project', + ], + 'UpdateClusterAuditLogConfig' => [ + 'summary' => '当您需要记录对Kubernetes API的请求以及请求结果来用于追溯集群操作历史、排查集群故障时，您可以调用UpdateClusterAuditLogConfig接口来开启、关闭指定ACK集群的审计日志功能、更新审计日志配置。', + 'path' => '/clusters/{clusterid}/audit_log', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '208650', + 'abilityTreeNodes' => [ + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterid', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求结构体。', + 'type' => 'object', + 'properties' => [ + 'sls_project_name' => [ + 'description' => '集群审计日志[Logstore](~~48874~~)所在的[SLS Project](~~48873~~)。'."\n" + ."\n" + .'- 默认值为k8s-log-{clusterid}。'."\n" + ."\n" + .'- 开启集群审计日志功能后会在指定的SLS Project下创建集群审计日志对应的Logstore。'."\n" + ."\n" + .'- 如您开启集群审计日志功能后需要修改SLS Project，可以通过该参数重新指定SLS Project（仅ACK托管集群支持修改SLS Project）。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s-log-c82e6987e2961451182edacd74faf****', + ], + 'disable' => [ + 'description' => '可以通过该参数开启或关闭集群审计日志功能。'."\n" + .'- false: 开启审计日志功能或更新审计日志配置。'."\n" + ."\n" + .'- true: 关闭审计日志功能。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c93095129fc41463aa455d89444fd****', + ], + 'request_id' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '48BD70F6-A7E6-543D-9F23-08DEB764****', + ], + 'task_id' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5faa48fb31b6b8078d00****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cluster_id\\": \\"c93095129fc41463aa455d89444fd****\\",\\n \\"request_id\\": \\"48BD70F6-A7E6-543D-9F23-08DEB764****\\",\\n \\"task_id\\": \\"T-5faa48fb31b6b8078d00****\\"\\n}","type":"json"}]', + 'title' => '更新集群审计日志配置', + 'description' => '请确保在使用该接口前，已充分了解<props="china">[日志服务](https://www.aliyun.com/price/product#/sls/detail/sls)</props><props="intl">[日志服务](https://www.alibabacloud.com/product/log-service/pricing)</props>产品的收费方式和价格。', + ], + 'DescribeEventsForRegion' => [ + 'summary' => '查询指定地域内全部事件列表。', + 'path' => '/regions/{region_id}/events', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '249410', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cf62854ac2130470897be7a27ed1f****', + ], + ], + [ + 'name' => 'page_size', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '每页显示的最大结果数。'."\n" + ."\n" + .'取值范围：[1,100]。'."\n" + ."\n" + .'默认值：50。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'page_number', + 'in' => 'query', + 'schema' => [ + 'title' => '没页记录数量', + 'description' => '分页页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'region_id', + 'in' => 'path', + 'schema' => [ + 'title' => '地域。', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体参数', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'events' => [ + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件详情。', + 'type' => 'object', + 'properties' => [ + 'event_id' => [ + 'title' => '事件ID', + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'e-9ad04f72-8ee7-46bf-a02c-e4a06b39****'."\n", + ], + 'type' => [ + 'title' => '事件类型', + 'description' => '事件类型。', + 'type' => 'string', + 'example' => 'nodePool_upgrade', + ], + 'source' => [ + 'title' => '事件源', + 'description' => '事件源。', + 'type' => 'string', + 'example' => 'task', + ], + 'subject' => [ + 'title' => '事件', + 'description' => '事件关联对象。', + 'type' => 'string', + 'example' => 'npdd89dc2b76c04f14b06774883b******', + ], + 'time' => [ + 'title' => '事件开始事件', + 'description' => '事件产生时间。', + 'type' => 'string', + 'example' => '2025-05-14T10:00:56+08:00', + ], + 'cluster_id' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + 'data' => [ + 'title' => '事件描述', + 'description' => '事件描述。', + 'type' => 'object', + 'properties' => [ + 'level' => [ + 'title' => '事件级别', + 'description' => '事件级别。', + 'type' => 'string', + 'example' => 'info', + ], + 'reason' => [ + 'title' => '事件状态', + 'description' => '事件状态。', + 'type' => 'string', + 'example' => 'Started', + ], + 'message' => [ + 'title' => '事件详情', + 'description' => '事件详情。', + 'type' => 'string', + 'example' => 'Start to upgrade NodePool nodePool/nodePool-A', + ], + ], + ], + ], + ], + ], + 'page_info' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'page_size' => [ + 'title' => '页数', + 'description' => '每页显示的最大结果数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'page_number' => [ + 'title' => '每页记录数量', + 'description' => '分页页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'total_count' => [ + 'title' => '结果总数', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"events\\": [\\n {\\n \\"event_id\\": \\"e-9ad04f72-8ee7-46bf-a02c-e4a06b39****\\\\n\\",\\n \\"type\\": \\"nodePool_upgrade\\",\\n \\"source\\": \\"task\\",\\n \\"subject\\": \\"npdd89dc2b76c04f14b06774883b******\\",\\n \\"time\\": \\"2025-05-14T10:00:56+08:00\\",\\n \\"cluster_id\\": \\"c82e6987e2961451182edacd74faf****\\",\\n \\"data\\": {\\n \\"level\\": \\"info\\",\\n \\"reason\\": \\"Started\\",\\n \\"message\\": \\"Start to upgrade NodePool nodePool/nodePool-A\\"\\n }\\n }\\n ],\\n \\"page_info\\": {\\n \\"page_size\\": 50,\\n \\"page_number\\": 1,\\n \\"total_count\\": 3\\n }\\n}","type":"json"}]', + 'title' => '查询指定地域的事件列表', + ], + 'DescribeEvents' => [ + 'summary' => '集群操作事件包括集群创建、集群变更、节点池创建、节点池扩容、Addon安装、集群升级等。您可以调用DescribeEvents接口，查询某类事件的详细信息，包括事件级别、时间状态、事件发生时间等。', + 'path' => '/events', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cf62854ac2130470897be7a27ed1f****', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'title' => '事件类型', + 'description' => '事件类型。不设置则查询所有类型的事件。取值：'."\n" + .'- `cluster_create`：创建集群。'."\n" + .'- `cluster_scaleout`：扩容集群。'."\n" + .'- `cluster_attach`：添加已有节点。'."\n" + .'- `cluster_delete`：删除集群。'."\n" + .'- `cluster_upgrade`：升级集群。'."\n" + .'- `cluster_migrate`：迁移集群。'."\n" + .'- `cluster_node_delete`：移除节点。'."\n" + .'- `cluster_node_drain`：清空节点。'."\n" + .'- `cluster_modify`：修改集群。'."\n" + .'- `cluster_configuration_modify`：修改集群管控配置。'."\n" + .'- `cluster_addon_install`：安装组件。'."\n" + .'- `cluster_addon_upgrade`：升级组件。'."\n" + .'- `cluster_addon_uninstall`：卸载组件。'."\n" + .'- `runtime_upgrade`：升级运行时。'."\n" + .'- `nodepool_upgrade`：升级节点池。'."\n" + .'- `nodepool_update`：更新节点池。', + 'type' => 'string', + 'required' => false, + 'example' => 'nodepool_upgrade', + ], + ], + [ + 'name' => 'page_size', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '每页显示的最大结果数。'."\n" + ."\n" + .'取值范围：[1,100]。'."\n" + ."\n" + .'默认值：50。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'page_number', + 'in' => 'query', + 'schema' => [ + 'title' => '没页记录数量', + 'description' => '分页查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体参数', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'events' => [ + 'description' => '事件详情。', + 'type' => 'array', + 'items' => [ + 'description' => '事件详情。', + 'type' => 'object', + 'properties' => [ + 'event_id' => [ + 'title' => '事件ID', + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'e-dba703c8-953b-40d8-82e8-cb713590****', + ], + 'type' => [ + 'title' => '事件类型', + 'description' => '事件类型。取值：'."\n" + .'- `cluster_create`：创建集群。'."\n" + .'- `cluster_scaleout`：扩容集群。'."\n" + .'- `cluster_attach`：添加已有节点。'."\n" + .'- `cluster_delete`：删除集群。'."\n" + .'- `cluster_upgrade`：升级集群。'."\n" + .'- `cluster_migrate`：迁移集群。'."\n" + .'- `cluster_node_delete`：移除节点。'."\n" + .'- `cluster_node_drain`：清空节点。'."\n" + .'- `cluster_modify`：修改集群。'."\n" + .'- `cluster_configuration_modify`：修改集群管控配置。'."\n" + .'- `cluster_addon_install`：安装组件。'."\n" + .'- `cluster_addon_upgrade`：升级组件。'."\n" + .'- `cluster_addon_uninstall`：卸载组件。'."\n" + .'- `runtime_upgrade`：升级运行时。'."\n" + .'- `nodepool_upgrade`：升级节点池。'."\n" + .'- `nodepool_update`：更新节点池。', + 'type' => 'string', + 'example' => 'nodepool_upgrade', + ], + 'source' => [ + 'title' => '事件源', + 'description' => '事件来源。', + 'type' => 'string', + 'example' => 'task', + ], + 'subject' => [ + 'title' => '事件', + 'description' => '事件主体。', + 'type' => 'string', + 'example' => 'np6a5c86f4ecae436f8f4a3dc034a7****', + ], + 'time' => [ + 'title' => '事件开始事件', + 'description' => '事件开始时间。', + 'type' => 'string', + 'example' => '2025-04-23T20:48:01+08:00', + ], + 'cluster_id' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cf62854ac2130470897be7a27ed1f****', + ], + 'data' => [ + 'title' => '事件描述', + 'description' => '事件描述。', + 'type' => 'object', + 'properties' => [ + 'level' => [ + 'title' => '事件级别', + 'description' => '事件等级。取值范围：'."\n" + .'- info：提示。'."\n" + .'- warning：警告。'."\n" + .'- error：错误。', + 'type' => 'string', + 'example' => 'info', + ], + 'reason' => [ + 'title' => '事件状态', + 'description' => '事件状态。', + 'type' => 'string', + 'example' => 'Started', + ], + 'message' => [ + 'title' => '事件详情', + 'description' => '事件详情。', + 'type' => 'string', + 'example' => 'Start to upgrade NodePool nodePool/nodePool-A', + ], + ], + ], + ], + ], + ], + 'page_info' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'page_size' => [ + 'title' => '页数', + 'description' => '每页显示的最大结果数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'page_number' => [ + 'title' => '每页记录数量', + 'description' => '分页查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'total_count' => [ + 'title' => '结果总数', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"events\\": [\\n {\\n \\"event_id\\": \\"e-dba703c8-953b-40d8-82e8-cb713590****\\",\\n \\"type\\": \\"nodepool_upgrade\\",\\n \\"source\\": \\"task\\",\\n \\"subject\\": \\"np6a5c86f4ecae436f8f4a3dc034a7****\\",\\n \\"time\\": \\"2025-04-23T20:48:01+08:00\\",\\n \\"cluster_id\\": \\"cf62854ac2130470897be7a27ed1f****\\",\\n \\"data\\": {\\n \\"level\\": \\"info\\",\\n \\"reason\\": \\"Started\\",\\n \\"message\\": \\"Start to upgrade NodePool nodePool/nodePool-A\\"\\n }\\n }\\n ],\\n \\"page_info\\": {\\n \\"page_size\\": 50,\\n \\"page_number\\": 1,\\n \\"total_count\\": 3\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeEventsResponse>\\n <events>\\n <event_id>A234-1234-1234</event_id>\\n <type>nodepool_upgrade</type>\\n <source>/clusters/cf62854ac2130470897be7a27ed1f****/nodepools</source>\\n <subject>nodePool-id</subject>\\n <time>2022-11-23T20:48:01+08:00</time>\\n <cluster_id>cluster-id</cluster_id>\\n <data>\\n <level>info</level>\\n <reason>Started</reason>\\n <message>Start to upgrade NodePool nodePool/nodePool-A</message>\\n </data>\\n </events>\\n <page_info>\\n <page_size>50</page_size>\\n <page_number>1</page_number>\\n <total_count>3</total_count>\\n </page_info>\\n</DescribeEventsResponse>","errorExample":""}]', + 'title' => '查询事件详情', + ], + 'DescribeClusterEvents' => [ + 'summary' => '集群操作事件包括集群创建、集群变更、节点池创建、节点池扩容、Addon安装、集群升级等。您可以调用DescribeClusterEvents接口，获取指定集群中发生的事件列表，并查询事件的详细信息，包括事件级别、时间状态、时间发生时间等。', + 'path' => '/clusters/{ClusterId}/events', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'page_size', + 'in' => 'query', + 'schema' => [ + 'title' => '每页大小。', + 'description' => '每页显示的最大结果数。'."\n" + ."\n" + .'取值范围：[1,100]。'."\n" + ."\n" + .'默认值：50。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'page_number', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页数。', + 'description' => '分页页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'task_id', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'T-6823f946ffadbb0106****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => '返回体参数。', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'events' => [ + 'title' => '事件列表。', + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'event_id' => [ + 'title' => '事件ID。', + 'description' => '事件ID。', + 'type' => 'string', + 'example' => 'e-9ad04f72-8ee7-46bf-a02c-e4a06b39****', + ], + 'type' => [ + 'title' => '事件类型。', + 'description' => '事件类型。取值：'."\n" + ."\n" + .'- cluster_create：创建集群。'."\n" + .'- cluster_scaleout：扩容集群。'."\n" + .'- cluster_attach：添加已有节点。'."\n" + .'- cluster_delete：删除集群。'."\n" + .'- cluster_upgrade：升级集群。'."\n" + .'- cluster_migrate：迁移集群。'."\n" + .'- cluster_node_delete：移除节点。'."\n" + .'- cluster_node_drain：清空节点。'."\n" + .'- cluster_modify：修改集群。'."\n" + .'- cluster_configuration_modify：修改集群管控配置。'."\n" + .'- cluster_addon_install：安装组件。'."\n" + .'- cluster_addon_upgrade：升级组件。'."\n" + .'- cluster_addon_uninstall：卸载组件。'."\n" + .'- runtime_upgrade：升级运行时。'."\n" + .'- nodepool_upgrade：升级节点池。'."\n" + .'- nodepool_update：更新节点池。', + 'type' => 'string', + 'example' => 'nodepool_update', + ], + 'source' => [ + 'title' => '事件源。', + 'description' => '事件源。', + 'type' => 'string', + 'example' => 'task', + ], + 'subject' => [ + 'title' => '事件子项。', + 'description' => '事件关联的操作对象。', + 'type' => 'string', + 'example' => 'npdd89dc2b76c04f14b06774883b******', + ], + 'time' => [ + 'title' => '事件开始时间。', + 'description' => '事件开始时间。', + 'type' => 'string', + 'example' => '2025-05-14T10:00:56+08:00', + ], + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + 'data' => [ + 'title' => '事件描述。', + 'description' => '事件描述。', + 'type' => 'object', + 'properties' => [ + 'level' => [ + 'title' => '事件级别。', + 'description' => '事件级别。', + 'type' => 'string', + 'enumValueTitles' => [ + 'warning' => 'warning', + 'error' => 'error', + 'info' => 'info', + ], + 'example' => 'info', + ], + 'reason' => [ + 'title' => '事件状态。', + 'description' => '事件状态。', + 'type' => 'string', + 'example' => 'Started', + ], + 'message' => [ + 'title' => '事件详情。', + 'description' => '事件详情。', + 'type' => 'string', + 'example' => 'Start to upgrade NodePool nodePool/npdd89dc2b76c04f14b06774883b******', + ], + ], + ], + ], + ], + ], + 'page_info' => [ + 'title' => '分页信息。', + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'page_size' => [ + 'title' => '每页大小。', + 'description' => '每页显示的最大结果数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '50', + ], + 'page_number' => [ + 'title' => '分页页数。', + 'description' => '分页页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'total_count' => [ + 'title' => '结果总数。', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '126', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"events\\": [\\n {\\n \\"event_id\\": \\"e-9ad04f72-8ee7-46bf-a02c-e4a06b39****\\",\\n \\"type\\": \\"nodepool_update\\",\\n \\"source\\": \\"task\\",\\n \\"subject\\": \\"npdd89dc2b76c04f14b06774883b******\\",\\n \\"time\\": \\"2025-05-14T10:00:56+08:00\\",\\n \\"cluster_id\\": \\"c82e6987e2961451182edacd74faf****\\",\\n \\"data\\": {\\n \\"level\\": \\"info\\",\\n \\"reason\\": \\"Started\\",\\n \\"message\\": \\"Start to upgrade NodePool nodePool/npdd89dc2b76c04f14b06774883b******\\"\\n }\\n }\\n ],\\n \\"page_info\\": {\\n \\"page_size\\": 50,\\n \\"page_number\\": 1,\\n \\"total_count\\": 126\\n }\\n}","type":"json"}]', + 'title' => '查询指定集群的事件', + ], + 'DescribeTaskInfo' => [ + 'summary' => '您可以调用DescribeTaskInfo接口，查询集群任务的详细信息，例如任务类型、运行状态、运行阶段等。', + 'path' => '/tasks/{task_id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'chargeType' => 'free', + 'abilityTreeCode' => '6923', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'task_id', + 'in' => 'path', + 'schema' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'T-5faa48fb31b6b8078d00****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回体参数。', + 'description' => '返回体数据。', + 'type' => 'object', + 'properties' => [ + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-5faa48fb31b6b8078d000006', + ], + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c78592bfe92244365b3c3ad47f1de****', + ], + 'task_type' => [ + 'title' => '当前任务类型。', + 'description' => '任务类型，扩容任务的类型为`cluster_scaleout`。', + 'type' => 'string', + 'example' => 'cluster_scaleout', + ], + 'state' => [ + 'title' => '任务当前状态。', + 'description' => '代表任务的运行状态。取值：'."\n" + .'- `running`：任务正在运行中。'."\n" + .'- `fail`：任务运行失败。'."\n" + .'- `success`：任务运行完成。'."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'created' => [ + 'title' => '任务创建时间。', + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '2020-11-10T16:02:04+08:00', + ], + 'updated' => [ + 'title' => '任务更新时间。', + 'description' => '任务更新时间。', + 'type' => 'string', + 'example' => '2020-11-10T16:03:06+08:00', + ], + 'target' => [ + 'title' => '任务执行对象。', + 'description' => '任务执行对象。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '任务执行对象ID。', + 'description' => '任务执行对象ID。', + 'type' => 'string', + 'example' => 'c78592bfe92244365b3c3ad47f1de****'."\n", + ], + 'type' => [ + 'title' => '任务执行对象类型。', + 'description' => '任务执行对象类型。', + 'type' => 'string', + 'example' => 'cluster', + ], + ], + ], + 'parameters' => [ + 'title' => '任务参数。', + 'description' => '任务参数。', + 'type' => 'object', + ], + 'stages' => [ + 'title' => '任务阶段。', + 'description' => '任务阶段。', + 'type' => 'array', + 'items' => [ + 'description' => '任务阶段。', + 'type' => 'object', + 'properties' => [ + 'state' => [ + 'title' => '任务阶段状态。', + 'description' => '任务阶段状态。', + 'type' => 'string', + 'example' => 'running', + ], + 'start_time' => [ + 'title' => '任务阶段开始时间。', + 'description' => '任务阶段开始时间。', + 'type' => 'string', + 'example' => '2022-12-15 23:00:00', + ], + 'end_time' => [ + 'title' => '任务阶段结束时间。', + 'description' => '任务阶段结束时间。', + 'type' => 'string', + 'example' => '2022-12-15 23:00:00', + ], + 'message' => [ + 'title' => '任务阶段信息。', + 'description' => '任务阶段信息。', + 'type' => 'string', + 'example' => 'success to xxxxx', + ], + 'outputs' => [ + 'title' => '任务阶段输出。', + 'description' => '任务阶段输出。', + 'type' => 'object', + ], + ], + ], + ], + 'current_stage' => [ + 'title' => '任务当前运行阶段。', + 'description' => '任务当前运行阶段。', + 'type' => 'string', + 'example' => 'DrainNodes', + ], + 'events' => [ + 'title' => '任务产生的事件。', + 'description' => '任务产生的事件。', + 'type' => 'array', + 'items' => [ + 'description' => '事件详情。', + 'type' => 'object', + 'properties' => [ + 'action' => [ + 'title' => '事件动作。', + 'description' => '事件动作。', + 'type' => 'string', + 'example' => 'start', + ], + 'level' => [ + 'title' => '事件等级。', + 'description' => '事件等级。', + 'type' => 'string', + 'example' => 'Normal', + ], + 'message' => [ + 'title' => '事件消息。', + 'description' => '事件消息。', + 'type' => 'string', + 'example' => 'start to xxx', + ], + 'reason' => [ + 'title' => '事件原因。', + 'description' => '事件原因。', + 'type' => 'string', + 'example' => 'NodePoolUpgradeStart', + ], + 'source' => [ + 'title' => '事件来源。', + 'description' => '事件来源。', + 'type' => 'string', + 'example' => 'ACK', + ], + 'timestamp' => [ + 'title' => '事件生成时间。', + 'description' => '事件生成时间。', + 'type' => 'string', + 'example' => '1669706229286', + ], + ], + ], + ], + 'task_result' => [ + 'title' => '任务执行详情。', + 'description' => '任务执行详情。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'data' => [ + 'title' => '操作的资源，例如：实例ID。', + 'description' => '任务操作的资源，例如：扩容时操作资源是实例，那么此处就是实例ID。', + 'type' => 'string', + 'example' => 'i-xxx', + ], + 'status' => [ + 'title' => '资源的状态。', + 'description' => '资源扩容的状态。取值：'."\n" + .'- `success`：扩容成功。'."\n" + .'- `failed`：扩容失败。'."\n" + .'- `initial`：初始化中。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + 'error' => [ + 'title' => '任务错误信息。', + 'description' => '任务错误信息。', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'title' => '错误码。', + 'description' => '错误码。', + 'type' => 'string', + 'example' => '400', + ], + 'message' => [ + 'title' => '错误消息。', + 'description' => '错误消息。', + 'type' => 'string', + 'example' => 'failed to xxx', + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"task_id\\": \\"T-5faa48fb31b6b8078d000006\\",\\n \\"cluster_id\\": \\"c78592bfe92244365b3c3ad47f1de****\\",\\n \\"task_type\\": \\"cluster_scaleout\\",\\n \\"state\\": \\"running\\",\\n \\"created\\": \\"2020-11-10T16:02:04+08:00\\",\\n \\"updated\\": \\"2020-11-10T16:03:06+08:00\\",\\n \\"target\\": {\\n \\"id\\": \\"c78592bfe92244365b3c3ad47f1de****\\\\n\\",\\n \\"type\\": \\"cluster\\"\\n },\\n \\"parameters\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"stages\\": [\\n {\\n \\"state\\": \\"running\\",\\n \\"start_time\\": \\"2022-12-15 23:00:00\\",\\n \\"end_time\\": \\"2022-12-15 23:00:00\\",\\n \\"message\\": \\"success to xxxxx\\",\\n \\"outputs\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ],\\n \\"current_stage\\": \\"DrainNodes\\",\\n \\"events\\": [\\n {\\n \\"action\\": \\"start\\",\\n \\"level\\": \\"Normal\\",\\n \\"message\\": \\"start to xxx\\",\\n \\"reason\\": \\"NodePoolUpgradeStart\\",\\n \\"source\\": \\"ACK\\",\\n \\"timestamp\\": \\"1669706229286\\"\\n }\\n ],\\n \\"task_result\\": [\\n {\\n \\"data\\": \\"i-xxx\\",\\n \\"status\\": \\"success\\"\\n }\\n ],\\n \\"error\\": {\\n \\"code\\": \\"400\\",\\n \\"message\\": \\"failed to xxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<cluster_id>c78592bfe92244365b3c3ad47f1de****</cluster_id>\\n<task_id>T-5faa48fb31b6b8078d000006</task_id>\\n<created>2020-11-10T16:02:04+08:00</created>\\n<updated>2020-11-10T16:03:06+08:00</updated>\\n<state>running</state>\\n<task_type>cluster_scaleout</task_type>\\n<task_result>\\n <data>i-xxx</data>\\n <status>success</status>\\n</task_result>","errorExample":""}]', + 'title' => '查询任务详情', + ], + 'PauseTask' => [ + 'summary' => '您可以调用PauseTask接口，暂停执行中的集群任务。', + 'path' => '/tasks/{task_id}/pause', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'chargeType' => 'free', + 'abilityTreeCode' => '124838', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'task_id', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'T-62a944794ee141074400****', + ], + ], + ], + 'responses' => [ + 202 => [], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '暂停任务', + ], + 'ResumeTask' => [ + 'summary' => '您可以调用ResumeTask接口，恢复已暂停的集群任务。', + 'path' => '/tasks/{task_id}/resume', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'task_id', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'T-62a944794ee141074400****', + ], + ], + ], + 'responses' => [ + 202 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '恢复任务', + ], + 'CancelTask' => [ + 'summary' => '您可以调用CancelTask接口，取消集群任务的执行。', + 'path' => '/tasks/{task_id}/cancel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'task_id', + 'in' => 'path', + 'schema' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'T-62ccd14aacb8db06ca00****', + ], + ], + ], + 'responses' => [ + 202 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '取消任务', + ], + 'DescribeClusterTasks' => [ + 'summary' => '您可以调用DescribeClusterTasks接口，查询集群下的任务列表。', + 'path' => '/clusters/{cluster_id}/tasks', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群id。', + 'description' => '集群id。', + 'type' => 'string', + 'required' => false, + 'example' => 'c23421cfa74454bc8b37163fd19af****', + ], + ], + [ + 'name' => 'page_size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'page_number', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'page_info' => [ + 'title' => '分页信息。', + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'page_size' => [ + 'title' => '每页数量。', + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'page_number' => [ + 'title' => '页数。', + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'total_count' => [ + 'title' => '结果总数。', + 'description' => '结果总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'tasks' => [ + 'title' => '任务数组。', + 'description' => '任务数组。', + 'type' => 'array', + 'items' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'task_id' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'install-addons-c3xxxxxx', + ], + 'task_type' => [ + 'title' => '任务类型。', + 'description' => '任务类型。', + 'type' => 'string', + 'example' => 'cluster_addon_install', + ], + 'state' => [ + 'title' => '任务状态。', + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'created' => [ + 'title' => '创建时间。', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-08-03T10:11:33+08:00', + ], + 'updated' => [ + 'title' => '更新时间。', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-08-03T10:12:03.482+08:00', + ], + 'error' => [ + 'description' => '任务错误信息。', + 'type' => 'object', + 'properties' => [ + 'message' => [ + 'title' => '错误信息。', + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Addon status not match', + ], + 'code' => [ + 'title' => '错误码。', + 'description' => '错误码。', + 'type' => 'string', + 'example' => 'BadRequest', + ], + ], + ], + ], + ], + ], + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0527ac9a-c899-4341-a21a-xxxxxxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"page_info\\": {\\n \\"page_size\\": 10,\\n \\"page_number\\": 1,\\n \\"total_count\\": 10\\n },\\n \\"tasks\\": [\\n {\\n \\"task_id\\": \\"install-addons-c3xxxxxx\\",\\n \\"task_type\\": \\"cluster_addon_install\\",\\n \\"state\\": \\"success\\",\\n \\"created\\": \\"2022-08-03T10:11:33+08:00\\",\\n \\"updated\\": \\"2022-08-03T10:12:03.482+08:00\\",\\n \\"error\\": {\\n \\"message\\": \\"Addon status not match\\",\\n \\"code\\": \\"BadRequest\\"\\n }\\n }\\n ],\\n \\"requestId\\": \\"0527ac9a-c899-4341-a21a-xxxxxxxxx\\"\\n}","type":"json"}]', + 'title' => '查询集群任务列表', + ], + 'ListOperationPlansForRegion' => [ + 'summary' => '查询指定地域内最近100条自动运维执行计划列表。开启集群智能托管模式Auto Mode、集群自动升级、节点池自动化运维等功能时，您可以通过该接口查询由系统自动生成的运维计划及其执行情况，例如集群升级、节点池CVE修复等。', + 'path' => '/regions/{region_id}/operation/plans', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'region_id', + 'in' => 'path', + 'schema' => [ + 'title' => '地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => [ + 'title' => '按集群ID过滤。', + 'description' => '按集群ID过滤。', + 'type' => 'string', + 'required' => false, + 'example' => 'c02b3e03be10643e8a644a843ffcb****', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'title' => '按执行计划类型过滤。', + 'description' => '按执行计划类型过滤。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CVE_FIX' => 'CVE_FIX', + 'CONTAINERD_UPGRADE' => 'CONTAINERD_UPGRADE', + 'CLUSTER_UPGRADE_MASTER' => 'CLUSTER_UPGRADE_MASTER', + 'CLUSTER_UPGRADE_ADDON' => 'CLUSTER_UPGRADE_ADDON', + 'NODEPOOL_CONFIG' => 'NODEPOOL_CONFIG', + 'KUBELET_UPGRADE' => 'KUBELET_UPGRADE', + 'NODEPOOL_UPDATE_OS' => 'NODEPOOL_UPDATE_OS', + 'IMAGE_UPGRADE' => 'IMAGE_UPGRADE', + ], + 'example' => 'CLUSTER_UPGRADE_MASTER', + ], + ], + [ + 'name' => 'state', + 'in' => 'query', + 'schema' => [ + 'title' => '按执行计划状态过滤。', + 'description' => '按执行计划状态过滤。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Scheduled' => '已编排计划', + 'Failed' => '执行失败', + 'ValidatingFailed' => '执行前检查失败', + 'Executing' => '执行中', + 'Canceled' => '已取消', + 'Executed' => '已执行', + ], + 'example' => 'Scheduled', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'plans' => [ + 'title' => '执行计划列表。', + 'description' => '执行计划列表。', + 'type' => 'array', + 'items' => [ + 'title' => '执行计划。', + 'description' => '执行计划。', + 'type' => 'object', + 'properties' => [ + 'plan_id' => [ + 'title' => '执行计划ID。', + 'description' => '执行计划ID。', + 'type' => 'string', + 'example' => 'P-655c9c127e0e6603ef00****', + ], + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c29ced64b3dfe4f33b57ca0aa9f68****', + ], + 'created' => [ + 'title' => '执行计划创建时间。', + 'description' => '执行计划创建时间。', + 'type' => 'string', + 'example' => '2023-11-21T20:01:22+08:00', + ], + 'start_time' => [ + 'title' => '预期开始执行时间。', + 'description' => '预期开始执行时间。', + 'type' => 'string', + 'example' => '2023-11-22T15:18:00+08:00', + ], + 'end_time' => [ + 'title' => '预期结束执行时间。', + 'description' => '预期结束执行时间。', + 'type' => 'string', + 'example' => '2023-11-22T18:00:00+08:00', + ], + 'state' => [ + 'title' => '状态。', + 'description' => '状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Scheduled' => '已编排计划', + 'Failed' => '执行失败', + 'ValidatingFailed' => '执行前检查失败', + 'Executing' => '执行中', + 'Canceled' => '已取消', + 'Executed' => '已执行', + ], + 'example' => 'Scheduled', + ], + 'state_reason' => [ + 'title' => '状态原因。', + 'description' => '状态原因。', + 'type' => 'object', + 'properties' => [ + 'code' => [ + 'title' => '代码。', + 'description' => '代码。', + 'type' => 'string', + 'example' => 'CanceledByUser', + ], + 'message' => [ + 'title' => '信息。', + 'description' => '信息。', + 'type' => 'string', + 'example' => 'plan has been canceled by user', + ], + ], + ], + 'type' => [ + 'title' => '类型。', + 'description' => '类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CVE_FIX' => 'CVE_FIX', + 'CONTAINERD_UPGRADE' => 'CONTAINERD_UPGRADE', + 'CLUSTER_UPGRADE_MASTER' => 'CLUSTER_UPGRADE_MASTER', + 'CLUSTER_UPGRADE_ADDON' => 'CLUSTER_UPGRADE_ADDON', + 'NODEPOOL_CONFIG' => 'NODEPOOL_CONFIG', + 'KUBELET_UPGRADE' => 'KUBELET_UPGRADE', + 'NODEPOOL_UPDATE_OS' => 'NODEPOOL_UPDATE_OS', + 'IMAGE_UPGRADE' => 'IMAGE_UPGRADE', + ], + 'example' => 'CLUSTER_UPGRADE_MASTER', + ], + 'target_type' => [ + 'title' => '执行目标类型。', + 'description' => '执行目标类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'cluster' => 'cluster', + 'nodepool' => 'nodepool', + 'addon' => 'addon', + ], + 'example' => 'cluster', + ], + 'target_id' => [ + 'title' => '执行目标ID。', + 'description' => '执行目标ID。', + 'type' => 'string', + 'example' => 'c29ced64b3dfe4f33b57ca0aa9f68****', + ], + 'task_id' => [ + 'title' => '执行计划产生的任务ID。', + 'description' => '执行计划产生的任务ID。', + 'type' => 'string', + 'example' => 'T-681ac448b23ced010600****', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"plans\\": [\\n {\\n \\"plan_id\\": \\"P-655c9c127e0e6603ef00****\\",\\n \\"cluster_id\\": \\"c29ced64b3dfe4f33b57ca0aa9f68****\\",\\n \\"created\\": \\"2023-11-21T20:01:22+08:00\\",\\n \\"start_time\\": \\"2023-11-22T15:18:00+08:00\\",\\n \\"end_time\\": \\"2023-11-22T18:00:00+08:00\\",\\n \\"state\\": \\"Scheduled\\",\\n \\"state_reason\\": {\\n \\"code\\": \\"CanceledByUser\\",\\n \\"message\\": \\"plan has been canceled by user\\"\\n },\\n \\"type\\": \\"CLUSTER_UPGRADE_MASTER\\",\\n \\"target_type\\": \\"cluster\\",\\n \\"target_id\\": \\"c29ced64b3dfe4f33b57ca0aa9f68****\\",\\n \\"task_id\\": \\"T-681ac448b23ced010600****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询指定地域自动运维任务执行计划列表', + ], + 'ListOperationPlans' => [ + 'summary' => '获取自动运维执行计划列表。', + 'path' => '/operation/plans', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '196741', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'query', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c29ced64b3dfe4f33b57ca0aa9f68****', + ], + ], + [ + 'name' => 'type', + 'in' => 'query', + 'schema' => [ + 'title' => '执行计划类型。', + 'description' => '执行计划类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'cluster_upgrade', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'plans' => [ + 'title' => '执行计划列表。', + 'description' => '执行计划列表。', + 'type' => 'array', + 'items' => [ + 'title' => '执行计划。', + 'description' => '执行计划。', + 'type' => 'object', + 'properties' => [ + 'plan_id' => [ + 'title' => '执行计划ID。', + 'description' => '执行计划ID。', + 'type' => 'string', + 'example' => 'P-655c9c127e0e6603ef00****', + ], + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c29ced64b3dfe4f33b57ca0aa9f68****', + ], + 'created' => [ + 'title' => '执行计划创建时间。', + 'description' => '执行计划创建时间。', + 'type' => 'string', + 'example' => '2023-11-21T20:01:22+08:00', + ], + 'start_time' => [ + 'title' => '预期开始执行时间。', + 'description' => '预期开始执行时间。', + 'type' => 'string', + 'example' => '2023-11-22T15:18:00+08:00', + ], + 'end_time' => [ + 'title' => '预期结束执行时间。', + 'description' => '预期结束执行时间。', + 'type' => 'string', + 'example' => '2023-11-22T18:00:00+08:00', + ], + 'state' => [ + 'title' => '状态。', + 'description' => '状态。取值：'."\n" + .'- scheduled：计划中'."\n" + .'- canceled：已取消', + 'type' => 'string', + 'example' => 'scheduled', + ], + 'type' => [ + 'title' => '类型。', + 'description' => '类型。取值：'."\n" + .'- cluster_upgrade：集群升级', + 'type' => 'string', + 'example' => 'cluster_upgrade', + ], + 'target_type' => [ + 'title' => '执行目标类型。', + 'description' => '执行目标类型。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'target_id' => [ + 'title' => '执行目标ID。', + 'description' => '执行目标ID。', + 'type' => 'string', + 'example' => 'c29ced64b3dfe4f33b57ca0aa9f68****', + ], + 'task_id' => [ + 'title' => '执行计划产生的任务ID。', + 'description' => '执行计划产生的任务ID。', + 'type' => 'string', + 'example' => 'T-6764d027be846d01310006b1', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"plans\\": [\\n {\\n \\"plan_id\\": \\"P-655c9c127e0e6603ef00****\\",\\n \\"cluster_id\\": \\"c29ced64b3dfe4f33b57ca0aa9f68****\\",\\n \\"created\\": \\"2023-11-21T20:01:22+08:00\\",\\n \\"start_time\\": \\"2023-11-22T15:18:00+08:00\\",\\n \\"end_time\\": \\"2023-11-22T18:00:00+08:00\\",\\n \\"state\\": \\"scheduled\\",\\n \\"type\\": \\"cluster_upgrade\\",\\n \\"target_type\\": \\"cluster\\",\\n \\"target_id\\": \\"c29ced64b3dfe4f33b57ca0aa9f68****\\",\\n \\"task_id\\": \\"T-6764d027be846d01310006b1\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListOperationPlansResponse>\\n <plans>\\n <plan_id>P-655c9c127e0e6603ef00****</plan_id>\\n <cluster_id>c29ced64b3dfe4f33b57ca0aa9f68****</cluster_id>\\n <created>2023-11-21T20:01:22+08:00</created>\\n <start_time>2023-11-22T15:18:00+08:00</start_time>\\n <end_time>2023-11-22T18:00:00+08:00</end_time>\\n <state>scheduled</state>\\n <type>cluster_upgrade</type>\\n <target_type>cluster</target_type>\\n <target_id>c29ced64b3dfe4f33b57ca0aa9f68****</target_id>\\n </plans>\\n</ListOperationPlansResponse>","errorExample":""}]', + 'title' => '查询自动运维任务执行计划列表', + ], + 'CancelOperationPlan' => [ + 'summary' => '使用CancelOperationPlan取消已存在但未执行的自动运维任务执行计划。', + 'path' => '/operation/plans/{plan_id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '196742', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'plan_id', + 'in' => 'path', + 'schema' => [ + 'title' => '执行计划ID。', + 'description' => '执行计划ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'P-655c9c127e0e6603ef00****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'db82195b-75a8-40e5-9be4-16f1829dc624', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"request_id\\": \\"db82195b-75a8-40e5-9be4-16f1829dc624\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelOperationPlanResponse>\\n <requestId>873DC52C-28AA-5A5C-938C-684D3D4B****</requestId>\\n</CancelOperationPlanResponse>","errorExample":""}]', + 'title' => '取消自动运维任务执行计划', + ], + 'GetUpgradeStatus' => [ + 'summary' => '根据集群ID，查询该集群的升级状态。', + 'path' => '/api/v2/clusters/{ClusterId}/upgrade/status', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '387', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c106f377e16f34eb1808d6b9362c9****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '集群升级状态详情。', + 'type' => 'object', + 'properties' => [ + 'error_message' => [ + 'title' => '错误信息描述。', + 'description' => '集群升级中的错误信息。', + 'type' => 'string', + 'example' => 'subject to actual return', + ], + 'precheck_report_id' => [ + 'title' => '预检查返回ID。', + 'description' => '预检查返回ID。', + 'type' => 'string', + 'example' => 'be4c8eb72de94d459ea7ace7c811d119', + ], + 'status' => [ + 'title' => '升级状态。', + 'description' => '集群目前升级的状态。取值：'."\n" + ."\n" + .'- `success` : 升级成功。'."\n" + .'- `fail` : 升级失败。'."\n" + .'- `pause` : 升级暂停。'."\n" + .'- `running` : 升级进行中。', + 'type' => 'string', + 'example' => 'running', + ], + 'upgrade_step' => [ + 'title' => '升级任务执行到哪一步了。', + 'description' => '集群目前升级的阶段。取值：'."\n" + ."\n" + .'- `not_start` : 暂未开始。'."\n" + .'- `prechecking` : 预检查中。'."\n" + .'- `upgrading`: 升级中。'."\n" + .'- `pause` : 暂停中。'."\n" + .'- `success` : 升级成功。', + 'type' => 'string', + 'example' => 'prechecking', + ], + 'upgrade_task' => [ + 'title' => '升级任务详情。', + 'description' => '升级任务详情。', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '任务状态： emptry、running、success、failed', + 'description' => '升级任务状态。取值：'."\n" + .'- `running`: 执行中。'."\n" + .'- `Success`: 执行成功。'."\n" + .'- `Failed`: 执行失败。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'running', + ], + 'message' => [ + 'title' => '任务描述信息。', + 'description' => '升级任务描述信息。', + 'type' => 'string', + 'example' => 'subject to actual return', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::DescribeTaskInfo', + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"error_message\\": \\"subject to actual return\\",\\n \\"precheck_report_id\\": \\"be4c8eb72de94d459ea7ace7c811d119\\",\\n \\"status\\": \\"running\\",\\n \\"upgrade_step\\": \\"prechecking\\",\\n \\"upgrade_task\\": {\\n \\"status\\": \\"running\\",\\n \\"message\\": \\"subject to actual return\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetUpgradeStatusResponse>\\n <error_message>subject to actual return</error_message>\\n <precheck_report_id>be4c8eb72de94d459ea7ace7c811d119</precheck_report_id>\\n <status>running</status>\\n <upgrade_step>prechecking</upgrade_step>\\n <upgrade_task>\\n <status>running</status>\\n <message>subject to actual return</message>\\n </upgrade_task>\\n</GetUpgradeStatusResponse>","errorExample":""}]', + 'title' => '（已废弃）查询集群升级状态', + ], + 'PauseClusterUpgrade' => [ + 'summary' => '暂停用户集群升级。', + 'path' => '/api/v2/clusters/{ClusterId}/upgrade/pause', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '580', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::PauseTask', + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '（已废弃）暂停集群升级', + ], + 'CancelClusterUpgrade' => [ + 'summary' => '取消处于升级状态的ACK集群。', + 'path' => '/api/v2/clusters/{ClusterId}/upgrade/cancel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '414', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c106f377e16f34eb1808d6b9362c9****', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::CancelTask', + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '（已废弃）取消集群升级', + ], + 'ResumeUpgradeCluster' => [ + 'summary' => '根据集群ID，恢复升级处于升级暂停状态的集群。', + 'path' => '/api/v2/clusters/{ClusterId}/upgrade/resume', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::ResumeTask', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '（已废弃）重新开始集群升级', + ], + 'DescribeAddons' => [ + 'summary' => '查询平台支持的所有组件的详情。', + 'path' => '/clusters/components/metadata', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'region', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID。', + 'description' => '集群所在地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'cluster_type', + 'in' => 'query', + 'schema' => [ + 'title' => '集群类型。 - Kubernetes: 专有版集群。 - ManagedKubernetes：托管版集群。 - Ask：Serverless 集群。 - ExternalKubernetes：注册到ACK的外部集群。', + 'description' => '- `Kubernetes`: ACK专有集群。'."\n" + ."\n" + .'- `ManagedKubernetes`：ACK托管类的集群，包括ACK托管集群（ACK集群Pro版、ACK集群基础版）、ACK Serverless集群（Pro版、基础版）、ACK Edge集群（Pro版、基础版）、ACK灵骏集群（Pro版）。'."\n" + ."\n" + .'- `ExternalKubernetes`：注册集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'ManagedKubernetes', + ], + ], + [ + 'name' => 'cluster_profile', + 'in' => 'query', + 'schema' => [ + 'description' => '集群类型，取值：'."\n" + .'- `Default`：托管版集群。'."\n" + .'- `Serverless`：Serverless集群。'."\n" + .'- `Edge`：边缘集群。', + 'type' => 'string', + 'required' => false, + 'example' => 'Default', + ], + ], + [ + 'name' => 'cluster_spec', + 'in' => 'query', + 'schema' => [ + 'description' => '当您选择`cluster_type`为`ManagedKubernetes`并配置`profile`后，您可以进一步指定集群的规格。'."\n" + ."\n" + .'- `ack.pro.small`：集群Pro版。'."\n" + ."\n" + .'- `ack.standard`：集群基础版（取值为空时默认选择）。', + 'type' => 'string', + 'required' => false, + 'example' => 'ack.pro.small', + ], + ], + [ + 'name' => 'cluster_version', + 'in' => 'query', + 'schema' => [ + 'description' => '集群版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.24.6-aliyun.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回体参数。', + 'type' => 'object', + 'properties' => [ + 'ComponentGroups' => [ + 'title' => '组件分组信息，例如：存储类组件，网络组件等。', + 'description' => '组件分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '组件分组详情。', + 'type' => 'object', + 'properties' => [ + 'group_name' => [ + 'title' => '组件组名称。', + 'description' => '组件分组名称。', + 'type' => 'string', + 'example' => 'storage', + ], + 'items' => [ + 'title' => '组件列表', + 'description' => '该分组内包含的组件名称。', + 'type' => 'array', + 'items' => [ + 'description' => '组件详情。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'flexvolume', + ], + ], + ], + ], + ], + ], + ], + 'StandardComponents' => [ + 'title' => '标准组件信息，包含各个组件的描述信息。', + 'description' => '标准组件。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'ack-arena', + ], + 'version' => [ + 'title' => '组件版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => '0.5.0', + ], + 'description' => [ + 'title' => '组件描述信息。', + 'description' => '组件功能说明。', + 'type' => 'string', + 'example' => '***', + ], + 'required' => [ + 'title' => '是否为必需组件。', + 'description' => '是否为集群必需组件。取值：'."\n" + ."\n" + .'- `true`：必需组件，集群创建时必须要安装的组件。'."\n" + ."\n" + .'- `false`：非必需组件，集群创建完成后，可通过`组件管理`进行安装。'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'disabled' => [ + 'title' => '是否禁止默认安装。', + 'description' => '是否禁止默认安装，集群创建时除了安装集群所需的组件外，还会额外安装一些与日志或者路由相关的组件（例如：Ingress），如果您不想默认安装，可通过设置该字段禁止默认安装。取值：'."\n" + ."\n" + .'- `true`：禁止默认安装。'."\n" + .'- `false`：默认安装。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '标准组件的详细信息。', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::ListAddons', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ComponentGroups\\": [\\n {\\n \\"group_name\\": \\"storage\\",\\n \\"items\\": [\\n {\\n \\"name\\": \\"flexvolume\\"\\n }\\n ]\\n }\\n ],\\n \\"StandardComponents\\": {\\n \\"key\\": {\\n \\"name\\": \\"ack-arena\\",\\n \\"version\\": \\"0.5.0\\",\\n \\"description\\": \\"***\\",\\n \\"required\\": \\"false\\",\\n \\"disabled\\": false\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<StandardComponents>\\n <cloud-controller-manager>\\n <name>cloud-controller-manager</name>\\n <version>v1.9.3.339-g9830b58-aliyun</version>\\n <disabled>false</disabled>\\n <required>true</required>\\n <description>name: Cloud Controller Manager introduction: Using Cloud Controller Manager to create load balancers for k8s applications and manage node route entries doc:en: https://www.alibabacloud.com/help/doc-detail/94925.htm</description>\\n </cloud-controller-manager>\\n <csi-plugin>\\n <name>csi-plugin</name>\\n <version>v1.16.9.43-f36bb540-aliyun</version>\\n <disabled>false</disabled>\\n <required>false</required>\\n <description>csi-plugin</description>\\n </csi-plugin>\\n</StandardComponents>\\n<ComponentGroups>\\n <group_name>storage</group_name>\\n <items>\\n <name>flexvolume</name>\\n </items>\\n <items>\\n <name>alicloud-disk-controller</name>\\n </items>\\n <items>\\n <name>csi-plugin</name>\\n </items>\\n <items>\\n <name>csi-provisioner</name>\\n </items>\\n</ComponentGroups>\\n<ComponentGroups>\\n <group_name>network</group_name>\\n <items>\\n <name>kube-flannel-ds</name>\\n </items>\\n <items>\\n <name>terway</name>\\n </items>\\n <items>\\n <name>terway-eni</name>\\n </items>\\n <items>\\n <name>terway-eniip</name>\\n </items>\\n <items>\\n <name>nginx-ingress-controller</name>\\n </items>\\n <items>\\n <name>coredns</name>\\n </items>\\n <items>\\n <name>managed-kube-proxy</name>\\n </items>\\n</ComponentGroups>","errorExample":""}]', + 'title' => '（已废弃）查询集群组件详情', + ], + 'DescribeClusterAddonsVersion' => [ + 'summary' => '根据集群ID，查询集群中已安装的所有组件的详情。', + 'path' => '/clusters/{ClusterId}/components/version', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '402', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '组件版本信息。', + 'description' => '返回体参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'component_name' => [ + 'title' => '组件名称', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'ack-node-problem-detector', + ], + 'version' => [ + 'title' => '组件当前版本', + 'description' => '组件当前版本。'."\n" + ."\n" + .'> 如果`version`值不为空，则表示该组件已经安装。', + 'type' => 'string', + 'example' => '1.2.1', + ], + 'next_version' => [ + 'title' => '组件可升级版本', + 'description' => '下一个可升级版本。', + 'type' => 'string', + 'example' => '1.2.1', + ], + 'changed' => [ + 'title' => '组件是否升级过。', + 'description' => '组件是否有更新。取值：'."\n" + ."\n" + .'- `true`：已更新。'."\n" + .'- `false`：未更新。', + 'type' => 'string', + 'example' => 'false', + ], + 'can_upgrade' => [ + 'title' => '组件是否可以升级。', + 'description' => '组件是否可升级。取值：'."\n" + ."\n" + .'- `true`：组件可升级。'."\n" + .'- `false`：组件不可升级。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'policy' => [ + 'title' => '组件升级策略', + 'description' => '组件升级策略。'."\n" + ."\n" + .'- `overwrite`：强制覆盖。'."\n" + ."\n" + .'默认值：`overwrite`。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'overwrite', + ], + 'ready_to_upgrade' => [ + 'title' => '组件是否满足升级条件', + 'description' => '组件是否满足升级条件。取值：'."\n" + ."\n" + .'- `true`：满足升级条件。'."\n" + .'- `false`：不满足升级条件。', + 'type' => 'string', + 'example' => 'false', + ], + 'exist' => [ + 'title' => '组件是否已经存在', + 'description' => '是否可以在集群中安装该组件。取值：'."\n" + ."\n" + .'- `true`：可安装。'."\n" + .'- `false`：不可安装。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'required' => [ + 'title' => '组件是否为集群必需。', + 'description' => '组件是否为集群必需组件。取值：'."\n" + ."\n" + .'- `true`：为必需组件。'."\n" + .'- `false`：非必需组件。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'message' => [ + 'title' => '组件描述信息', + 'description' => '组件是否可升级的额外说明。', + 'type' => 'string', + 'example' => '节点故障检测以及上报至事件中心的插件', + ], + 'value' => [ + 'title' => '安装addon的时候，用户自定义的参数值。Yaml字符串。', + 'description' => '组件安装时，用户自定义的参数值。', + 'type' => 'string', + 'example' => 'npd:\\n # Custom monitor definitions to add to Node Problem Detector ****', + ], + ], + 'description' => '组件详情。', + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::ListClusterAddonInstances', + 'CS::2015-12-15::GetClusterAddonInstance', + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"key\\": {\\n \\"component_name\\": \\"ack-node-problem-detector\\",\\n \\"version\\": \\"1.2.1\\",\\n \\"next_version\\": \\"1.2.1\\",\\n \\"changed\\": \\"false\\",\\n \\"can_upgrade\\": false,\\n \\"policy\\": \\"overwrite\\",\\n \\"ready_to_upgrade\\": \\"false\\",\\n \\"exist\\": true,\\n \\"required\\": false,\\n \\"message\\": \\"节点故障检测以及上报至事件中心的插件\\",\\n \\"value\\": \\"npd:\\\\\\\\n # Custom monitor definitions to add to Node Problem Detector ****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<ack-node-problem-detector>\\n <exist>true</exist>\\n <component_name>ack-node-problem-detector</component_name>\\n <can_upgrade>false</can_upgrade>\\n <ready_to_upgrade>false</ready_to_upgrade>\\n <message>节点故障检测以及上报至事件中心的插件</message>\\n <version>1.2.1</version>\\n <value>npd:\\n # Custom monitor definitions to add to Node Problem Detector ****</value>\\n <required>false</required>\\n <next_version>1.2.1</next_version>\\n <changed>false</changed>\\n <policy>overwrite</policy>\\n</ack-node-problem-detector>","errorExample":""}]', + 'title' => '（已废弃）查询集群组件版本', + ], + 'DescribeClusterAddonInstance' => [ + 'summary' => '调用DescribeClusterAddonInstance查询已安装的集群组件的版本、状态和配置等信息。', + 'path' => '/clusters/{ClusterID}/components/{AddonName}/instance', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '170092', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterID', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cd06bbf8a86764a31bcac76136691****', + ], + ], + [ + 'name' => 'AddonName', + 'in' => 'path', + 'schema' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'terway-eniip', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'terway-eniip', + ], + 'version' => [ + 'title' => '组件版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'example' => 'v1.4.3', + ], + 'state' => [ + 'title' => '组件状态。', + 'description' => '组件状态：'."\n" + ."\n" + .'- initial：安装中'."\n" + .'- active：已安装'."\n" + .'- unhealthy：状态异常'."\n" + .'- upgrading：升级中'."\n" + .'- updating：变更中'."\n" + .'- deleting：卸载中'."\n" + .'- deleted：已删除', + 'type' => 'string', + 'example' => 'active', + 'enum' => [ + 'initial', + 'active', + 'unhealthy', + 'upgrading', + 'updating', + 'deleting', + 'deleted', + ], + ], + 'config' => [ + 'title' => '组件配置。', + 'description' => '组件配置。', + 'type' => 'string', + 'example' => '{"NetworkPolicy":"true"}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::GetClusterAddonInstance', + ], + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"name\\": \\"terway-eniip\\",\\n \\"version\\": \\"v1.4.3\\",\\n \\"state\\": \\"active\\",\\n \\"config\\": \\"{\\\\\\"NetworkPolicy\\\\\\":\\\\\\"true\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterAddonInstanceResponse>\\n <name>terway-eniip</name>\\n <version>v1.4.3</version>\\n <state>active</state>\\n <config>{\\"NetworkPolicy\\":\\"true\\"}</config>\\n</DescribeClusterAddonInstanceResponse>","errorExample":""}]', + 'title' => '（已废弃）查询集群组件实例信息', + ], + 'DescribeClusterAddonMetadata' => [ + 'summary' => '调用DescribeClusterAddonMetadata查询特定集群可使用的指定组件版本信息，包括组件版本、可配置参数等。', + 'path' => '/clusters/{cluster_id}/components/{component_id}/metadata', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '101052', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID', + 'type' => 'string', + 'required' => true, + 'example' => 'c71d616e629ff40d5b42d7bb87770****', + ], + ], + [ + 'name' => 'component_id', + 'in' => 'path', + 'schema' => [ + 'title' => '组件ID', + 'description' => '组件ID', + 'type' => 'string', + 'required' => true, + 'example' => 'coredns', + ], + ], + [ + 'name' => 'version', + 'in' => 'query', + 'schema' => [ + 'title' => '组件版本', + 'description' => '组件版本', + 'type' => 'string', + 'required' => false, + 'example' => '1.8.4.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '组件版本元数据', + 'description' => '组件版本元数据', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称', + 'description' => '组件名称', + 'type' => 'string', + 'example' => 'coredns', + ], + 'version' => [ + 'title' => '组件版本', + 'description' => '组件版本', + 'type' => 'string', + 'example' => '1.8.4.1', + ], + 'config_schema' => [ + 'title' => '组件参数Schema', + 'description' => '组件参数Schema', + 'type' => 'string', + 'example' => '{\\n \\"$schema\\": \\"https://json-schema.org/draft-07/schema#\\",\\n \\"properties\\": {\\n \\"controller\\": {\\n \\"description\\": \\"\\",\\n \\"properties\\": {\\n \\"resources\\": {\\n \\"properties\\": {\\n \\"armsPrometheusOperator\\": {\\n \\"properties\\": {\\n \\"resources\\": {\\n \\"properties\\": {\\n \\"limits\\": {\\n \\"properties\\": {\\n \\"memory\\": {\\n \\"description\\": \\"memory limit of arms prometheus operator\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^[1-9][0-9]*(\\\\\\\\.\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\",\\n \\"default\\": \\"500m\\",\\n \\"x-ui-description\\": \\"<mds-key>\\",\\n \\"x-ui-prompt-message\\": \\"<mds-key>\\",\\n \\"x-ui-validation-message\\": \\"<mds-key>\\",\\n \\"x-ui-additional-tips\\": \\"<mds-key>\\"\\n },\\n \\"cpu\\": {\\n \\"description\\": \\"cpu limit of arms prometheus operator\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^[1-9][0-9]*(m|\\\\\\\\.\\\\\\\\d+)?$\\",\\n \\"default\\": \\"1.0\\",\\n \\"x-ui-description\\": \\"<mds-key>\\",\\n \\"x-ui-validation-message\\": \\"<mds-key>\\"\\n }\\n },\\n \\"type\\": \\"object\\",\\n \\"additionalProperties\\": false\\n },\\n \\"requests\\": {\\n \\"properties\\": {\\n \\"memory\\": {\\n \\"description\\": \\"memory request of arms prometheus operator\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^[1-9][0-9]*(\\\\\\\\.\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\",\\n \\"default\\": \\"500m\\",\\n \\"x-ui-description\\": \\"<mds-key>\\",\\n \\"x-ui-validation-message\\": \\"<mds-key>\\"\\n },\\n \\"cpu\\": {\\n \\"description\\": \\"cpu request of arms prometheus operator\\",\\n \\"type\\": \\"string\\",\\n \\"pattern\\": \\"^[1-9][0-9]*(m|\\\\\\\\.\\\\\\\\d+)?$\\",\\n \\"default\\": \\"1.0\\",\\n \\"x-ui-description\\": \\"<mds-key>\\",\\n \\"x-ui-validation-message\\": \\"<mds-key>\\"\\n }\\n },\\n \\"type\\": \\"object\\",\\n \\"additionalProperties\\": false\\n }\\n },\\n \\"type\\": \\"object\\",\\n \\"additionalProperties\\": false\\n }\\n },\\n \\"type\\": \\"object\\",\\n \\"additionalProperties\\": false\\n }\\n },\\n \\"type\\": \\"object\\",\\n \\"additionalProperties\\": false\\n }\\n },\\n \\"type\\": \\"object\\",\\n \\"additionalProperties\\": false\\n }\\n },\\n \\"title\\": \\"Values\\",\\n \\"type\\": \\"object\\",\\n \\"additionalProperties\\": false\\n}', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::DescribeAddon', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"name\\": \\"coredns\\",\\n \\"version\\": \\"1.8.4.1\\",\\n \\"config_schema\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"$schema\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"https://json-schema.org/draft-07/schema#\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"controller\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"resources\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"armsPrometheusOperator\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"resources\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"limits\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"memory limit of arms prometheus operator\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"pattern\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"^[1-9][0-9]*(\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"default\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"500m\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-prompt-message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-validation-message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-additional-tips\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\"\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cpu limit of arms prometheus operator\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"pattern\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"^[1-9][0-9]*(m|\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\d+)?$\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"default\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-validation-message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\"\\\\\\\\n }\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"additionalProperties\\\\\\\\\\\\\\": false\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"requests\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"memory\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"memory request of arms prometheus operator\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"pattern\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"^[1-9][0-9]*(\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"default\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"500m\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-validation-message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\"\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"cpu\\\\\\\\\\\\\\": {\\\\\\\\n \\\\\\\\\\\\\\"description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"cpu request of arms prometheus operator\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"string\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"pattern\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"^[1-9][0-9]*(m|\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\d+)?$\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"default\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"1.0\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-description\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"x-ui-validation-message\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"<mds-key>\\\\\\\\\\\\\\"\\\\\\\\n }\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"additionalProperties\\\\\\\\\\\\\\": false\\\\\\\\n }\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"additionalProperties\\\\\\\\\\\\\\": false\\\\\\\\n }\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"additionalProperties\\\\\\\\\\\\\\": false\\\\\\\\n }\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"additionalProperties\\\\\\\\\\\\\\": false\\\\\\\\n }\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"additionalProperties\\\\\\\\\\\\\\": false\\\\\\\\n }\\\\\\\\n },\\\\\\\\n \\\\\\\\\\\\\\"title\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Values\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"object\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"additionalProperties\\\\\\\\\\\\\\": false\\\\\\\\n}\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterAddonMetadataResponse>\\n <name>coredns</name>\\n <version>1.8.4.1</version>\\n <config_schema>{\\\\n \\\\\\"$schema\\\\\\": \\\\\\"https://json-schema.org/draft-07/schema#\\\\\\",\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"controller\\\\\\": {\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"resources\\\\\\": {\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"armsPrometheusOperator\\\\\\": {\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"resources\\\\\\": {\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"limits\\\\\\": {\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"memory\\\\\\": {\\\\n \\\\\\"description\\\\\\": \\\\\\"memory limit of arms prometheus operator\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\",\\\\n \\\\\\"pattern\\\\\\": \\\\\\"^[1-9][0-9]*(\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\\\\\",\\\\n \\\\\\"default\\\\\\": \\\\\\"500m\\\\\\",\\\\n \\\\\\"x-ui-description\\\\\\": \\\\\\"<mds-key>\\\\\\",\\\\n \\\\\\"x-ui-prompt-message\\\\\\": \\\\\\"<mds-key>\\\\\\",\\\\n \\\\\\"x-ui-validation-message\\\\\\": \\\\\\"<mds-key>\\\\\\",\\\\n \\\\\\"x-ui-additional-tips\\\\\\": \\\\\\"<mds-key>\\\\\\"\\\\n },\\\\n \\\\\\"cpu\\\\\\": {\\\\n \\\\\\"description\\\\\\": \\\\\\"cpu limit of arms prometheus operator\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\",\\\\n \\\\\\"pattern\\\\\\": \\\\\\"^[1-9][0-9]*(m|\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+)?$\\\\\\",\\\\n \\\\\\"default\\\\\\": \\\\\\"1.0\\\\\\",\\\\n \\\\\\"x-ui-description\\\\\\": \\\\\\"<mds-key>\\\\\\",\\\\n \\\\\\"x-ui-validation-message\\\\\\": \\\\\\"<mds-key>\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\n \\\\\\"additionalProperties\\\\\\": false\\\\n },\\\\n \\\\\\"requests\\\\\\": {\\\\n \\\\\\"properties\\\\\\": {\\\\n \\\\\\"memory\\\\\\": {\\\\n \\\\\\"description\\\\\\": \\\\\\"memory request of arms prometheus operator\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\",\\\\n \\\\\\"pattern\\\\\\": \\\\\\"^[1-9][0-9]*(\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+)?(K|Ki|M|Mi|G|Gi|T|Ti)?$\\\\\\",\\\\n \\\\\\"default\\\\\\": \\\\\\"500m\\\\\\",\\\\n \\\\\\"x-ui-description\\\\\\": \\\\\\"<mds-key>\\\\\\",\\\\n \\\\\\"x-ui-validation-message\\\\\\": \\\\\\"<mds-key>\\\\\\"\\\\n },\\\\n \\\\\\"cpu\\\\\\": {\\\\n \\\\\\"description\\\\\\": \\\\\\"cpu request of arms prometheus operator\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\",\\\\n \\\\\\"pattern\\\\\\": \\\\\\"^[1-9][0-9]*(m|\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\d+)?$\\\\\\",\\\\n \\\\\\"default\\\\\\": \\\\\\"1.0\\\\\\",\\\\n \\\\\\"x-ui-description\\\\\\": \\\\\\"<mds-key>\\\\\\",\\\\n \\\\\\"x-ui-validation-message\\\\\\": \\\\\\"<mds-key>\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\n \\\\\\"additionalProperties\\\\\\": false\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\n \\\\\\"additionalProperties\\\\\\": false\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\n \\\\\\"additionalProperties\\\\\\": false\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\n \\\\\\"additionalProperties\\\\\\": false\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\n \\\\\\"additionalProperties\\\\\\": false\\\\n }\\\\n },\\\\n \\\\\\"title\\\\\\": \\\\\\"Values\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\n \\\\\\"additionalProperties\\\\\\": false\\\\n}</config_schema>\\n</DescribeClusterAddonMetadataResponse>","errorExample":""}]', + 'title' => '（已废弃）查询集群组件元数据', + ], + 'DescribeClusterAddonsUpgradeStatus' => [ + 'summary' => '根据组件名称查询该组件升级状态。', + 'path' => '/clusters/{ClusterId}/components/upgradestatus', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '498', + 'abilityTreeNodes' => [ + 'FEATUREcskGIIHWM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c23421cfa74454bc8b37163fd19af****', + ], + ], + [ + 'name' => 'componentIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '组件名称列表。', + 'description' => '组件名称列表。', + 'type' => 'array', + 'items' => [ + 'description' => '组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'metric-server', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => '组件升级详情', + 'description' => "\n" + .'返回数据体。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'addon_info' => [ + 'title' => '组件信息', + 'description' => '组件信息。', + 'type' => 'object', + 'properties' => [ + 'component_name' => [ + 'title' => '组件名称', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'cloud-controller-manager', + ], + 'version' => [ + 'title' => '组件版本', + 'description' => '组件当前版本。'."\n", + 'type' => 'string', + 'example' => 'v1.9.3.340-g9830b58-aliyun', + ], + 'ready_to_upgrade' => [ + 'title' => '组件是否满足升级条件', + 'description' => '组件是否满足升级条件。取值：'."\n" + ."\n" + .'- `true`：满足升级条件。'."\n" + .'- `false`：不满足升级条件。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'tasks' => [ + 'title' => '升级任务详情', + 'description' => '升级任务详情。', + 'type' => 'object', + 'properties' => [ + 'created_at' => [ + 'title' => '升级任务创建时间', + 'description' => '任务开始时间。', + 'type' => 'string', + 'example' => '2020-12-28T17:00:50Z', + ], + 'finished_at' => [ + 'title' => '升级任务完成时间', + 'description' => '任务完成时间。', + 'type' => 'string', + 'example' => '2020-12-28T17:05:36Z', + ], + 'status' => [ + 'title' => '升级任务状态', + 'description' => '升级任务状态。取值：'."\n" + .'- `Upgrading`：升级中。'."\n" + .'- `Success`：成功。'."\n" + .'- ` Failed`：失败。'."\n" + .'- ` Running`：安装中。'."\n" + .'- `Paused`：暂停中。'."\n" + .'- `Canceled`：已取消。', + 'type' => 'string', + 'example' => 'Success', + ], + 'is_canceled' => [ + 'title' => '升级任务是否被取消。', + 'description' => '升级任务是否被取消。取值：'."\n" + ."\n" + .'- `true`：任务被取消。'."\n" + .'- `false`：任务未被取消。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'description' => '组件升级状态详情。', + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::ListClusterAddonInstances', + 'CS::2015-12-15::GetClusterAddonInstance', + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"key\\": {\\n \\"addon_info\\": {\\n \\"component_name\\": \\"cloud-controller-manager\\",\\n \\"version\\": \\"v1.9.3.340-g9830b58-aliyun\\",\\n \\"ready_to_upgrade\\": \\"true\\"\\n },\\n \\"tasks\\": {\\n \\"created_at\\": \\"2020-12-28T17:00:50Z\\",\\n \\"finished_at\\": \\"2020-12-28T17:05:36Z\\",\\n \\"status\\": \\"Success\\",\\n \\"is_canceled\\": false\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeClusterAddonsUpgradeStatusResponse>\\n <key>\\n <addon_info>\\n <component_name>cloud-controller-manager</component_name>\\n <version>v1.9.3.340-g9830b58-aliyun</version>\\n <ready_to_upgrade>true</ready_to_upgrade>\\n </addon_info>\\n <tasks>\\n <created_at>2020-12-28T17:00:50Z</created_at>\\n <finished_at>2020-12-28T17:05:36Z</finished_at>\\n <status>Success</status>\\n <is_canceled>false</is_canceled>\\n </tasks>\\n </key>\\n</DescribeClusterAddonsUpgradeStatusResponse>","errorExample":""}]', + 'title' => '（已废弃）查询集群组件升级状态', + ], + 'UpdateNodePoolComponent' => [ + 'summary' => '更新节点组件。', + 'path' => '/clusters/{clusterId}/nodepools/{nodepoolId}/component', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsk4JRUSW', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'nodepoolId', + 'in' => 'path', + 'schema' => [ + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'np7c4fa4a5f1ce412b84967089****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求Body参数。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '节点组件名称。', + 'description' => '节点组件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'kubelet', + ], + 'version' => [ + 'title' => '节点组件版本。', + 'description' => '节点组件版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.28.9-aliyun.1', + ], + 'config' => [ + 'title' => '节点组件配置。', + 'description' => '节点组件配置。', + 'type' => 'object', + 'properties' => [ + 'customConfig' => [ + 'title' => '组件自定义配置。', + 'description' => '组件自定义配置。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '组件配置', + 'example' => 'cpuCFSQuota', + ], + ], + ], + 'required' => false, + ], + 'disableRolling' => [ + 'title' => '是否禁止轮转，默认值为false，更新基线配置会同步轮转节点。', + 'description' => '是否禁止轮转，默认值为false，更新基线配置会同步轮转节点。', + 'type' => 'boolean', + 'required' => false, + 'default' => 'false', + ], + 'nodeNames' => [ + 'title' => '指定轮转的节点列表，默认为全部节点。', + 'description' => '指定轮转的节点列表，默认为全部节点。', + 'type' => 'array', + 'items' => [ + 'title' => '节点名称。', + 'description' => '节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou.10.91.xx.xx', + ], + 'required' => false, + ], + 'rollingPolicy' => [ + 'title' => '轮转配置。', + 'description' => '轮转配置。', + 'type' => 'object', + 'properties' => [ + 'maxParallelism' => [ + 'title' => '每批次的最大并行数，默认值1。', + 'description' => '每批次的最大并行数，默认值1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + 'pausePolicy' => [ + 'title' => '节点升级过程中的自动暂停策略。', + 'description' => '节点升级过程中的自动暂停策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'NotPause', + 'default' => 'NotPause', + 'enum' => [ + 'NotPause', + 'FirstBatch', + 'EveryBatch', + ], + ], + 'batchInterval' => [ + 'title' => '批次之间的升级间隔时间，单位秒。', + 'description' => '批次之间的升级间隔时间，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '49511F2D-D56A-5C24-B9AE-C8491E09B***', + ], + 'taskId' => [ + 'description' => '异步任务ID。', + 'type' => 'string', + 'example' => 'T-67d7ec016ce37c0106000***', + ], + 'clusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"49511F2D-D56A-5C24-B9AE-C8491E09B***\\",\\n \\"taskId\\": \\"T-67d7ec016ce37c0106000***\\",\\n \\"clusterId\\": \\"c82e6987e2961451182edacd74faf****\\"\\n}","type":"json"}]', + 'title' => '更新节点组件', + ], + 'InstallNodePoolComponents' => [ + 'summary' => '安装节点组件，支持配置并指定节点安装节点组件。', + 'path' => '/clusters/{clusterId}/nodepools/{nodePoolId}/components', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcsk4HGX7D', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'nodePoolId', + 'in' => 'path', + 'schema' => [ + 'title' => '节点池ID。', + 'description' => '节点池ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'np7c4fa4a5f1ce412b849****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'components' => [ + 'title' => '节点组件列表。', + 'description' => '节点组件列表。', + 'type' => 'array', + 'items' => [ + 'title' => '单个组件配置。', + 'description' => '单个组件配置。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '组件名称。', + 'description' => '组件名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'kubelet', + ], + 'version' => [ + 'title' => '组件版本。', + 'description' => '组件版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.28.9-aliyun.1', + ], + 'config' => [ + 'title' => '组件配置。', + 'description' => '组件配置。', + 'type' => 'object', + 'properties' => [ + 'customConfig' => [ + 'title' => '组件自定义配置。', + 'description' => '组件自定义配置。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'cpuCFSQuota', + 'description' => '组件配置', + ], + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'rollingPolicy' => [ + 'title' => '轮转配置。', + 'description' => '轮转配置。', + 'type' => 'object', + 'properties' => [ + 'maxParallelism' => [ + 'title' => '每批次的最大并行数，默认值1。', + 'description' => '每批次的最大并行数，默认值1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + 'pausePolicy' => [ + 'title' => '节点升级过程中的自动暂停策略。', + 'description' => '节点升级过程中的自动暂停策略。', + 'type' => 'string', + 'required' => false, + 'example' => 'NotPause', + 'default' => 'NotPause', + 'enum' => [ + 'NotPause', + 'FirstBatch', + 'EveryBatch', + ], + ], + 'batchInterval' => [ + 'title' => '批次之间的升级间隔时间，单位秒。', + 'description' => '批次之间的升级间隔时间，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + 'default' => '0', + ], + ], + 'required' => false, + ], + 'nodeNames' => [ + 'title' => '指定轮转的节点名称列表，默认为全部节点。', + 'description' => '指定轮转的节点名称列表，默认为全部节点。', + 'type' => 'array', + 'items' => [ + 'title' => '节点名称。', + 'description' => '节点名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou.10.2xxx', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '49511F2D-D56A-5C24-B9AE-C8491E09B***', + ], + 'taskId' => [ + 'title' => '任务ID。', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'T-67d7ec016ce37c0106000***', + ], + 'clusterId' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c8155823d057948c69a****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"49511F2D-D56A-5C24-B9AE-C8491E09B***\\",\\n \\"taskId\\": \\"T-67d7ec016ce37c0106000***\\",\\n \\"clusterId\\": \\"c8155823d057948c69a****\\"\\n}","type":"json"}]', + 'title' => '安装节点组件', + ], + 'DescribeExternalAgent' => [ + 'summary' => '根据集群ID查询集群中部署注册集群的代理配置。', + 'path' => '/k8s/{ClusterId}/external/agent/deployment', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '392', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c106f377e16f34eb1808d6b9362c9****', + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '是否获取内网访问凭据。 true：获取内网连接凭据 false：获取公网连接凭据 默认值：false。', + 'description' => '是否获取内网访问凭据。'."\n" + ."\n" + .'- `true`：仅获取内网连接凭据。'."\n" + .'- `false`：仅获取公网连接凭据。'."\n" + ."\n" + .'默认值：`false`。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AgentMode', + 'in' => 'query', + 'schema' => [ + 'title' => 'agent模式', + 'description' => 'Agent权限模式。'."\n" + ."\n" + .'admin：管理员模式，拥有所有权限。'."\n" + .'restricted：受限模式，仅拥有部分权限。'."\n" + .'默认值：admin。', + 'type' => 'string', + 'required' => false, + 'example' => 'admin', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'config' => [ + 'title' => '代理配置。', + 'description' => 'YAML格式的代理配置。', + 'type' => 'string', + 'example' => 'apiVersion: v1****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"config\\": \\"apiVersion: v1****\\"\\n}","errorExample":""},{"type":"xml","example":"<config>apiVersion: v1****</config>","errorExample":""}]', + 'title' => '查询集群代理', + 'description' => '关于集群接入的更多信息，请参见[注册外部Kubernetes集群](~~121053~~)。', + ], + 'CreateKubernetesTrigger' => [ + 'summary' => '为应用创建触发器。', + 'path' => '/triggers', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskT7MN2U', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'schema' => [ + 'title' => '请求体参数', + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + 'project_id' => [ + 'title' => '项目名称。', + 'description' => '触发器项目名称。'."\n" + ."\n" + .'由应用所在命名空间及应用名称组成，格式为`${namespace}/${name}`。'."\n" + ."\n" + .'取值示例：`default/test-app`。', + 'type' => 'string', + 'required' => true, + 'example' => 'default/test-app', + ], + 'action' => [ + 'title' => '触发器行为', + 'description' => '触发器行为，取值：'."\n" + ."\n" + .'`redeploy`：重新部署`project_id`中定义的资源。', + 'type' => 'string', + 'required' => true, + 'example' => 'redeploy', + ], + 'type' => [ + 'title' => '触发器类型。默认deployment。', + 'description' => '触发器类型。取值：'."\n" + ."\n" + .'- `deployment`：针对无状态应用的触发器。 '."\n" + ."\n" + .'- `application`：针对应用中心应用的触发器。'."\n" + ."\n" + .'默认值：`deployment`。', + 'type' => 'string', + 'required' => false, + 'example' => 'deployment', + ], + ], + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'description' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '触发器ID。', + 'description' => '触发器ID。', + 'type' => 'string', + 'example' => '111', + ], + 'cluster_id' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + 'project_id' => [ + 'title' => '触发器项目名称。', + 'description' => '触发器项目名称。', + 'type' => 'string', + 'example' => 'default/test-app', + ], + 'type' => [ + 'title' => '触发器类型。默认值为 deployment 。', + 'description' => '触发器类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- `deployment`：针对无状态应用的触发器。 '."\n" + ."\n" + .'- `application`：针对应用中心应用的触发器。'."\n", + 'type' => 'string', + 'example' => 'deployment', + ], + 'action' => [ + 'title' => '触发器行为。', + 'description' => '触发器行为。例如，`redeploy`：重新部署。', + 'type' => 'string', + 'example' => 'redeploy', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::CreateTrigger', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"id\\": \\"111\\",\\n \\"cluster_id\\": \\"c5cdf7e3938bc4f8eb0e44b21a80f****\\",\\n \\"project_id\\": \\"default/test-app\\",\\n \\"type\\": \\"deployment\\",\\n \\"action\\": \\"redeploy\\"\\n}","errorExample":""},{"type":"xml","example":"<id>111</id>\\n<cluster_id>c5cdf7e3938bc4f8eb0e44b21a80f****</cluster_id>\\n<project_id>default/test-app</project_id>\\n<type>deployment</type>\\n<action>redeploy</action>","errorExample":""}]', + 'title' => '创建触发器', + ], + 'ResumeComponentUpgrade' => [ + 'summary' => '调用ResumeComponentUpgrade重新启动被暂停的组件升级任务。', + 'path' => '/clusters/{clusterid}/components/{componentid}/resume', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '378', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterid', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5b5e80b0b64a4bf6939d2d8fbbc5****', + ], + ], + [ + 'name' => 'componentid', + 'in' => 'path', + 'schema' => [ + 'title' => '组件ID。', + 'description' => '组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'metric-server', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::ResumeTask', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '重新开始组件升级', + ], + 'PauseComponentUpgrade' => [ + 'summary' => '调用PauseComponentUpgrade暂停组件升级。', + 'path' => '/clusters/{clusterid}/components/{componentid}/pause', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '381', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterid', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'componentid', + 'in' => 'path', + 'schema' => [ + 'title' => '组件ID。', + 'description' => '组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'metric-server', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::PauseTask', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '暂停组件升级', + ], + 'GetKubernetesTrigger' => [ + 'summary' => '根据应用名称查询该应用的触发器。', + 'path' => '/triggers/{ClusterId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '388', + 'abilityTreeNodes' => [ + 'FEATUREcskT7MN2U', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '应用所属命名空间。', + 'description' => '命名空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'default', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '应用类型。', + 'description' => '触发器类型。取值：'."\n" + ."\n" + .'- `deployment`：针对无状态应用的触发器。 '."\n" + ."\n" + .'- `application`：针对应用中心应用的触发器。'."\n" + ."\n" + .'默认值：`deployment`。'."\n" + ."\n" + .'当不指定触发器类型时，查询结果将不过滤触发器类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'deployment', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '应用名称。', + 'description' => '应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'web-server', + ], + ], + [ + 'name' => 'action', + 'in' => 'query', + 'schema' => [ + 'title' => '触发器行为。', + 'description' => '触发器行为，取值：'."\n" + ."\n" + .'`redeploy`：重新部署`project_id`中定义的资源。'."\n" + ."\n" + .'当不指定触发器行为时，查询结果将不过滤触发器行为。', + 'type' => 'string', + 'required' => false, + 'example' => 'redeploy', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回参数。', + 'description' => '触发器查询结果详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '触发器详情。', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '触发器ID。', + 'description' => '触发器ID。', + 'type' => 'string', + 'example' => '1234', + ], + 'name' => [ + 'title' => '触发器名称。', + 'description' => '触发器名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'cluster_id' => [ + 'title' => '集群ID', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c259f563386444ebb8d7**', + ], + 'project_id' => [ + 'title' => '触发器项目名称', + 'description' => '触发器项目名称。'."\n" + ."\n" + .'由应用所在命名空间及应用名称组成，格式为`${namespace}/${name}`，取值示例：default/test-app。', + 'type' => 'string', + 'example' => 'default/test-app', + ], + 'type' => [ + 'title' => '触发器类型。', + 'description' => '触发器类型。'."\n" + ."\n" + .'取值：'."\n" + ."\n" + .'- `deployment`：针对无状态应用的触发器。 '."\n" + ."\n" + .'- `application`：针对应用中心应用的触发器。'."\n" + ."\n" + .'默认值：`deployment`。', + 'type' => 'string', + 'example' => 'deployment', + ], + 'action' => [ + 'title' => '触发器行为', + 'description' => '触发器行为，取值：'."\n" + ."\n" + .'`redeploy`: 重新部署project_id中定义的资源。', + 'type' => 'string', + 'example' => 'redeploy', + ], + 'token' => [ + 'title' => 'Token', + 'description' => 'Token', + 'type' => 'string', + 'example' => 'eyJhbGci***', + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::DescribeTrigger', + ], + ], + 'responseDemo' => '[{"type":"json","example":"[\\n {\\n \\"id\\": \\"1234\\",\\n \\"name\\": \\"test\\",\\n \\"cluster_id\\": \\"c259f563386444ebb8d7**\\",\\n \\"project_id\\": \\"default/test-app\\",\\n \\"type\\": \\"deployment\\",\\n \\"action\\": \\"redeploy\\",\\n \\"token\\": \\"eyJhbGci***\\"\\n }\\n]","errorExample":""},{"type":"xml","example":"<0>\\n <id>1234</id>\\n <name>test</name>\\n <cluster_id>c259f563386444ebb8d7**</cluster_id>\\n <project_id>default/test-app</project_id>\\n <type>deployment</type>\\n <action>redeploy</action>\\n</0>","errorExample":""}]', + 'title' => '查询触发器', + ], + 'DescribeClusters' => [ + 'summary' => '查看容器服务中创建的所有集群（包括Swarm和Kubernetes集群）。', + 'path' => '/clusters', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '394', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'name', + 'in' => 'query', + 'schema' => [ + 'description' => '根据集群Name进行模糊匹配查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '集群名称。', + ], + ], + [ + 'name' => 'clusterType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ManagedKubernetes', + 'title' => '集群类型。', + ], + ], + [ + 'name' => 'resource_group_id', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'array', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '348D4C9C-9105-4A1B-A86E-B58F0F875575', + 'index' => 200, + ], + 'clusters' => [ + 'description' => '集群详情列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'created' => [ + 'description' => '集群的创建时间。', + 'type' => 'string', + 'example' => '2019-11-25T15:50:20+08:00', + 'index' => 200, + ], + 'security_group_id' => [ + 'description' => '集群安全组ID。'."\n", + 'type' => 'string', + 'example' => 'sg-2zedf74ifulatvx0****', + 'index' => 200, + ], + 'docker_version' => [ + 'description' => '集群使用的Docker版本。', + 'type' => 'string', + 'example' => '18.09.2', + 'index' => 200, + ], + 'master_url' => [ + 'description' => '连接集群的endpoint地址，包括api_server_endpoint、dashboard_endpoint、mirana_endpoint、reverse_tunnel_endpoint和intranet_api_server_endpoint。更多详细信息，参见[SSH访问Kubernetes集群](~~86491~~)。 ', + 'type' => 'string', + 'example' => '"{\\"api_server_endpoint\\":\\"https://47.93.xx.xxx:6443https://mirana.cs-cn-beijing.aliyuncs.com:4243https://192.xxx.x.xx:6443\\"}", "external_loadbalancer_id": "lb-2ze3buguz3gx9920z****"', + 'index' => 200, + ], + 'meta_data' => [ + 'description' => '集群元数据信息。', + 'type' => 'string', + 'example' => '***', + 'index' => 200, + ], + 'cluster_id' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cb95aa626a47740afbf6aa099b650****', + 'index' => 200, + ], + 'external_loadbalancer_id' => [ + 'description' => '集群负载均衡服务的ID。', + 'type' => 'string', + 'example' => 'lb-2ze3buguz3gx9920z****', + 'index' => 200, + ], + 'network_mode' => [ + 'description' => '集群网络模式（VPC网络：vpc）。', + 'type' => 'string', + 'example' => 'vpc', + 'index' => 200, + ], + 'zone_id' => [ + 'description' => '集群所在地域的Zone的ID。', + 'type' => 'string', + 'example' => 'cn-beijing-a', + 'index' => 200, + ], + 'deletion_protection' => [ + 'description' => '是否开启集群删除保护，防止通过控制台或api误删除集群。', + 'type' => 'boolean', + 'example' => 'true', + 'index' => 200, + ], + 'current_version' => [ + 'description' => '集群当前版本。'."\n", + 'type' => 'string', + 'example' => '1.14.8-aliyun.1', + 'index' => 200, + ], + 'updated' => [ + 'description' => '最后更新时间。', + 'type' => 'string', + 'example' => '2020-01-13T23:01:03+08:00', + 'index' => 200, + ], + 'resource_group_id' => [ + 'description' => '集群资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmyvw3wjm****', + 'index' => 200, + ], + 'cluster_type' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'Kubernetes', + 'index' => 200, + ], + 'region_id' => [ + 'description' => '集群所在地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + 'index' => 200, + ], + 'vpc_id' => [ + 'description' => '专有网络(VPC) ID。', + 'type' => 'string', + 'example' => 'vpc-2zecuu62b9zw7a7qn****', + 'index' => 200, + ], + 'data_disk_size' => [ + 'description' => '数据盘大小，单位GB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + 'index' => 200, + ], + 'state' => [ + 'description' => '集群状态，running为运行状态，filed和stoped为异常状态。', + 'type' => 'string', + 'example' => 'running', + 'index' => 200, + ], + 'size' => [ + 'description' => '节点数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + 'index' => 200, + ], + 'vswitch_id' => [ + 'description' => '虚拟交换机(VSwitch) ID。', + 'type' => 'string', + 'example' => 'vsw-2zete8s4qocqg0mf6****', + 'index' => 200, + ], + 'vswitch_cidr' => [ + 'description' => '虚拟交换机(VSwitch)的网络前缀。', + 'type' => 'string', + 'example' => '"26"', + 'index' => 200, + ], + 'name' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'my-test-Kubernetes-cluster', + 'index' => 200, + ], + 'data_disk_category' => [ + 'description' => '数据盘类型。', + 'type' => 'string', + 'example' => 'cloud', + 'index' => 200, + ], + 'tags' => [ + 'description' => '集群标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '集群标签名称。', + 'type' => 'string', + 'example' => '2', + 'index' => 200, + ], + 'value' => [ + 'description' => '集群标签值。', + 'type' => 'string', + 'example' => '3', + 'index' => 200, + ], + ], + ], + 'index' => 200, + 'itemName' => 'tags', + ], + ], + ], + 'index' => 200, + 'itemName' => 'clusterDetail', + ], + ], + 'title' => '返回数据体。', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'cluster_id' => [ + 'title' => '集群ID。', + 'type' => 'string', + ], + 'cluster_type' => [ + 'title' => '集群类型。', + 'type' => 'string', + ], + 'created' => [ + 'title' => '集群创建时间。', + 'type' => 'string', + ], + 'current_version' => [ + 'title' => '集群当前版本。', + 'type' => 'string', + ], + 'data_disk_category' => [ + 'title' => '节点系统盘类型。', + 'type' => 'string', + ], + 'data_disk_size' => [ + 'title' => '节点系统盘大小。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'deletion_protection' => [ + 'title' => '集群是否开启删除保护。', + 'type' => 'boolean', + ], + 'docker_version' => [ + 'title' => '容器运行时版本。', + 'type' => 'string', + ], + 'external_loadbalancer_id' => [ + 'title' => '集群Ingerss SLB实例的ID。', + 'type' => 'string', + ], + 'init_version' => [ + 'title' => '集群创建时版本。', + 'type' => 'string', + ], + 'master_url' => [ + 'title' => '集群的endpoint地址。', + 'type' => 'string', + ], + 'meta_data' => [ + 'title' => '集群元数据。', + 'type' => 'string', + ], + 'name' => [ + 'title' => '集群名称。', + 'type' => 'string', + ], + 'network_mode' => [ + 'title' => '集群使用的网络类型。', + 'type' => 'string', + ], + 'private_zone' => [ + 'title' => '集群是否开启Private Zone，默认false。', + 'type' => 'boolean', + ], + 'profile' => [ + 'title' => '集群标识，区分是否为边缘托管版。', + 'type' => 'string', + ], + 'region_id' => [ + 'title' => '集群所在地域ID。', + 'type' => 'string', + ], + 'resource_group_id' => [ + 'title' => '集群资源组ID。', + 'type' => 'string', + ], + 'security_group_id' => [ + 'title' => '集群安全组ID。', + 'type' => 'string', + ], + 'size' => [ + 'title' => '集群内实例数量。', + 'type' => 'integer', + 'format' => 'int64', + ], + 'state' => [ + 'title' => '集群运行状态。', + 'type' => 'string', + ], + 'subnet_cidr' => [ + 'title' => 'POD网络。', + 'type' => 'string', + ], + 'tags' => [ + 'title' => '集群标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '标签名。', + 'type' => 'string', + ], + 'value' => [ + 'title' => '标签值。', + 'type' => 'string', + ], + ], + ], + ], + 'updated' => [ + 'title' => '集群更新时间。', + 'type' => 'string', + ], + 'vpc_id' => [ + 'title' => '集群使用的VPC ID。', + 'type' => 'string', + ], + 'vswitch_cidr' => [ + 'title' => '虚拟交换机网络ID。', + 'type' => 'string', + ], + 'vswitch_id' => [ + 'title' => '节点使用的Vswitch ID。', + 'type' => 'string', + ], + 'worker_ram_role_name' => [ + 'title' => '集群Worker节点RAM角色名称。', + 'type' => 'string', + ], + 'zone_id' => [ + 'title' => '集群所在Region内的区域ID。', + 'type' => 'string', + ], + ], + ], + ], + ], + '5XX' => [], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::DescribeClustersForRegion', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"348D4C9C-9105-4A1B-A86E-B58F0F875575\\",\\n \\"clusters\\": [\\n {\\n \\"created\\": \\"2019-11-25T15:50:20+08:00\\",\\n \\"security_group_id\\": \\"sg-2zedf74ifulatvx0****\\",\\n \\"docker_version\\": \\"18.09.2\\",\\n \\"master_url\\": \\"\\\\\\"{\\\\\\\\\\\\\\"api_server_endpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://47.93.xx.xxx:6443https://mirana.cs-cn-beijing.aliyuncs.com:4243https://192.xxx.x.xx:6443\\\\\\\\\\\\\\"}\\\\\\", \\\\\\"external_loadbalancer_id\\\\\\": \\\\\\"lb-2ze3buguz3gx9920z****\\\\\\"\\",\\n \\"meta_data\\": \\"***\\",\\n \\"cluster_id\\": \\"cb95aa626a47740afbf6aa099b650****\\",\\n \\"external_loadbalancer_id\\": \\"lb-2ze3buguz3gx9920z****\\",\\n \\"network_mode\\": \\"vpc\\",\\n \\"zone_id\\": \\"cn-beijing-a\\",\\n \\"deletion_protection\\": true,\\n \\"current_version\\": \\"1.14.8-aliyun.1\\",\\n \\"updated\\": \\"2020-01-13T23:01:03+08:00\\",\\n \\"resource_group_id\\": \\"rg-acfmyvw3wjm****\\",\\n \\"cluster_type\\": \\"Kubernetes\\",\\n \\"region_id\\": \\"cn-beijing\\",\\n \\"vpc_id\\": \\"vpc-2zecuu62b9zw7a7qn****\\",\\n \\"data_disk_size\\": 0,\\n \\"state\\": \\"running\\",\\n \\"size\\": 4,\\n \\"vswitch_id\\": \\"vsw-2zete8s4qocqg0mf6****\\",\\n \\"vswitch_cidr\\": \\"\\\\\\"26\\\\\\"\\",\\n \\"name\\": \\"my-test-Kubernetes-cluster\\",\\n \\"data_disk_category\\": \\"cloud\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"2\\",\\n \\"value\\": \\"3\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<0>\\n <name>sl-numa</name>\\n <cluster_id>cd62be8675b514f278163cf750acb****</cluster_id>\\n <size>4</size>\\n <region_id>cn-shenzhen</region_id>\\n <state>running</state>\\n <cluster_type>Kubernetes</cluster_type>\\n <current_version>1.16.6-aliyun.1</current_version>\\n <resource_group_id>rg-acfmyvw3wjm****</resource_group_id>\\n <instance_type/>\\n <vswitch_id>vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****</vswitch_id>\\n <data_disk_category>cloud</data_disk_category>\\n <security_group_id>sg-wz956lln6kknnwlw****</security_group_id>\\n <tags>\\n <key>ack.aliyun.com</key>\\n <value>cd62be8675b514f278163cf750acb****</value>\\n </tags>\\n <zone_id>cn-shenzhen-e</zone_id>\\n <docker_version>19.03.5</docker_version>\\n <deletion_protection>false</deletion_protection>\\n</0>\\n<1>\\n <name>sl-terway</name>\\n <cluster_id>c5b269738d1f5427ebd32884fc59c****</cluster_id>\\n <size>5</size>\\n <region_id>cn-shenzhen</region_id>\\n <state>running</state>\\n <cluster_type>Kubernetes</cluster_type>\\n <current_version>1.16.6-aliyun.1</current_version>\\n <vpc_id>vpc-wz984yvbd6lck22z3****</vpc_id>\\n <vswitch_id>vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****,vsw-wz9uwxhawmtzg7u9h****</vswitch_id>\\n <security_group_id>sg-wz9e8pvnjalx1tm1****</security_group_id>\\n <tags>\\n <key>ack.aliyun.com</key>\\n <value>c5b269738d1f5427ebd32884fc59c****</value>\\n </tags>\\n <zone_id>cn-shenzhen-e</zone_id>\\n <docker_version>19.03.5</docker_version>\\n <deletion_protection>false</deletion_protection>\\n</1>","errorExample":""}]', + 'title' => '（旧）查询用户所有集群实例', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeClusterV2UserKubeconfig' => [ + 'summary' => '获取集群kubeconfig接口', + 'path' => '/api/v2/k8s/{ClusterId}/user_config', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '395', + 'abilityTreeNodes' => [ + 'FEATUREcskCWOUHM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'PrivateIpAddress', + 'in' => 'query', + 'schema' => [ + 'title' => '是否为内网访问。', + 'type' => 'boolean', + ], + ], + [ + 'name' => 'TemporaryDurationMinutes', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '返回数据体。', + 'type' => 'object', + 'properties' => [ + 'config' => [ + 'title' => 'kubeconfig内容。', + 'type' => 'string', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::DescribeClusterUserKubeconfig', + ], + ], + 'responseDemo' => '', + ], + 'DescribeClusterAddonUpgradeStatus' => [ + 'summary' => '调用DescribeClusterAddonUpgradeStatus查询集群组件升级状态。', + 'path' => '/clusters/{ClusterId}/components/{ComponentId}/upgradestatus', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c106f377e16f34eb1808d6b9362c9****', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'path', + 'schema' => [ + 'title' => '组件ID。', + 'description' => '组件ID，例如：nginx-ingress-controller、flexvolume、metrics-server。'."\n" + ."\n" + .'集群支持的组件，可通过API `DescribeAddons` 进行查询。', + 'type' => 'string', + 'required' => true, + 'example' => 'cloud-controller-manager', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '组件升级状态', + 'description' => '返回体参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'addon_info' => [ + 'title' => '组件详情', + 'description' => '组件信息。', + 'type' => 'object', + 'properties' => [ + 'component_name' => [ + 'title' => '组件名称', + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'cloud-controller-manager', + ], + 'version' => [ + 'title' => '组件版本', + 'description' => '组件当前版本。', + 'type' => 'string', + 'example' => 'v1.9.3.340-g9830b58-aliyun', + ], + 'ready_to_upgrade' => [ + 'title' => '是否满足升级条件', + 'description' => '是否满足升级条件。取值：'."\n" + ."\n" + .'- `true`：满足升级条件。'."\n" + .'- `false`：不满足升级条件。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'tasks' => [ + 'title' => '升级任务详情', + 'description' => '升级任务详情。', + 'type' => 'object', + 'properties' => [ + 'created_at' => [ + 'title' => '升级开始时间', + 'description' => ' '."\n" + .'升级开始时间。', + 'type' => 'string', + 'example' => '0001-01-01T00:00:00Z', + ], + 'finished_at' => [ + 'title' => '升级完成时间', + 'description' => '升级完成时间。', + 'type' => 'string', + 'example' => '0001-01-01T00:00:00Z', + ], + 'status' => [ + 'title' => '升级任务状态', + 'description' => '升级任务状态。', + 'type' => 'string', + 'example' => 'Success', + ], + 'is_canceled' => [ + 'title' => '任务是否被取消', + 'description' => '升级任务是否被取消。取值：'."\n" + ."\n" + .'- `true`：任务被取消。'."\n" + .'- `false`：任务未被取消。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'description' => '组件升级状态详情。', + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::GetClusterAddonInstance', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"key\\": {\\n \\"addon_info\\": {\\n \\"component_name\\": \\"cloud-controller-manager\\",\\n \\"version\\": \\"v1.9.3.340-g9830b58-aliyun\\",\\n \\"ready_to_upgrade\\": \\"true\\"\\n },\\n \\"tasks\\": {\\n \\"created_at\\": \\"0001-01-01T00:00:00Z\\",\\n \\"finished_at\\": \\"0001-01-01T00:00:00Z\\",\\n \\"status\\": \\"Success\\",\\n \\"is_canceled\\": false\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<cloud-controller-manager>\\n <tasks>\\n <created_at>2020-12-28T16:05:32Z</created_at>\\n <finished_at>2020-12-28T16:06:54Z</finished_at>\\n <is_canceled>false</is_canceled>\\n <status>Success</status>\\n </tasks>\\n <addon_info>\\n <component_name>cloud-controller-manager</component_name>\\n <version>v1.9.3.340-g9830b58-aliyun</version>\\n <ready_to_upgrade>true</ready_to_upgrade>\\n </addon_info>\\n</cloud-controller-manager>","errorExample":""}]', + 'title' => '查询集群Addons升级状态', + ], + 'CancelComponentUpgrade' => [ + 'summary' => '取消集群组件升级。', + 'path' => '/clusters/{clusterId}/components/{componentId}/cancel', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '413', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'clusterId', + 'in' => 'path', + 'schema' => [ + 'title' => '集群ID。', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'componentId', + 'in' => 'path', + 'schema' => [ + 'title' => '组件ID。', + 'description' => '组件ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'metric-server', + ], + ], + ], + 'responses' => [ + 200 => [], + '5XX' => [], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::CancelTask', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '取消升级集群Addons', + ], + 'DeleteKubernetesTrigger' => [ + 'summary' => '根据应用触发器ID，删除应用触发器。', + 'path' => '/triggers/revoke/{Id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '408', + 'abilityTreeNodes' => [ + 'FEATUREcskT7MN2U', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'path', + 'schema' => [ + 'title' => '触发器ID。', + 'description' => '触发器ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5cdf7e3938bc4f8eb0e44b21a80f****', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'CS::2015-12-15::DeleteTrigger', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => '删除触发器', + ], + 'CreateAutoRepairPolicy' => [ + 'summary' => '创建自愈规则。', + 'path' => '/clusters/{cluster_id}/auto_repair_policies', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cb95aa626a47740afbf6aa099b650****', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求参数。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '自愈规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'resource_type' => [ + 'title' => '', + 'description' => '自愈规则能够绑定的资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'nodepool', + ], + 'resource_sub_type' => [ + 'description' => '自愈规则能够绑定的资源子类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'ess', + ], + 'rules' => [ + 'description' => '自愈子规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自愈子规则。', + 'type' => 'object', + 'properties' => [ + 'incidents' => [ + 'description' => '识别的故障列表。', + 'type' => 'array', + 'items' => [ + 'description' => '识别的故障。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '故障的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Node.FaultNeedReboot.HOST', + ], + 'type' => [ + 'description' => '故障的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + 'conditions' => [ + 'description' => '识别为故障的condition条件，仅type为custom时支持指定，和event字段二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '识别为故障的 condition 条件。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'condition类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'KubeletReady', + ], + 'status' => [ + 'description' => 'condition状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'False', + ], + 'reason' => [ + 'description' => 'condition原因。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'events' => [ + 'description' => '识别为故障的event条件，仅type为custom时支持指定，和condition二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '识别为故障的 event 条件。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'event类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'reason' => [ + 'description' => 'event原因。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'repair_procedure' => [ + 'description' => '修复流程。', + 'type' => 'array', + 'items' => [ + 'description' => '修复流程。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流程的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Drain', + ], + 'intervention' => [ + 'description' => '配置人工参与流程。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => '是否开启人工审批。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'type' => [ + 'description' => '人工审批的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'label', + ], + 'inquiring_label' => [ + 'description' => '授权问询的label配置。当进入该阶段时，ACK 会为您的节点添加以下标签（Label），等待您进行授权执行该阶段动作。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签的 key。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s.aliyun.com/incident', + ], + 'value' => [ + 'description' => '标签的 value。', + 'type' => 'string', + 'required' => false, + 'example' => 'inquiring', + ], + ], + 'required' => false, + ], + 'approved_label' => [ + 'description' => '确认授权的 label 配置。当您为节点添加以下标签（Label）时，即表示授权 ACK 执行该阶段的操作。ACK 将在完成该阶段操作后，自动移除该阶段对应的授权问询与确认授权的标签（Label）。如您未及时添加以下标签（Label）授权，ACK 将不会执行该阶段动作和后续动作，节点可能停留在受损状态。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签的 key。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s.aliyun.com/incident', + ], + 'value' => [ + 'description' => '标签的 value。', + 'type' => 'string', + 'required' => false, + 'example' => 'approved', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'config' => [ + 'description' => '修复流程的配置参数。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{'."\n" + .'"drain_timeout": "30s" '."\n" + .'}', + 'description' => '修复流程的配置参数。', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '["np-xxx"]', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E368C761-F8F6-4A36-9B58-BD53D5******', + ], + 'policy_id' => [ + 'description' => '自愈规则ID。', + 'type' => 'string', + 'example' => 'r-xxxxxxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"E368C761-F8F6-4A36-9B58-BD53D5******\\",\\n \\"policy_id\\": \\"r-xxxxxxx\\"\\n}","type":"json"}]', + 'title' => '创建自愈规则', + 'description' => '><notice>API 暂未开放，敬请期待></notice>', + ], + 'DeleteAutoRepairPolicy' => [ + 'summary' => '删除自愈规则。', + 'path' => '/clusters/{cluster_id}/auto_repair_policies/{policy_id}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c104d5d5f301c4e2a8ee578c37******', + ], + ], + [ + 'name' => 'policy_id', + 'in' => 'path', + 'schema' => [ + 'description' => '自愈规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A9891419-D125-4D89-AFCA-68846675****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"A9891419-D125-4D89-AFCA-68846675****\\"\\n}","type":"json"}]', + 'title' => '删除自愈规则', + 'description' => '><notice>API 暂未开放，敬请期待></notice>', + ], + 'ModifyAutoRepairPolicy' => [ + 'summary' => '修改自愈规则。', + 'path' => '/clusters/{cluster_id}/auto_repair_policies/{policy_id}', + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'description' => '目标集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c68deb844dc6d480eb775be611fdf****', + ], + ], + [ + 'name' => 'policy_id', + 'in' => 'path', + 'schema' => [ + 'description' => '自愈规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-xxxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '自愈规则的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'rules' => [ + 'description' => '自愈子规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自愈子规则列表。', + 'type' => 'object', + 'properties' => [ + 'incidents' => [ + 'description' => '识别的故障列表。', + 'type' => 'array', + 'items' => [ + 'description' => '识别的故障列表。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '故障名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Node.FaultNeedReboot.HOST', + ], + 'type' => [ + 'description' => '人工审批的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'system', + ], + 'conditions' => [ + 'description' => '识别为故障的condition条件，仅type为custom时支持指定，和event字段二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '识别为故障的condition条件。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'condition的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'KubeletReady', + ], + 'status' => [ + 'description' => 'condition 的状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'False', + ], + 'reason' => [ + 'description' => 'condition的原因。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'events' => [ + 'description' => '识别为故障的 event 条件，仅 type 为 custom 时支持指定，和 conditions 字段二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '识别为故障的 event 条件。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'event类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'reason' => [ + 'description' => 'event原因。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'repair_procedure' => [ + 'description' => '修复流程。', + 'type' => 'array', + 'items' => [ + 'description' => '修复流程。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流程的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'QuarantineGPU', + ], + 'intervention' => [ + 'description' => '配置人工参与流程。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => '是否开启人工审批。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'type' => [ + 'description' => '审批的类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'label', + ], + 'inquiring_label' => [ + 'description' => '授权问询的 label 配置。当进入该阶段时，ACK 会为您的节点添加以下标签（Label），等待您进行授权执行该阶段动作。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签`key`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s.aliyun.com/incident', + ], + 'value' => [ + 'description' => '标签`value`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'inquiring', + ], + ], + 'required' => false, + ], + 'approved_label' => [ + 'description' => '确认授权的 label 配置。当您为节点添加以下标签（Label）时，即表示授权 ACK 执行该阶段的操作。ACK 将在完成该阶段操作后，自动移除该阶段对应的授权问询与确认授权的标签（Label）。如您未及时添加以下标签（Label）授权，ACK 将不会执行该阶段动作和后续动作，节点可能停留在受损状态。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签`key`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s.aliyun.com/incident', + ], + 'value' => [ + 'description' => '标签`value`值。', + 'type' => 'string', + 'required' => false, + 'example' => 'approved', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'config' => [ + 'description' => '流程的参数配置。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '流程的参数配置。', + 'example' => '{'."\n" + .'"drain_timeout": "30s" '."\n" + .'}', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'request_id' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'db82195b-75a8-40e5-9be4-16f182******', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"request_id\\": \\"db82195b-75a8-40e5-9be4-16f182******\\"\\n}","type":"json"}]', + 'title' => '修改自愈规则', + 'description' => '><notice>API暂未开放，敬请期待></notice>', + ], + 'DescribeAutoRepairPolicy' => [ + 'summary' => '查询自愈规则。', + 'path' => '/clusters/{cluster_id}/auto_repair_policies/{policy_id}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c82e6987e2961451182edacd74faf****', + ], + ], + [ + 'name' => 'policy_id', + 'in' => 'path', + 'schema' => [ + 'description' => '自愈规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-xxxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '自愈规则名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'id' => [ + 'description' => '自愈规则ID。', + 'type' => 'string', + 'example' => 'r-xxx', + ], + 'resource_type' => [ + 'description' => '自愈规则绑定的资源类型。', + 'type' => 'string', + 'example' => 'nodepool', + ], + 'resource_ids' => [ + 'description' => '自愈规则绑定的资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自愈规则绑定的资源。', + 'type' => 'string', + 'example' => 'npxxxxx', + ], + ], + 'rules' => [ + 'description' => '自愈子规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自愈子规则列表。', + 'type' => 'object', + 'properties' => [ + 'incidents' => [ + 'description' => '识别的故障列表。', + 'type' => 'array', + 'items' => [ + 'description' => '识别的故障列表。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '故障名称。', + 'type' => 'string', + 'example' => 'Node.FaultNeedReboot.HOST', + ], + 'type' => [ + 'description' => '故障类型。', + 'type' => 'string', + 'example' => 'system', + ], + 'conditions' => [ + 'description' => '识别为故障的condition条件，仅type为custom时支持指定，和event字段二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '识别为故障的condition条件。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'condition类型。', + 'type' => 'string', + 'example' => 'KubeletReady', + ], + 'status' => [ + 'description' => 'condition 状态。', + 'type' => 'string', + 'example' => 'False', + ], + 'reason' => [ + 'description' => 'condition原因。', + 'type' => 'string', + 'example' => 'xxxx', + ], + ], + ], + ], + 'events' => [ + 'description' => '识别为故障的 event 条件，仅 type 为 custom 时支持指定，和 conditions 字段二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '识别为故障的 event 条件。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'event类型。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'reason' => [ + 'description' => 'event原因。', + 'type' => 'string', + 'example' => 'xxxx', + ], + ], + ], + ], + ], + ], + ], + 'repair_procedure' => [ + 'description' => '修复流程。', + 'type' => 'array', + 'items' => [ + 'description' => '修复流程。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流程的名称。', + 'type' => 'string', + 'example' => 'QuarantineGPU', + ], + 'intervention' => [ + 'description' => '配置人工参与流程。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => '是否开启人工审批。', + 'type' => 'string', + 'example' => 'true', + ], + 'type' => [ + 'description' => '人工审批的类型。', + 'type' => 'string', + 'example' => 'label', + ], + 'inquiring_label' => [ + 'description' => '授权问询的标签配置，当进入该阶段时，ACK 会为您的节点添加以下标签（Label），等待您进行授权执行该阶段动作。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签key值。', + 'type' => 'string', + 'example' => 'k8s.aliyun.com/incident', + ], + 'value' => [ + 'description' => '标签value值。', + 'type' => 'string', + 'example' => 'inquiring', + ], + ], + ], + 'approved_label' => [ + 'description' => '确认授权的标签配置，当您为节点添加以下标签（Label）时，即表示授权 ACK 执行该阶段的操作。ACK 将在完成该阶段操作后，自动移除该阶段对应的授权问询与确认授权的标签（Label）。如您未及时添加以下标签（Label）授权，ACK 将不会执行该阶段动作和后续动作，节点可能停留在受损状态。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签`key`值。', + 'type' => 'string', + 'example' => 'k8s.aliyun.com/incident', + ], + 'value' => [ + 'description' => '标签 value 值。', + 'type' => 'string', + 'example' => 'approved', + ], + ], + ], + ], + ], + 'config' => [ + 'description' => '流程的配置参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '"drain_timeout": "30s" ', + 'description' => '流程的配置参数。', + ], + ], + ], + ], + ], + ], + ], + ], + 'resource_sub_type' => [ + 'description' => '自愈规则绑定的资源子类型。', + 'type' => 'string', + 'example' => 'ess', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"test\\",\\n \\"id\\": \\"r-xxx\\",\\n \\"resource_type\\": \\"nodepool\\",\\n \\"resource_ids\\": [\\n \\"npxxxxx\\"\\n ],\\n \\"rules\\": [\\n {\\n \\"incidents\\": [\\n {\\n \\"name\\": \\"Node.FaultNeedReboot.HOST\\",\\n \\"type\\": \\"system\\",\\n \\"conditions\\": [\\n {\\n \\"type\\": \\"KubeletReady\\",\\n \\"status\\": \\"False\\",\\n \\"reason\\": \\"xxxx\\"\\n }\\n ],\\n \\"events\\": [\\n {\\n \\"type\\": \\"xxxx\\",\\n \\"reason\\": \\"xxxx\\"\\n }\\n ]\\n }\\n ],\\n \\"repair_procedure\\": [\\n {\\n \\"name\\": \\"QuarantineGPU\\",\\n \\"intervention\\": {\\n \\"enable\\": \\"true\\",\\n \\"type\\": \\"label\\",\\n \\"inquiring_label\\": {\\n \\"key\\": \\"k8s.aliyun.com/incident\\",\\n \\"value\\": \\"inquiring\\"\\n },\\n \\"approved_label\\": {\\n \\"key\\": \\"k8s.aliyun.com/incident\\",\\n \\"value\\": \\"approved\\"\\n }\\n },\\n \\"config\\": {\\n \\"key\\": \\"\\\\\\"drain_timeout\\\\\\": \\\\\\"30s\\\\\\" \\"\\n }\\n }\\n ]\\n }\\n ],\\n \\"resource_sub_type\\": \\"ess\\"\\n}","type":"json"}]', + 'title' => '查询自愈规则', + 'description' => '><notice>API 暂未开放，敬请期待></notice>', + ], + 'ListAutoRepairPolicies' => [ + 'summary' => '获取自愈规则列表。', + 'path' => '/clusters/{cluster_id}/auto_repair_policies', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREcskEUXDVA', + ], + ], + 'parameters' => [ + [ + 'name' => 'cluster_id', + 'in' => 'path', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ce0da5a1d627e4e9e9f96cae8ad07****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'items' => [ + 'description' => '自愈规则。', + 'type' => 'array', + 'items' => [ + 'description' => '自愈规则。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '自愈规则名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'id' => [ + 'description' => '自愈规则ID。', + 'type' => 'string', + 'example' => 'r-xxxxx', + ], + 'resource_type' => [ + 'description' => '自愈规则绑定的资源类型。', + 'type' => 'string', + 'example' => 'nodepool', + ], + 'resource_sub_type' => [ + 'description' => '自愈规则绑定的资源子类型。', + 'type' => 'string', + 'example' => 'ess', + ], + 'resource_ids' => [ + 'description' => '自愈规则绑定的资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自愈规则绑定的资源列表。', + 'type' => 'string', + 'example' => 'npxxxxx', + ], + ], + 'rules' => [ + 'description' => '自愈子规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自愈子规则列表。', + 'type' => 'object', + 'properties' => [ + 'incidents' => [ + 'description' => '识别的故障列表。', + 'type' => 'array', + 'items' => [ + 'description' => '识别的故障列表。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '故障名称。', + 'type' => 'string', + 'example' => 'Node.FaultNeedReboot.HOST', + ], + 'type' => [ + 'description' => '诊断类型。', + 'type' => 'string', + 'example' => 'system'."\n", + ], + 'conditions' => [ + 'description' => '识别为故障的condition条件，仅type为custom时支持指定，和event字段二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '识别为故障的condition条件。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'condition类型。', + 'type' => 'string', + 'example' => 'KubeletReady', + ], + 'status' => [ + 'description' => 'condition状态。', + 'type' => 'string', + 'example' => 'False', + ], + 'reason' => [ + 'description' => 'condition原因。', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + 'events' => [ + 'description' => '识别为故障的event条件，仅type为custom时支持指定，和condition二选一。', + 'type' => 'array', + 'items' => [ + 'description' => '识别为故障的 event 条件。', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'description' => 'event类型。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'reason' => [ + 'description' => 'event的原因。', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + ], + ], + ], + ], + 'repair_procedure' => [ + 'description' => '修复流程。', + 'type' => 'array', + 'items' => [ + 'description' => '修复流程。', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'description' => '流程的名称。', + 'type' => 'string', + 'example' => 'QuarantineGPU', + ], + 'intervention' => [ + 'description' => '配置人工参与流程。', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => '是否开启人工审批。', + 'type' => 'string', + 'example' => 'true', + ], + 'type' => [ + 'description' => '人工审批的类型。', + 'type' => 'string', + 'example' => 'label', + ], + 'inquiring_label' => [ + 'description' => '授权问询的标签配置。当进入该阶段时，ACK 会为您的节点添加以下标签（Label），等待您进行授权执行该阶段动作。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签`key`值。', + 'type' => 'string', + 'example' => 'k8s.aliyun.com/incident', + ], + 'value' => [ + 'description' => '污点`value`值。', + 'type' => 'string', + 'example' => 'inquiring', + ], + ], + ], + 'approved_label' => [ + 'description' => '确认授权的 label 配置。当您为节点添加以下标签（Label）时，即表示授权 ACK 执行该阶段的操作。ACK 将在完成该阶段操作后，自动移除该阶段对应的授权问询与确认授权的标签（Label）。如您未及时添加以下标签（Label）授权，ACK 将不会执行该阶段动作和后续动作，节点可能停留在受损状态。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'description' => '标签`key`值。', + 'type' => 'string', + 'example' => 'k8s.aliyun.com/incident', + ], + 'value' => [ + 'description' => '标签`value`值。', + 'type' => 'string', + 'example' => 'approved', + ], + ], + ], + ], + ], + 'config' => [ + 'description' => '流程的配置参数。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{'."\n" + .'"drain_timeout": "30s" '."\n" + .'}', + 'description' => '流程的配置参数。', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"items\\": [\\n {\\n \\"name\\": \\"test\\",\\n \\"id\\": \\"r-xxxxx\\",\\n \\"resource_type\\": \\"nodepool\\",\\n \\"resource_sub_type\\": \\"ess\\",\\n \\"resource_ids\\": [\\n \\"npxxxxx\\"\\n ],\\n \\"rules\\": [\\n {\\n \\"incidents\\": [\\n {\\n \\"name\\": \\"Node.FaultNeedReboot.HOST\\",\\n \\"type\\": \\"system\\\\n\\",\\n \\"conditions\\": [\\n {\\n \\"type\\": \\"KubeletReady\\",\\n \\"status\\": \\"False\\",\\n \\"reason\\": \\"xxx\\"\\n }\\n ],\\n \\"events\\": [\\n {\\n \\"type\\": \\"xxx\\",\\n \\"reason\\": \\"xxx\\"\\n }\\n ]\\n }\\n ],\\n \\"repair_procedure\\": [\\n {\\n \\"name\\": \\"QuarantineGPU\\",\\n \\"intervention\\": {\\n \\"enable\\": \\"true\\",\\n \\"type\\": \\"label\\",\\n \\"inquiring_label\\": {\\n \\"key\\": \\"k8s.aliyun.com/incident\\",\\n \\"value\\": \\"inquiring\\"\\n },\\n \\"approved_label\\": {\\n \\"key\\": \\"k8s.aliyun.com/incident\\",\\n \\"value\\": \\"approved\\"\\n }\\n },\\n \\"config\\": {\\n \\"key\\": \\"{\\\\n\\\\\\"drain_timeout\\\\\\": \\\\\\"30s\\\\\\" \\\\n}\\"\\n }\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '获取自愈规则列表', + 'description' => '><notice>API 暂未开放，敬请期待></notice>', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'cs.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'cs.cn-beijing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'cs.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-jva', + 'endpoint' => 'cs.cn-zhengzhou-jva.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'cs.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'cs.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'cs.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'cs.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-nanjing', + 'endpoint' => 'cs.cn-nanjing.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fuzhou', + 'endpoint' => 'cs.cn-fuzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'cs.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'cs.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'cs.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'cs.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan-lr', + 'endpoint' => 'cs.cn-wuhan-lr.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'cs.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'cs.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'cs.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cs.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'cs.ap-southeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'cs.ap-southeast-3.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'cs.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'cs.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'cs.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'cs.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'cs.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'cs.ap-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'cs.me-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'cs.cn-hangzhou-finance.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'cs.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'cs.cn-shenzhen-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'cs.ap-southeast-7.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'cs.cn-beijing-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'cs.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan-acdr-1', + 'endpoint' => 'cs.cn-heyuan-acdr-1.aliyuncs.com', + ], + [ + 'regionId' => 'na-south-1', + 'endpoint' => 'cs.na-south-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-southeast-1', + 'endpoint' => 'cs.us-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu-gic-1', + 'endpoint' => 'cs.cn-wulanchabu-gic-1.aliyuncs.com', + ], + ], +]; |