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/eflo-controller/2022-12-15 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/eflo-controller/2022-12-15')
| -rw-r--r-- | data/zh_cn/eflo-controller/2022-12-15/api-docs.php | 11473 |
1 files changed, 11473 insertions, 0 deletions
diff --git a/data/zh_cn/eflo-controller/2022-12-15/api-docs.php b/data/zh_cn/eflo-controller/2022-12-15/api-docs.php new file mode 100644 index 0000000..03a43f5 --- /dev/null +++ b/data/zh_cn/eflo-controller/2022-12-15/api-docs.php @@ -0,0 +1,11473 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'eflo-controller', + 'version' => '2022-12-15', + ], + 'directories' => [ + [ + 'id' => 268833, + 'title' => '灵骏集群', + 'type' => 'directory', + 'children' => [ + 'CreateCluster', + 'DeleteCluster', + 'DescribeCluster', + 'ExtendCluster', + 'ListClusters', + 'ListClusterNodes', + 'ShrinkCluster', + ], + ], + [ + 'id' => 268841, + 'title' => '灵骏节点组', + 'type' => 'directory', + 'children' => [ + 'CreateNodeGroup', + 'UpdateNodeGroup', + 'DeleteNodeGroup', + 'ListNodeGroups', + ], + ], + [ + 'id' => 268846, + 'title' => '灵骏节点', + 'type' => 'directory', + 'children' => [ + 'DeleteNode', + 'DescribeNode', + 'ListFreeNodes', + 'RebootNodes', + 'ReimageNodes', + ], + ], + [ + 'id' => 268852, + 'title' => '灵骏Vsc', + 'type' => 'directory', + 'children' => [ + 'CreateVsc', + 'DescribeVsc', + 'DeleteVsc', + 'ListVscs', + ], + ], + [ + 'id' => 268857, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'UntagResources', + 'TagResources', + 'ListTagResources', + 'DescribeZones', + 'DescribeTask', + 'DescribeRegions', + 'ChangeResourceGroup', + 'ApproveOperation', + 'StopInvocation', + 'RunCommand', + 'DescribeInvocations', + 'DescribeSendFileResults', + 'SendFile', + 'ListMachineTypes', + 'CreateDiagnosticTask', + 'StopNodes', + 'ListImages', + 'DescribeDiagnosticResult', + 'CloseSession', + 'CreateSession', + 'CreateNetTestTask', + 'ListUserClusterTypes', + 'ListNetTestResults', + 'ListDiagnosticResults', + 'DescribeNetTestResult', + 'ListMachineNetworkInfo', + ], + ], + [ + 'id' => 268884, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'DescribeNodeType', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'ListSyslogs', + 'ReportNodesStatus', + 'DescribeNodeGroup', + 'ChangeNodeGroup', + 'ListClusterHyperNodes', + 'ListHyperNodes', + 'ListFreeHyperNodes', + 'DescribeHyperNode', + 'ChangeNodeTypes', + 'DeleteHyperNode', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateCluster' => [ + 'summary' => '创建一个新的灵骏集群。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ClusterName', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群名称', + 'description' => '集群名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard_Cluster', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群类型', + 'description' => '集群类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Lite' => 'Lite', + ], + 'example' => 'Lite', + ], + ], + [ + 'name' => 'ClusterDescription', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群描述', + 'description' => '集群描述', + 'type' => 'string', + 'required' => false, + 'example' => '标准集群测试', + ], + ], + [ + 'name' => 'NodeGroups', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '节点组列表'."\n", + 'description' => '节点组列表'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '节点分组信息', + 'type' => 'object', + 'properties' => [ + 'SystemDisk' => [ + 'description' => '系统盘信息', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'description' => '磁盘类型。取值范围:'."\n" + ."\n" + .' - cloud_essd:ESSD云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'description' => '单位GB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '9999', + ], + 'PerformanceLevel' => [ + 'description' => '创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。取值范围:'."\n" + .'- PL0:单盘最高随机读写IOPS 1万。'."\n" + .'- PL1:单盘最高随机读写IOPS 5万。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + ], + 'required' => false, + ], + 'NodeGroupDescription' => [ + 'title' => '节点组描述', + 'description' => '节点组描述', + 'type' => 'string', + 'required' => false, + 'example' => '默认节点组', + ], + 'KeyPairName' => [ + 'description' => '密钥对名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-keypair', + ], + 'FileSystemMountEnabled' => [ + 'title' => '是否支持文件系统挂载', + 'description' => '是否支持文件系统挂载', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'NodeGroupName' => [ + 'title' => '节点组名称', + 'description' => '节点组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'emr-default', + ], + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + 'UserData' => [ + 'title' => '用户自定义脚本,命令', + 'description' => '实例自定义数据。需要以Base64方式编码,原始数据最多为16 KB。', + 'type' => 'string', + 'required' => false, + 'example' => 'ZWNobyBoZWxsbyBlY3Mh', + ], + 'VirtualGpuEnabled' => [ + 'title' => '是否支持GPU虚拟化切分', + 'description' => '是否开启GPU虚拟化切分', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'required' => false, + 'example' => 'efg1.nvga1', + ], + 'ImageId' => [ + 'title' => '系统镜像id', + 'description' => '系统镜像ID', + 'type' => 'string', + 'required' => false, + 'example' => 'i190297201634099844192', + ], + 'Nodes' => [ + 'title' => '节点列表', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表', + 'type' => 'object', + 'properties' => [ + 'DataDisk' => [ + 'description' => '数据盘规格。', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘规格信息。', + 'type' => 'object', + 'properties' => [ + 'DeleteWithNode' => [ + 'description' => '数据盘是否随节点退订删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'True', + ], + 'Category' => [ + 'description' => '类型', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'description' => '磁盘大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'PerformanceLevel' => [ + 'description' => '数据盘性能参数', + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + 'BurstingEnabled' => [ + 'description' => '是否开启Burst(性能突发)', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'ProvisionedIops' => [ + 'description' => '预配置性能(IOPS)。取值范围为0~50000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'VpcId' => [ + 'title' => 'dpu使用的虚拟网络id', + 'description' => '专有网络ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-0jlasms92fdxqd3wlf8ny', + ], + 'VSwitchId' => [ + 'title' => 'dpu使用的交换机id'."\n", + 'description' => '虚拟交换机ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp169pi5fj151rrms4sia', + ], + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01poc-cn-i7m2wnivf0d', + ], + 'Hostname' => [ + 'title' => '主机名'."\n", + 'description' => '主机名'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8d13b784-17a9-11ed-bc7b-acde48001122', + ], + 'LoginPassword' => [ + 'title' => '登录密码', + 'description' => '登录密码', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'HyperNodes' => [ + 'title' => '节点列表', + 'description' => '超节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '超节点信息。', + 'type' => 'object', + 'properties' => [ + 'DataDisk' => [ + 'description' => '数据盘列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘信息。', + 'type' => 'object', + 'properties' => [ + 'DeleteWithNode' => [ + 'description' => '数据盘是否随节点退订删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'True', + ], + 'Category' => [ + 'description' => '磁盘类型。取值范围:'."\n" + ."\n" + .' - cloud_essd:ESSD云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'description' => '磁盘大小,单位GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '180', + ], + 'PerformanceLevel' => [ + 'description' => '创建ESSD云盘作为数据盘使用时,设置云盘的性能等级。取值范围:'."\n" + .'- PL0:单盘最高随机读写IOPS 1万。'."\n" + .'- PL1:单盘最高随机读写IOPS 5万。'."\n" + .'- PL2:单盘最高随机读写IOPS 10万。'."\n" + .'- PL3:单盘最高随机读写IOPS 100万。'."\n" + ."\n" + .'默认值:PL1。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + 'BurstingEnabled' => [ + 'description' => '是否开启 Burst(性能突发)', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ProvisionedIops' => [ + 'description' => 'ESSD AutoPL 云盘(单盘)预配置性能的读写 IOPS。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'VpcId' => [ + 'title' => 'dpu使用的虚拟网络id', + 'description' => '专有网络ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf689skpx56nk7yfw0jhy', + ], + 'VSwitchId' => [ + 'title' => 'dpu使用的交换机id'."\n", + 'description' => '专有网络交换机ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp1xn9iq3s3p8218c4qu4', + ], + 'HyperNodeId' => [ + 'title' => '节点id', + 'description' => '超节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-dw72u2c23jk', + ], + 'Hostname' => [ + 'title' => '主机名'."\n", + 'description' => '主机名', + 'type' => 'string', + 'required' => false, + 'example' => 'q25b01265.cloud.ng152', + ], + 'LoginPassword' => [ + 'title' => '登录密码', + 'description' => '登录密码'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aaadddddfdsfdsfsdffd', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'LoginPassword' => [ + 'title' => '节点组内的机器登录密码', + 'description' => '登录密码', + 'type' => 'string', + 'required' => false, + 'example' => '密码', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IgnoreFailedNodeTasks', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许跳过失败节点,默认值为Flase', + 'description' => '是否允许跳过失败节点,默认值为False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组id', + 'description' => '资源组ID', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'rg-acfm26zesdlqa2q' => 'rg-acfm26zesdlqa2q', + ], + 'example' => 'rg-aek2xdkc6icwfha', + ], + ], + [ + 'name' => 'Networks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '网络信息', + 'description' => '网络信息', + 'type' => 'object', + 'properties' => [ + 'NewVpdInfo' => [ + 'description' => 'Vpd配置信息', + 'type' => 'object', + 'properties' => [ + 'CenId' => [ + 'title' => '云企业网id', + 'description' => '云企业网ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cen-1gb1eftc5qp2ao75fo', + ], + 'CloudLinkCidr' => [ + 'title' => '云链cidr', + 'description' => '云链cidr', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.0.0/24', + ], + 'CloudLinkId' => [ + 'title' => '云链id', + 'description' => '云链ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vcc-cn-c4dtycm5i08', + ], + 'MonitorVpcId' => [ + 'title' => '专有网络', + 'description' => '专有网络', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-0jl2x45apm6odc2c10h25', + ], + 'MonitorVswitchId' => [ + 'title' => '专有网络交换机', + 'description' => '专有网络交换机', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-0jl2w3ffbghkss0x2foff', + ], + 'VpdCidr' => [ + 'title' => '集群网段', + 'description' => '集群网段', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.0/16', + ], + 'VpdSubnets' => [ + 'title' => 'vpd子网信息', + 'description' => '集群子网', + 'type' => 'array', + 'items' => [ + 'description' => '集群子网', + 'type' => 'object', + 'properties' => [ + 'SubnetCidr' => [ + 'title' => '子网cidr', + 'description' => '子网cidr', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.1.8/24', + ], + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-wulanchabu-b', + ], + 'SubnetType' => [ + 'title' => '子网类型', + 'description' => '子网类型', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.2.8/24', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'VpdInfo' => [ + 'description' => '复用VPD信息', + 'type' => 'object', + 'properties' => [ + 'VpdId' => [ + 'description' => '专有网络ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpd-vfuz6ejv', + ], + 'VpdSubnets' => [ + 'description' => '集群子网ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '集群子网ID', + 'type' => 'string', + 'required' => false, + 'example' => 'subnet-jcloe1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'IpAllocationPolicy' => [ + 'description' => 'IP分配策略', + 'type' => 'array', + 'items' => [ + 'description' => 'IP分配策略', + 'type' => 'object', + 'properties' => [ + 'MachineTypePolicy' => [ + 'description' => '机型分配策略', + 'type' => 'array', + 'items' => [ + 'description' => '机型分配策略', + 'type' => 'object', + 'properties' => [ + 'Bonds' => [ + 'description' => 'bond信息', + 'type' => 'array', + 'items' => [ + 'description' => 'bond信息', + 'type' => 'object', + 'properties' => [ + 'Subnet' => [ + 'description' => 'IP来源集群子网', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.0/24', + ], + 'Name' => [ + 'description' => 'bond名称', + 'type' => 'string', + 'required' => false, + 'example' => 'bond0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'MachineType' => [ + 'description' => '机型', + 'type' => 'string', + 'required' => false, + 'example' => 'efg1.nvga8n', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'BondPolicy' => [ + 'description' => 'bond策略', + 'type' => 'object', + 'properties' => [ + 'Bonds' => [ + 'description' => 'bond信息', + 'type' => 'array', + 'items' => [ + 'description' => 'bond信息', + 'type' => 'object', + 'properties' => [ + 'Subnet' => [ + 'description' => 'IP来源集群子网', + 'type' => 'string', + 'required' => false, + 'example' => '172.16.0.0/24', + ], + 'Name' => [ + 'description' => 'bond名称', + 'type' => 'string', + 'required' => false, + 'example' => 'bond0', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'BondDefaultSubnet' => [ + 'description' => '默认bond集群子网', + 'type' => 'string', + 'required' => false, + 'example' => '172.168.0.0/24', + ], + ], + 'required' => false, + ], + 'NodePolicy' => [ + 'description' => '节点分配策略', + 'type' => 'array', + 'items' => [ + 'description' => '节点分配策略', + 'type' => 'object', + 'properties' => [ + 'Bonds' => [ + 'description' => 'bond信息', + 'type' => 'array', + 'items' => [ + 'description' => 'bond信息', + 'type' => 'object', + 'properties' => [ + 'Subnet' => [ + 'description' => 'IP来源集群子网', + 'type' => 'string', + 'required' => false, + 'example' => '10.0.0.0/24', + ], + 'Name' => [ + 'description' => 'bond名称', + 'type' => 'string', + 'required' => false, + 'example' => 'bond0'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'NodeId' => [ + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-2r42vq62001', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp1d3dvbh9by7j5rujax', + ], + 'VSwitchZoneId' => [ + 'description' => '交换机ZoneID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-b', + ], + 'VpcId' => [ + 'description' => '专有网络ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-0jl36lqzmc06qogy0t5ll', + ], + 'VSwitchId' => [ + 'description' => '交换机ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-asjdfklj', + ], + 'TailIpVersion' => [ + 'description' => 'IP版本', + 'type' => 'string', + 'required' => false, + 'example' => 'IPv4', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源标签', + 'description' => '资源标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表', + 'type' => 'object', + 'properties' => [ + 'Value' => [ + 'title' => '值', + 'description' => '值', + 'type' => 'string', + 'required' => false, + 'example' => 'dev', + ], + 'Key' => [ + 'title' => '键', + 'description' => '键', + 'type' => 'string', + 'required' => false, + 'example' => 'env-name', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Components', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '组件(软件实例)', + 'description' => '组件(软件实例)', + 'type' => 'array', + 'items' => [ + 'title' => '组件类型', + 'description' => '组件类型', + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'title' => '组件类型: "ACKEdge"(ACK边缘集群)'."\n" + .'"ARMS"(ARMS监控)', + 'description' => '组件类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ARMS' => 'ARMS监控', + 'ACKEdge' => 'ACK边缘集群', + ], + 'example' => 'ACKEdge', + ], + 'ComponentConfig' => [ + 'title' => '组件配置', + 'description' => '组件配置', + 'type' => 'object', + 'properties' => [ + 'BasicArgs' => [ + 'description' => '组件基础参数', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "EndpointPublicAccess": false,'."\n" + .' "ContainerCidr": "10.4.0.0/24",'."\n" + .' "KeyPair": "test",'."\n" + .' "NodeCidrMask": "25",'."\n" + .' "ResourceGroupId": "rg-axsadm3sdzsdvdsndstdisd",'."\n" + .' "WorkerSystemDiskCategory": "da",'."\n" + .' "WorkerSystemDiskSize": 40,'."\n" + .' "DeletionProtection": false,'."\n" + .' "KubeProxy": "iptables",'."\n" + .' "Name": "da",'."\n" + .' "LoadBalancerSpec": "slb.s1.small",'."\n" + .' "Runtime": {'."\n" + .' "Version": "19.03.15",'."\n" + .' "Name": "docker"'."\n" + .' },'."\n" + .' "IsEnterpriseSecurityGroup": true,'."\n" + .' "Vpcid": "192.168.23.0/24",'."\n" + .' "NumOfNodes": 1,'."\n" + .' "VswitchIds": ['."\n" + .' "dad"'."\n" + .' ],'."\n" + .' "ServiceCidr": "10.0.0.0/16",'."\n" + .' "SnatEntry": false,'."\n" + .' "kubernetesVersion": "1.20.11-aliyunedge.1",'."\n" + .' "WorkerInstanceTypes": ['."\n" + .' "da"'."\n" + .' ]'."\n" + .'}', + ], + 'NodeUnits' => [ + 'title' => '节点池配置, 并用于建立节点组和节点池的对应关系。 当'."\n" + .'ComponentType=”ACKEdge“时必填,其他为空。', + 'description' => '节点池配置, 并用于建立节点组和节点池的对应关系。 当'."\n" + .'ComponentType=”ACKEdge“时必填,其他为空。', + 'type' => 'array', + 'items' => [ + 'description' => '节点池配置, 并用于建立节点组和节点池的对应关系。 当'."\n" + .'ComponentType=”ACKEdge“时必填,其他为空。', + 'type' => 'any', + 'required' => false, + 'example' => '{'."\n" + .' "Options": {},'."\n" + .' "Type": "edge",'."\n" + .' "ResourceGroupId": "rg-acfm2cdxm3zvnt4dsa1s1t65fi",'."\n" + .' "RelatedNodeGroups": ['."\n" + .' "tes"'."\n" + .' ],'."\n" + .' "NodeUnitKey": "da",'."\n" + .' "MaxNodes": 30'."\n" + .'}', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'HpnZone', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群编号', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'A1' => 'A1', + ], + 'example' => 'A1', + ], + ], + [ + 'name' => 'NimizVSwitches', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Node虚拟交换机', + 'type' => 'array', + 'items' => [ + 'description' => 'Node虚拟交换机ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-0jlx7dkziyhgf6klwnsi3', + ], + 'required' => false, + ], + ], + [ + 'name' => 'OpenEniJumboFrame', + 'in' => 'formData', + 'schema' => [ + 'description' => '网络接口是否支持巨帧', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应体参数。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '3C683243-7915-57FB-9570-A2932C1C0F78', + ], + 'ClusterId' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'example' => 'i116913051663373010974', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i159809891662373011015', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C683243-7915-57FB-9570-A2932C1C0F78\\",\\n \\"ClusterId\\": \\"i116913051663373010974\\",\\n \\"TaskId\\": \\"i159809891662373011015\\"\\n}","type":"json"}]', + 'title' => '创建集群', + ], + 'DeleteCluster' => [ + 'summary' => '删除灵骏集群实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群 id', + 'type' => 'string', + 'required' => true, + 'example' => 'i116913051662373010974', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '0FC4A1C7-421C-5EAB-9361-4C0338EFA287', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FC4A1C7-421C-5EAB-9361-4C0338EFA287\\"\\n}","type":"json"}]', + 'title' => '删除集群', + ], + 'DescribeCluster' => [ + 'summary' => '查询灵骏集群详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => '集群id。', + 'type' => 'string', + 'required' => true, + 'example' => 'i119982311660892626523', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id。', + 'type' => 'string', + 'example' => '887FA855-89F4-5DB3-B305-C5879EC480E6', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-06-08T07:05:11Z', + ], + 'NodeCount' => [ + 'title' => '节点数', + 'description' => '节点数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NodeGroupCount' => [ + 'title' => '节点组数量', + 'description' => '节点组数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2022-08-23T06:36:17.000Z', + ], + 'ClusterDescription' => [ + 'title' => '集群描述', + 'description' => '集群描述', + 'type' => 'string', + 'example' => '测试集群', + ], + 'OperatingState' => [ + 'title' => '集群状态', + 'description' => '集群状态', + 'type' => 'string', + 'example' => 'running', + ], + 'Components' => [ + 'title' => '组件信息', + 'description' => '组件信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ComponentType' => [ + 'title' => '组件类型', + 'description' => '组件类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'ARMS' => 'ARMS监控', + 'ACKEdge' => 'ACK边缘集群', + ], + 'example' => 'ACKEdge', + ], + 'ComponentId' => [ + 'title' => '组件id', + 'description' => '组件id', + 'type' => 'string', + 'example' => 'i149549021660892626529', + ], + ], + ], + ], + 'ClusterId' => [ + 'title' => '集群id'."\n", + 'description' => '集群id'."\n", + 'type' => 'string', + 'example' => 'i116913051662373010974', + ], + 'ClusterName' => [ + 'title' => '集群名称', + 'description' => '集群名称', + 'type' => 'string', + 'example' => 'Eflo-YJ-Test-Cluster', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i152609221670466904596', + ], + 'ClusterType' => [ + 'title' => '集群类型', + 'description' => '集群类型', + 'type' => 'string', + 'example' => 'AckEdgePro', + ], + 'ResourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'example' => 'rg-aek2k3rqlvv6ytq', + ], + 'VpcId' => [ + 'description' => '专有网络ID', + 'type' => 'string', + 'example' => 'vpc-0jlkqysom5dmcviymep3f', + ], + 'HpnZone' => [ + 'description' => '集群编号', + 'type' => 'string', + 'example' => 'A2', + ], + 'ComputingIpVersion' => [ + 'description' => '计算网络的IP类型', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'OpenEniJumboFrame' => [ + 'description' => '网络接口巨帧', + 'type' => 'string', + 'example' => 'unsupported', + ], + 'Networks' => [ + 'title' => '网络信息', + 'description' => '网络信息', + 'type' => 'object', + 'properties' => [ + 'VpdId' => [ + 'title' => '集群网段id', + 'description' => '集群网段id', + 'type' => 'string', + 'example' => 'vpd-iqd7xunc', + ], + ], + ], + 'VSwitchId' => [ + 'description' => '专有网络交换机ID', + 'type' => 'string', + 'example' => 'vsw-0jlwrfecgcbflyosvo242', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID', + 'type' => 'string', + 'example' => 'sg-0jlff84q4o3s58i7fkhy', + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"887FA855-89F4-5DB3-B305-C5879EC480E6\\",\\n \\"CreateTime\\": \\"2022-06-08T07:05:11Z\\",\\n \\"NodeCount\\": 2,\\n \\"NodeGroupCount\\": 2,\\n \\"UpdateTime\\": \\"2022-08-23T06:36:17.000Z\\",\\n \\"ClusterDescription\\": \\"测试集群\\",\\n \\"OperatingState\\": \\"running\\",\\n \\"Components\\": [\\n {\\n \\"ComponentType\\": \\"ACKEdge\\",\\n \\"ComponentId\\": \\"i149549021660892626529\\"\\n }\\n ],\\n \\"ClusterId\\": \\"i116913051662373010974\\",\\n \\"ClusterName\\": \\"Eflo-YJ-Test-Cluster\\",\\n \\"TaskId\\": \\"i152609221670466904596\\",\\n \\"ClusterType\\": \\"AckEdgePro\\",\\n \\"ResourceGroupId\\": \\"rg-aek2k3rqlvv6ytq\\",\\n \\"VpcId\\": \\"vpc-0jlkqysom5dmcviymep3f\\",\\n \\"HpnZone\\": \\"A2\\",\\n \\"ComputingIpVersion\\": \\"IPv4\\",\\n \\"OpenEniJumboFrame\\": \\"unsupported\\",\\n \\"Networks\\": {\\n \\"VpdId\\": \\"vpd-iqd7xunc\\"\\n },\\n \\"VSwitchId\\": \\"vsw-0jlwrfecgcbflyosvo242\\",\\n \\"SecurityGroupId\\": \\"sg-0jlff84q4o3s58i7fkhy\\"\\n}","type":"json"}]', + 'title' => '查询集群', + 'description' => '关闭远程会话的接口。', + ], + 'ExtendCluster' => [ + 'summary' => '集群扩容。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '161261', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群ID', + 'type' => 'string', + 'required' => false, + 'example' => 'i15b480fbd2fcdbc2869cd80', + ], + ], + [ + 'name' => 'NodeGroups', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '节点组', + 'description' => '节点组', + 'type' => 'array', + 'items' => [ + 'description' => '节点组', + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'title' => '节点列表。当Amount参数取值为1~500时,该参数失效。', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表', + 'type' => 'object', + 'properties' => [ + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名', + 'type' => 'string', + 'required' => false, + 'example' => 'd044d220-33fd-11ed-86a6', + ], + 'LoginPassword' => [ + 'title' => '登录密码'."\n", + 'description' => '登录密码'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-zvp2zdpy601', + ], + 'VpcId' => [ + 'description' => '专有网络ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-0jlasms92fdxqd3wlf8ny', + ], + 'VSwitchId' => [ + 'description' => '交换机ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp169pi5fj151rrms4sia', + ], + 'DataDisk' => [ + 'description' => '数据盘规格', + 'type' => 'array', + 'items' => [ + 'description' => '数据盘规格', + 'type' => 'object', + 'properties' => [ + 'DeleteWithNode' => [ + 'description' => '数据盘是否随节点退订删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'True', + ], + 'Category' => [ + 'description' => '类型', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'description' => '磁盘大小', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '80', + ], + 'PerformanceLevel' => [ + 'description' => '数据盘性能参数', + 'type' => 'string', + 'required' => false, + 'example' => 'PL0', + ], + 'BurstingEnabled' => [ + 'description' => '是否开启Burst(性能突发)', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ProvisionedIops' => [ + 'description' => '预配置性能(IOPS)。取值范围为0~50000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'HyperNodes' => [ + 'title' => '节点列表。当Amount参数取值为1~500时,该参数失效。', + 'description' => '超节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '超节点信息', + 'type' => 'object', + 'properties' => [ + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名', + 'type' => 'string', + 'required' => false, + 'example' => 'liliang-rmn7stf7-0000', + ], + 'LoginPassword' => [ + 'title' => '登录密码'."\n", + 'description' => '登录密码', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'HyperNodeId' => [ + 'title' => '节点id', + 'description' => '超节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-2r42tmj4z02', + ], + 'VpcId' => [ + 'description' => '专有网络ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-0jl8gs7qmx89739e210dn', + ], + 'VSwitchId' => [ + 'description' => '交换机ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-8vbobo4cvzsygw98f4j6b', + ], + 'DataDisk' => [ + 'description' => '磁盘信息列表', + 'type' => 'array', + 'items' => [ + 'description' => '磁盘信息', + 'type' => 'object', + 'properties' => [ + 'DeleteWithNode' => [ + 'description' => '数据盘是否随节点退订删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + 'default' => 'True', + ], + 'Category' => [ + 'description' => '磁盘类型。取值范围:'."\n" + ."\n" + .' - cloud_essd:ESSD云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'description' => '磁盘大小,单位GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'PerformanceLevel' => [ + 'description' => '创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。取值范围:'."\n" + .'- PL0:单盘最高随机读写IOPS 1万。'."\n" + .'- PL1:单盘最高随机读写IOPS 5万。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'BurstingEnabled' => [ + 'description' => '是否开启 Burst(性能突发)。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'ProvisionedIops' => [ + 'description' => 'ESSD AutoPL 云盘(单盘)预配置性能的读写 IOPS。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '9600', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'NodeGroupId' => [ + 'title' => '节点组id', + 'description' => '节点组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'i16d4883a46cbadeb4bc9', + ], + 'UserData' => [ + 'title' => '用户自定义脚本,命令', + 'description' => '自定义数据', + 'type' => 'string', + 'required' => false, + 'example' => '#!/bin/sh'."\n" + .'echo "Hello World. The time is now $(date -R)!" | tee /root/userdata_test.txt', + ], + 'ZoneId' => [ + 'description' => '可用区ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + 'Amount' => [ + 'title' => '购买节点的数量。取值范围:0~500。'."\n" + .'● 如果Amount参数取值为0,则表示不购买节点,使用已有节点进行扩容。'."\n" + .'● 如果Amount参数取值为1~500,则表示购买一定数量节点,并使用购买的节点进行扩容。'."\n" + .'默认值:0', + 'description' => '购买节点的数量。取值范围:0~500。 如果 Amount 参数取值为 0,则表示不购买节点,使用已有节点进行扩容。 如果 Amount 参数取值为 1~500,则表示购买一定数量节点,并使用购买的节点进行扩容。 默认值:0', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4', + ], + 'ChargeType' => [ + 'title' => '节点的付费方式。当Amount参数取值为0时,该参数不生效。取值范围:'."\n" + .'● PrePaid:包年包月。'."\n" + .'● PostPaid:按量付费。'."\n" + .'默认值:PrePaid。', + 'description' => '节点的付费方式。当 Amount 参数取值为 0 时,该参数不生效。取值范围: PREPAY:包年包月;POSTPAY:按量付费。 默认值:PREPAY。', + 'type' => 'string', + 'required' => false, + 'example' => 'PostPaid', + ], + 'Period' => [ + 'title' => '购买节点的时长(单位:月)。取值范围:1、6、12、24、36、48。当Amount参数取值不为0且ChargeType取值为PrePaid时,该参数生效。', + 'description' => '购买节点的时长(单位:月)。取值范围:1、6、12、24、36、48。当 Amount 参数取值不为 0 且 ChargeType 取值为 PREPAY 时,该参数生效。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '6', + ], + 'AutoRenew' => [ + 'title' => '购买的节点是否要自动续费。当Amount参数取值不为0且ChargeType取值为PrePaid时,该参数生效。取值范围:'."\n" + .'● True:自动续费'."\n" + .'● False:不自动续费'."\n" + .'默认值:False', + 'description' => '购买的节点是否要自动续费。当 Amount 参数取值不为 0 且 ChargeType 取值为 PREPAY或POSTPAY 时,该参数生效。取值范围: True:自动续费 ; False:不自动续费。 默认值:False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + 'Hostnames' => [ + 'title' => '设置购买节点的主机名。当Amount参数取值为0时,该参数不生效。', + 'description' => '设置购买节点的主机名。当 Amount 参数取值为 0 时,该参数不生效。', + 'type' => 'array', + 'items' => [ + 'description' => '主机名。', + 'type' => 'string', + 'required' => false, + 'example' => 'i22c11282.eu95sqa', + ], + 'required' => false, + ], + 'LoginPassword' => [ + 'title' => '设置购买节点的登陆密码。当Amount参数取值为0时,该参数不生效。', + 'description' => '设置购买节点的登录密码。当 Amount 参数取值为 0 时,该参数不生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'skkO(*89Y', + ], + 'NodeTag' => [ + 'title' => '节点的标签信息。当Amount参数取值为0时,该参数不生效。', + 'description' => '节点标签', + 'type' => 'array', + 'items' => [ + 'description' => '节点标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '节点的标签键', + 'description' => '节点标签key', + 'type' => 'string', + 'required' => false, + 'example' => 'key_my', + ], + 'Value' => [ + 'title' => '节点的标签值', + 'description' => '节点标签value', + 'type' => 'string', + 'required' => false, + 'example' => 'value_my', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'VpcId' => [ + 'title' => '专有网络 ID', + 'description' => '专有网络ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-0jl3b0c0ukydlfezr13n6', + ], + 'VSwitchId' => [ + 'title' => '交换机 ID', + 'description' => '交换机ID', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf65m8xqjgy55xj9jw92n', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IgnoreFailedNodeTasks', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许跳过失败节点,默认值为Flase', + 'description' => '是否允许跳过失败节点,默认值为False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False'."\n", + ], + ], + [ + 'name' => 'VpdSubnets', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '集群子网列表', + 'type' => 'array', + 'items' => [ + 'description' => 'vpd子网', + 'type' => 'string', + 'required' => false, + 'example' => '["subnet-3od2fe","subnet-fdo3dv"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'IpAllocationPolicy', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '分配IP的组合策略: 每个策略只能选择一种策略类型,可以有多个策略进行组合', + 'type' => 'array', + 'items' => [ + 'description' => '分配IP策略', + 'type' => 'object', + 'properties' => [ + 'BondPolicy' => [ + 'description' => '根据bond名称指定集群子网ID', + 'type' => 'object', + 'properties' => [ + 'BondDefaultSubnet' => [ + 'description' => '默认bond集群子网', + 'type' => 'string', + 'required' => false, + 'example' => 'subnet-3od2fe', + ], + 'Bonds' => [ + 'description' => 'bond信息', + 'type' => 'array', + 'items' => [ + 'description' => 'bond对象', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'bond名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Bond0', + ], + 'Subnet' => [ + 'description' => 'IP来源集群子网', + 'type' => 'string', + 'required' => false, + 'example' => 'subnet-3od2fe'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'MachineTypePolicy' => [ + 'description' => '机型分配策略', + 'type' => 'array', + 'items' => [ + 'description' => '策略对象', + 'type' => 'object', + 'properties' => [ + 'Bonds' => [ + 'description' => 'bond信息', + 'type' => 'array', + 'items' => [ + 'description' => 'bond对象', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'bond名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Bond0', + ], + 'Subnet' => [ + 'description' => 'IP来源集群子网', + 'type' => 'string', + 'required' => false, + 'example' => 'subnet-fdo3dv', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'MachineType' => [ + 'description' => '机型', + 'type' => 'string', + 'required' => false, + 'example' => 'efg1.nvga1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'NodePolicy' => [ + 'description' => '节点分配策略', + 'type' => 'array', + 'items' => [ + 'description' => '策略对象', + 'type' => 'object', + 'properties' => [ + 'Bonds' => [ + 'description' => 'bond信息', + 'type' => 'array', + 'items' => [ + 'description' => 'bond对象', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'bond名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Bond0', + ], + 'Subnet' => [ + 'description' => 'IP来源集群子网', + 'type' => 'string', + 'required' => false, + 'example' => 'subnet-fdo3dv', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'NodeId' => [ + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'i-3fdodw2', + ], + 'Hostname' => [ + 'description' => '主机名', + 'type' => 'string', + 'required' => false, + 'example' => 'a100-xa5dza28-0085', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'VSwitchZoneId', + 'in' => 'formData', + 'schema' => [ + 'description' => '交换机可用区ID', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cn-beijing-d' => 'cn-beijing-b', + ], + 'example' => 'cn-shanghai-b', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '出参', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求ID', + 'type' => 'string', + 'example' => '03668372-18FF-5959-98D9-6B36A4643C7A', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'i158475611663639202234', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03668372-18FF-5959-98D9-6B36A4643C7A\\",\\n \\"TaskId\\": \\"i158475611663639202234\\"\\n}","type":"json"}]', + 'title' => '扩容集群', + ], + 'ListClusters' => [ + 'summary' => '查询集群实例列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161259', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'description' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a3f2224a5ec7224116c4f5246120abe2', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数,默认值为20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2bg6wyoox6jq', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key', + 'type' => 'string', + 'required' => false, + 'example' => 'my_key', + 'maxLength' => 129, + ], + 'Value' => [ + 'description' => '标签value', + 'type' => 'string', + 'required' => false, + 'example' => 'my_value', + 'maxLength' => 129, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1', + ], + 'Clusters' => [ + 'title' => '集群信息', + 'description' => '集群信息', + 'type' => 'array', + 'items' => [ + 'description' => '集群对象', + 'type' => 'object', + 'properties' => [ + 'Components' => [ + 'title' => '组件信息'."\n", + 'description' => '组件信息'."\n", + 'type' => 'any', + 'example' => '{}', + ], + 'ClusterId' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'example' => 'i137590131672134915401', + ], + 'ClusterName' => [ + 'title' => '集群name', + 'description' => '集群name', + 'type' => 'string', + 'example' => 'cnp_test_cluster', + ], + 'OperatingState' => [ + 'title' => '集群状态', + 'description' => '集群状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'running' => '运行中', + 'expanding' => '扩容中', + 'shrinking' => '缩容中', + 'initializing' => '初始化中', + ], + 'example' => 'initializing', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i156365121663149566024', + ], + 'ClusterType' => [ + 'title' => '集群类型', + 'description' => '集群类型', + 'type' => 'string', + 'enumValueTitles' => [ + 'AckEdgePro' => '基于ACK@Edge Pro的灵骏集群', + 'ExclusiveBareCluster' => '专属裸集群', + 'Lite' => '基础版灵骏集群', + ], + 'example' => 'AckEdgePro', + ], + 'NodeCount' => [ + 'title' => '节点数量', + 'description' => '节点数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'NodeGroupCount' => [ + 'title' => '节点组数量', + 'description' => '节点组数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1672134938', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '1672134968', + ], + 'ClusterDescription' => [ + 'title' => '集群描述', + 'description' => '集群描述', + 'type' => 'string', + 'example' => '测试集群', + ], + 'ResourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'example' => 'rg-aek2ajbjoloa23q', + ], + 'VpcId' => [ + 'description' => '专有网络id', + 'type' => 'string', + 'example' => 'vpc-0jlx4hol2bjboafzmffvd', + ], + 'HpnZone' => [ + 'description' => '集群编号', + 'type' => 'string', + 'example' => 'B1', + ], + 'ComputingIpVersion' => [ + 'description' => '计算网络的IP类型', + 'type' => 'string', + 'example' => 'IPv4', + ], + 'Tags' => [ + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值', + 'type' => 'string', + 'example' => 'daily', + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '本次调用返回的查询凭证值。'."\n", + 'description' => '本次调用返回的查询凭证值。'."\n", + 'type' => 'string', + 'example' => 'f4f9a292c17072a2', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1\\",\\n \\"Clusters\\": [\\n {\\n \\"Components\\": \\"{}\\",\\n \\"ClusterId\\": \\"i137590131672134915401\\",\\n \\"ClusterName\\": \\"cnp_test_cluster\\",\\n \\"OperatingState\\": \\"initializing\\",\\n \\"TaskId\\": \\"i156365121663149566024\\",\\n \\"ClusterType\\": \\"AckEdgePro\\",\\n \\"NodeCount\\": 12,\\n \\"NodeGroupCount\\": 2,\\n \\"CreateTime\\": \\"1672134938\\",\\n \\"UpdateTime\\": \\"1672134968\\",\\n \\"ClusterDescription\\": \\"测试集群\\",\\n \\"ResourceGroupId\\": \\"rg-aek2ajbjoloa23q\\",\\n \\"VpcId\\": \\"vpc-0jlx4hol2bjboafzmffvd\\",\\n \\"HpnZone\\": \\"B1\\",\\n \\"ComputingIpVersion\\": \\"IPv4\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"env\\",\\n \\"Value\\": \\"daily\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"f4f9a292c17072a2\\"\\n}","type":"json"}]', + 'title' => '查询集群列表', + ], + 'ListClusterNodes' => [ + 'summary' => '查询集群节点列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162039', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i15b480fbd2fcdbc2869cd80', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAdQ3Z+oPlg49gsr2y8jb6wY=', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数,默认值为20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NodeGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ng-ec3c96ff0aa4c60d', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签信息', + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '节点标签键值', + 'type' => 'string', + 'required' => false, + 'example' => 'my_key', + 'maxLength' => 129, + ], + 'Value' => [ + 'description' => '节点标签的值', + 'type' => 'string', + 'required' => false, + 'example' => 'my_value', + 'maxLength' => 129, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID', + 'description' => '资源组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-ksld39333ss', + ], + ], + [ + 'name' => 'OperatingStates', + 'in' => 'formData', + 'allowEmptyValue' => false, + 'style' => 'repeatList', + 'schema' => [ + 'title' => '节点状态', + 'description' => '节点状态列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点状态', + 'type' => 'string', + 'required' => false, + 'example' => 'Extending', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '出参', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2BA76272-6608-5AEC-BBA8-B6F0D3D14CDB', + ], + 'NextToken' => [ + 'title' => '本次调用返回的查询凭证值。'."\n", + 'description' => '本次调用返回的查询凭证值。'."\n", + 'type' => 'string', + 'example' => 'AAAAAXW/ZB9TBvH+0ZK0phtCibQgQmu1RbqplAI6Velo2OKR', + ], + 'Nodes' => [ + 'title' => '节点列表', + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1642472468000'."\n", + ], + 'ExpiredTime' => [ + 'title' => '机器过期时间', + 'description' => '机器过期时间。', + 'type' => 'string', + 'example' => '1762185600000', + ], + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名。', + 'type' => 'string', + 'example' => '72432f80-273e-11ed-b57a-acde48001122', + ], + 'ImageId' => [ + 'title' => '系统镜像id', + 'description' => '系统镜像ID。', + 'type' => 'string', + 'example' => 'i190297201669099844192', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型。', + 'type' => 'string', + 'example' => 'cn-wulanchabu-b11', + ], + 'NodeGroupId' => [ + 'title' => '节点组id'."\n", + 'description' => '节点组ID。', + 'type' => 'string', + 'example' => 'ng-e9b74f4d450cf18d', + ], + 'NodeGroupName' => [ + 'title' => '节点组名称'."\n", + 'description' => '节点组名称。', + 'type' => 'string', + 'example' => 'emr_master', + ], + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'e01-cn-2r42tmj4z02', + ], + 'Sn' => [ + 'title' => '机器sn', + 'description' => '机器SN。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'sn_tOuUk', + ], + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'Networks' => [ + 'title' => '', + 'description' => '网络信息。', + 'type' => 'array', + 'items' => [ + 'description' => '网络信息', + 'type' => 'object', + 'properties' => [ + 'BondName' => [ + 'description' => '机器网口名称。', + 'type' => 'string', + 'example' => 'bond0', + ], + 'Ip' => [ + 'description' => '专有网络内的机器IP。', + 'type' => 'string', + 'example' => '192.168.22.2', + ], + 'SubnetId' => [ + 'description' => '专有网络子网ID。', + 'type' => 'string', + 'example' => 'subnet-fwekrvg9', + ], + 'VpdId' => [ + 'description' => '专有网络ID。', + 'type' => 'string', + 'example' => 'vpd-eoiy88ju', + ], + ], + ], + ], + 'HpnZone' => [ + 'description' => '集群编号。', + 'type' => 'string', + 'example' => 'A1', + ], + 'VpcId' => [ + 'title' => '专有网络ID', + 'description' => '专有网络ID', + 'type' => 'string', + 'example' => 'vpc-f8zcet5mwerafyqlrhyoi', + ], + 'VSwitchId' => [ + 'title' => '专有网络交换机ID', + 'description' => '专有网络交换机ID', + 'type' => 'string', + 'example' => 'vsw-0jlohur7nhbxd1ttyq8p8', + ], + 'OperatingState' => [ + 'title' => '节点状态', + 'description' => '节点状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Extending' => '扩容中', + 'UnusedNodeStopped' => '未使用节点停服中', + 'UnusedNodeStopping' => '未使用节点停服处理中', + 'Unused' => '未使用', + 'Using' => '使用中', + 'ReleaseLocking' => '待释放', + 'Operating' => '操作中', + 'Cutting' => '缩容中', + 'ClusterNodeStopped' => '集群节点停服中', + 'UnusedNodeRecovering' => '未使用节点恢复中', + 'ClusterNodeStopping' => '集群节点停服处理中', + 'ClusterNodeRecovering' => '未使用节点恢复中', + 'Replacing' => '替换中', + ], + 'example' => 'Extending', + ], + 'Tags' => [ + 'title' => '标签信息', + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'description' => '标签对象', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key', + 'type' => 'string', + 'example' => 'alarm_xdc', + ], + 'Value' => [ + 'description' => '标签value', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + 'TaskId' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'i-skkdsdl83ksxxs3', + ], + 'CommodityCode' => [ + 'title' => '商品码', + 'description' => '商品码', + 'type' => 'string', + 'example' => 'bccluster_eflocomputing_public_cn', + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => '镜像名称', + 'type' => 'string', + 'example' => 'Alinux3_x86_gu8xf_P_Host_D3_C7E3_550.127_Legacy_N_241230', + ], + 'FileSystemMountEnabled' => [ + 'title' => '是否支持文件存储挂载', + 'description' => '是否支持文件存储挂载', + 'type' => 'boolean', + 'example' => 'False', + ], + 'HyperNodeId' => [ + 'title' => '超节点ID', + 'description' => '超节点ID', + 'type' => 'string', + 'example' => 'e01-cn-2r42tmj4z02', + ], + 'NodeType' => [ + 'description' => '节点规格', + 'type' => 'string', + 'example' => 'standard', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2BA76272-6608-5AEC-BBA8-B6F0D3D14CDB\\",\\n \\"NextToken\\": \\"AAAAAXW/ZB9TBvH+0ZK0phtCibQgQmu1RbqplAI6Velo2OKR\\",\\n \\"Nodes\\": [\\n {\\n \\"CreateTime\\": \\"1642472468000\\\\n\\",\\n \\"ExpiredTime\\": \\"1762185600000\\",\\n \\"Hostname\\": \\"72432f80-273e-11ed-b57a-acde48001122\\",\\n \\"ImageId\\": \\"i190297201669099844192\\",\\n \\"MachineType\\": \\"cn-wulanchabu-b11\\",\\n \\"NodeGroupId\\": \\"ng-e9b74f4d450cf18d\\",\\n \\"NodeGroupName\\": \\"emr_master\\",\\n \\"NodeId\\": \\"e01-cn-2r42tmj4z02\\",\\n \\"Sn\\": \\"sn_tOuUk\\",\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"Networks\\": [\\n {\\n \\"BondName\\": \\"bond0\\",\\n \\"Ip\\": \\"192.168.22.2\\",\\n \\"SubnetId\\": \\"subnet-fwekrvg9\\",\\n \\"VpdId\\": \\"vpd-eoiy88ju\\"\\n }\\n ],\\n \\"HpnZone\\": \\"A1\\",\\n \\"VpcId\\": \\"vpc-f8zcet5mwerafyqlrhyoi\\",\\n \\"VSwitchId\\": \\"vsw-0jlohur7nhbxd1ttyq8p8\\",\\n \\"OperatingState\\": \\"Extending\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"alarm_xdc\\",\\n \\"Value\\": \\"true\\"\\n }\\n ],\\n \\"TaskId\\": \\"i-skkdsdl83ksxxs3\\",\\n \\"CommodityCode\\": \\"bccluster_eflocomputing_public_cn\\",\\n \\"ImageName\\": \\"Alinux3_x86_gu8xf_P_Host_D3_C7E3_550.127_Legacy_N_241230\\",\\n \\"FileSystemMountEnabled\\": true,\\n \\"HyperNodeId\\": \\"e01-cn-2r42tmj4z02\\",\\n \\"NodeType\\": \\"standard\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群节点列表', + ], + 'ShrinkCluster' => [ + 'summary' => '灵骏集群缩容。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162886', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'required' => false, + 'example' => 'i15dfa12e8f27c44f4a006c2c8bb', + ], + ], + [ + 'name' => 'NodeGroups', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '节点组信息', + 'description' => '节点组信息', + 'type' => 'array', + 'items' => [ + 'description' => '节点组信息', + 'type' => 'object', + 'properties' => [ + 'NodeGroupId' => [ + 'title' => '节点组id', + 'description' => '节点组id', + 'type' => 'string', + 'required' => false, + 'example' => 'ng-3b6fbd24b1b845a0', + ], + 'Nodes' => [ + 'title' => '节点列表', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点id', + 'type' => 'string', + 'required' => false, + 'example' => 'e01poc-cn-zmb2ypjdc01', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'HyperNodes' => [ + 'title' => '节点列表', + 'description' => '超节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '超节点', + 'type' => 'object', + 'properties' => [ + 'HyperNodeId' => [ + 'title' => '节点id', + 'description' => '超节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IgnoreFailedNodeTasks', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许跳过失败节点,默认值为Flase', + 'description' => '是否允许跳过失败节点,默认值为False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id'."\n", + 'description' => '请求id'."\n", + 'type' => 'string', + 'example' => 'CC9FEF89-9BE5-5E03-845E-238B48D7599B', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i159136551662516768776', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CC9FEF89-9BE5-5E03-845E-238B48D7599B\\",\\n \\"TaskId\\": \\"i159136551662516768776\\"\\n}","type":"json"}]', + 'title' => '集群缩容', + ], + 'CreateNodeGroup' => [ + 'summary' => '创建集群下的节点分组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeGroup', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '节点ID。', + 'type' => 'object', + 'properties' => [ + 'Az' => [ + 'description' => '可用区', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-wulanchabu-b', + ], + 'NodeGroupDescription' => [ + 'description' => '节点组描述', + 'type' => 'string', + 'required' => false, + 'example' => '节点分组描述', + ], + 'NodeGroupName' => [ + 'description' => '节点组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'PAI-LINGJUN', + ], + 'MachineType' => [ + 'description' => '机型', + 'type' => 'string', + 'required' => true, + 'example' => 'mock-machine-type3', + ], + 'ImageId' => [ + 'description' => '镜像ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i191887641687336652616', + ], + 'UserData' => [ + 'title' => '用户自定义脚本', + 'description' => '用户自定义数据', + 'type' => 'string', + 'required' => false, + 'example' => '#!/bin/bash'."\n" + .'uptime'."\n" + .'echo "aaaaaaa" >> /tmp/ttttt20250110141010.sh', + ], + 'SystemDisk' => [ + 'description' => '节点系统盘配置详情。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '单位GB。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1000', + ], + 'PerformanceLevel' => [ + 'description' => '创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。取值范围:'."\n" + .'- PL0:单盘最高随机读写IOPS 1万。'."\n" + .'- PL1:单盘最高随机读写IOPS 5万。', + 'type' => 'string', + 'required' => false, + 'example' => 'PL1', + ], + 'Category' => [ + 'description' => '磁盘类型。取值范围:'."\n" + ."\n" + .' - cloud_essd:ESSD云盘。', + 'type' => 'string', + 'required' => false, + 'example' => 'clou_essd', + ], + ], + 'required' => false, + ], + 'FileSystemMountEnabled' => [ + 'title' => '是否支持文件存储挂载', + 'description' => '是否支持文件存储挂载', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'VirtualGpuEnabled' => [ + 'title' => '是否支持GPU虚拟化切分', + 'description' => '是否开启GPU虚拟化切分', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + 'KeyPairName' => [ + 'description' => '密钥对名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-keypair', + ], + 'LoginPassword' => [ + 'title' => '节点组内机器的登录密码', + 'description' => '密码', + 'type' => 'string', + 'required' => false, + 'example' => 'test-LoginPassword', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群id'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i118191731740041623425', + ], + ], + [ + 'name' => 'NodeUnit', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '节点信息', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{\\"NodeUnitId\\":\\"3c2999a8-2b95-4409-93c5-ad3985fc5c9f\\",\\"ResourceGroupId\\":\\"\\",\\"MaxNodes\\":0,\\"NodeUnitName\\":\\"asi_cn-serverless-sale_e01-lingjun-psale\\"}', + 'description' => '节点信息', + ], + 'example' => '{\\"NodeUnitId\\":\\"3c2999a8-2b95-4409-93c5-ad3985fc5c9f\\",\\"ResourceGroupId\\":\\"\\",\\"MaxNodes\\":0,\\"NodeUnitName\\":\\"asi_cn-serverless-sale_e01-lingjun-psale\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '887FA855-89F4-5DB3-B305-C5879EC480E6', + ], + 'NodeGroupId' => [ + 'description' => '节点组id', + 'type' => 'string', + 'example' => 'ng-ec3c96ff0aa4c60d', + ], + 'NodeGroupName' => [ + 'description' => '节点组名称', + 'type' => 'string', + 'example' => 'emr-default', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"887FA855-89F4-5DB3-B305-C5879EC480E6\\",\\n \\"NodeGroupId\\": \\"ng-ec3c96ff0aa4c60d\\",\\n \\"NodeGroupName\\": \\"emr-default\\"\\n}","type":"json"}]', + 'title' => '创建集群下的节点分组', + ], + 'UpdateNodeGroup' => [ + 'summary' => '更新节点分组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点组id', + 'type' => 'string', + 'required' => false, + 'example' => 'i120021051733814190732', + ], + ], + [ + 'name' => 'NewNodeGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test-update', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户自定义脚本', + 'description' => '用户自定义脚本', + 'type' => 'string', + 'required' => false, + 'example' => '#!/bin/bash'."\n" + .'uptime'."\n" + .'echo "aaaaaaa" >> /tmp/ttttt20250110141010.sh', + ], + ], + [ + 'name' => 'FileSystemMountEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否支持文件存储挂载', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'KeyPairName', + 'in' => 'formData', + 'schema' => [ + 'description' => '密钥对名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点组的默认镜像id,如果不设置,那么就不会改变。', + 'description' => '节点组的默认镜像id,如果不设置,那么就不会改变。', + 'type' => 'string', + 'required' => false, + 'example' => 'i1232142432432', + ], + ], + [ + 'name' => 'LoginPassword', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点组内机器的登录密码', + 'description' => '节点组内机器的登录密码', + 'type' => 'string', + 'required' => false, + 'example' => '密码', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '8F065DDD-6996-5973-9691-9EC57BD0072E', + ], + 'TaskId' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'i154273451745372344629', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F065DDD-6996-5973-9691-9EC57BD0072E\\",\\n \\"TaskId\\": \\"i154273451745372344629\\"\\n}","type":"json"}]', + 'title' => '更新节点分组', + ], + 'DeleteNodeGroup' => [ + 'summary' => '删除节点分组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群id', + 'type' => 'string', + 'required' => false, + 'example' => 'i114444141733395242745', + ], + ], + [ + 'name' => 'NodeGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点组id', + 'type' => 'string', + 'required' => false, + 'example' => 'i121824791737080429819', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '887FA855-89F4-5DB3-B305-C5879EC480E6', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"887FA855-89F4-5DB3-B305-C5879EC480E6\\"\\n}","type":"json"}]', + 'title' => '删除节点分组', + ], + 'ListNodeGroups' => [ + 'summary' => '查询集群下的节点分组信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点组id', + 'type' => 'string', + 'required' => false, + 'example' => 'ng-ec3c96ff0aa4c60d', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '下一页的NextToken,请求下一页时带上此返回值', + 'type' => 'string', + 'required' => false, + 'example' => 'a3f2224a5ec7224116c4f5246120abe4', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群id', + 'type' => 'string', + 'required' => false, + 'example' => 'i119982311660892626523', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '887FA855-89F4-5DB3-B305-C5879EC480E6', + ], + 'NextToken' => [ + 'description' => '下一页的NextToken,请求下一页时带上此返回值', + 'type' => 'string', + 'example' => '563d42ae0b17572449ec8c97f7f66069', + ], + 'Groups' => [ + 'description' => '集群分组信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '组名称。', + 'type' => 'string', + 'example' => 'backend-group', + ], + 'Description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => 'created by ga2_prepare', + ], + 'NodeCount' => [ + 'description' => '节点数', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'ZoneId' => [ + 'description' => '可用区id', + 'type' => 'string', + 'example' => 'cn-shenzhen-c', + ], + 'ClusterId' => [ + 'description' => '集群id', + 'type' => 'string', + 'example' => 'i113952461729854708648', + ], + 'VirtualGpuEnabled' => [ + 'title' => '是否支持GPU虚拟化切分', + 'description' => '是否支持GPU虚拟化切分', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2024-02-27T13:16:31.599', + ], + 'MachineType' => [ + 'description' => '机型', + 'type' => 'string', + 'example' => 'efg1.nvga1n', + ], + 'GroupId' => [ + 'description' => '组ID。', + 'type' => 'string', + 'example' => '238276221', + ], + 'ImageName' => [ + 'description' => '镜像名称', + 'type' => 'string', + 'example' => 'CentOS_7.9_x86_64_FULL_20221110', + ], + 'FileSystemMountEnabled' => [ + 'title' => '是否支持文件存储挂载', + 'description' => '是否支持文件存储挂载', + 'type' => 'boolean', + ], + 'ImageId' => [ + 'description' => '镜像id', + 'type' => 'string', + 'example' => 'i194015071707321240258', + ], + 'UpdateTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2023-09-22T00:03:05.114', + ], + 'ClusterName' => [ + 'description' => '集群名称', + 'type' => 'string', + 'example' => 'wzq-exclusivelite-71', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"887FA855-89F4-5DB3-B305-C5879EC480E6\\",\\n \\"NextToken\\": \\"563d42ae0b17572449ec8c97f7f66069\\",\\n \\"Groups\\": [\\n {\\n \\"GroupName\\": \\"backend-group\\",\\n \\"Description\\": \\"created by ga2_prepare\\",\\n \\"NodeCount\\": 2,\\n \\"ZoneId\\": \\"cn-shenzhen-c\\",\\n \\"ClusterId\\": \\"i113952461729854708648\\",\\n \\"VirtualGpuEnabled\\": false,\\n \\"CreateTime\\": \\"2024-02-27T13:16:31.599\\",\\n \\"MachineType\\": \\"efg1.nvga1n\\",\\n \\"GroupId\\": \\"238276221\\",\\n \\"ImageName\\": \\"CentOS_7.9_x86_64_FULL_20221110\\",\\n \\"FileSystemMountEnabled\\": true,\\n \\"ImageId\\": \\"i194015071707321240258\\",\\n \\"UpdateTime\\": \\"2023-09-22T00:03:05.114\\",\\n \\"ClusterName\\": \\"wzq-exclusivelite-71\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群下的节点分组信息', + ], + 'DeleteNode' => [ + 'summary' => '按量付费节点释放。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点Id', + 'type' => 'string', + 'required' => true, + 'example' => 'e01-cn-kvw****dn04', + ], + ], + ], + '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' => '8F065DDD-6996-5973-9691-9EC57BD0****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F065DDD-6996-5973-9691-9EC57BD0****\\"\\n}","type":"json"}]', + 'title' => '释放节点', + ], + 'DescribeNode' => [ + 'summary' => '查询节点列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161252', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'mock-sn-2060', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '出参', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AC4F0004-7BCE-52E0-891B-CAC7D64E3368', + ], + 'NodeGroupName' => [ + 'title' => '节点组名称', + 'description' => '节点组名称。', + 'type' => 'string', + 'example' => 'emr-default', + ], + 'ClusterId' => [ + 'title' => '集群id', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'i116913051662373010974', + ], + 'ClusterName' => [ + 'title' => '集群名称', + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'Standard_Cluster', + ], + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-09-30T03:35:53Z', + ], + 'NodeGroupId' => [ + 'title' => '节点组id', + 'description' => '节点组ID。', + 'type' => 'string', + 'example' => 'ng-ec3c96ff0aa4c60d', + ], + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名。', + 'type' => 'string', + 'example' => '31d38530-241e-11ed-bc63-acde48001122', + ], + 'ImageId' => [ + 'title' => '镜像id', + 'description' => '镜像ID。', + 'type' => 'string', + 'example' => 'i190297201634099844192', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型。', + 'type' => 'string', + 'example' => 'efg1.nvga1', + ], + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'e01-cn-zvp2tgykr08', + ], + 'Sn' => [ + 'title' => '机器唯一标识', + 'description' => '机器唯一标识。', + 'type' => 'string', + 'example' => 'sag42ckf4jx', + ], + 'OperatingState' => [ + 'title' => '节点状态'."\n", + 'description' => '节点状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Extending' => '扩容中', + 'UnusedNodeStopped' => '未使用节点停服中', + 'UnusedNodeStopping' => '未使用节点停服处理中', + 'Unused' => '未使用', + 'Using' => '使用中', + 'ReleaseLocking' => '待释放', + 'Operating' => '操作中', + 'Cutting' => '缩容中 ', + 'ClusterNodeStopped' => '集群节点停服中', + 'UnusedNodeRecovering' => '未使用节点恢复中', + 'ClusterNodeStopping' => '集群节点停服处理中', + 'ClusterNodeRecovering' => '集群节点恢复中', + 'Replacing' => '替换中', + ], + 'example' => 'Using', + ], + 'ExpiredTime' => [ + 'title' => '过期时间', + 'description' => '过期时间。', + 'type' => 'string', + 'example' => '2022-06-23T16:00:00Z', + ], + 'Networks' => [ + 'title' => '网络信息', + 'description' => '网络信息。', + 'type' => 'array', + 'items' => [ + 'description' => '网络信息', + 'type' => 'object', + 'properties' => [ + 'BondName' => [ + 'title' => '网卡端口信息', + 'description' => '网卡端口信息。', + 'type' => 'string', + 'example' => 'Bond0', + ], + 'Ip' => [ + 'title' => '机器ip', + 'description' => '机器IP。', + 'type' => 'string', + 'example' => '47.254.235.44', + ], + 'SubnetId' => [ + 'title' => '集群子网id', + 'description' => '集群子网ID。', + 'type' => 'string', + 'example' => 'vsw-uf68v51fldm5egmui5a6k', + ], + 'VpdId' => [ + 'title' => '集群网络id', + 'description' => '集群网络ID。', + 'type' => 'string', + 'example' => 'vpd-xcuhjyrj', + ], + ], + ], + ], + 'ImageName' => [ + 'title' => '镜像名称', + 'description' => '镜像名称。', + 'type' => 'string', + 'example' => 'Centos7.9_all_0811', + ], + 'HpnZone' => [ + 'description' => '集群编号。', + 'type' => 'string', + 'example' => 'A1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmywpvugkh7kq', + ], + 'UserData' => [ + 'title' => '用户自定义脚本', + 'description' => '用户自定义脚本', + 'type' => 'string', + 'example' => '#!/bin/bash'."\n" + .'uptime'."\n" + .'echo "aaaaaaa" >> /tmp/ttttt20250110141010.sh', + ], + 'Disks' => [ + 'description' => '磁盘信息例表。', + 'type' => 'array', + 'items' => [ + 'description' => '磁盘信息。', + 'type' => 'object', + 'properties' => [ + 'DiskId' => [ + 'description' => '磁盘ID。', + 'type' => 'string', + 'example' => 'd-2zeap7wkns2tdmbr11se', + ], + 'Category' => [ + 'description' => '磁盘类型。取值范围:'."\n" + ."\n" + .' - cloud_essd:ESSD云盘。', + 'type' => 'string', + 'example' => 'cloud_essd', + ], + 'Size' => [ + 'description' => '磁盘大小,单位GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'PerformanceLevel' => [ + 'description' => '创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。取值范围:'."\n" + .'- PL0:单盘最高随机读写IOPS 1万。'."\n" + .'- PL1:单盘最高随机读写IOPS 5万。', + 'type' => 'string', + 'example' => 'PL1', + ], + 'Type' => [ + 'description' => '磁盘类型。可能值:'."\n" + ."\n" + .'- system:系统盘。'."\n" + .'- data:数据盘。', + 'type' => 'string', + 'example' => 'system', + ], + ], + ], + ], + 'FileSystemMountEnabled' => [ + 'title' => '是否支持文件存储挂载', + 'description' => '是否支持文件存储挂载', + 'type' => 'boolean', + 'example' => 'True', + ], + 'NodeType' => [ + 'title' => '当前节点的类型,枚举值:'."\n" + .'● cpfs-enhanced'."\n" + .'● ebs-enhanced'."\n" + .'● standard'."\n" + .'● standby'."\n" + .'● standard-v2'."\n" + .'● standby-v2', + 'description' => '当前节点的类型,枚举值:'."\n" + .'● cpfs-enhanced'."\n" + .'● ebs-enhanced'."\n" + .'● standard'."\n" + .'● standby'."\n" + .'● standard-v2'."\n" + .'● standby-v2', + 'type' => 'string', + 'example' => 'standard', + ], + 'HyperNodeId' => [ + 'title' => '超节点ID', + 'description' => '超节点ID', + 'type' => 'string', + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC4F0004-7BCE-52E0-891B-CAC7D64E3368\\",\\n \\"NodeGroupName\\": \\"emr-default\\",\\n \\"ClusterId\\": \\"i116913051662373010974\\",\\n \\"ClusterName\\": \\"Standard_Cluster\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"CreateTime\\": \\"2022-09-30T03:35:53Z\\",\\n \\"NodeGroupId\\": \\"ng-ec3c96ff0aa4c60d\\",\\n \\"Hostname\\": \\"31d38530-241e-11ed-bc63-acde48001122\\",\\n \\"ImageId\\": \\"i190297201634099844192\\",\\n \\"MachineType\\": \\"efg1.nvga1\\",\\n \\"NodeId\\": \\"e01-cn-zvp2tgykr08\\",\\n \\"Sn\\": \\"sag42ckf4jx\\",\\n \\"OperatingState\\": \\"Using\\",\\n \\"ExpiredTime\\": \\"2022-06-23T16:00:00Z\\",\\n \\"Networks\\": [\\n {\\n \\"BondName\\": \\"Bond0\\",\\n \\"Ip\\": \\"47.254.235.44\\",\\n \\"SubnetId\\": \\"vsw-uf68v51fldm5egmui5a6k\\",\\n \\"VpdId\\": \\"vpd-xcuhjyrj\\"\\n }\\n ],\\n \\"ImageName\\": \\"Centos7.9_all_0811\\",\\n \\"HpnZone\\": \\"A1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmywpvugkh7kq\\",\\n \\"UserData\\": \\"#!/bin/bash\\\\nuptime\\\\necho \\\\\\"aaaaaaa\\\\\\" >> /tmp/ttttt20250110141010.sh\\",\\n \\"Disks\\": [\\n {\\n \\"DiskId\\": \\"d-2zeap7wkns2tdmbr11se\\",\\n \\"Category\\": \\"cloud_essd\\",\\n \\"Size\\": 100,\\n \\"PerformanceLevel\\": \\"PL1\\",\\n \\"Type\\": \\"system\\"\\n }\\n ],\\n \\"FileSystemMountEnabled\\": true,\\n \\"NodeType\\": \\"standard\\",\\n \\"HyperNodeId\\": \\"e01-cn-zvp2tgykr08\\"\\n}","type":"json"}]', + 'title' => '查询节点', + ], + 'ListFreeNodes' => [ + 'summary' => '查询未使用节点列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162040', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'description' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a3f2224a5ec7224116c4f5246120abe4', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数,默认值为20。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'MachineType', + 'in' => 'formData', + 'schema' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'efg1.nvga1' => 'efg1.nvga1', + 'efg1.nvga1n' => 'efg1.nvga1n', + 'efg1.nvga4' => 'efg1.nvga4', + 'efg2.C48cA3sen' => 'efg2.C48cA3sen', + 'efg2.56NHmcn' => 'efg2.56NHmcn', + 'efg1.nvga8n' => 'efg1.nvga8n', + 'efg2.C48cNHmcn' => 'efg2.C48cNHmcn', + ], + 'example' => 'mock-machine-type2', + ], + ], + [ + 'name' => 'HpnZone', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群编号', + 'type' => 'string', + 'required' => false, + 'example' => 'A1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组id', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'rg-acfmvqmpwbwecli' => 'rg-acfmvqmpwbwecli', + 'rg-acfm25os62qi5fq' => 'rg-acfm25os62qi5fq', + 'rg-acfmoiyerhvhrvq' => 'rg-acfmoiyerhvhrvq', + 'rg-acfmwaateahzoii' => 'rg-acfmwaateahzoii', + 'rg-acfmwfm33rlt6zi' => 'rg-acfmwfm33rlt6zi', + 'rg-acfm2zkwhkns57i' => 'rg-acfm2zkwhkns57i', + ], + 'example' => 'rg-acfmxno4vh5muoq', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签信息', + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key', + 'type' => 'string', + 'required' => false, + 'example' => 'my_key', + 'maxLength' => 129, + ], + 'Value' => [ + 'description' => '标签value', + 'type' => 'string', + 'required' => false, + 'example' => '129', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'OperatingStates', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '表示返回的未使用节点类型'."\n" + .'*:匹配所有类型'."\n" + .'未使用 Unused'."\n" + .'使用中 Using'."\n" + .'扩容中 Extending'."\n" + .'缩容中 Cutting'."\n" + .'操作中 Operating'."\n" + .'未使用节点停服中 UnusedNodeStopping'."\n" + .'未使用节点已停服 UnusedNodeStopped'."\n" + .'未使用节点维修审批停服中 UnusedNodeApprovalPendingRenew'."\n" + .'未使用节点维修停服中 UnusedNodeRepairingPendingRenew'."\n" + .'集群节点停服中 ClusterNodeStopping'."\n" + .'集群节点已停服 ClusterNodeStopped'."\n" + .'集群节点维修待审批已停服 ClusterNodeApprovalPendingRenew'."\n" + .'集群节点维修已停服 ClusterNodeRepairingPendingRenew'."\n" + .'未使用节点恢复中 UnusedNodeRecovering'."\n" + .'集群节点恢复中 ClusterNodeRecovering'."\n" + .'待释放 ReleaseLocking'."\n" + .'释放中 Releasing'."\n" + .'诊断中 Diagnosing'."\n" + .'跨ASI集群切换中 Switching'."\n" + .'集群节点维修恢复中 RecoveringClusterNode'."\n" + .'集群节点维修预处理 PreparationForRepairingClusterNode'."\n" + .'未使用节点维修恢复中 RecoveringUnusedNode'."\n" + .'未使用节点维修预处理 PreparationForRepairingUnusedNode'."\n" + .'集群节点维修中 ClusterNodeRepairing'."\n" + .'未使用节点维修中 UnusedNodeRepairing'."\n" + .'集群节点维修待审批 ClusterNodeRepairPendingApproval'."\n" + .'未使用节点维修待审批中 UnusedNodeRepairPendingApproval'."\n" + .'节点替换中 Replacing'."\n" + .'软件恢复中 SoftwareRestoring'."\n" + .'软件启动中 SoftwareInitializing'."\n" + .'集群节点重启待审批 ClusterNodeRebootPendingApproval'."\n" + .'集群节点关机中 ClusterNodeShuttingDown'."\n" + .'集群节点已关机 ClusterNodeShutdown'."\n" + .'集群关机节点停服中 ClusterNodeStoppingShutdown'."\n" + .'集群关机节点已停服 ClusterNodeStoppedShutdown'."\n" + .'集群关机节点维修待审批 ClusterNodeRepairPendingApprovalShutdown'."\n" + .'集群关机节点维修预处理 PreparationForRepairingClusterNodeShutdown'."\n" + .'集群关机节点维修中 ClusterNodeRepairingShutdown'."\n" + .'集群关机节点维修待审批已停服 ClusterNodeApprovalPendingRenewShutdown'."\n" + .'集群关机节点维修已停服 ClusterNodeRepairingPendingRenewShutdown'."\n" + .'集群关机节点重启待审批 ClusterNodeRebootPendingApprovalShutdown'."\n" + .'集群关机节点停服恢复中 ClusterNodeRecoveringShutdown'."\n" + .'集群关机节点维修恢复上线中 RecoveringClusterNodeShutdown', + 'description' => '表示返回的未使用节点类型', + 'type' => 'array', + 'items' => [ + 'description' => '表示返回的未使用节点类型'."\n" + .'*:匹配所有类型'."\n" + .'未使用 Unused'."\n" + .'使用中 Using'."\n" + .'扩容中 Extending'."\n" + .'缩容中 Cutting'."\n" + .'操作中 Operating'."\n" + .'未使用节点停服中 UnusedNodeStopping'."\n" + .'未使用节点已停服 UnusedNodeStopped'."\n" + .'未使用节点维修审批停服中 UnusedNodeApprovalPendingRenew'."\n" + .'未使用节点维修停服中 UnusedNodeRepairingPendingRenew'."\n" + .'集群节点停服中 ClusterNodeStopping'."\n" + .'集群节点已停服 ClusterNodeStopped'."\n" + .'集群节点维修待审批已停服 ClusterNodeApprovalPendingRenew'."\n" + .'集群节点维修已停服 ClusterNodeRepairingPendingRenew'."\n" + .'未使用节点恢复中 UnusedNodeRecovering'."\n" + .'集群节点恢复中 ClusterNodeRecovering'."\n" + .'待释放 ReleaseLocking'."\n" + .'释放中 Releasing'."\n" + .'诊断中 Diagnosing'."\n" + .'跨ASI集群切换中 Switching'."\n" + .'集群节点维修恢复中 RecoveringClusterNode'."\n" + .'集群节点维修预处理 PreparationForRepairingClusterNode'."\n" + .'未使用节点维修恢复中 RecoveringUnusedNode'."\n" + .'未使用节点维修预处理 PreparationForRepairingUnusedNode'."\n" + .'集群节点维修中 ClusterNodeRepairing'."\n" + .'未使用节点维修中 UnusedNodeRepairing'."\n" + .'集群节点维修待审批 ClusterNodeRepairPendingApproval'."\n" + .'未使用节点维修待审批中 UnusedNodeRepairPendingApproval'."\n" + .'节点替换中 Replacing'."\n" + .'软件恢复中 SoftwareRestoring'."\n" + .'软件启动中 SoftwareInitializing'."\n" + .'集群节点重启待审批 ClusterNodeRebootPendingApproval'."\n" + .'集群节点关机中 ClusterNodeShuttingDown'."\n" + .'集群节点已关机 ClusterNodeShutdown'."\n" + .'集群关机节点停服中 ClusterNodeStoppingShutdown'."\n" + .'集群关机节点已停服 ClusterNodeStoppedShutdown'."\n" + .'集群关机节点维修待审批 ClusterNodeRepairPendingApprovalShutdown'."\n" + .'集群关机节点维修预处理 PreparationForRepairingClusterNodeShutdown'."\n" + .'集群关机节点维修中 ClusterNodeRepairingShutdown'."\n" + .'集群关机节点维修待审批已停服 ClusterNodeApprovalPendingRenewShutdown'."\n" + .'集群关机节点维修已停服 ClusterNodeRepairingPendingRenewShutdown'."\n" + .'集群关机节点重启待审批 ClusterNodeRebootPendingApprovalShutdown'."\n" + .'集群关机节点停服恢复中 ClusterNodeRecoveringShutdown'."\n" + .'集群关机节点维修恢复上线中 RecoveringClusterNodeShutdown', + 'type' => 'string', + 'required' => false, + 'example' => 'Unused', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '出参', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id'."\n", + 'description' => '请求id'."\n", + 'type' => 'string', + 'example' => 'AA14CB86-70C4-5CB7-9E7B-6CCA77F3512B', + ], + 'Nodes' => [ + 'title' => '节点列表', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区id', + 'type' => 'string', + 'example' => 'cn-hangzhou-j', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1652321554', + ], + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点id', + 'type' => 'string', + 'example' => 'e01-cn-7pp2x193801', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'example' => 'efg1.nvga1', + ], + 'Sn' => [ + 'title' => '机器sn', + 'description' => '机器sn', + 'type' => 'string', + 'example' => 'sn_pozkHBgicd', + ], + 'ExpiredTime' => [ + 'title' => '机器过期时间', + 'description' => '机器过期时间', + 'type' => 'string', + 'example' => '1673107200', + ], + 'HpnZone' => [ + 'description' => '集群编号', + 'type' => 'string', + 'example' => 'A1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组id', + 'type' => 'string', + 'example' => 'rg-aekzkkbrpl4owgy', + ], + 'OperatingState' => [ + 'title' => '节点状态', + 'description' => '节点状态', + 'type' => 'string', + 'example' => 'Extending', + ], + 'CommodityCode' => [ + 'title' => '商品码', + 'description' => '商品码', + 'type' => 'string', + 'example' => 'bccluster_eflocomputing_public_cn', + ], + 'Tags' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key', + 'type' => 'string', + 'example' => 'alarm_xdc', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + 'HyperNodeId' => [ + 'title' => '超节点ID', + 'description' => '超节点ID', + 'type' => 'string', + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '本次调用返回的查询凭证值。'."\n", + 'description' => '本次调用返回的查询凭证值。'."\n", + 'type' => 'string', + 'example' => 'a3f2224a5ec7224116c4f5246120abe4', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AA14CB86-70C4-5CB7-9E7B-6CCA77F3512B\\",\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-j\\",\\n \\"CreateTime\\": \\"1652321554\\",\\n \\"NodeId\\": \\"e01-cn-7pp2x193801\\",\\n \\"MachineType\\": \\"efg1.nvga1\\",\\n \\"Sn\\": \\"sn_pozkHBgicd\\",\\n \\"ExpiredTime\\": \\"1673107200\\",\\n \\"HpnZone\\": \\"A1\\",\\n \\"ResourceGroupId\\": \\"rg-aekzkkbrpl4owgy\\",\\n \\"OperatingState\\": \\"Extending\\",\\n \\"CommodityCode\\": \\"bccluster_eflocomputing_public_cn\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"alarm_xdc\\",\\n \\"Value\\": \\"true\\"\\n }\\n ],\\n \\"HyperNodeId\\": \\"e01-cn-zvp2tgykr08\\"\\n }\\n ],\\n \\"NextToken\\": \\"a3f2224a5ec7224116c4f5246120abe4\\"\\n}","type":"json"}]', + 'title' => '获取未使用节点列表', + ], + 'RebootNodes' => [ + 'summary' => '重启机器。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '161357', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'required' => false, + 'example' => 'i15b480fbd2fcdbc2869cd80', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '节点列表', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点id', + 'type' => 'string', + 'required' => false, + 'example' => 'i138475611663639202234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'IgnoreFailedNodeTasks', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许跳过失败节点,默认值为Flase', + 'description' => '是否允许跳过失败节点,默认值为False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i158475611663639202234', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"TaskId\\": \\"i158475611663639202234\\"\\n}","type":"json"}]', + 'title' => '重启机器', + ], + 'ReimageNodes' => [ + 'summary' => '机器重装。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '162088', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id'."\n", + 'description' => '集群id'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'i15dfa12e8f27c44f4a006c2c8bb', + ], + ], + [ + 'name' => 'Nodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '节点列表', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名', + 'type' => 'string', + 'required' => false, + 'example' => '457db5ca-241d-11ed-9fd7-acde48001122', + ], + 'LoginPassword' => [ + 'title' => '登录密码', + 'description' => '登录密码', + 'type' => 'string', + 'required' => false, + 'example' => '***', + ], + 'NodeId' => [ + 'title' => '节点id'."\n", + 'description' => '节点id'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-zvp2tgykr0b', + ], + 'ImageId' => [ + 'title' => '系统镜像id', + 'description' => '系统镜像id', + 'type' => 'string', + 'required' => false, + 'example' => 'm-8vbf8rpv2nn14y7oybjy', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'IgnoreFailedNodeTasks', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许跳过失败节点,默认值为Flase', + 'description' => '是否允许跳过失败节点,默认值为False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False'."\n", + ], + ], + [ + 'name' => 'UserData', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户自定义脚本,命令', + 'description' => '自定义数据', + 'type' => 'string', + 'required' => false, + 'example' => '#!/bin/sh'."\n" + .'echo "Hello World. The time is now $(date -R)!" | tee /root/userdata_test.txt', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '15FBCD9B-C93F-54E8-A168-AADE7E66DAD2', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i158782151663841517926', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"15FBCD9B-C93F-54E8-A168-AADE7E66DAD2\\",\\n \\"TaskId\\": \\"i158782151663841517926\\"\\n}","type":"json"}]', + 'title' => '机器重装', + ], + 'CreateVsc' => [ + 'summary' => '创建Vsc。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterYMLW2J', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点Id', + 'description' => '节点Id', + 'type' => 'string', + 'required' => true, + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + [ + 'name' => 'VscType', + 'in' => 'formData', + 'schema' => [ + 'title' => '设置VSC类型,primary/secondary,默认值为primary', + 'description' => '设置VSC类型,primary/standard,默认值为primary', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'standard' => 'standard', + 'primary' => 'primary', + ], + 'example' => 'primary', + ], + ], + [ + 'name' => 'VscName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'vscId用户自定义名称,单计算节点上唯一', + 'description' => 'vscId用户自定义名称,单计算节点上唯一', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源标签', + 'description' => '资源标签', + 'type' => 'array', + 'items' => [ + 'title' => '资源标签', + 'description' => '资源标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '资源标签键', + 'description' => '资源标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'key001', + ], + 'Value' => [ + 'title' => '资源标签值', + 'description' => '资源标签值', + 'type' => 'string', + 'required' => false, + 'example' => 'value001', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组Id', + 'description' => '资源组Id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2xdkc6icwfha', + ], + ], + ], + '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' => '887FA855-89F4-5DB3-B305-C5879EC480E6', + ], + 'VscId' => [ + 'title' => '创建的VscId', + 'description' => '创建的VscId', + 'type' => 'string', + 'example' => 'vsc-001', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"887FA855-89F4-5DB3-B305-C5879EC480E6\\",\\n \\"VscId\\": \\"vsc-001\\"\\n}","type":"json"}]', + 'title' => '创建Vsc', + ], + 'DescribeVsc' => [ + 'summary' => '获取单个Vsc详情。', + 'path' => '', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterYMLW2J', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'VscId', + 'in' => 'formData', + 'schema' => [ + 'title' => '需要查询的VscId', + 'description' => '需要查询的VscId', + 'type' => 'string', + 'required' => true, + 'example' => 'vsc-001', + ], + ], + ], + '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' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'VscId' => [ + 'title' => 'VscId', + 'description' => 'VscId', + 'type' => 'string', + 'example' => 'vsc-001', + ], + 'VscType' => [ + 'title' => 'Vsc类型', + 'description' => 'Vsc类型', + 'type' => 'string', + 'example' => 'primary', + ], + 'VscName' => [ + 'title' => 'Vsc自定义的名称', + 'description' => 'Vsc自定义的名称', + 'type' => 'string', + 'example' => 'test_name', + ], + 'NodeId' => [ + 'title' => 'Vsc所在计算节点的id', + 'description' => 'Vsc所在计算节点的id', + 'type' => 'string', + 'example' => 'e01-cn-kvw44e6dn04', + ], + 'Status' => [ + 'title' => 'Vsc所处的状态', + 'description' => 'Vsc所处的状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Creating' => 'Creating', + 'Normal' => 'Normal', + 'Deleting' => 'Deleting', + ], + 'example' => 'Normal', + ], + 'ResourceGroupId' => [ + 'title' => '资源组Id', + 'description' => '资源组Id', + 'type' => 'string', + 'example' => 'rg-aek2k3rqlvv6ytq', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"VscId\\": \\"vsc-001\\",\\n \\"VscType\\": \\"primary\\",\\n \\"VscName\\": \\"test_name\\",\\n \\"NodeId\\": \\"e01-cn-kvw44e6dn04\\",\\n \\"Status\\": \\"Normal\\",\\n \\"ResourceGroupId\\": \\"rg-aek2k3rqlvv6ytq\\"\\n}","type":"json"}]', + 'title' => '查询Vsc', + ], + 'DeleteVsc' => [ + 'summary' => '删除Vsc。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterYMLW2J', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => '幂等参数', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'VscId', + 'in' => 'formData', + 'schema' => [ + 'title' => '需要删除的VscId', + 'description' => '需要删除的VscId', + 'type' => 'string', + 'required' => true, + 'example' => 'vsc-001', + ], + ], + ], + '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' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\"\\n}","type":"json"}]', + 'title' => '删除Vsc', + ], + 'ListVscs' => [ + 'summary' => '查询Vsc列表。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterYMLW2J', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '标记当前开始读取的位置,置空表示从头开始', + 'description' => '标记当前开始读取的位置,置空表示从头开始', + 'type' => 'string', + 'required' => false, + 'example' => '563d42ae0b17572449ec8c97f7f66069', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '本次读取的最大数据记录数量', + 'description' => '本次读取的最大数据记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '节点ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID列表', + 'type' => 'string', + 'required' => false, + 'example' => '[\'mock-sn-200101\']', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'VscName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Vsc名称', + 'description' => 'Vsc名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'key001', + 'maxLength' => 129, + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'value001', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组Id', + 'description' => '资源组Id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2xdkc6icwfha', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => 'TotalCount本次请求条件下的数据总量,此参数为可选参数,默认可不返回', + 'description' => 'TotalCount本次请求条件下的数据总量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '03668372-18FF-5959-98D9-6B36A4643C7A', + ], + 'NextToken' => [ + 'title' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕', + 'description' => '表示当前调用返回读取到的位置,空代表数据已经读取完毕', + 'type' => 'string', + 'required' => true, + 'example' => '3a6b93229825ac667104463b56790c91', + ], + 'Vscs' => [ + 'title' => 'VSC列表', + 'description' => 'VSC列表', + 'type' => 'array', + 'items' => [ + 'description' => 'VSC', + 'type' => 'object', + 'properties' => [ + 'VscId' => [ + 'title' => 'VscId', + 'description' => 'VscId', + 'type' => 'string', + 'example' => 'vsc-001', + ], + 'VscType' => [ + 'title' => 'Vsc类型,primary/secondary', + 'description' => 'Vsc类型,primary/standard', + 'type' => 'string', + 'example' => 'primary', + ], + 'VscName' => [ + 'title' => 'Vsc自定义的名称', + 'description' => 'Vsc自定义的名称', + 'type' => 'string', + 'example' => 'test_name', + ], + 'NodeId' => [ + 'title' => '灵骏节点Id', + 'description' => '灵骏节点Id', + 'type' => 'string', + 'example' => 'e01-cn-fzh47xd7u08', + ], + 'Status' => [ + 'title' => 'Vsc所处的状态', + 'description' => 'Vsc所处的状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'Creating' => 'Creating', + 'Normal' => 'Normal', + 'Deleting' => 'Deleting', + ], + 'example' => 'Normal', + ], + 'Tags' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'title' => '标签', + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'title' => '标签键', + 'description' => '标签键', + 'type' => 'string', + 'example' => 'key001', + ], + 'TagValue' => [ + 'title' => '标签值', + 'description' => '标签值', + 'type' => 'string', + 'example' => 'value001', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'title' => '资源组Id', + 'description' => '资源组Id', + 'type' => 'string', + 'example' => 'rg-acfm2zkwhkns57i', + ], + ], + ], + ], + 'MaxResults' => [ + 'description' => '暂无返回。请使用TotalCount', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 3,\\n \\"RequestId\\": \\"03668372-18FF-5959-98D9-6B36A4643C7A\\",\\n \\"NextToken\\": \\"3a6b93229825ac667104463b56790c91\\",\\n \\"Vscs\\": [\\n {\\n \\"VscId\\": \\"vsc-001\\",\\n \\"VscType\\": \\"primary\\",\\n \\"VscName\\": \\"test_name\\",\\n \\"NodeId\\": \\"e01-cn-fzh47xd7u08\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"key001\\",\\n \\"TagValue\\": \\"value001\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfm2zkwhkns57i\\"\\n }\\n ],\\n \\"MaxResults\\": 0\\n}","type":"json"}]', + 'title' => '查询Vsc列表', + ], + 'UntagResources' => [ + 'summary' => '删除资源自定义标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Node' => '节点', + 'Cluster' => '集群', + ], + 'example' => 'Cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源 ID 列表。可输入最多 50 个资源 ID。', + 'description' => '资源id列表', + 'type' => 'array', + 'items' => [ + 'title' => '资源 ID。', + 'description' => '资源id', + 'type' => 'string', + 'required' => false, + 'example' => 'i15z93xkon193oaxf1ese8', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源所属的地域 ID。', + 'description' => '地域Id', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源的标签键列表。可输入最多 20 个标签键。', + 'description' => '标签键列表', + 'type' => 'array', + 'items' => [ + 'title' => '资源的标签键。', + 'description' => '标签键,最多20个子项', + 'type' => 'string', + 'required' => false, + 'example' => 'ac-cus-tag-0', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'title' => '是否解绑资源上全部的标签。当请求中未设置 TagKey.N 时,该参数才有效。取值范围:'."\n" + .'true'."\n" + .'false'."\n" + .'默认值:false', + 'description' => '是否全部删除,只针对TagKey.N为空时有效。取值范围:'."\n" + ."\n" + .'- True,全部删除'."\n" + .'- False,不全部删除'."\n" + ."\n" + .'默认是 False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID。', + 'description' => '请求id', + 'type' => 'string', + 'example' => '81F648D0-5570-5351-AE98-6F501C7E957F', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'The operator is not permission for this operate ', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"81F648D0-5570-5351-AE98-6F501C7E957F\\"\\n}","type":"json"}]', + 'title' => '删除资源标签', + ], + 'TagResources' => [ + 'summary' => '资源打用户标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Node' => '节点', + 'Vcc' => '入云专线', + 'Cluster' => '集群', + 'Vpd' => '灵骏网段', + 'Subnet' => '灵骏子网', + ], + 'example' => 'Cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '资源id', + 'description' => '资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i-uf6dlxcxssr4cgpkoo85', + ], + 'required' => true, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源所属的地域 ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签数组。数组长度:1~20。如果数组中有多个标签对象,标签键Key不允许重复。', + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'title' => '标签对象。', + 'description' => '标签对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键,不允许为空和空字符串。最多支持 128 个字符,不能以aliyun和acs:开头,不能包含http://或者https://。', + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + 'maxLength' => 128, + ], + 'Value' => [ + 'title' => '标签值。不允许为空,可以为空字符串。最多支持 128 个字符,不能包含http://或者https://。', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'v3', + 'maxLength' => 256, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E7BB53E1-0B08-5C4E-BA66-9225548C3151', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission', + 'errorMessage' => 'The operator is not permission for this operate', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7BB53E1-0B08-5C4E-BA66-9225548C3151\\"\\n}","type":"json"}]', + 'title' => '资源打标签', + ], + 'ListTagResources' => [ + 'summary' => '查询资源标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'Node' => '节点', + 'Vcc' => '入云专线', + 'Cluster' => '集群', + 'Subnet' => '灵骏子网', + 'Vpd ' => '灵骏网段 ', + ], + 'example' => 'Node', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '资源ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'i1520224L16AY60305', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源所属的地域 ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表。', + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'title' => '精确查找灵骏资源时使用的标签键。标签健长度的取值范围为 1~128。N 的取值范围为 1~20。', + 'description' => '精确查找灵骏资源时使用的标签键。标签健长度的取值范围为 1~128。N 的取值范围为 1~20。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '精确查找灵骏资源时使用的标签键。标签键长度的取值范围为 1~128。N 的取值范围为 1~20。', + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'PodName', + ], + 'Value' => [ + 'title' => '精确查找灵骏资源时使用的标签值。标签值长度的取值范围为 1~128。N 的取值范围为 1~20。', + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'WFT-OTC', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询凭证(Token),取值为上一次API调用返回的NextToken参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'AAAAAdQ3Z+oPlg49gsr2y8jb6wY=', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8F208B6D-4C42-5FD3-B6BE-E826E92A44DD', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'title' => '由资源及其标签组成的集合,包含了资源 ID、资源类型和标签键值等信息。', + 'description' => '标签资源。', + 'type' => 'array', + 'items' => [ + 'title' => '标签对象', + 'description' => '标签对象', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'title' => '标签键。', + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'env', + ], + 'TagValue' => [ + 'title' => '标签值。', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'dev'."\n", + ], + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'i15azeddnvf7uhw2oij57o0', + ], + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Node' => '节点', + 'Cluster' => '集群', + ], + 'example' => 'Cluster'."\n", + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'description' => '下一页的NextToken,请求下一页时带上此返回值。', + 'type' => 'string', + 'example' => 'AAAAAdQ3Z+oPlg49gsr2y8jb6wY=', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + ], + 403 => [ + [ + 'errorCode' => 'NoPermission ', + 'errorMessage' => 'The operator is not permission for this operate', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F208B6D-4C42-5FD3-B6BE-E826E92A44DD\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"TagKey\\": \\"env\\",\\n \\"TagValue\\": \\"dev\\\\n\\",\\n \\"ResourceId\\": \\"i15azeddnvf7uhw2oij57o0\\",\\n \\"ResourceType\\": \\"Cluster\\\\n\\"\\n }\\n ]\\n },\\n \\"NextToken\\": \\"AAAAAdQ3Z+oPlg49gsr2y8jb6wY=\\"\\n}","type":"json"}]', + 'title' => '查询资源标签', + ], + 'DescribeZones' => [ + 'summary' => '可用区列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161776', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'title' => '根据汉语、英语筛选返回结果。更多信息,请参见RFC7231。取值范围:'."\n" + ."\n" + .'zh-CN'."\n" + .'en-US'."\n" + .'默认值:zh-CN', + 'description' => '根据汉语、英语筛选返回结果。更多信息,请参见RFC7231。取值范围:'."\n" + ."\n" + .'zh-CN'."\n" + .'en-US'."\n" + .'默认值:zh-CN', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en-US' => '英文', + 'zh-CN' => '中文', + ], + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'E9116F2D-82F8-501E-9ADB-2BE0C02B6A84', + ], + 'Zones' => [ + 'title' => '可用区列表', + 'description' => '可用区列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'title' => '可用区名称', + 'description' => '可用区名称', + 'type' => 'string', + 'example' => '杭州', + ], + 'ZoneId' => [ + 'title' => '可用区id'."\n", + 'description' => '可用区id'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9116F2D-82F8-501E-9ADB-2BE0C02B6A84\\",\\n \\"Zones\\": [\\n {\\n \\"LocalName\\": \\"杭州\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询可用区列表', + ], + 'DescribeTask' => [ + 'summary' => '查询任务详情。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161255', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'title' => '任务id', + 'description' => '任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'i156331731670384438138', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A7FD7411-9395-52E8-AF42-EB3A4A55446D', + ], + 'ClusterId' => [ + 'title' => '集群id', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'i119982311660892626523', + ], + 'ClusterName' => [ + 'title' => '集群名称', + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'Standard_Cluster', + ], + 'TaskState' => [ + 'title' => '任务状态:waiting_to_run(等待执行),running(执行),execution_fail(执行失败),execution_success(执行成功)', + 'description' => '任务状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'running' => '执行中', + 'execution_success' => '执行成功', + 'execution_fail' => '执行失败', + 'waiting_to_run' => '等待执行', + ], + 'example' => 'running', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'reclone_node_sub_task' => '重装节点子任务', + 'initialize_bare_cluster' => '初始化裸集群', + 'extend_bare_cluster' => '扩容裸集群', + 'reclone_node' => '重装节点', + 'reboot_node' => '重启节点', + 'extend_ack_edge_cluster' => '扩容ack集群', + 'extend_cluster' => '扩容集群', + 'initialize_ack_edge_cluster' => '初始化ack集群', + 'cut_node_sub_task' => '缩容集群子任务', + 'reboot_node_sub_task' => '重启节点子任务', + 'reclone_ack_edge_node' => '重装ack节点', + 'initialize_cluster' => '初始化标准集群', + 'cut_cluster' => '缩容集群', + 'reclone_bare_node' => '重装裸集群节点', + 'cut_bare_cluster' => '缩容裸集群', + ], + 'example' => 'cut_cluster', + ], + 'Message' => [ + 'title' => '任务失败信息', + 'description' => '任务失败信息。', + 'type' => 'string', + 'example' => 'Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]', + ], + 'Steps' => [ + 'title' => '执行步骤', + 'description' => '执行步骤。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StepName' => [ + 'title' => '步骤名称', + 'description' => '步骤名称。', + 'type' => 'string', + 'example' => 'create_vpd', + ], + 'StepState' => [ + 'title' => '步骤执行状态', + 'description' => '步骤执行状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'execution_success' => '执行成功', + 'execution_failed' => '执行失败', + ], + 'example' => 'execution_success', + ], + 'StepType' => [ + 'title' => '步骤类型', + 'description' => '步骤类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'normal' => '普通类型,有且只有一个后继step', + 'dispersive' => '发散类型,有多个后继step', + ], + 'example' => 'normal', + ], + 'SubTasks' => [ + 'title' => '子任务', + 'description' => '子任务。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务ID。', + 'type' => 'string', + 'example' => 'i158805051661047928377', + ], + 'TaskType' => [ + 'title' => '任务类型', + 'description' => '任务类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'reclone_node_sub_task' => '重装节点子任务', + 'initialize_bare_cluster' => '初始化裸集群', + 'extend_bare_cluster' => '扩容裸集群', + 'reclone_node' => '重装节点', + 'reboot_node' => '重启节点', + 'extend_ack_edge_cluster' => '扩容ack集群', + 'extend_cluster' => '扩容集群', + 'initialize_ack_edge_cluster' => '初始化ack集群', + 'cut_node_sub_task' => '缩容集群子任务', + 'reboot_node_sub_task' => '重启节点子任务', + 'reclone_ack_edge_node' => '重装ack节点', + 'initialize_cluster' => '初始化标准集群', + 'cut_cluster' => '缩容集群', + 'reclone_bare_node' => '重装裸集群节点', + 'cut_bare_cluster' => '缩容裸集群', + ], + 'example' => 'cut_node_sub_task', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2022-11-30T2:00:00.852Z', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-11-30T02:20:14.852Z', + ], + 'Message' => [ + 'title' => '子任务失败信息', + 'description' => '子任务失败信息。', + 'type' => 'string', + 'example' => 'Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]', + ], + 'TaskState' => [ + 'title' => '任务执行状态', + 'description' => '任务执行状态。', + 'type' => 'string', + 'example' => 'running', + ], + ], + ], + ], + 'StageTag' => [ + 'title' => '阶段标记', + 'description' => '阶段标记。', + 'type' => 'string', + 'enumValueTitles' => [ + '机器释放' => '机器释放', + '节点并发初始化' => '节点并发初始化', + '节点释放' => '节点释放', + '机器替换' => '机器替换', + '节点缩容' => '节点缩容', + '提前续费' => '提前续费', + '物理机清理' => '物理机清理', + '节点清理' => '节点清理', + '创建K8s集群' => '创建K8s集群', + '网络初始化' => '网络初始化', + '节点重启' => '节点重启', + '节点退订' => '节点退订', + '集群扩容' => '集群扩容', + '异常机器释放' => '异常机器释放', + ], + 'example' => '节点缩容', + ], + 'Message' => [ + 'title' => '步骤失败信息', + 'description' => '步骤失败信息。', + 'type' => 'string', + 'example' => 'get taskinfo failed', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2022-11-30T2:00:00.852Z', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-11-30T02:20:14.852Z', + ], + ], + ], + ], + 'CreateTime' => [ + 'title' => '开始时间', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2022-11-30T02:00:00.852Z', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2022-11-30T03:40:14.852Z', + ], + 'NodeIds' => [ + 'title' => '节点ID列表', + 'description' => '节点ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID列表。', + 'type' => 'string', + 'example' => '[\'mock-sn-200101\']', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7FD7411-9395-52E8-AF42-EB3A4A55446D\\",\\n \\"ClusterId\\": \\"i119982311660892626523\\",\\n \\"ClusterName\\": \\"Standard_Cluster\\",\\n \\"TaskState\\": \\"running\\",\\n \\"TaskType\\": \\"cut_cluster\\",\\n \\"Message\\": \\"Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]\\",\\n \\"Steps\\": [\\n {\\n \\"StepName\\": \\"create_vpd\\",\\n \\"StepState\\": \\"execution_success\\",\\n \\"StepType\\": \\"normal\\",\\n \\"SubTasks\\": [\\n {\\n \\"TaskId\\": \\"i158805051661047928377\\",\\n \\"TaskType\\": \\"cut_node_sub_task\\",\\n \\"CreateTime\\": \\"2022-11-30T2:00:00.852Z\\",\\n \\"UpdateTime\\": \\"2022-11-30T02:20:14.852Z\\",\\n \\"Message\\": \\"Releasing [prod_main_mid_26e234cf] in region [cn-beijing] with weight [0]\\",\\n \\"TaskState\\": \\"running\\"\\n }\\n ],\\n \\"StageTag\\": \\"节点缩容\\",\\n \\"Message\\": \\"get taskinfo failed\\",\\n \\"StartTime\\": \\"2022-11-30T2:00:00.852Z\\",\\n \\"UpdateTime\\": \\"2022-11-30T02:20:14.852Z\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2022-11-30T02:00:00.852Z\\",\\n \\"UpdateTime\\": \\"2022-11-30T03:40:14.852Z\\",\\n \\"NodeIds\\": [\\n \\"[\'mock-sn-200101\']\\"\\n ]\\n}","type":"json"}]', + 'title' => '查询任务信息', + ], + 'DescribeRegions' => [ + 'summary' => '查询地域信息列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161612', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AcceptLanguage', + 'in' => 'formData', + 'schema' => [ + 'title' => '根据汉语、英语和日语筛选返回结果。更多信息,请参见RFC7231。取值范围:'."\n" + ."\n" + .'zh-CN'."\n" + .'en-US'."\n" + .'默认值:zh-CN', + 'description' => '根据汉语、英语和日语筛选返回结果。更多信息,请参见RFC7231。取值范围:'."\n" + ."\n" + .'zh-CN'."\n" + .'en-US'."\n" + .'默认值:zh-CN', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en-US' => '英文', + 'zh-CN' => '中文', + ], + 'example' => 'zh-CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '1D2FBB36-C39B-5EBB-9928-FCC1A236D65D', + ], + 'Regions' => [ + 'description' => '地域信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LocalName' => [ + 'title' => '区域名称', + 'description' => '区域名称', + 'type' => 'string', + 'example' => '杭州', + ], + 'RegionId' => [ + 'title' => '区域id', + 'description' => '区域id', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1D2FBB36-C39B-5EBB-9928-FCC1A236D65D\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"杭州\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询地域列表', + ], + 'ChangeResourceGroup' => [ + 'summary' => '资源转组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterTOL3OM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'Node', + 'default' => 'Cluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '资源Id', + 'description' => '资源Id', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'i118099391667548921125', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => '地域Id', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-wulanchabu', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => '目标资源组', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aekzyqdwnfabx6q', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求 ID。', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '8F065DDD-6996-5973-9691-9EC57BD0072E', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => ' The specified resource is not found', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F065DDD-6996-5973-9691-9EC57BD0072E\\"\\n}","type":"json"}]', + 'title' => '资源转组', + ], + 'ApproveOperation' => [ + 'summary' => '审批运维操作。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '196045', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + [ + 'name' => 'OperationType', + 'in' => 'formData', + 'schema' => [ + 'description' => '运维类型。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RepairMachine' => 'RepairMachine', + ], + 'example' => 'RepairMachine', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '8F065DDD-6996-5973-9691-9EC57BD0072E', + ], + 'ErrorMessage' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'Resource not found', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F065DDD-6996-5973-9691-9EC57BD0072E\\",\\n \\"ErrorMessage\\": \\"Resource not found\\"\\n}","type":"json"}]', + 'title' => '审批运维操作', + ], + 'StopInvocation' => [ + 'summary' => '停止运维助手命令进程。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '202206', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InvokeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '命令执行ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'f-hz044748dzepds0', + ], + ], + [ + 'name' => 'NodeIdList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '灵骏节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => '\'i-bp1cfrqj4pztngvlq7la\'', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A7FD7411-9395-52E8-AF42-EB3A4A55446D', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A7FD7411-9395-52E8-AF42-EB3A4A55446D\\"\\n}","type":"json"}]', + 'title' => '停止运维命令', + ], + 'RunCommand' => [ + 'summary' => '一台或多台灵骏机器中执行一段Shell的脚本。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '202207', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '命令名称。支持全字符集,长度不得超过 128 个字符。', + 'description' => '命令名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testName', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '命令描述。支持全字符集,长度不得超过 512 个字符。', + 'description' => '命令描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'testDescription', + ], + ], + [ + 'name' => 'CommandContent', + 'in' => 'formData', + 'schema' => [ + 'title' => 'CommandId 二选一。命令内容。命令内容可以是明文内容或 Base64 编码后的内容。 ', + 'description' => '命令内容。您需要注意:'."\n" + ."\n" + .'- 指定参数`EnableParameter=true`可在命令内容中启用自定义参数功能。'."\n" + .'- 用{{}}包含的方式定义自定义参数,在`{{}}`内参数名前后的空格以及换行符会被忽略。'."\n" + .'- 自定义参数个数不能超过20个。'."\n" + .'- 自定义参数名允许a-zA-Z0-9-_的组合,不支持其余字符,参数名不区分大小写。'."\n" + .'- 单个自定义参数名不能超过64字节。', + 'type' => 'string', + 'required' => false, + 'example' => 'ZWNobyAxMjM=', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'title' => '执行命令的超时时间,单位:秒。'."\n" + ."\n" + .'当因为进程原因、缺失模块 等原因无法运行命令时,会出现超时现象。超时后,会强制终止命令进程。'."\n" + ."\n" + .'默认值:60。', + 'description' => '执行命令的超时时间,单位:秒。当因为进程原因、缺失模块、缺失云助手Agent等原因无法运行命令时,会出现超时现象。超时后,会强制终止命令进程。默认值:60。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '3600'."\n", + ], + ], + [ + 'name' => 'WorkingDir', + 'in' => 'formData', + 'schema' => [ + 'title' => '命令在 灵骏节点中的运行目录。长度不得超过 200 个字符。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'Linux 系统实例默认在管理员(root 用户)的 home 目录下,即/root。', + 'description' => '您可自定义命令的执行路径。默认路径如下:'."\n" + ."\n" + .'Linux实例:执行路径默认在管理员root用户的/home目录下。', + 'type' => 'string', + 'required' => false, + 'example' => '/home/user', + ], + ], + [ + 'name' => 'EnableParameter', + 'in' => 'formData', + 'schema' => [ + 'title' => '命令中是否包含自定义参数。'."\n" + ."\n" + .'默认值:false。', + 'description' => '命令中是否包含自定义参数。'."\n" + ."\n" + .'默认值:false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ContentEncoding', + 'in' => 'formData', + 'schema' => [ + 'title' => '命令内容(CommandContent)的编码方式。取值范围(不区分大小写):'."\n" + ."\n" + .'PlainText:不编码,采用明文传输。'."\n" + .'Base64:Base64 编码。'."\n" + .'默认值:PlainText,乱填或错填该取值会当作 PlainText 处理。', + 'description' => '脚本内容的编码方式。取值范围:'."\n" + ."\n" + .'- PlainText:不编码,采用明文传输。'."\n" + .'- Base64:Base64编码。'."\n" + ."\n" + .'默认值:PlainText。乱填或错填时,该取值会当作PlainText处理。', + 'type' => 'string', + 'required' => false, + 'example' => 'Base64', + ], + ], + [ + 'name' => 'Username', + 'in' => 'formData', + 'schema' => [ + 'title' => '在灵骏节点中执行命令的用户名称。长度不得超过 255 个字符。', + 'description' => '在实例中执行命令的用户名称。长度不得超过255个字符。'."\n" + .'Linux系统的实例,默认以root用户执行命令。', + 'type' => 'string', + 'required' => false, + 'example' => 'root', + ], + ], + [ + 'name' => 'NodeIdList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '灵骏节点id', + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => '"i-bp185dy2o3o6neg****"', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RepeatMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '设置命令执行的方式。取值范围:'."\n" + ."\n" + .'Once:立即执行命令。'."\n" + .'Period:定时执行命令。当该参数取值为Period时,必须同时指定Frequency参数。'."\n" + .'NextRebootOnly:当实例下一次启动时,自动执行命令。'."\n" + .'EveryReboot:实例每一次启动都将自动执行命令。'."\n" + .'默认值:'."\n" + ."\n" + .'当不指定Frequency参数时,默认值为Once。'."\n" + .'当指定Frequency参数时,无论是否已设置了该参数值,都将按照Period处理', + 'description' => '设置命令执行的方式。取值范围:'."\n" + ."\n" + .'- Once:立即执行命令。'."\n" + .'- Period:定时执行命令。当该参数取值为`Period`时,必须同时指定`Frequency`参数。'."\n" + .'- NextRebootOnly:当实例下一次启动时,自动执行命令。'."\n" + .'- EveryReboot:实例每一次启动都将自动执行命令。'."\n" + ."\n" + .'默认值:'."\n" + .'- 当不指定`Frequency`参数时,默认值为`Once`。'."\n" + .'- 当指定`Frequency`参数时,无论是否已设置了该参数值,都将按照`Period`处理。', + 'type' => 'string', + 'required' => false, + 'example' => 'Once', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性。', + 'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。更多信息,请参见如何保证幂等性。', + 'type' => 'string', + 'required' => false, + 'example' => '123e4567-e89b-12d3-a456-426655440000', + ], + ], + [ + 'name' => 'Frequency', + 'in' => 'formData', + 'schema' => [ + 'title' => '定时执行命令的执行时间。目前支持三种定时执行方式:固定时间间隔执行(基于 Rate 表达式)、仅在指定时间执行一次、基于时钟定时执行(基于 Cron 表达式)。', + 'description' => '定时执行命令的执行时间。目前支持三种定时执行方式:固定时间间隔执行(基于 Rate 表达式)、仅在指定时间执行一次、基于时钟定时执行(基于 Cron 表达式)。'."\n" + ."\n" + .'- 固定时间间隔执行:基于 Rate 表达式,按照设置的时间间隔执行命令。时间间隔支持按秒(s) 、分钟(m) 、小时(h)和天(d)来选择,适用于在固定时间间隔执行任务的场景。格式为 rate(<执行间隔数值><执行间隔单位>),如 5 分钟执行一次,格式为 rate(5m)。使用固定时间间隔执行有以下限制: '."\n" + .' - 设置的时间间隔不大于 7 天、不小于 60 秒,且需大于定时任务的超时时间。 '."\n" + .' - 执行间隔只基于固定频率,与任务实际执行需要的时间无关。例如设置每 5 分钟执行一次命令,任务需要 2 分钟执行完成,则在任务完成 3 分钟后继续执行下一轮。 '."\n" + .' - 创建任务时不会立即执行。例如设置每 5 分钟执行一次命令,创建任务时不会立即执行一次命令,而是在任务创建完成后的 5 分钟后开始执行。'."\n" + .' '."\n" + .'- 仅在指定时间执行一次:按照设置的时区和执行时间点执行一次命令。格式为 at(yyyy-MM-dd HH:mm:ss <时区>),即 at(年-月-日 时:分:秒 <时区>)。如果不指定时区,默认为 UTC 时区。时区支持以下三种形式: 时区全称: 如 Asia/Shanghai(中国/上海时间)、America/Los_Angeles(美国/洛杉矶时间)等。 时区相对于格林威治时间的偏移量: 如 GMT+8:00(东八区)、GMT-7:00(西七区)等。使用 GMT 格式时,小时位不支持添加前导零。 时区缩写: 仅支持 UTC(协调世界时间)。'."\n" + .'如果指定在中国/上海时间 2022 年 06 月 06 日 13 时 15 分 30 秒执行一次,格式为:at(2022-06-06 13:15:30 Asia/Shanghai);如果指定在西七区 2022 年 06 月 06 日 13 时 15 分 30 秒执行一次,格式为:at(2022-06-06 13:15:30 GMT-7:00)。'."\n" + ."\n" + .'- 基于时钟定时执行(基于 Cron 表达式):基于 Cron 表达式,按照设置的定时任务执行命令。格式为<秒> <分钟> <小时> <日期> <月份> <星期> <年份(可选)> <时区>,即<Cron 表达式> <时区>。在指定的时区下,根据 Cron 表达式推算定时任务执行时间并执行。若不指定时区,默认为执行定时任务实例的系统内部时区。关于 Cron 表达式的更多信息,请参见 Cron 表达式。时区支持以下三种形式: '."\n" + .' - 时区全称:如 Asia/Shanghai(中国/上海时间)、America/Los_Angeles(美国/洛杉矶时间)等。 '."\n" + .' - 时区相对于格林威治时间的偏移量:如 GMT+8:00(东八区)、GMT-7:00(西七区)等。使用 GMT 格式时,小时位不支持添加前导零。 '."\n" + .' - 时区缩写:仅支持 UTC(协调世界时间)。'."\n" + ."\n" + .' 例如,在中国/上海时间,2022 年每天上午 10:15 执行一次命令,格式为 0 15 10 ? * * 2022 Asia/Shanghai;在东八区时间,2022 年每天上午 10:00 到 11:30 每隔半小时执行,格式为 0 0/30 10-11 * * ? 2022 GMT+8:00;在 UTC 时间,从 2022 年开始,每隔两年的 10 月每天下午 14:00 到下午 14:55 时间段内每隔 5 分钟执行,格式为 0 0/5 14 * 10 ? 2022/2 UTC。', + 'type' => 'string', + 'required' => false, + 'example' => '0 */20 * * * ?', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '命令中包含自定义参数时,执行命令时传入的自定义参数的键值对。', + 'description' => '命令中包含自定义参数时,执行命令时传入的自定义参数的键值对。例如,命令内容为`echo {{name}}`,则可以通过`Parameter`参数传入键值对`{"name":"Jack"}`。自定义参数将自动替换变量值`name`,得到一条新的命令,实际执行的是`echo Jack`。'."\n" + ."\n" + .'自定义参数的个数范围为0~10,且您需要注意:'."\n" + ."\n" + .'- 键不允许为空字符串,最多支持64个字符。'."\n" + .'- 值允许为空字符串。'."\n" + .'- 自定义参数与原始命令内容在Base64编码后,若保存命令,命令内容在Base64编码后的大小不能超过18 KB;若不保存命令,命令内容在Base64编码后的大小不能超过24 KB。您可通过`KeepCommand`设置是否保留命令。'."\n" + .'- 设置的自定义参数名集合必须为创建命令时定义的参数集的子集。对于未传入的参数,您可以使用空字符串代替。'."\n" + ."\n" + .'默认值为空,表示取消设置该参数从而禁用自定义参数。', + 'type' => 'object', + 'required' => false, + 'example' => '{"name":"Jack", "accessKey":"LTAI***********"}', + ], + ], + [ + 'name' => 'CommandId', + 'in' => 'formData', + 'schema' => [ + 'title' => '命令ID', + 'description' => '命令ID', + 'type' => 'string', + 'required' => false, + 'example' => 'c-e996287206324975b5fbe1d***', + ], + ], + [ + 'name' => 'TerminationMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '停止任务(手动停止或执行超时打断)时的模式。可能值:'."\n" + ."\n" + .'Process:停止当前脚本进程。'."\n" + .'ProcessTree:停止当前进程树(脚本进程以及它创建的所有子进程的集合)', + 'description' => '停止任务(手动停止或执行超时打断)时的模式。可能值:'."\n" + ."\n" + .'Process:停止当前脚本进程。'."\n" + .'ProcessTree:停止当前进程树(脚本进程以及它创建的所有子进程的集合)', + 'type' => 'string', + 'required' => false, + 'example' => 'ProcessTree', + ], + ], + [ + 'name' => 'Launcher', + 'in' => 'formData', + 'schema' => [ + 'title' => '脚本执行的引导程序。长度不能超过 1 KB。', + 'description' => '脚本执行的引导程序。长度不能超过 1 KB。', + 'type' => 'string', + 'required' => false, + 'example' => 'python3 -u {{ACS::ScriptFileName|Ext(".py")}}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1', + ], + 'InvokeId' => [ + 'description' => '命令执行ID。', + 'type' => 'string', + 'example' => 't-7d2a745b412b4601b2d47f6a768d*', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1\\",\\n \\"InvokeId\\": \\"t-7d2a745b412b4601b2d47f6a768d*\\"\\n}","type":"json"}]', + 'title' => '一台或多台灵骏机器中执行一段Shell的脚本', + ], + 'DescribeInvocations' => [ + 'summary' => '查询运维助手命令的执行列表和状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InvokeId', + 'in' => 'formData', + 'schema' => [ + 'title' => '命令执行ID', + 'description' => '命令执行ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't-cd03crwys0lrls0', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例ID', + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + [ + 'name' => 'IncludeOutput', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否在结果中返回命令运行的输出信息。'."\n" + .'- true:返回。此时,您至少指定参数`InvokeId`或`InstanceId`。'."\n" + .'- false(默认值):不返回。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ContentEncoding', + 'in' => 'formData', + 'schema' => [ + 'description' => '设置返回数据中`CommandContent`字段和`Output`字段的编码方式。取值范围:'."\n" + .'- PlainText:返回原始命令内容和输出信息。'."\n" + .'- Base64(默认值):返回Base64编码后的命令内容和输出信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'PlainText', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'Invocations' => [ + 'description' => '脚本执行记录对象。', + 'type' => 'object', + 'properties' => [ + 'Invocation' => [ + 'description' => '文件下发记录。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '任务的创建时间。', + 'type' => 'string', + 'example' => '2020-01-19T09:15:46Z', + ], + 'Frequency' => [ + 'description' => '定时执行命令的执行时间。', + 'type' => 'string', + 'example' => '0 */20 * * * *', + ], + 'InvocationStatus' => [ + 'description' => '命令执行的总执行状态,总执行状态取决于本次调用的全部实例的共同执行状态,取值:'."\n" + .'- Pending:系统正在校验或发送命令。存在至少一台实例的命令执行状态为Pending,则总执行状态为Pending。'."\n" + .'- Scheduled:定时执行的命令已发送,等待运行。存在至少一台实例的命令执行状态为Scheduled,则总执行状态为Scheduled。'."\n" + .'- Running:命令正在实例上运行。存在至少一台实例的命令执行状态为Running,则总执行状态为Running。'."\n" + .'- Success:各个实例上的命令执行状态均为Stopped或Success,且至少一个实例的命令执行状态是Success,则总执行状态为Success。'."\n" + .' - 立即运行的任务:命令执行完成,且退出码为0。'."\n" + .' - 定时运行的任务:最近一次执行成功且退出码为0,且指定的时间已全部完成。'."\n" + .'- Failed:各个实例上的命令执行状态均为Stopped或Failed,则总执行状态为Failed。实例上的命令执行状态一项或多项为以下状态时,返回值均为Failed状态:'."\n" + .' - 命令校验失败(Invalid)。'."\n" + .' - 命令发送失败(Aborted)。'."\n" + .' - 命令执行完成但退出码非0(Failed)。'."\n" + .' - 命令执行超时(Timeout)。'."\n" + .' - 命令执行异常(Error)。'."\n" + .'- Stopping:正在停止任务。存在至少一台实例的命令执行状态为Stopping,则总执行状态为Stopping。'."\n" + .'- Stopped:任务已停止。所有实例的命令执行状态是Stopped,则总执行状态为Stopped。实例上的命令执行状态为以下状态时,返回值均为Stopped状态:'."\n" + .' - 任务已取消(Cancelled)。'."\n" + .' - 任务已终止(Terminated)。'."\n" + .'- PartialFailed:部分实例执行成功且部分实例执行失败。各个实例的命令执行状态均为Success、Failed或Stopped,则总执行状态为PartialFailed。'."\n" + ."\n" + .'> 返回参数中的`InvokeStatus`与该参数意义相似,但建议您查看该返回值。', + 'type' => 'string', + 'example' => 'Success', + ], + 'RepeatMode' => [ + 'description' => '命令执行的方式。取值:'."\n" + .'- Once:立即执行命令。'."\n" + .'- Period:定时执行命令。'."\n" + .'- NextRebootOnly:当实例下一次启动时,自动执行命令。'."\n" + .'- EveryReboot:实例每一次启动都将自动执行命令。', + 'type' => 'string', + 'example' => 'Once', + ], + 'InvokeStatus' => [ + 'description' => '命令执行的总执行状态。总执行状态取决于创建执行中的一台或多台实例的共同执行状态。取值: '."\n" + .' '."\n" + .'- Running:'."\n" + .' - 定时执行:未手动停止定时执行命令前,执行状态一直为进行中。'."\n" + .' - 单次执行:一旦有进行中的命令进程,总的执行状态就为进行中。'."\n" + .'- Finished:'."\n" + .' - 定时执行:命令进程不可能为执行完成。'."\n" + .' - 单次执行:所有实例全部完成执行。或者手动停止部分实例的命令进程,其余实例全部执行完成。'."\n" + .'- Failed:'."\n" + .' - 定时执行:命令进程不可能为执行失败。'."\n" + .' - 单次执行:所有实例全部执行失败。'."\n" + .'- Stopped:停止命令。'."\n" + .'- Stopping:停止中。'."\n" + .'- PartialFailed:部分失败;如果同时设置了`InstanceId`参数,则不生效。', + 'type' => 'string', + 'example' => 'Running', + ], + 'Parameters' => [ + 'description' => '命令中的自定义参数。', + 'type' => 'string', + 'example' => '{}', + ], + 'CommandContent' => [ + 'description' => '命令内容。'."\n" + ."\n" + .'- 若ContentEncoding指定PlainText,返回原始脚本内容。'."\n" + .'- 若ContentEncoding指定Base64,返回Base64编码后的脚本内容。', + 'type' => 'string', + 'example' => 'cnBtIC1xYSB8IGdyZXAgdnNm****', + ], + 'CommandName' => [ + 'description' => '命令名称。', + 'type' => 'string', + 'example' => 'CommandTestName', + ], + 'CommandDescription' => [ + 'description' => '命令描述。', + 'type' => 'string', + 'example' => 'testDescription', + ], + 'InvokeId' => [ + 'description' => '命令执行ID。', + 'type' => 'string', + 'example' => 't-ind3k9ytvvduoe8', + ], + 'Username' => [ + 'description' => '执行命令的用户名称。', + 'type' => 'string', + 'example' => 'root', + ], + 'WorkingDir' => [ + 'description' => '命令在实例中的运行目录。', + 'type' => 'string', + 'example' => '/home', + ], + 'Timeout' => [ + 'description' => '执行命令的超时时间,单位:秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'InvokeNodes' => [ + 'description' => '命令执行记录。', + 'type' => 'object', + 'properties' => [ + 'InvokeNode' => [ + 'description' => '节点命令执行记录。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreationTime' => [ + 'description' => '命令执行的开始时间。', + 'type' => 'string', + 'example' => '2023-02-06T07:12:50Z', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-02-06T07:12:50Z', + ], + 'FinishTime' => [ + 'description' => '结束完成时间。', + 'type' => 'string', + 'example' => '2023-02-06T07:12:50Z', + ], + 'InvocationStatus' => [ + 'description' => '单台实例的命令进度状态,取值:'."\n" + .'- Pending:系统正在校验或发送命令。'."\n" + .'- Invalid:指定命令类型或参数有误。'."\n" + .'- Aborted:向实例发送命令失败。实例必须在运行中,且命令可以1分钟内发送完成。'."\n" + .'- Running:命令正在实例上运行。'."\n" + .'- Success:'."\n" + .' - 单次执行的命令:命令执行完成,且退出码为0。'."\n" + .' - 周期执行的命令:上一次运行成功且退出码为0,且指定的周期已结束。'."\n" + .'- Failed:'."\n" + .' - 单次执行的命令:命令执行完成,且退出码非0。'."\n" + .' - 周期执行的命令:上一次运行成功且退出码非0,且指定的周期将中止。'."\n" + .'- Error:命令执行时发生异常无法继续。'."\n" + .'- Timeout:命令执行超时。'."\n" + .'- Cancelled:命令的执行动作已经取消,命令未曾启动。'."\n" + .'- Stopping:正在停止任务。'."\n" + .'- Terminated:命令运行时被终止。'."\n" + .'- Scheduled:'."\n" + .' - 单次执行的命令:不适用,不会出现。'."\n" + .' - 周期执行的命令:等待运行。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'Repeats' => [ + 'description' => '命令在该实例上执行的次数。'."\n" + .'- 若执行方式为单次执行,则值为0或1。'."\n" + .'- 若执行方式为定时执行,则值为执行过多少次。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'example' => 'e01-cn-lbj36wkp70b', + ], + 'Output' => [ + 'description' => '命令的输出信息。'."\n" + ."\n" + .'- 若ContentEncoding指定PlainText,返回原始输出信息。'."\n" + .'- 若ContentEncoding指定Base64,返回Base64编码后的输出信息。', + 'type' => 'string', + 'example' => 'OutPutTestmsg', + ], + 'Dropped' => [ + 'description' => 'Output字段中文字长度超出24 KB后,截断丢弃的文字长度。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StopTime' => [ + 'description' => '若调用了StopInvocation以停止命令执行,表示调用的时间。', + 'type' => 'string', + 'example' => '2019-12-20T06:15:55Z '."\n", + ], + 'ExitCode' => [ + 'description' => '命令进程的退出代码。取值:'."\n" + ."\n" + .'- Linux实例为Shell进程的退出码。'."\n" + .'- Windows实例为Bat或者PowerShell进程的退出码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StartTime' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2019-12-20T06:15:55Z', + ], + 'ErrorInfo' => [ + 'description' => '命令的下发失败或执行失败原因的详情,取值:'."\n" + .'- 空:命令执行正常。'."\n" + .'- the specified node does not exists:指定的实例不存在或已释放。'."\n" + .'- the node has node when create task:执行命令期间,该实例被释放。'."\n" + .'- the node is not running when create task:命令执行时,该实例不在运行中。'."\n" + .'- the command is not applicable:命令不适用于指定的实例。'."\n" + .'- the specified account does not exists:指定的账号不存在。'."\n" + .'- the specified directory does not exists:指定的目录不存在。'."\n" + .'- the cron job expression is invalid:指定的执行时间表达式不合法。'."\n" + .'- the aliyun service is not running on the instance:云助手Agent未运行。'."\n" + .'- the aliyun service in the instance does not response:云助手Agent无响应。'."\n" + .'- the aliyun service in the node is upgrading now:云助手Agent正在升级中。'."\n" + .'- the aliyun service in the node need upgrade:云助手Agent需要升级。'."\n" + .'- the command delivery has been timeout:发送命令超时。'."\n" + .'- the command execution has been timeout:命令执行超时。'."\n" + .'- the command execution got an exception:命令执行发生异常。'."\n" + .'- the command execution has been interrupted:命令执行被中断。'."\n" + .'- the command execution exit code is not zero:命令执行结束,退出码非0。'."\n" + .'- the specified node has been released:下发文件期间,该实例被释放。', + 'type' => 'string', + 'example' => 'the specified node does not exists', + ], + 'Timed' => [ + 'description' => '查询的命令是否在将来会自动执行。取值:'."\n" + ."\n" + .'- true:查询在调用`RunCommand`或`InvokeCommand`执行命令时,`RepeatMode`参数取值为`Period`、`NextRebootOnly`或者`EveryReboot`。'."\n" + .'- false(默认值):查询以下两种状态的命令。'."\n" + .' - 在调用`RunCommand`或`InvokeCommand`执行命令时,`RepeatMode`参数取值为`Once`。'."\n" + .' - 已被取消、被停止或者已完成执行的命令。', + 'type' => 'string', + 'example' => 'false', + ], + 'ErrorCode' => [ + 'description' => '文件下发的失败原因代码。取值:'."\n" + ."\n" + .'- 空:文件下发正常。'."\n" + .'- NodeNotExists:指定的实例不存在或已释放。'."\n" + .'- NodeReleased:下发文件期间,该实例被释放。'."\n" + .'- NodeNotRunning:创建下发文件任务时,该实例不在运行中。'."\n" + .'- AccountNotExists:指定的账号不存在。'."\n" + .'- ClientNotRunning:云助手Agent未运行。'."\n" + .'- ClientNotResponse:云助手Agent无响应。'."\n" + .'- ClientIsUpgrading:云助手Agent正在升级中。'."\n" + .'- ClientNeedUpgrade:云助手Agent需要升级。'."\n" + .'- DeliveryTimeout:发送文件超时。'."\n" + .'- FileCreateFail:文件创建失败。'."\n" + .'- FileAlreadyExists:相同路径下存在同名文件。'."\n" + .'- FileContentInvalid:文件内容不合法。'."\n" + .'- FileNameInvalid:文件名不合法。'."\n" + .'- FilePathInvalid:文件路径不合法。'."\n" + .'- FileAuthorityInvalid:文件权限不合法。'."\n" + .'- UserGroupNotExists:发送文件时指定的用户组不存在。', + 'type' => 'string', + 'example' => ' NodeNotExists', + ], + 'NodeInvokeStatus' => [ + 'description' => '单台实例的命令进度状态。', + 'type' => 'string', + 'example' => 'Finished', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"Invocations\\": {\\n \\"Invocation\\": [\\n {\\n \\"CreationTime\\": \\"2020-01-19T09:15:46Z\\",\\n \\"Frequency\\": \\"0 */20 * * * *\\",\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"RepeatMode\\": \\"Once\\",\\n \\"InvokeStatus\\": \\"Running\\",\\n \\"Parameters\\": \\"{}\\",\\n \\"CommandContent\\": \\"cnBtIC1xYSB8IGdyZXAgdnNm****\\",\\n \\"CommandName\\": \\"CommandTestName\\",\\n \\"CommandDescription\\": \\"testDescription\\",\\n \\"InvokeId\\": \\"t-ind3k9ytvvduoe8\\",\\n \\"Username\\": \\"root\\",\\n \\"WorkingDir\\": \\"/home\\",\\n \\"Timeout\\": 60,\\n \\"InvokeNodes\\": {\\n \\"InvokeNode\\": [\\n {\\n \\"CreationTime\\": \\"2023-02-06T07:12:50Z\\",\\n \\"UpdateTime\\": \\"2023-02-06T07:12:50Z\\",\\n \\"FinishTime\\": \\"2023-02-06T07:12:50Z\\",\\n \\"InvocationStatus\\": \\"Pending\\",\\n \\"Repeats\\": 0,\\n \\"NodeId\\": \\"e01-cn-lbj36wkp70b\\",\\n \\"Output\\": \\"OutPutTestmsg\\",\\n \\"Dropped\\": 0,\\n \\"StopTime\\": \\"2019-12-20T06:15:55Z\\\\t\\\\n\\",\\n \\"ExitCode\\": 0,\\n \\"StartTime\\": \\"2019-12-20T06:15:55Z\\",\\n \\"ErrorInfo\\": \\"the specified node does not exists\\",\\n \\"Timed\\": \\"false\\",\\n \\"ErrorCode\\": \\" NodeNotExists\\",\\n \\"NodeInvokeStatus\\": \\"Finished\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询命令的执行列表和状态', + ], + 'DescribeSendFileResults' => [ + 'summary' => '查询运维助手下发文件列表及状态。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '202212', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InvokeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '命令执行ID。', + 'type' => 'string', + 'required' => true, + 'example' => 't-bj038i0d6r8zoqo', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'TotalCount' => [ + 'description' => '命令总个数。', + 'type' => 'string', + 'example' => '1', + ], + 'Invocations' => [ + 'description' => '文件下发记录。', + 'type' => 'object', + 'properties' => [ + 'Invocation' => [ + 'description' => '命令执行ID。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileMode' => [ + 'description' => '文件的权限。', + 'type' => 'string', + 'example' => '0644', + ], + 'Overwrite' => [ + 'description' => '如果同名文件在目标目录已存在,是否覆盖文件。'."\n" + .'- true:覆盖。'."\n" + .'- false:不覆盖。'."\n" + ."\n" + .'默认值为false。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InvocationStatus' => [ + 'description' => '文件的总下发状态。总状态取决于本次下发的全部实例的共同执行状态,可能值:'."\n" + ."\n" + .'- Pending:系统正在校验或下发文件。存在至少一台实例的文件下发状态为Pending,则总执行状态为Pending。'."\n" + .'- Running:正在实例上下发文件。存在至少一台实例的文件下发状态为Running,则总执行状态为Running。'."\n" + .'- Success:各个实例上的文件下发状态均为Success,则总执行状态为Success。'."\n" + .'- Failed:各个实例上的文件下发状态均为Failed,则总执行状态为Failed。实例上的文件下发状态一项或多项为以下状态时,返回值均为Failed状态:'."\n" + .' - 指定文件参数有误,校验失败(Invalid)。'."\n" + .' - 向实例下发文件失败(Aborted)。'."\n" + .' - 文件在实例内创建失败(Failed)。'."\n" + .' - 下发文件超时(Timeout)。'."\n" + .' - 下发文件时发生异常无法继续(Error)。'."\n" + .'- PartialFailed:部分实例文件下发成功且部分实例下发失败。各个实例的文件下发状态均为Success或Failed,则总执行状态为PartialFailed。', + 'type' => 'string', + 'example' => 'Pending', + ], + 'Description' => [ + 'description' => '命令描述。', + 'type' => 'string', + 'example' => '描述信息。', + ], + 'ContentType' => [ + 'description' => '文件内容类型。'."\n" + ."\n" + .'PlainText:普通文本。'."\n" + .'Base64:Base64编码。'."\n" + .'默认值为PlainText。', + 'type' => 'string', + 'example' => 'PlainText', + ], + 'NodeCount' => [ + 'description' => '节点数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TargetDir' => [ + 'description' => '目标路径。', + 'type' => 'string', + 'example' => ' /home/user', + ], + 'FileGroup' => [ + 'description' => '文件的用户组。', + 'type' => 'string', + 'example' => 'root', + ], + 'FileOwner' => [ + 'description' => '文件的用户。', + 'type' => 'string', + 'example' => 'root', + ], + 'Name' => [ + 'description' => '文件下发名称', + 'type' => 'string', + 'example' => 'test', + ], + 'Content' => [ + 'description' => '命令执行后的输出信息。'."\n" + ."\n" + .'若ContentEncoding指定PlainText,返回原始输出信息。'."\n" + .'若ContentEncoding指定Base64,返回Base64编码后的输出信息。', + 'type' => 'string', + 'example' => 'Base64', + ], + 'CreationTime' => [ + 'description' => '下发创建时间', + 'type' => 'string', + 'example' => '2023-04-10T10:53:46.156+08:00'."\n", + ], + 'InvokeNodes' => [ + 'description' => '文件下发记录', + 'type' => 'object', + 'properties' => [ + 'InvokeNode' => [ + 'description' => '节点文件下发记录', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InvocationStatus' => [ + 'description' => '单台实例下发任务的状态,可能值:'."\n" + .'- Pending:系统正在校验或下发文件。'."\n" + .'- Invalid:指定文件参数有误,校验失败。'."\n" + .'- Running:正在实例上下发文件。'."\n" + .'- Aborted:向实例下发文件失败。'."\n" + .'- Success:文件下发完成。'."\n" + .'- Failed:文件在实例内创建失败。'."\n" + .'- Error:下发文件时发生异常无法继续。'."\n" + .'- Timeout:下发文件超时。', + 'type' => 'string', + 'example' => 'Success', + ], + 'FinishTime' => [ + 'description' => '结束时间,格式:"2020-05-22T17:04:18"。', + 'type' => 'string', + 'example' => '2023-04-10T10:53:46.156+08:00', + ], + 'NodeId' => [ + 'description' => '节点id', + 'type' => 'string', + 'example' => 'e01-cn-9lb3c15m81j', + ], + 'ErrorInfo' => [ + 'description' => '命令的下发失败或执行失败原因的详情,可能值:'."\n" + .'- 空:命令执行正常。'."\n" + .'- the specified instance does not exists:指定的实例不存在或已释放。'."\n" + .'- the node has released when create task:执行命令期间,该实例被释放。'."\n" + .'- the node is not running when create task:命令执行时,该实例不在运行中。'."\n" + .'- the command is not applicable:命令不适用于指定的实例。'."\n" + .'- the specified account does not exists:指定的账号不存在。'."\n" + .'- the specified directory does not exists:指定的目录不存在。'."\n" + .'- the cron job expression is invalid:指定的执行时间表达式不合法。'."\n" + .'- the aliyun service is not running on the instance:云助手Agent未运行。'."\n" + .'- the aliyun service in the instance does not response:云助手Agent无响应。'."\n" + .'- the aliyun service in the node is upgrading now:云助手Agent正在升级中。'."\n" + .'- the aliyun service in the node need upgrade:云助手Agent需要升级。'."\n" + .'- the command delivery has been timeout:发送命令超时。'."\n" + .'- the command execution has been timeout:命令执行超时。'."\n" + .'- the command execution got an exception:命令执行发生异常。'."\n" + .'- the command execution has been interrupted:命令执行被中断。'."\n" + .'- the command execution exit code is not zero:命令执行结束,退出码非0。'."\n" + .'- the specified instance has been released:下发文件期间,该实例被释放。', + 'type' => 'string', + 'example' => 'the specified instance does not exists', + ], + 'CreationTime' => [ + 'description' => '文件下发任务的创建时间。', + 'type' => 'string', + 'example' => '2023-02-06T07:12:50Z', + ], + 'StartTime' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2023-03-30T16:00:00Z', + ], + 'UpdateTime' => [ + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2023-03-30T16:00:00Z', + ], + 'ErrorCode' => [ + 'description' => '文件下发的失败原因代码。可能值:'."\n" + ."\n" + .'空:文件下发正常。'."\n" + .'NodeNotExists:指定的实例不存在或已释放。'."\n" + .'NodeReleased:下发文件期间,该实例被释放。'."\n" + .'NodeNotRunning:创建下发文件任务时,该实例不在运行中。'."\n" + .'AccountNotExists:指定的账号不存在。'."\n" + .'ClientNotRunning:云助手Agent未运行。'."\n" + .'ClientNotResponse:云助手Agent无响应。'."\n" + .'ClientIsUpgrading:云助手Agent正在升级中。'."\n" + .'ClientNeedUpgrade:云助手Agent需要升级。'."\n" + .'DeliveryTimeout:发送文件超时。'."\n" + .'FileCreateFail:文件创建失败。'."\n" + .'FileAlreadyExists:相同路径下存在同名文件。'."\n" + .'FileContentInvalid:文件内容不合法。'."\n" + .'FileNameInvalid:文件名不合法。'."\n" + .'FilePathInvalid:文件路径不合法。'."\n" + .'FileAuthorityInvalid:文件权限不合法。'."\n" + .'UserGroupNotExists:发送文件时指定的用户组不存在。', + 'type' => 'string', + 'example' => 'AccountNotExists', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"Invocations\\": {\\n \\"Invocation\\": [\\n {\\n \\"FileMode\\": \\"0644\\",\\n \\"Overwrite\\": true,\\n \\"InvocationStatus\\": \\"Pending\\",\\n \\"Description\\": \\"描述信息。\\",\\n \\"ContentType\\": \\"PlainText\\",\\n \\"NodeCount\\": 3,\\n \\"TargetDir\\": \\"\\\\t/home/user\\",\\n \\"FileGroup\\": \\"root\\",\\n \\"FileOwner\\": \\"root\\",\\n \\"Name\\": \\"test\\",\\n \\"Content\\": \\"Base64\\",\\n \\"CreationTime\\": \\"2023-04-10T10:53:46.156+08:00\\\\n\\",\\n \\"InvokeNodes\\": {\\n \\"InvokeNode\\": [\\n {\\n \\"InvocationStatus\\": \\"Success\\",\\n \\"FinishTime\\": \\"2023-04-10T10:53:46.156+08:00\\",\\n \\"NodeId\\": \\"e01-cn-9lb3c15m81j\\",\\n \\"ErrorInfo\\": \\"the specified instance does not exists\\",\\n \\"CreationTime\\": \\"2023-02-06T07:12:50Z\\",\\n \\"StartTime\\": \\"2023-03-30T16:00:00Z\\",\\n \\"UpdateTime\\": \\"2023-03-30T16:00:00Z\\",\\n \\"ErrorCode\\": \\"AccountNotExists\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询下发文件列表及状态', + ], + 'SendFile' => [ + 'summary' => '一台或多台灵骏机器下发远程文件。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '202211', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件名称。支持全字符集,长度不得超过255个字符。', + 'type' => 'string', + 'required' => true, + 'example' => 'file.txt', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述信息。支持全字符集,长度不得超过512个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'This is a test file. '."\n", + ], + ], + [ + 'name' => 'TargetDir', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件下发目标灵骏节点中的目录。如不存在则会自动创建。', + 'type' => 'string', + 'required' => true, + 'example' => '/home', + ], + ], + [ + 'name' => 'ContentType', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件内容类型。'."\n" + ."\n" + .'PlainText:普通文本。'."\n" + .'Base64:Base64编码。'."\n" + .'默认值为PlainText。', + 'type' => 'string', + 'required' => false, + 'example' => 'PlainText', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件内容。文件内容在Base64编码后,大小不能超过32 KB。'."\n" + ."\n" + .'- 当`ContentType`参数为`PlainText`时,该字段为明文格式的普通文本。'."\n" + .'- 当`ContentType`参数为`Base64`时,该字段为Base64编码的文本。', + 'type' => 'string', + 'required' => true, + 'example' => '#!/bin/bash echo "Current User is :" echo $(ps | grep "$$" | awk \'{print $2}\') -------- oss://bucketName/objectName', + ], + ], + [ + 'name' => 'FileMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的权限。只对Linux实例生效,设置方式与chmod命令相同。'."\n" + ."\n" + .'默认值为0644,表示用户具有读写权限,用户组和其它用户具有只读权限。', + 'type' => 'string', + 'required' => false, + 'example' => '0644', + ], + ], + [ + 'name' => 'FileOwner', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的用户。只对Linux实例生效,默认为root。', + 'type' => 'string', + 'required' => false, + 'example' => 'root', + ], + ], + [ + 'name' => 'FileGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => '文件的用户组。只对Linux实例生效,默认为root。长度不得超过64个字符。'."\n" + ."\n" + .'说明'."\n" + .'使用其他用户组时,请确保实例中存在该用户组。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'NodeIdList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '灵骏节点ID', + 'type' => 'string', + 'required' => false, + 'example' => '[\'i-bp1b00g1wdnrvpz68o0b\', \'i-bp1bu2fp0uhruyf88k6v\']', + ], + 'required' => true, + ], + ], + [ + 'name' => 'Overwrite', + 'in' => 'formData', + 'schema' => [ + 'description' => '如果同名文件在目标目录已存在,是否覆盖文件。'."\n" + .'- true:覆盖。'."\n" + .'- false:不覆盖。'."\n" + ."\n" + .'默认值为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => [ + 'description' => '下发文件的超时时间。单位:秒。'."\n" + ."\n" + .'- 当因为进程原因、缺失模块、缺失云助手Agent等原因无法下发文件时,会出现超时现象。'."\n" + .'- 当设置的超时时间小于10秒时,为确保下发成功,系统会将超时时间自动设置为10秒。'."\n" + ."\n" + .'默认值为60。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '600', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '3C683243-7915-57FB-9570-A2932C1C0F78', + ], + 'InvokeId' => [ + 'description' => '命令执行ID。', + 'type' => 'string', + 'example' => 't-hz03la52z1zkvls', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C683243-7915-57FB-9570-A2932C1C0F78\\",\\n \\"InvokeId\\": \\"t-hz03la52z1zkvls\\"\\n}","type":"json"}]', + 'title' => '向一台或多台ECS实例下发远程文件', + ], + 'ListMachineTypes' => [ + 'summary' => '查询用户可用的机型列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '机型名', + 'description' => '机型名', + 'type' => 'string', + 'required' => false, + 'example' => 'efg1.nvga1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F16BA4D8-FF50-53B6-A026-F443FE31006C', + ], + 'NextToken' => [ + 'description' => '下一页的NextToken,请求下一页时带上此返回值', + 'type' => 'string', + 'example' => 'a3f2224a5ec7224116c4f5246120abe4', + ], + 'MachineTypes' => [ + 'description' => '机型详情', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CpuInfo' => [ + 'description' => 'CPU信息', + 'type' => 'string', + 'example' => '2x Intel Icelake 8369B 32C CPU', + ], + 'DiskInfo' => [ + 'description' => '磁盘信息', + 'type' => 'string', + 'example' => '2x 480GB SATA SSD', + ], + 'GpuInfo' => [ + 'description' => 'GPU信息', + 'type' => 'string', + 'example' => '8x NVIDIA SXM4 80GB A100 GPU', + ], + 'MemoryInfo' => [ + 'description' => '存储信息', + 'type' => 'string', + 'example' => '32x 64GB DDR4 3200 Memory', + ], + 'Name' => [ + 'description' => '机型名', + 'type' => 'string', + 'example' => 'efg1.nvga1', + ], + 'NetworkInfo' => [ + 'description' => '网络信息', + 'type' => 'string', + 'example' => '2x 100Gbps DP NIC', + ], + 'NodeCount' => [ + 'description' => '节点数量', + 'type' => 'string', + 'example' => '10', + ], + 'Type' => [ + 'description' => '机型类型', + 'type' => 'string', + 'example' => 'Public', + ], + 'BondNum' => [ + 'description' => 'bond数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalCpuCore' => [ + 'description' => 'CPU核心数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '48', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F16BA4D8-FF50-53B6-A026-F443FE31006C\\",\\n \\"NextToken\\": \\"a3f2224a5ec7224116c4f5246120abe4\\",\\n \\"MachineTypes\\": [\\n {\\n \\"CpuInfo\\": \\"2x Intel Icelake 8369B 32C CPU\\",\\n \\"DiskInfo\\": \\"2x 480GB SATA SSD\\",\\n \\"GpuInfo\\": \\"8x NVIDIA SXM4 80GB A100 GPU\\",\\n \\"MemoryInfo\\": \\"32x 64GB DDR4 3200 Memory\\",\\n \\"Name\\": \\"efg1.nvga1\\",\\n \\"NetworkInfo\\": \\"2x 100Gbps DP NIC\\",\\n \\"NodeCount\\": \\"10\\",\\n \\"Type\\": \\"Public\\",\\n \\"BondNum\\": 2,\\n \\"TotalCpuCore\\": 48\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询机型列表', + ], + 'CreateDiagnosticTask' => [ + 'summary' => '诊断任务创建接口。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188554', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群id', + 'type' => 'string', + 'required' => false, + 'example' => 'i118913031696573280136', + ], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'description' => '节点ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID列表', + 'type' => 'string', + 'required' => false, + 'example' => '[\'mock-sn-200101\']', + ], + 'required' => false, + ], + ], + [ + 'name' => 'DiagnosticType', + 'in' => 'formData', + 'schema' => [ + 'description' => '诊断类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'CheckByAiJobLogs', + ], + ], + [ + 'name' => 'AiJobLogInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '日志信息', + 'type' => 'object', + 'properties' => [ + 'AiJobLogs' => [ + 'description' => '任务日志', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AiInstance' => [ + 'description' => '实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + 'Logs' => [ + 'description' => '日志对象', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Datetime' => [ + 'description' => '发送日期,格式为yyyymmdd。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-05T10:10:01', + ], + 'LogContent' => [ + 'description' => '日志内容', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'NodeId' => [ + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-tw-p2p2al5u1hn', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'EndTime' => [ + 'description' => '结束时间。时间戳格式,单位:秒。'."\n" + .'> 必须为整点分钟。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-05T10:10:01', + ], + 'StartTime' => [ + 'description' => '开始时间。时间戳格式,单位:秒。'."\n" + .'> 必须为整点分钟。', + 'type' => 'string', + 'required' => false, + 'example' => '2024-10-11T00:00:00Z', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'A511C02A-0127-51AA-A9F9-966382C9A1B5', + ], + 'DiagnosticId' => [ + 'description' => '诊断ID', + 'type' => 'string', + 'example' => 'diag-i150553931717380274931', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A511C02A-0127-51AA-A9F9-966382C9A1B5\\",\\n \\"DiagnosticId\\": \\"diag-i150553931717380274931\\"\\n}","type":"json"}]', + 'title' => '诊断任务创建接口', + ], + 'StopNodes' => [ + 'summary' => '节点关机。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '229860', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Nodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '节点列表', + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表信息。', + 'type' => 'string', + 'required' => false, + 'example' => '["e01-dks34dmdfo3","e01-dfjd34nsl4"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'IgnoreFailedNodeTasks', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许跳过失败节点,默认值为Flase', + 'description' => '是否允许跳过失败节点,默认值为Flase。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i155847351716171893489', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"TaskId\\": \\"i155847351716171893489\\"\\n}","type":"json"}]', + 'title' => '节点关机', + ], + 'ListImages' => [ + 'summary' => '查询用户可用的镜像列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '189004', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ImageVersion', + 'in' => 'formData', + 'schema' => [ + 'title' => '镜像版本', + 'description' => '镜像版本', + 'type' => 'string', + 'required' => false, + 'example' => '7.9', + ], + ], + [ + 'name' => 'Architecture', + 'in' => 'formData', + 'schema' => [ + 'title' => '架构', + 'description' => '架构', + 'type' => 'string', + 'required' => false, + 'example' => 'x86_64', + ], + ], + [ + 'name' => 'Platform', + 'in' => 'formData', + 'schema' => [ + 'title' => '平台', + 'description' => '平台', + 'type' => 'string', + 'required' => false, + 'example' => 'ALinux3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '0FC4A1C7-421C-5EAB-9361-4C0338EFA287', + ], + 'NextToken' => [ + 'description' => '下一页的NextToken,请求下一页时带上此返回值', + 'type' => 'string', + 'example' => '3a6b93229825ac667104463b56790c91', + ], + 'Images' => [ + 'description' => '镜像详情', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Architecture' => [ + 'title' => '架构', + 'description' => '架构', + 'type' => 'string', + 'example' => 'x86_64', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'alibaba cloud linux 3 full for H800', + ], + 'ImageId' => [ + 'title' => '镜像id', + 'description' => '镜像id', + 'type' => 'string', + 'example' => 'i190951671671438639388', + ], + 'ImageName' => [ + 'title' => '镜像名', + 'description' => '镜像名', + 'type' => 'string', + 'example' => 'CentOS_7.9_x86_64_FULL_20221110', + ], + 'ImageVersion' => [ + 'title' => '镜像版本', + 'description' => '镜像版本', + 'type' => 'string', + 'example' => '7.9', + ], + 'Platform' => [ + 'title' => '平台', + 'description' => '平台', + 'type' => 'string', + 'example' => 'ALinux3', + ], + 'ReleaseFileMd5' => [ + 'title' => '文件MD5', + 'description' => '文件MD5', + 'type' => 'string', + 'example' => '40741292480fc6d778138adcf8c', + ], + 'Type' => [ + 'title' => '镜像类型', + 'description' => '镜像类型', + 'type' => 'string', + 'example' => 'Public', + ], + 'NodeCount' => [ + 'title' => '节点数量', + 'description' => '节点数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ReleaseFileSize' => [ + 'description' => '镜像大小', + 'type' => 'string', + 'example' => '5.8G', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0FC4A1C7-421C-5EAB-9361-4C0338EFA287\\",\\n \\"NextToken\\": \\"3a6b93229825ac667104463b56790c91\\",\\n \\"Images\\": [\\n {\\n \\"Architecture\\": \\"x86_64\\",\\n \\"Description\\": \\"alibaba cloud linux 3 full for H800\\",\\n \\"ImageId\\": \\"i190951671671438639388\\",\\n \\"ImageName\\": \\"CentOS_7.9_x86_64_FULL_20221110\\",\\n \\"ImageVersion\\": \\"7.9\\",\\n \\"Platform\\": \\"ALinux3\\",\\n \\"ReleaseFileMd5\\": \\"40741292480fc6d778138adcf8c\\",\\n \\"Type\\": \\"Public\\",\\n \\"NodeCount\\": 20,\\n \\"ReleaseFileSize\\": \\"5.8G\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询镜像列表', + ], + 'DescribeDiagnosticResult' => [ + 'summary' => '诊断任务查询接口。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188556', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DiagnosticId', + 'in' => 'formData', + 'schema' => [ + 'description' => '诊断ID', + 'type' => 'string', + 'required' => false, + 'example' => 'diag-i151942361720577788844', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '8F065DDD-6996-5973-9691-9EC57BD0072E', + ], + 'DiagnosticId' => [ + 'description' => '诊断ID', + 'type' => 'string', + 'example' => 'diag-i155363241720059671316', + ], + 'NodeIds' => [ + 'description' => '节点ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID列表', + 'type' => 'string', + 'example' => '[\'mock-sn-200101\']', + ], + ], + 'ClusterId' => [ + 'description' => '集群id', + 'type' => 'string', + 'example' => 'i118913031696573280136', + ], + 'DiagnosticType' => [ + 'description' => '诊断类型。', + 'type' => 'string', + 'example' => 'CheckByAiJobLogs', + ], + 'DiagnosticState' => [ + 'description' => '诊断状态', + 'type' => 'string', + 'example' => 'Fault', + ], + 'DiagnosticResults' => [ + 'description' => '诊断信息', + 'type' => 'array', + 'items' => [ + 'description' => '诊断信息', + 'type' => 'any', + 'example' => '[]', + ], + ], + 'CreatedTime' => [ + 'description' => '设备创建时间。', + 'type' => 'string', + 'example' => '2024-06-15T10:17:56', + ], + 'EndTime' => [ + 'description' => '节点异常问题结束时间。按照 ISO8601 标准表示,带时区的时间格式,格式为 yyyy-MM-ddTHH:mm:ss+0800', + 'type' => 'string', + 'example' => '2024-06-11T10:00:30', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F065DDD-6996-5973-9691-9EC57BD0072E\\",\\n \\"DiagnosticId\\": \\"diag-i155363241720059671316\\",\\n \\"NodeIds\\": [\\n \\"[\'mock-sn-200101\']\\"\\n ],\\n \\"ClusterId\\": \\"i118913031696573280136\\",\\n \\"DiagnosticType\\": \\"CheckByAiJobLogs\\",\\n \\"DiagnosticState\\": \\"Fault\\",\\n \\"DiagnosticResults\\": [\\n \\"[]\\"\\n ],\\n \\"CreatedTime\\": \\"2024-06-15T10:17:56\\",\\n \\"EndTime\\": \\"2024-06-11T10:00:30\\"\\n}","type":"json"}]', + 'title' => '查询诊断任务结果', + ], + 'CloseSession' => [ + 'summary' => '关闭terminal时,汇报连接断开。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220506', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SessionToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '会话凭证', + 'type' => 'string', + 'required' => false, + 'example' => '03f53c719015a9ad4f4f55d66cac2dac161b18e8065ca75a3220b89de389c980', + ], + ], + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '会话ID', + 'type' => 'string', + 'required' => false, + 'example' => 'i207023871669364793713', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '07AA3A1F-321E-50D8-B834-88C411331C94', + ], + 'SessionId' => [ + 'description' => '会话ID。'."\n", + 'type' => 'string', + 'example' => 'i206495551737511455528', + ], + 'State' => [ + 'description' => 'ClosingActive', + 'type' => 'string', + 'example' => 'Inactive', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"07AA3A1F-321E-50D8-B834-88C411331C94\\",\\n \\"SessionId\\": \\"i206495551737511455528\\",\\n \\"State\\": \\"Inactive\\"\\n}","type":"json"}]', + 'title' => '断开链接', + 'description' => '关闭远程会话的接口。', + ], + 'CreateSession' => [ + 'summary' => '创建Web Terminal会话。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220468', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-kvw44e6****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '发起时间,13位时间戳。', + 'type' => 'string', + 'required' => false, + 'example' => '1669340937156', + ], + ], + [ + 'name' => 'SessionType', + 'in' => 'formData', + 'schema' => [ + 'description' => '会话包对应的会话类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'N 两种:'."\n" + .'Sol:基于串口[默认]'."\n" + .'Assistant:基于云助手', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '887FA855-89F4-5DB3-B305-C5879EC480E6', + ], + 'WssEndpoint' => [ + 'description' => 'WebSocket地址。', + 'type' => 'string', + 'example' => 'ws://x.x.x.x:xx/calypso_web_console', + ], + 'SessionId' => [ + 'description' => '会话ID。', + 'type' => 'string', + 'example' => 'i20702387166936479****', + ], + 'SessionToken' => [ + 'description' => '会话凭证。', + 'type' => 'string', + 'example' => '03f53c719015a9ad4f4f55d66cac2dac161b18e8065ca75a3220b89de389****', + ], + 'ServerSn' => [ + 'description' => '节点 ID。', + 'type' => 'string', + 'example' => '2A591****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"887FA855-89F4-5DB3-B305-C5879EC480E6\\",\\n \\"WssEndpoint\\": \\"ws://x.x.x.x:xx/calypso_web_console\\",\\n \\"SessionId\\": \\"i20702387166936479****\\",\\n \\"SessionToken\\": \\"03f53c719015a9ad4f4f55d66cac2dac161b18e8065ca75a3220b89de389****\\",\\n \\"ServerSn\\": \\"2A591****\\"\\n}","type":"json"}]', + 'title' => '创建会话', + 'description' => '创建会话的接口,返回前端EndPoint,并且起一个周期任务跟踪会话状态', + ], + 'CreateNetTestTask' => [ + 'summary' => '创建网络测试任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220480', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NetTestType', + 'in' => 'formData', + 'schema' => [ + 'description' => '网络测试类型。'."\n" + .'例如:时延测试DelayTest、流量测试TrafficTest、通信库测试CommTest。', + 'type' => 'string', + 'required' => false, + 'example' => 'DelayTest', + ], + ], + [ + 'name' => 'Port', + 'in' => 'formData', + 'schema' => [ + 'description' => '测试端口号。', + 'type' => 'string', + 'required' => false, + 'example' => '23604', + ], + ], + [ + 'name' => 'TrafficTest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '如果流量模型TrafficModel为Fullmesh时,此字段为空。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => '网络协议,分为RDMA或者TCP。', + 'type' => 'string', + 'required' => false, + 'example' => 'TCP', + ], + 'TrafficModel' => [ + 'description' => '流量模型,分为MTON或者Fullmesh。', + 'type' => 'string', + 'required' => false, + 'example' => 'Fullmesh', + ], + 'Duration' => [ + 'description' => '工作流任务的运行时长,单位为秒。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'QP' => [ + 'description' => '协议为TCP时填写测试并发连接数,协议为RDMA时,填写配置QP值。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'GDR' => [ + 'description' => '协议为RDMA时,填写True/False,'."\n" + .'协议为TCP时,此字段为空。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + 'Clients' => [ + 'description' => '资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源id', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-20s41p6cx01', + ], + 'Bond' => [ + 'description' => '网卡bond口', + 'type' => 'string', + 'required' => false, + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => '节点IP', + 'type' => 'string', + 'required' => false, + 'example' => '192.168.1.1', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'xMv', + ], + 'NodeId' => [ + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-tw-w5elqg7pw18', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Servers' => [ + 'description' => '服务列表', + 'type' => 'array', + 'items' => [ + 'description' => '服务列表', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源id', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-wwo3etaqu0b', + ], + 'Bond' => [ + 'description' => '网卡bond口', + 'type' => 'string', + 'required' => false, + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => '节点IP', + 'type' => 'string', + 'required' => false, + 'example' => '47.121.110.190', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'xMv', + ], + 'NodeId' => [ + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-tw-bqisacl3z6l', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'DelayTest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '网络测试类型为时延测试时填写', + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => '输入测试节点的hosts', + 'type' => 'array', + 'items' => [ + 'description' => '输入测试节点的hosts', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源id', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-bcd3u1aee06', + ], + 'Bond' => [ + 'description' => '网卡bond口', + 'type' => 'string', + 'required' => false, + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => '节点IP', + 'type' => 'string', + 'required' => false, + 'example' => '125.210.225.48', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'NQU', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-fou43an0a05', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CommTest', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '流量测试类型为通信库测试时需要填写', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '通信库测试类别:ACCL或NCCL', + 'type' => 'string', + 'required' => false, + 'example' => 'ACCL', + ], + 'Model' => [ + 'description' => '通信库模型', + 'type' => 'string', + 'required' => false, + 'example' => 'intention_v4', + ], + 'GPUNum' => [ + 'description' => 'GPU数量', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'Hosts' => [ + 'description' => '资源id', + 'type' => 'array', + 'items' => [ + 'description' => '资源id', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源id', + 'type' => 'string', + 'required' => false, + 'example' => 'i111670831721110797708', + ], + 'IP' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '169.253.253.15', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'VBw', + ], + 'NodeId' => [ + 'description' => '节点ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-tw-bqisacl3z6l', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群 id', + 'type' => 'string', + 'required' => false, + 'example' => 'i119982311660892626523', + ], + ], + [ + 'name' => 'NetworkMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '网络模式', + 'type' => 'string', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群名称', + 'type' => 'string', + 'required' => false, + 'example' => 'Eflo-YJ-Test-Cluster', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE*****', + ], + 'TestId' => [ + 'description' => '启动测试任务ID,网络测试任务的唯一标志。', + 'type' => 'string', + 'example' => 'dr-uf6i0tv2refv8wz*****', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE*****\\",\\n \\"TestId\\": \\"dr-uf6i0tv2refv8wz*****\\"\\n}","type":"json"}]', + 'title' => '创建网络测试任务', + ], + 'ListUserClusterTypes' => [ + 'summary' => '查询用户可以使用的集群类型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220490', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'NextToken' => [ + 'description' => '下一页的NextToken,请求下一页时带上此返回值', + 'type' => 'string', + 'example' => '3a6b93229825ac667104463b56790c91', + ], + 'ClusterTypes' => [ + 'description' => '集群类型列表。数组元素个数N的取值范围:1~100。', + 'type' => 'array', + 'items' => [ + 'description' => '集群类型列表。数组元素个数N的取值范围:1~100。', + 'type' => 'object', + 'properties' => [ + 'TypeName' => [ + 'description' => '类型名称', + 'type' => 'string', + 'example' => 'AckEdgePro', + ], + 'AccessType' => [ + 'description' => '访问类型。', + 'type' => 'string', + 'example' => 'Public', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"NextToken\\": \\"3a6b93229825ac667104463b56790c91\\",\\n \\"ClusterTypes\\": [\\n {\\n \\"TypeName\\": \\"AckEdgePro\\",\\n \\"AccessType\\": \\"Public\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询用户可以使用的集群类型', + ], + 'ListNetTestResults' => [ + 'summary' => '网络测试列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220488', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。', + 'description' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。', + 'type' => 'string', + 'required' => false, + 'example' => '3a6b93229825ac667104463b5679****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'- 当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'- 当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NetTestType', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组id', + 'description' => '网络测试类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'DelayTest', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxno4vh5****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '3C683243-7915-57FB-9570-A2932C1C0F78', + ], + 'NetTestResults' => [ + 'title' => '节点列表', + 'description' => '节点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表。', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'title' => '', + 'description' => '测试端口号。', + 'type' => 'string', + 'example' => '80', + ], + 'NetTestType' => [ + 'title' => '', + 'description' => '网络测试类型。'."\n", + 'type' => 'string', + 'example' => 'NetDiag', + ], + 'TestId' => [ + 'title' => '', + 'description' => '测试ID。资源测试任务的唯一标志。', + 'type' => 'string', + 'example' => 'String i-uf6i0tv2refv8wz*****', + ], + 'Status' => [ + 'title' => '', + 'description' => '网络测试任务状态。取值范围:</br>'."\n" + .'● InProgress:测试中。</br>'."\n" + .'● Finished:测试完成。</br>'."\n" + .'● Failed:测试失败。', + 'type' => 'string', + 'example' => 'InProgress', + ], + 'CreationTime' => [ + 'title' => '', + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2024-01-19T02:18:12Z', + ], + 'FinishedTime' => [ + 'title' => '', + 'description' => '完成时间。', + 'type' => 'string', + 'example' => '2024-10-30T02:07Z', + ], + 'TrafficTest' => [ + 'description' => '网络测试类型为流量测试时填写。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => '网络协议,分为RDMA或者TCP。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'TrafficModel' => [ + 'description' => '流量模型,分为MTON或者Fullmesh。', + 'type' => 'string', + 'example' => 'Fullmesh', + ], + 'Duration' => [ + 'description' => '工作流任务的运行时长,单位为秒。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'QP' => [ + 'description' => '协议为TCP时填写测试并发连接数,协议为RDMA时,填写配置QP值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'RDMA', + ], + 'GDR' => [ + 'description' => '协议为RDMA时,填写True/False,'."\n" + .'协议为TCP时,此字段为空。', + 'type' => 'string', + 'example' => 'True', + ], + 'Clients' => [ + 'description' => '客户端。', + 'type' => 'array', + 'items' => [ + 'description' => '客户端。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'e01-cn-20p36bqet39', + ], + 'Bond' => [ + 'description' => '网卡bond口。', + 'type' => 'string', + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '74.73.100.1', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'prod-gf-cn.juequling.com', + ], + ], + ], + ], + 'Servers' => [ + 'description' => '如果流量模型TrafficModel为Fullmesh时,此字段为空。', + 'type' => 'array', + 'items' => [ + 'description' => '如果流量模型TrafficModel为Fullmesh时,此字段为空。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'e01-cn-wwo3ete****', + ], + 'Bond' => [ + 'description' => '网卡bond口。', + 'type' => 'string', + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => '节点IP。', + 'type' => 'string', + 'example' => '10.1.168.183', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'prod-gf-cn.juequling.com', + ], + ], + ], + ], + ], + ], + 'DelayTest' => [ + 'description' => '网络测试类型为时延测试时填写。', + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => '资源列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源列表。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'e01-cn-wwo3ete****', + ], + 'Bond' => [ + 'description' => '网卡bond口。', + 'type' => 'string', + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => '节点IP。', + 'type' => 'string', + 'example' => 'pgm-bp174z988a27wre71o.pg.rds.aliyuncs.com', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'WrF', + ], + ], + ], + ], + ], + ], + 'CommTest' => [ + 'description' => '流量测试类型为通信库测试时需要填写。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '通信库测试类别:ACCL或NCCL。', + 'type' => 'string', + 'example' => 'ACCL', + ], + 'Model' => [ + 'description' => '通信库模型。', + 'type' => 'string', + 'example' => 'AllToAll', + ], + 'GPUNum' => [ + 'description' => 'GPU数量。', + 'type' => 'string', + 'example' => '4', + ], + 'Hosts' => [ + 'description' => '输入测试节点的hosts。', + 'type' => 'array', + 'items' => [ + 'description' => '输入测试节点的hosts。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'e01-cn-wwo3ete****', + ], + 'IP' => [ + 'description' => '节点IP。', + 'type' => 'string', + 'example' => '10.51.16.21', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'www.xinjiaoyu.com', + ], + ], + ], + ], + ], + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'i11066721171826501****', + ], + 'NetworkMode' => [ + 'description' => '网络模式。', + 'type' => 'string', + 'example' => '01', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '下一页的NextToken,请求下一页时带上此返回值', + 'description' => '下一页的NextToken,请求下一页时带上此返回值。', + 'type' => 'string', + 'example' => '3a6b93229825ac667104463b5679****', + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'- 当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'- 当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C683243-7915-57FB-9570-A2932C1C0F78\\",\\n \\"NetTestResults\\": [\\n {\\n \\"Port\\": \\"80\\",\\n \\"NetTestType\\": \\"NetDiag\\",\\n \\"TestId\\": \\"String\\\\ti-uf6i0tv2refv8wz*****\\",\\n \\"Status\\": \\"InProgress\\",\\n \\"CreationTime\\": \\"2024-01-19T02:18:12Z\\",\\n \\"FinishedTime\\": \\"2024-10-30T02:07Z\\",\\n \\"TrafficTest\\": {\\n \\"Protocol\\": \\"TCP\\",\\n \\"TrafficModel\\": \\"Fullmesh\\",\\n \\"Duration\\": 1,\\n \\"QP\\": 0,\\n \\"GDR\\": \\"True\\",\\n \\"Clients\\": [\\n {\\n \\"ResourceId\\": \\"e01-cn-20p36bqet39\\",\\n \\"Bond\\": \\"bond1\\",\\n \\"IP\\": \\"74.73.100.1\\",\\n \\"ServerName\\": \\"prod-gf-cn.juequling.com\\"\\n }\\n ],\\n \\"Servers\\": [\\n {\\n \\"ResourceId\\": \\"e01-cn-wwo3ete****\\",\\n \\"Bond\\": \\"bond1\\",\\n \\"IP\\": \\"10.1.168.183\\",\\n \\"ServerName\\": \\"prod-gf-cn.juequling.com\\"\\n }\\n ]\\n },\\n \\"DelayTest\\": {\\n \\"Hosts\\": [\\n {\\n \\"ResourceId\\": \\"e01-cn-wwo3ete****\\",\\n \\"Bond\\": \\"bond1\\",\\n \\"IP\\": \\"pgm-bp174z988a27wre71o.pg.rds.aliyuncs.com\\",\\n \\"ServerName\\": \\"WrF\\"\\n }\\n ]\\n },\\n \\"CommTest\\": {\\n \\"Type\\": \\"ACCL\\",\\n \\"Model\\": \\"AllToAll\\",\\n \\"GPUNum\\": \\"4\\",\\n \\"Hosts\\": [\\n {\\n \\"ResourceId\\": \\"e01-cn-wwo3ete****\\",\\n \\"IP\\": \\"10.51.16.21\\",\\n \\"ServerName\\": \\"www.xinjiaoyu.com\\"\\n }\\n ]\\n },\\n \\"ClusterId\\": \\"i11066721171826501****\\",\\n \\"NetworkMode\\": \\"01\\",\\n \\"ClusterName\\": \\"test\\"\\n }\\n ],\\n \\"NextToken\\": \\"3a6b93229825ac667104463b5679****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '网络列表', + ], + 'ListDiagnosticResults' => [ + 'summary' => '诊断任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220474', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。', + 'description' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。', + 'type' => 'string', + 'required' => false, + 'example' => 'a3f2224a5ec7224116c4f5246120****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'- 当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'- 当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'DiagType', + 'in' => 'formData', + 'schema' => [ + 'title' => '诊断类型', + 'description' => '诊断类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'NetDiag', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmywpvugk****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'AC4F0004-7BCE-52E0-891B-CAC7D64E3368', + ], + 'DiagnosticResults' => [ + 'title' => '', + 'description' => '诊断信息。', + 'type' => 'array', + 'items' => [ + 'description' => '诊断信息。', + 'type' => 'object', + 'properties' => [ + 'DiagContent' => [ + 'title' => '', + 'description' => '诊断内容。例如网络诊断类型中,存在静态配置类检查、动态运行类检查等诊断内容。', + 'type' => 'string', + 'example' => '测试诊断信息', + ], + 'ResourceId' => [ + 'title' => '', + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'e01-cn-bl03ofg6****', + ], + 'ClusterId' => [ + 'title' => '', + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'i11857814169474524****', + ], + 'DiagId' => [ + 'title' => '', + 'description' => '诊断ID。', + 'type' => 'string', + 'example' => '123', + ], + 'Status' => [ + 'title' => '', + 'description' => '治理状态。', + 'type' => 'string', + 'example' => 'succeed', + ], + 'CreationTime' => [ + 'title' => '', + 'description' => '诊断任务创建时间。', + 'type' => 'string', + 'example' => '2024-01-15T02:01:12Z', + ], + 'FinishedTime' => [ + 'title' => '', + 'description' => '诊断任务完成时间。', + 'type' => 'string', + 'example' => '2024-10-16T02:04Z', + ], + 'DiagResult' => [ + 'title' => '', + 'description' => '诊断结果,成功或者失败。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'proxy-rps.mos.csvw.com', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'pjlab-lingjun', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '下一页的NextToken,请求下一页时带上此返回值', + 'description' => '下一页的NextToken,请求下一页时带上此返回值。', + 'type' => 'string', + 'example' => 'a3f2224a5ec7224116c4f5246120****', + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'- 当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'- 当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AC4F0004-7BCE-52E0-891B-CAC7D64E3368\\",\\n \\"DiagnosticResults\\": [\\n {\\n \\"DiagContent\\": \\"测试诊断信息\\",\\n \\"ResourceId\\": \\"e01-cn-bl03ofg6****\\",\\n \\"ClusterId\\": \\"i11857814169474524****\\",\\n \\"DiagId\\": \\"123\\",\\n \\"Status\\": \\"succeed\\",\\n \\"CreationTime\\": \\"2024-01-15T02:01:12Z\\",\\n \\"FinishedTime\\": \\"2024-10-16T02:04Z\\",\\n \\"DiagResult\\": \\"Success\\",\\n \\"ServerName\\": \\"proxy-rps.mos.csvw.com\\",\\n \\"ClusterName\\": \\"pjlab-lingjun\\"\\n }\\n ],\\n \\"NextToken\\": \\"a3f2224a5ec7224116c4f5246120****\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '诊断任务列表', + ], + 'DescribeNetTestResult' => [ + 'summary' => '查询网络测试结果。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220510', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TestId', + 'in' => 'formData', + 'schema' => [ + 'description' => '测试任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'dr-uf6i0tv2refv8wz*****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '8F065DDD-6996-5973-9691-9EC57BD0072E', + ], + 'NetTestType' => [ + 'title' => '', + 'description' => '网络测试类型。', + 'type' => 'string', + 'example' => 'DelayTest', + ], + 'Port' => [ + 'title' => '', + 'description' => '测试端口号。', + 'type' => 'string', + 'example' => '23604', + ], + 'TestId' => [ + 'title' => '', + 'description' => '启动测试任务ID,网络测试任务的唯一标志。', + 'type' => 'string', + 'example' => 'af35ce53-7c35-4277-834a-fbf49c316a96', + ], + 'Status' => [ + 'title' => '', + 'description' => '诊断任务状态。取值范围:'."\n" + .'- InProgress:诊断中。'."\n" + .'- Finished:诊断完成。'."\n" + .'- Failed:诊断失败。', + 'type' => 'string', + 'example' => 'Failed', + ], + 'CreationTime' => [ + 'title' => '', + 'description' => '诊断任务创建时间。', + 'type' => 'string', + 'example' => '2024-10-15T10:25:42+08:00', + ], + 'FinishedTime' => [ + 'title' => '', + 'description' => '诊断任务完成时间。', + 'type' => 'string', + 'example' => '2024-10-16T02:04Z', + ], + 'ResultDetial' => [ + 'description' => '诊断结果详情。以json字符串返回。', + 'type' => 'string', + 'example' => '{}', + ], + 'TrafficTest' => [ + 'description' => '如果流量模型TrafficModel为Fullmesh时,此字段为空。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => '网络协议,分为RDMA或者TCP。', + 'type' => 'string', + 'example' => 'TCP', + ], + 'TrafficModel' => [ + 'description' => '流量模型,分为MTON或者Fullmesh。', + 'type' => 'string', + 'example' => 'Fullmesh', + ], + 'Duration' => [ + 'description' => '工作流任务的运行时长,单位为秒。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'QP' => [ + 'description' => '协议为TCP时填写测试并发连接数,协议为RDMA时,填写配置QP值。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GDR' => [ + 'description' => '协议为RDMA时,填写True/False,'."\n" + .'协议为TCP时,此字段为空。', + 'type' => 'string', + 'example' => 'False', + ], + 'Clients' => [ + 'description' => '资源ID。', + 'type' => 'array', + 'items' => [ + 'description' => '资源ID。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源id', + 'type' => 'string', + 'example' => 'e01-cn-20s41p6cx01', + ], + 'Bond' => [ + 'description' => '网卡bond口', + 'type' => 'string', + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => '节点IP', + 'type' => 'string', + 'example' => '192.168.1.1', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'xMv', + ], + ], + ], + ], + 'Servers' => [ + 'description' => '服务列表', + 'type' => 'array', + 'items' => [ + 'description' => '服务列表', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源id', + 'type' => 'string', + 'example' => 'e01-cn-wwo3etaqu0b', + ], + 'Bond' => [ + 'description' => '网卡bond口', + 'type' => 'string', + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => '节点IP', + 'type' => 'string', + 'example' => '47.121.110.190', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'xMv', + ], + ], + ], + ], + ], + ], + 'DelayTest' => [ + 'description' => '网络测试类型为时延测试时填写', + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => '输入测试节点的hosts', + 'type' => 'array', + 'items' => [ + 'description' => '输入测试节点的hosts', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源id', + 'type' => 'string', + 'example' => 'e01-cn-bcd3u1aee06', + ], + 'Bond' => [ + 'description' => '网卡bond口', + 'type' => 'string', + 'example' => 'bond1', + ], + 'IP' => [ + 'description' => '节点IP', + 'type' => 'string', + 'example' => '125.210.225.48', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'NQU', + ], + ], + ], + ], + ], + ], + 'CommTest' => [ + 'description' => '流量测试类型为通信库测试时需要填写', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '通信库测试类别:ACCL或NCCL', + 'type' => 'string', + 'example' => 'ACCL', + ], + 'Model' => [ + 'description' => '通信库模型', + 'type' => 'string', + 'example' => 'intention_v4', + ], + 'GPUNum' => [ + 'description' => 'GPU数量', + 'type' => 'string', + 'example' => '1', + ], + 'Hosts' => [ + 'description' => '资源id', + 'type' => 'array', + 'items' => [ + 'description' => '资源id', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源id', + 'type' => 'string', + 'example' => 'i111670831721110797708', + ], + 'IP' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '169.253.253.15', + ], + 'ServerName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'VBw', + ], + ], + ], + ], + ], + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'i119982311660892626523', + ], + 'ClusterName' => [ + 'description' => '集群名称', + 'type' => 'string', + 'example' => 'Standard_Cluster', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8F065DDD-6996-5973-9691-9EC57BD0072E\\",\\n \\"NetTestType\\": \\"DelayTest\\",\\n \\"Port\\": \\"23604\\",\\n \\"TestId\\": \\"af35ce53-7c35-4277-834a-fbf49c316a96\\",\\n \\"Status\\": \\"Failed\\",\\n \\"CreationTime\\": \\"2024-10-15T10:25:42+08:00\\",\\n \\"FinishedTime\\": \\"2024-10-16T02:04Z\\",\\n \\"ResultDetial\\": \\"{}\\",\\n \\"TrafficTest\\": {\\n \\"Protocol\\": \\"TCP\\",\\n \\"TrafficModel\\": \\"Fullmesh\\",\\n \\"Duration\\": 1,\\n \\"QP\\": 1,\\n \\"GDR\\": \\"False\\",\\n \\"Clients\\": [\\n {\\n \\"ResourceId\\": \\"e01-cn-20s41p6cx01\\",\\n \\"Bond\\": \\"bond1\\",\\n \\"IP\\": \\"192.168.1.1\\",\\n \\"ServerName\\": \\"xMv\\"\\n }\\n ],\\n \\"Servers\\": [\\n {\\n \\"ResourceId\\": \\"e01-cn-wwo3etaqu0b\\",\\n \\"Bond\\": \\"bond1\\",\\n \\"IP\\": \\"47.121.110.190\\",\\n \\"ServerName\\": \\"xMv\\"\\n }\\n ]\\n },\\n \\"DelayTest\\": {\\n \\"Hosts\\": [\\n {\\n \\"ResourceId\\": \\"e01-cn-bcd3u1aee06\\",\\n \\"Bond\\": \\"bond1\\",\\n \\"IP\\": \\"125.210.225.48\\",\\n \\"ServerName\\": \\"NQU\\"\\n }\\n ]\\n },\\n \\"CommTest\\": {\\n \\"Type\\": \\"ACCL\\",\\n \\"Model\\": \\"intention_v4\\",\\n \\"GPUNum\\": \\"1\\",\\n \\"Hosts\\": [\\n {\\n \\"ResourceId\\": \\"i111670831721110797708\\",\\n \\"IP\\": \\"169.253.253.15\\",\\n \\"ServerName\\": \\"VBw\\"\\n }\\n ]\\n },\\n \\"ClusterId\\": \\"i119982311660892626523\\",\\n \\"ClusterName\\": \\"Standard_Cluster\\"\\n}","type":"json"}]', + 'title' => '查询网络测试结果', + ], + 'ListMachineNetworkInfo' => [ + 'summary' => '使用 HPNZone 和机型查询机型网络配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248670', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterTOL3OM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MachineHpnInfo', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '数组', + 'type' => 'array', + 'items' => [ + 'description' => '对象', + 'type' => 'object', + 'properties' => [ + 'HpnZone' => [ + 'description' => '集群编号', + 'type' => 'string', + 'required' => false, + 'example' => 'C1', + ], + 'MachineType' => [ + 'description' => '机型', + 'type' => 'string', + 'required' => false, + 'example' => 'efg2.C48cNHmcn', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-heyuan', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '对象', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'MachineNetworkInfo' => [ + 'description' => '数组', + 'type' => 'array', + 'items' => [ + 'description' => '对象', + 'type' => 'object', + 'properties' => [ + 'ClusterNet' => [ + 'description' => '集群网络', + 'type' => 'string', + 'example' => 'vpc/acl', + ], + 'EnableJumboFrame' => [ + 'description' => '是否启用jumbo帧能力', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HpnZone' => [ + 'description' => '集群编号', + 'type' => 'string', + 'example' => 'B1', + ], + 'IsDpuMode' => [ + 'description' => '是否为dpu', + 'type' => 'boolean', + 'example' => 'true', + ], + 'MachineType' => [ + 'description' => '机型', + 'type' => 'string', + 'example' => 'efg1.nvga8n', + ], + 'NetArch' => [ + 'description' => '网络架构', + 'type' => 'string', + 'example' => 'XX-7.0', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"MachineNetworkInfo\\": [\\n {\\n \\"ClusterNet\\": \\"vpc/acl\\",\\n \\"EnableJumboFrame\\": true,\\n \\"HpnZone\\": \\"B1\\",\\n \\"IsDpuMode\\": true,\\n \\"MachineType\\": \\"efg1.nvga8n\\",\\n \\"NetArch\\": \\"XX-7.0\\",\\n \\"RegionId\\": \\"cn-heyuan\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '机型网络配置查询', + ], + 'DescribeNodeType' => [ + 'summary' => '创建Web Terminal会话。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '220468', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NodeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点扩容的模式', + 'description' => '节点扩容的模式', + 'type' => 'string', + 'required' => false, + 'example' => 'standard', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求id', + 'type' => 'string', + 'example' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'EniQuantity' => [ + 'title' => '支持的弹性网卡数量上限(主 + 辅助)', + 'description' => '支持的弹性网卡数量上限(主 + 辅助)', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '22', + ], + 'EniHighDenseQuantity' => [ + 'title' => '高密模式网卡数量上限', + 'description' => '高密模式网卡数量上限', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '63', + ], + 'EniPrivateIpAddressQuantity' => [ + 'title' => '网卡支持的 IPV4 上限', + 'description' => '网卡支持的 IPV4 上限', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '256', + ], + 'EniIpv6AddressQuantity' => [ + 'title' => '网卡支持的 IPV6 上限', + 'description' => '网卡支持的 IPV6 上限', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '256', + ], + 'DiskQuantity' => [ + 'description' => '支持挂载的云盘数量上限。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '17', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"EniQuantity\\": 22,\\n \\"EniHighDenseQuantity\\": 63,\\n \\"EniPrivateIpAddressQuantity\\": 256,\\n \\"EniIpv6AddressQuantity\\": 256,\\n \\"DiskQuantity\\": 17\\n}","type":"json"}]', + 'title' => '查询节点类型详情', + ], + 'ListSyslogs' => [ + 'summary' => '查询系统日志。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185830', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ToTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '截止时间', + 'description' => '截止时间', + 'type' => 'string', + 'required' => true, + 'example' => '1665369329', + ], + ], + [ + 'name' => 'Query', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询条件', + 'description' => '查询条件', + 'type' => 'string', + 'required' => false, + 'example' => '*', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否时间倒序查找', + 'description' => '是否时间倒序查找', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '下一页的token,获取下一页数据时需要带上', + 'description' => '下一页的token,获取下一页数据时需要带上', + 'type' => 'string', + 'required' => false, + 'example' => '392e8b4a03ed171433cc39f5b464ec9d', + ], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点id', + 'description' => '节点id', + 'type' => 'string', + 'required' => true, + 'example' => 'e01-cn-nwy37atbj44', + ], + ], + [ + 'name' => 'FromTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间', + 'description' => '开始时间', + 'type' => 'string', + 'required' => true, + 'example' => '1659745800', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1', + ], + 'NextToken' => [ + 'title' => '下一页的NextToken,请求下一页时带上此返回值', + 'description' => '下一页的NextToken,请求下一页时带上此返回值', + 'type' => 'string', + 'example' => '563d42ae0b17572449ec8c97f7f66069', + ], + 'Logs' => [ + 'description' => '返回日志分页列表对象', + 'type' => 'array', + 'items' => [ + 'description' => '日志对象', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'example' => 'i119583961673208491760', + ], + 'Domain' => [ + 'title' => '客户端安全域', + 'description' => '客户端安全域', + 'type' => 'string', + 'example' => 'ALIYUN_PUBLIC', + ], + 'Facility' => [ + 'title' => 'linux syslog标准字段', + 'description' => 'linux syslog标准字段', + 'type' => 'string', + 'example' => 'kern', + ], + 'Hostname' => [ + 'title' => '客户端主机名', + 'description' => '客户端主机名', + 'type' => 'string', + 'example' => 'damo-m53kr8kd-0008', + ], + 'Ip' => [ + 'title' => '客户端ip', + 'description' => '客户端ip', + 'type' => 'string', + 'example' => '114.55.254.44', + ], + 'Msg' => [ + 'title' => 'syslog内容', + 'description' => 'syslog内容', + 'type' => 'string', + 'example' => 'bond4: failed to get link speed/duplex for eth8', + ], + 'NodeId' => [ + 'title' => '节点id', + 'description' => '节点id', + 'type' => 'string', + 'example' => 'e01-cn-9lb36u4s601', + ], + 'Severity' => [ + 'title' => 'linux syslog标准字段', + 'description' => 'linux syslog标准字段', + 'type' => 'string', + 'example' => 'warning', + ], + 'Sn' => [ + 'title' => '机器唯一标识', + 'description' => '机器唯一标识', + 'type' => 'string', + 'example' => '21A401332', + ], + 'Source' => [ + 'title' => 'syslog服务器的hostname', + 'description' => 'syslog服务器的hostname', + 'type' => 'string', + 'example' => 'damo-m53kr8kd-0008'."\n", + ], + 'Syslogtag' => [ + 'title' => 'linux syslog标准字段', + 'description' => 'linux syslog标准字段', + 'type' => 'string', + 'example' => 'kernel', + ], + 'TagHostname' => [ + 'title' => '标签:主机名', + 'description' => '标签:主机名', + 'type' => 'string', + 'example' => 'damo-m53kr8kd-0008'."\n", + ], + 'TagPackId' => [ + 'title' => '标签:包Id', + 'description' => '标签:包Id', + 'type' => 'string', + 'example' => 'D990314D3C25D7E8-1080', + ], + 'TagPath' => [ + 'title' => '标签:路径', + 'description' => '标签:路径', + 'type' => 'string', + 'example' => '/var/log/kern', + ], + 'TagReceiveTime' => [ + 'title' => '标签:接收时间', + 'description' => '标签:接收时间', + 'type' => 'string', + 'example' => '1687363348', + ], + 'TagUserDefinedId' => [ + 'title' => '标签:用户自定义id', + 'description' => '标签:用户自定义id', + 'type' => 'string', + 'example' => 'application_b', + ], + 'Time' => [ + 'title' => 'unix时间格式', + 'description' => 'unix时间格式', + 'type' => 'string', + 'example' => '1687363346', + ], + 'Topic' => [ + 'title' => '主题 logserver或者log2sls (注:两者均为syslog服务器,logserver采用tcp收集,log2sls采用udp)', + 'description' => '主题 logserver或者log2sls (注:两者均为syslog服务器,logserver采用tcp收集,log2sls采用udp)', + 'type' => 'string', + 'example' => 'logserver', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1\\",\\n \\"NextToken\\": \\"563d42ae0b17572449ec8c97f7f66069\\",\\n \\"Logs\\": [\\n {\\n \\"ClusterId\\": \\"i119583961673208491760\\",\\n \\"Domain\\": \\"ALIYUN_PUBLIC\\",\\n \\"Facility\\": \\"kern\\",\\n \\"Hostname\\": \\"damo-m53kr8kd-0008\\",\\n \\"Ip\\": \\"114.55.254.44\\",\\n \\"Msg\\": \\"bond4: failed to get link speed/duplex for eth8\\",\\n \\"NodeId\\": \\"e01-cn-9lb36u4s601\\",\\n \\"Severity\\": \\"warning\\",\\n \\"Sn\\": \\"21A401332\\",\\n \\"Source\\": \\"damo-m53kr8kd-0008\\\\n\\",\\n \\"Syslogtag\\": \\"kernel\\",\\n \\"TagHostname\\": \\"damo-m53kr8kd-0008\\\\n\\",\\n \\"TagPackId\\": \\"D990314D3C25D7E8-1080\\",\\n \\"TagPath\\": \\"/var/log/kern\\",\\n \\"TagReceiveTime\\": \\"1687363348\\",\\n \\"TagUserDefinedId\\": \\"application_b\\",\\n \\"Time\\": \\"1687363346\\",\\n \\"Topic\\": \\"logserver\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询系统内核日志', + ], + 'ReportNodesStatus' => [ + 'summary' => '节点异常问题上报。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235597', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Nodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"e01-cn-fou3yvon53d\\"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点异常问题开始时间。按照 ISO8601 标准表示,带时区的时间格式,格式为 yyyy-MM-ddTHH:mm:ss+0800', + 'type' => 'string', + 'required' => false, + 'example' => '2024-09-22T16:00:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点异常问题结束时间。按照 ISO8601 标准表示,带时区的时间格式,格式为 yyyy-MM-ddTHH:mm:ss+0800', + 'type' => 'string', + 'required' => false, + 'example' => '2024-07-10T10:17:06', + ], + ], + [ + 'name' => 'Reason', + 'in' => 'formData', + 'schema' => [ + 'description' => '异常问题对灵骏节点造成的影响。'."\n" + .'取值范围(枚举值):'."\n" + .'● HardwareError:硬件出现异常'."\n" + .'● SoftwareError:软件出现异常'."\n" + .'● NetworkError:网络出现异常'."\n" + .'● Others:其他异常问题。当以上影响类型不符合条件时,您可以设置Reason=Others并在Description中描述更多信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'SoftwareError', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '描述', + 'type' => 'string', + 'required' => false, + 'example' => 'dwd_mysql_lingwan_faxing_login_di', + ], + ], + [ + 'name' => 'IssueCategory', + 'in' => 'formData', + 'schema' => [ + 'description' => '异常问题的类别。当Reason=HardwareError时,此值为必填项。取值范围:</br>'."\n" + .'● hardware-cpu-error:CPU 故障</br>'."\n" + .'● hardware-gpu-error:GPU 故障</br>'."\n" + .'● hardware-motherboard-error:主板故障</br>'."\n" + .'● hardware-mem-error:内存故障</br>'."\n" + .'● hardware-power-error:电源故障</br>'."\n" + .'● hardware-disk-error:磁盘故障'."\n" + .'● hardware-networkcard-error:网卡故障</br>'."\n" + .'● hardware-fan-error:风扇故障</br>'."\n" + .'● hardware-cable-error:网线故障</br>'."\n" + .'● others:其他', + 'type' => 'string', + 'required' => false, + 'example' => 'hardware-disk-error', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'B0699629-14FC-51E7-B49E-AAD83F6FEB60', + ], + 'ErrorMessage' => [ + 'description' => 'Error Message', + 'type' => 'string', + 'example' => 'Resource not found', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B0699629-14FC-51E7-B49E-AAD83F6FEB60\\",\\n \\"ErrorMessage\\": \\"Resource not found\\"\\n}","type":"json"}]', + 'title' => '报告节点状态', + 'description' => '创建会话的接口,返回前端EndPoint,并且起一个周期任务跟踪会话状态', + ], + 'DescribeNodeGroup' => [ + 'summary' => '查询节点分组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'NodeGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点组id'."\n", + 'description' => '节点组id'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'i128903591758597631635', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '83896080-59E3-5775-BDDC-8084691C3D96', + ], + 'ImageName' => [ + 'title' => '镜像名', + 'description' => '镜像名', + 'type' => 'string', + 'example' => 'Alinux3_x86_5.10.134-16.3_NV_RunC_D3_E3C7_570.133.20_V1.0_250428', + ], + 'NodeGroupDescription' => [ + 'title' => '节点组描述', + 'description' => '节点组描述', + 'type' => 'string', + 'example' => 'lingjun alinux node group', + ], + 'NodeGroupName' => [ + 'title' => '节点组名称', + 'description' => '节点组名称', + 'type' => 'string', + 'example' => 'test-ack', + ], + 'NodeCount' => [ + 'title' => '节点数量', + 'description' => '节点数量', + 'type' => 'string', + 'example' => '1', + ], + 'ClusterId' => [ + 'title' => '集群id'."\n", + 'description' => '集群id'."\n", + 'type' => 'string', + 'example' => 'i111987311754895199538', + ], + 'NodeGroupId' => [ + 'title' => '节点组id', + 'description' => '节点组id', + 'type' => 'string', + 'example' => 'i120982301752461697971', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-07-07T17:19:42.980000', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'example' => 'efg2.NH2cn', + ], + 'ImageId' => [ + 'title' => '镜像id', + 'description' => '镜像id', + 'type' => 'string', + 'example' => 'i190720111752146430748', + ], + 'UpdateTime' => [ + 'title' => '更新时间', + 'description' => '更新时间', + 'type' => 'string', + 'example' => '2025-08-20T11:18:11.164000', + ], + 'ClusterName' => [ + 'title' => '集群名称', + 'description' => '集群名称', + 'type' => 'string', + 'example' => 'aliyun-basic-cluster', + ], + 'Az' => [ + 'title' => '可用区', + 'description' => '可用区', + 'type' => 'string', + 'example' => 'cn-wulanchabu-a', + ], + 'UserData' => [ + 'title' => '用户自定义脚本', + 'description' => '用户自定义脚本', + 'type' => 'string', + 'example' => '#!/bin/bash'."\n" + .'uptime'."\n" + .'echo "aaaaaaa" >> /tmp/tttest.sh', + ], + 'SystemDisk' => [ + 'description' => '云系统盘信息。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '系统盘大小,单位为GiB。取值范围:'."\n" + ."\n" + .'- 普通云盘:20~500。'."\n" + .'- ESSD云盘:'."\n" + .' - PL0:1~2048。'."\n" + .' - PL1:20~2048。'."\n" + .' - PL2:461~2048。'."\n" + .' - PL3:1261~2048。'."\n" + .'- ESSD AutoPL 云盘:1~2048。'."\n" + .'- 其他云盘类型:20~2048。'."\n" + ."\n" + .'默认值:max{20, 参数ImageId对应的镜像大小}。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'PerformanceLevel' => [ + 'description' => '创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。取值范围:'."\n" + .'- PL0:单盘最高随机读写IOPS 1万。'."\n" + .'- PL1:单盘最高随机读写IOPS 5万。', + 'type' => 'string', + 'example' => 'PL0', + ], + 'Category' => [ + 'description' => '云盘种类。', + 'type' => 'string', + 'example' => 'system', + ], + ], + ], + 'FileSystemMountEnabled' => [ + 'title' => '是否支持文件存储挂载', + 'description' => '是否支持文件存储挂载', + 'type' => 'boolean', + 'example' => 'True', + ], + 'VirtualGpuEnabled' => [ + 'title' => '是否支持GPU虚拟化切分', + 'description' => '是否支持GPU虚拟化切分', + 'type' => 'boolean', + 'example' => 'False', + ], + 'KeyPairName' => [ + 'description' => '密钥对名称。', + 'type' => 'string', + 'example' => 'k8s-key', + ], + 'LoginType' => [ + 'title' => '枚举值:'."\n" + .'• password- 当前分组只支持密码登录 '."\n" + .'• keypair- 当前分组只支持密钥对登录 '."\n" + .'• both - 当前分组同时支持密码和密钥对登录'."\n" + ."\n" + .'如果返回为空,代表分组上没有设置任何登录方式', + 'description' => '枚举值:'."\n" + .'• password- 当前分组只支持密码登录 '."\n" + .'• keypair- 当前分组只支持密钥对登录 '."\n" + .'• both - 当前分组同时支持密码和密钥对登录'."\n" + ."\n" + .'如果返回为空,代表分组上没有设置任何登录方式', + 'type' => 'string', + 'example' => 'password', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"83896080-59E3-5775-BDDC-8084691C3D96\\",\\n \\"ImageName\\": \\"Alinux3_x86_5.10.134-16.3_NV_RunC_D3_E3C7_570.133.20_V1.0_250428\\",\\n \\"NodeGroupDescription\\": \\"lingjun alinux node group\\",\\n \\"NodeGroupName\\": \\"test-ack\\",\\n \\"NodeCount\\": \\"1\\",\\n \\"ClusterId\\": \\"i111987311754895199538\\",\\n \\"NodeGroupId\\": \\"i120982301752461697971\\",\\n \\"CreateTime\\": \\"2025-07-07T17:19:42.980000\\",\\n \\"MachineType\\": \\"efg2.NH2cn\\",\\n \\"ImageId\\": \\"i190720111752146430748\\",\\n \\"UpdateTime\\": \\"2025-08-20T11:18:11.164000\\",\\n \\"ClusterName\\": \\"aliyun-basic-cluster\\",\\n \\"Az\\": \\"cn-wulanchabu-a\\",\\n \\"UserData\\": \\"#!/bin/bash\\\\nuptime\\\\necho \\\\\\"aaaaaaa\\\\\\" >> /tmp/tttest.sh\\",\\n \\"SystemDisk\\": {\\n \\"Size\\": 1024,\\n \\"PerformanceLevel\\": \\"PL0\\",\\n \\"Category\\": \\"system\\"\\n },\\n \\"FileSystemMountEnabled\\": true,\\n \\"VirtualGpuEnabled\\": true,\\n \\"KeyPairName\\": \\"k8s-key\\",\\n \\"LoginType\\": \\"password\\"\\n}","type":"json"}]', + 'title' => '查询节点组详细信息', + ], + 'ChangeNodeGroup' => [ + 'summary' => '修改节点的节点组。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterRN0MBH', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '这些接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证。因此需要在接口上设置”不支持自动化测试“来做加白操作', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Nodes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '节点信息。', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表', + 'type' => 'string', + 'required' => false, + 'example' => '["e01-dks34dmdfo3","e01-dfjd34nsl4"]', + ], + 'required' => false, + ], + ], + [ + 'name' => 'IgnoreFailedNodeTasks', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许跳过失败节点,默认值为False', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False'."\n", + ], + ], + [ + 'name' => 'TargetNodeGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '目标节点组id', + 'type' => 'string', + 'required' => false, + 'example' => 'i234242342342', + ], + ], + ], + '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' => '887FA855-89F4-5DB3-B305-C5879EC480E6', + ], + 'TaskId' => [ + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i159136551662516768776', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"887FA855-89F4-5DB3-B305-C5879EC480E6\\",\\n \\"TaskId\\": \\"i159136551662516768776\\"\\n}","type":"json"}]', + 'title' => '变更节点组', + 'description' => '创建会话的接口,返回前端EndPoint,并且起一个周期任务跟踪会话状态', + ], + 'ListClusterHyperNodes' => [ + 'summary' => '集群下的主机分组列表,分组下的主机列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162039', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'required' => true, + 'example' => 'i119982311660892626523', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'description' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '563d42ae0b17572449ec8c97f7f66069', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'NodeGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '节点组id', + 'type' => 'string', + 'required' => false, + 'example' => 'ng-ec3c96ff0aa4c60d', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签信息', + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key', + 'type' => 'string', + 'required' => false, + 'example' => 'my_key', + 'maxLength' => 129, + ], + 'Value' => [ + 'description' => '标签value', + 'type' => 'string', + 'required' => false, + 'example' => 'my_value', + 'maxLength' => 129, + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组ID', + 'description' => '资源组ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmywpvugkh7kq', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4FD06DF0-9167-5C6F-A145-F30CA4A15D54', + ], + 'NextToken' => [ + 'title' => '本次调用返回的查询凭证值。'."\n", + 'description' => '本次调用返回的查询凭证值。'."\n", + 'type' => 'string', + 'example' => '563d42ae0b17572449ec8c97f7f66069', + ], + 'HyperNodes' => [ + 'title' => '超节点列表', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点信息', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-07-07T17:38:35.391', + ], + 'ExpireTime' => [ + 'title' => '机器过期时间', + 'description' => '机器过期时间', + 'type' => 'string', + 'example' => '2025-04-19T02:32:48Z', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'example' => 'efg2.NH2cn', + ], + 'NodeGroupId' => [ + 'title' => '节点组id'."\n", + 'description' => '节点组id'."\n", + 'type' => 'string', + 'example' => 'i123229811742436895560', + ], + 'NodeGroupName' => [ + 'title' => '节点组名称'."\n", + 'description' => '节点组名称'."\n", + 'type' => 'string', + 'example' => 'g1', + ], + 'HyperNodeId' => [ + 'title' => '节点id', + 'description' => '节点id', + 'type' => 'string', + 'example' => 'e01-cn-2r42tmj4z02', + ], + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区id', + 'type' => 'string', + 'example' => 'cn-shanghai-b', + ], + 'HpnZone' => [ + 'description' => '集群编号', + 'type' => 'string', + 'example' => 'B1', + ], + 'VpcId' => [ + 'title' => '专有网络ID', + 'description' => '专有网络ID', + 'type' => 'string', + 'example' => 'vpc-0jl8gs7qmx89739e210dn', + ], + 'VSwitchId' => [ + 'title' => '专有网络交换机ID', + 'description' => '专有网络交换机ID', + 'type' => 'string', + 'example' => 'vsw-bp1u4ej4ap8c4yiqfi87c', + ], + 'Tags' => [ + 'title' => '标签信息', + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key', + 'type' => 'string', + 'example' => 'key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'ali-zeekr-ota-doris-prod-hz-selectdb', + ], + ], + ], + ], + 'TaskId' => [ + 'title' => '任务ID', + 'description' => '任务ID', + 'type' => 'string', + 'example' => 'i153907661745288876128', + ], + 'CommodityCode' => [ + 'title' => '商品码', + 'description' => '商品码', + 'type' => 'string', + 'example' => 'bccluster_eflocomputing_public_cn', + ], + 'FileSystemMountEnabled' => [ + 'title' => '是否支持文件存储挂载', + 'description' => '是否支持文件存储挂载', + 'type' => 'boolean', + 'example' => 'False', + ], + 'Status' => [ + 'title' => '节点状态', + 'description' => '节点状态', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Extending', + ], + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名', + 'type' => 'string', + 'example' => 'alywlcb-lingjun-gpu-0025', + ], + 'OperatingState' => [ + 'title' => '超节点状态', + 'description' => '超节点状态', + 'type' => 'string', + 'example' => 'Using', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4FD06DF0-9167-5C6F-A145-F30CA4A15D54\\",\\n \\"NextToken\\": \\"563d42ae0b17572449ec8c97f7f66069\\",\\n \\"HyperNodes\\": [\\n {\\n \\"CreateTime\\": \\"2025-07-07T17:38:35.391\\",\\n \\"ExpireTime\\": \\"2025-04-19T02:32:48Z\\",\\n \\"MachineType\\": \\"efg2.NH2cn\\",\\n \\"NodeGroupId\\": \\"i123229811742436895560\\",\\n \\"NodeGroupName\\": \\"g1\\",\\n \\"HyperNodeId\\": \\"e01-cn-2r42tmj4z02\\",\\n \\"ZoneId\\": \\"cn-shanghai-b\\",\\n \\"HpnZone\\": \\"B1\\",\\n \\"VpcId\\": \\"vpc-0jl8gs7qmx89739e210dn\\",\\n \\"VSwitchId\\": \\"vsw-bp1u4ej4ap8c4yiqfi87c\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"ali-zeekr-ota-doris-prod-hz-selectdb\\"\\n }\\n ],\\n \\"TaskId\\": \\"i153907661745288876128\\",\\n \\"CommodityCode\\": \\"bccluster_eflocomputing_public_cn\\",\\n \\"FileSystemMountEnabled\\": true,\\n \\"Status\\": \\"Extending\\",\\n \\"Hostname\\": \\"alywlcb-lingjun-gpu-0025\\",\\n \\"OperatingState\\": \\"Using\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询集群分组列表及分组下的超节点列表', + ], + 'ListHyperNodes' => [ + 'summary' => '机器列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NodeGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点组名称', + 'description' => '节点组名称', + 'type' => 'string', + 'required' => false, + 'example' => 'emr-default', + ], + ], + [ + 'name' => 'MachineType', + 'in' => 'formData', + 'schema' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'required' => false, + 'example' => 'efg1.nvga1', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'formData', + 'schema' => [ + 'title' => '可用区id', + 'description' => '可用区id', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-i', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。', + 'description' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。', + 'type' => 'string', + 'required' => false, + 'example' => '3a6b93229825ac667104463b56790c91', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组id', + 'description' => '资源组id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmwfm33rlt6zi', + ], + ], + [ + 'name' => 'HyperNodeId', + 'in' => 'formData', + 'schema' => [ + 'title' => '节点ID', + 'description' => '节点ID', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群名', + 'description' => '集群名', + 'type' => 'string', + 'required' => false, + 'example' => 'Standard_Cluster', + ], + ], + [ + 'name' => 'HpnZone', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群编号。', + 'type' => 'string', + 'required' => false, + 'example' => 'A1', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签信息', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key', + 'type' => 'string', + 'required' => false, + 'example' => 'alarm_xdc', + ], + 'Value' => [ + 'description' => '标签value', + 'type' => 'string', + 'required' => false, + 'example' => '129', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'OperatingStates', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '节点状态, 如果不填表示所有状态:Extending、UnusedNodeStopped'."\n" + .'UnusedNodeStopping、Unused、Using、ReleaseLocking、Operating、Cutting、ClusterNodeStopped、UnusedNodeRecovering、ClusterNodeStopping、ClusterNodeRecovering、Replacing', + 'description' => '节点状态, 如果不填表示所有状态:Extending、UnusedNodeStopped'."\n" + .'UnusedNodeStopping、Unused、Using、ReleaseLocking、Operating、Cutting、ClusterNodeStopped、UnusedNodeRecovering、ClusterNodeStopping、ClusterNodeRecovering、Replacing', + 'type' => 'array', + 'items' => [ + 'description' => '节点状态, 如果不填表示所有状态:Extending、UnusedNodeStopped'."\n" + .'UnusedNodeStopping、Unused、Using、ReleaseLocking、Operating、Cutting、ClusterNodeStopped、UnusedNodeRecovering、ClusterNodeStopping、ClusterNodeRecovering、Replacing', + 'type' => 'string', + 'required' => false, + 'example' => 'Extending', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'title' => '商品code代码', + 'description' => '商品code代码', + 'type' => 'string', + 'required' => false, + 'example' => 'rds_machineinstanceba_public_cn', + ], + ], + [ + 'name' => 'HyperNodeIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '节点ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点ID列表', + 'type' => 'string', + 'required' => false, + 'example' => 'e01-cn-xp54hgqx1y2z', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'E64F9128-E2FC-5998-B769-199B0CB18138', + ], + 'HyperNodes' => [ + 'title' => '节点列表', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区id', + 'type' => 'string', + 'example' => 'cn-hangzhou-b', + ], + 'ClusterName' => [ + 'title' => '集群名称', + 'description' => '集群名称', + 'type' => 'string', + 'example' => 'test-ack', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-07-09T10:41:56.577', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'example' => 'efg2.GN9C.cn8', + ], + 'HyperNodeId' => [ + 'title' => '节点id', + 'description' => '节点id', + 'type' => 'string', + 'example' => 'e01-cn-2r42tmj4z02', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id', + 'type' => 'string', + 'example' => 'i153333771756952392398', + ], + 'ExpireTime' => [ + 'title' => '过期时间', + 'description' => '过期时间', + 'type' => 'string', + 'example' => '2025-09-28T16:00:00Z', + ], + 'ClusterId' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'example' => 'i115226661755786900341', + ], + 'NodeGroupId' => [ + 'title' => '节点组id', + 'description' => '节点组id', + 'type' => 'string', + 'example' => 'i121135081698451727812', + ], + 'NodeGroupName' => [ + 'title' => '节点组', + 'description' => '节点组', + 'type' => 'string', + 'example' => 'l20c-0801', + ], + 'HpnZone' => [ + 'description' => '集群编号', + 'type' => 'string', + 'example' => 'A1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组id', + 'type' => 'string', + 'example' => 'rg-acfmwfm33rlt6zi', + ], + 'CommodityCode' => [ + 'description' => '产品code', + 'type' => 'string', + 'example' => 'bccluster_eflocomputing_public_cn', + ], + 'Status' => [ + 'description' => '节点状态', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Extending', + ], + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名', + 'type' => 'string', + 'example' => 'alywlcb-lingjun-gpu-0025', + ], + 'OperatingState' => [ + 'title' => '超节点状态', + 'description' => '超节点状态', + 'type' => 'string', + 'example' => 'Using', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '节点标签key', + 'type' => 'string', + 'example' => 'alarm_xdc', + ], + 'Value' => [ + 'description' => '节点标签value', + 'type' => 'string', + 'example' => '97', + ], + ], + ], + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '下一页的NextToken,请求下一页时带上此返回值', + 'description' => '下一页的NextToken,请求下一页时带上此返回值', + 'type' => 'string', + 'example' => '7ed93fda-5e7f-436a-ae5a-bd8e6b04e36b', + ], + 'MaxResults' => [ + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E64F9128-E2FC-5998-B769-199B0CB18138\\",\\n \\"HyperNodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-b\\",\\n \\"ClusterName\\": \\"test-ack\\",\\n \\"CreateTime\\": \\"2025-07-09T10:41:56.577\\",\\n \\"MachineType\\": \\"efg2.GN9C.cn8\\",\\n \\"HyperNodeId\\": \\"e01-cn-2r42tmj4z02\\",\\n \\"TaskId\\": \\"i153333771756952392398\\",\\n \\"ExpireTime\\": \\"2025-09-28T16:00:00Z\\",\\n \\"ClusterId\\": \\"i115226661755786900341\\",\\n \\"NodeGroupId\\": \\"i121135081698451727812\\",\\n \\"NodeGroupName\\": \\"l20c-0801\\",\\n \\"HpnZone\\": \\"A1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmwfm33rlt6zi\\",\\n \\"CommodityCode\\": \\"bccluster_eflocomputing_public_cn\\",\\n \\"Status\\": \\"Extending\\",\\n \\"Hostname\\": \\"alywlcb-lingjun-gpu-0025\\",\\n \\"OperatingState\\": \\"Using\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"alarm_xdc\\",\\n \\"Value\\": \\"97\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"7ed93fda-5e7f-436a-ae5a-bd8e6b04e36b\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '查询超节点', + 'description' => '查询超节点详细信息。', + ], + 'ListFreeHyperNodes' => [ + 'summary' => '可用rack物理机列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162040', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'description' => '查询凭证(Token),取值为上一次API调用返回的 NextToken 参数值。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a3f2224a5ec7224116c4f5246120****', + ], + ], + [ + 'name' => 'MaxResults', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'MachineType', + 'in' => 'formData', + 'schema' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'required' => false, + 'example' => 'efg1.nvga1', + ], + ], + [ + 'name' => 'HpnZone', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群编号', + 'type' => 'string', + 'required' => false, + 'example' => 'A1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '资源组id', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzyqdwnfabx6q', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签信息', + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签key', + 'type' => 'string', + 'required' => false, + 'example' => 'my_key', + 'maxLength' => 129, + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => '129', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '返回的未使用节点状态列表', + 'type' => 'array', + 'items' => [ + 'description' => '返回的未使用节点状态', + 'type' => 'string', + 'required' => false, + 'example' => 'Unused', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id'."\n", + 'description' => '请求id'."\n", + 'type' => 'string', + 'example' => 'A511C02A-0127-51AA-A9F9-966382C9A1B5', + ], + 'HyperNodes' => [ + 'title' => '节点列表', + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区id', + 'type' => 'string', + 'example' => 'cn-wulanchabu-a', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-08-06T10:11:41.569', + ], + 'HyperNodeId' => [ + 'title' => '节点id', + 'description' => '节点id', + 'type' => 'string', + 'example' => 'e01-cn-7pp2x193801', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'example' => 'efg2.ks01L20Z2', + ], + 'ExpireTime' => [ + 'title' => '机器过期时间', + 'description' => '机器过期时间', + 'type' => 'string', + 'example' => '2025-01-22T23:59:59Z', + ], + 'HpnZone' => [ + 'description' => '集群编号', + 'type' => 'string', + 'example' => 'A1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID', + 'type' => 'string', + 'example' => 'rg-acfmwaateahzoii', + ], + 'CommodityCode' => [ + 'title' => '商品码', + 'description' => '商品码', + 'type' => 'string', + 'example' => 'bccluster_eflocomputing_public_cn', + ], + 'Tags' => [ + 'description' => '标签列表', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'example' => 'Cpu_Usage', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'on', + ], + ], + ], + ], + 'Status' => [ + 'description' => '超节点状态', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Using', + ], + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名', + 'type' => 'string', + 'example' => 'alywlcb-lingjun-gpu-0025', + ], + 'OperatingState' => [ + 'title' => '超节点状态', + 'description' => '超节点状态', + 'type' => 'string', + 'example' => 'Using', + ], + ], + ], + ], + 'NextToken' => [ + 'title' => '本次调用返回的查询凭证值。'."\n", + 'description' => '本次调用返回的查询凭证值。'."\n", + 'type' => 'string', + 'example' => '563d42ae0b17572449ec8c97f7f66069', + ], + 'MaxResults' => [ + 'title' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'description' => '分页查询时每页行数。最大值为100。'."\n" + ."\n" + .'默认值:'."\n" + ."\n" + .'•当不设置值或设置的值小于20时,默认值为20。'."\n" + ."\n" + .'•当设置的值大于100时,默认值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A511C02A-0127-51AA-A9F9-966382C9A1B5\\",\\n \\"HyperNodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-wulanchabu-a\\",\\n \\"CreateTime\\": \\"2025-08-06T10:11:41.569\\",\\n \\"HyperNodeId\\": \\"e01-cn-7pp2x193801\\",\\n \\"MachineType\\": \\"efg2.ks01L20Z2\\",\\n \\"ExpireTime\\": \\"2025-01-22T23:59:59Z\\",\\n \\"HpnZone\\": \\"A1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmwaateahzoii\\",\\n \\"CommodityCode\\": \\"bccluster_eflocomputing_public_cn\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Cpu_Usage\\",\\n \\"Value\\": \\"on\\"\\n }\\n ],\\n \\"Status\\": \\"Using\\",\\n \\"Hostname\\": \\"alywlcb-lingjun-gpu-0025\\",\\n \\"OperatingState\\": \\"Using\\"\\n }\\n ],\\n \\"NextToken\\": \\"563d42ae0b17572449ec8c97f7f66069\\",\\n \\"MaxResults\\": 20\\n}","type":"json"}]', + 'title' => '查询可用超节点列表', + ], + 'DescribeHyperNode' => [ + 'summary' => '查询超节点详细信息。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161252', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'HyperNodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '超节点ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'D6058705-1C45-35C9-9461-02504897D4D0', + ], + 'NodeGroupName' => [ + 'title' => '节点组名称', + 'description' => '节点组名称', + 'type' => 'string', + 'example' => 'lisan-nodegroup', + ], + 'ClusterId' => [ + 'title' => '集群id', + 'description' => '集群id', + 'type' => 'string', + 'example' => 'i119982311660892626523', + ], + 'ClusterName' => [ + 'title' => '集群名称', + 'description' => '集群名称', + 'type' => 'string', + 'example' => 'Standard_Cluster', + ], + 'ZoneId' => [ + 'title' => '可用区id', + 'description' => '可用区id', + 'type' => 'string', + 'example' => 'cn-wulanchabu-c', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2022-11-30T02:00:00.852Z', + ], + 'NodeGroupId' => [ + 'title' => '节点组id', + 'description' => '节点组id', + 'type' => 'string', + 'example' => 'ng-ec3c96ff0aa4c60d', + ], + 'MachineType' => [ + 'title' => '机型', + 'description' => '机型', + 'type' => 'string', + 'example' => 'efg1.nvga1', + ], + 'ExpireTime' => [ + 'title' => '过期时间', + 'description' => '过期时间', + 'type' => 'string', + 'example' => '2125-06-24T16:52:44.318000', + ], + 'HpnZone' => [ + 'description' => '集群编号。', + 'type' => 'string', + 'example' => 'A1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组Id', + 'type' => 'string', + 'example' => 'rg-acfmxno4vh5****', + ], + 'FileSystemMountEnabled' => [ + 'title' => '是否支持文件存储挂载', + 'description' => '是否支持文件存储挂载', + 'type' => 'boolean', + 'example' => 'True', + ], + 'HyperNodeId' => [ + 'description' => '超节点ID', + 'type' => 'string', + 'example' => 'e01-cn-zvp2tgykr08', + ], + 'Nodes' => [ + 'description' => '节点列表', + 'type' => 'array', + 'items' => [ + 'description' => '节点列表', + 'type' => 'object', + 'properties' => [ + 'NodeId' => [ + 'description' => '节点id', + 'type' => 'string', + 'example' => 'e01-cn-zvp2tgykr0b', + ], + 'ImageId' => [ + 'description' => '镜像id', + 'type' => 'string', + 'example' => 'i190297201669099844192', + ], + 'Hostname' => [ + 'description' => '主机名', + 'type' => 'string', + 'example' => '457db5ca-241d-11ed-9fd7-acde48001122', + ], + 'Status' => [ + 'description' => '状态', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'InProgress', + ], + 'ImageName' => [ + 'description' => '镜像名', + 'type' => 'string', + 'example' => 'Alinux3_x86_gu8xf_P_Host_D3_C7E3_550.127_Legacy_N_241230', + ], + 'Networks' => [ + 'description' => '网络信息', + 'type' => 'object', + 'properties' => [ + 'BondName' => [ + 'description' => '机器网口名称。', + 'type' => 'string', + 'example' => 'bond0', + ], + 'Ip' => [ + 'description' => '专有网络内的机器IP。', + 'type' => 'string', + 'example' => '192.168.22.2', + ], + ], + ], + 'UserData' => [ + 'description' => '用户自定义脚本。', + 'type' => 'string', + 'example' => '#!/bin/bash'."\n" + .'uptime'."\n" + .'echo "aaaaaaa" >> /tmp/ttttttest.sh', + ], + 'Disks' => [ + 'description' => '磁盘信息。', + 'type' => 'array', + 'items' => [ + 'description' => '磁盘信息。', + 'type' => 'object', + 'properties' => [ + 'DiskId' => [ + 'description' => '磁盘ID。', + 'type' => 'string', + 'example' => 'd-bp1564bcc2306uui4zpk', + ], + 'Category' => [ + 'description' => '数据包分类。取值:'."\n" + ."\n" + .'- **DOWNLINK_PACKET**:下行包'."\n" + .'- **UPLINK_PACKET**:上行包', + 'type' => 'string', + 'example' => 'DOWNLINK_PACKET', + ], + 'Size' => [ + 'description' => '磁盘大小,单位GiB。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'PerformanceLevel' => [ + 'description' => '创建ESSD云盘作为系统盘使用时,设置云盘的性能等级。取值范围:'."\n" + .'- PL0:单盘最高随机读写IOPS 1万。'."\n" + .'- PL1:单盘最高随机读写IOPS 5万。', + 'type' => 'string', + 'example' => 'PL0', + ], + 'Type' => [ + 'description' => '磁盘类型。可能值:'."\n" + ."\n" + .'- system:系统盘。'."\n" + .'- data:数据盘。', + 'type' => 'string', + 'example' => 'system', + ], + ], + ], + ], + 'OperatingState' => [ + 'title' => '节点状态', + 'description' => '节点状态', + 'type' => 'string', + 'example' => 'Using', + ], + ], + ], + ], + 'Status' => [ + 'description' => '节点状态', + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Operating', + ], + 'Hostname' => [ + 'title' => '主机名', + 'description' => '主机名', + 'type' => 'string', + 'example' => 'alywlcb-lingjun-gpu-0025', + ], + 'OperatingState' => [ + 'title' => '超节点状态', + 'description' => '超节点状态', + 'type' => 'string', + 'example' => 'Using', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6058705-1C45-35C9-9461-02504897D4D0\\",\\n \\"NodeGroupName\\": \\"lisan-nodegroup\\",\\n \\"ClusterId\\": \\"i119982311660892626523\\",\\n \\"ClusterName\\": \\"Standard_Cluster\\",\\n \\"ZoneId\\": \\"cn-wulanchabu-c\\",\\n \\"CreateTime\\": \\"2022-11-30T02:00:00.852Z\\",\\n \\"NodeGroupId\\": \\"ng-ec3c96ff0aa4c60d\\",\\n \\"MachineType\\": \\"efg1.nvga1\\",\\n \\"ExpireTime\\": \\"2125-06-24T16:52:44.318000\\",\\n \\"HpnZone\\": \\"A1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxno4vh5****\\",\\n \\"FileSystemMountEnabled\\": true,\\n \\"HyperNodeId\\": \\"e01-cn-zvp2tgykr08\\",\\n \\"Nodes\\": [\\n {\\n \\"NodeId\\": \\"e01-cn-zvp2tgykr0b\\",\\n \\"ImageId\\": \\"i190297201669099844192\\",\\n \\"Hostname\\": \\"457db5ca-241d-11ed-9fd7-acde48001122\\",\\n \\"Status\\": \\"InProgress\\",\\n \\"ImageName\\": \\"Alinux3_x86_gu8xf_P_Host_D3_C7E3_550.127_Legacy_N_241230\\",\\n \\"Networks\\": {\\n \\"BondName\\": \\"bond0\\",\\n \\"Ip\\": \\"192.168.22.2\\"\\n },\\n \\"UserData\\": \\"#!/bin/bash\\\\nuptime\\\\necho \\\\\\"aaaaaaa\\\\\\" >> /tmp/ttttttest.sh\\",\\n \\"Disks\\": [\\n {\\n \\"DiskId\\": \\"d-bp1564bcc2306uui4zpk\\",\\n \\"Category\\": \\"DOWNLINK_PACKET\\",\\n \\"Size\\": 5,\\n \\"PerformanceLevel\\": \\"PL0\\",\\n \\"Type\\": \\"system\\"\\n }\\n ],\\n \\"OperatingState\\": \\"Using\\"\\n }\\n ],\\n \\"Status\\": \\"Operating\\",\\n \\"Hostname\\": \\"alywlcb-lingjun-gpu-0025\\",\\n \\"OperatingState\\": \\"Using\\"\\n}","type":"json"}]', + 'title' => '查询超节点详细信息接口', + 'description' => '查询超节点详细信息。', + ], + 'ChangeNodeTypes' => [ + 'summary' => '节点规格变配。节点规格变配需要用户保证相关节点资源满足目标规格上限。节点规格是否变配成功,以任务结束后再查询节点返回对应的规格为准, 不能以任务是否成功为准。'."\n" + .'在发起规格变配请求之后,如果节点不满足规格要求,任务会成功,但是实际不会变配。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '162088', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NodeType', + 'in' => 'formData', + 'schema' => [ + 'title' => '集群id'."\n", + 'description' => '节点规格', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'zeroLeni-ebs' => 'zeroLeni-ebs', + 'ebs-enhanced' => 'ebs-enhanced', + 'cpfs-enhanced' => 'cpfs-enhanced', + 'zeroLeni-cpfs' => 'zeroLeni-cpfs', + ], + 'example' => 'cpfs-enhanced', + ], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '节点列表', + 'description' => '节点列表, 当前限制一批最大10台', + 'type' => 'array', + 'items' => [ + 'title' => '节点id', + 'description' => '节点id', + 'type' => 'string', + 'required' => false, + 'example' => '[\'2423423423423\']', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求id', + 'description' => '请求id', + 'type' => 'string', + 'example' => '887FA855-89F4-5DB3-B305-C5879EC480E6', + ], + 'TaskId' => [ + 'title' => '任务id', + 'description' => '任务id 只有当所有节点检查通过才会返回TaskId'."\n" + .'异常情况TaskId为空', + 'type' => 'string', + 'example' => 'i158475611663639202234', + ], + 'NodeResponse' => [ + 'title' => '节点响应数据', + 'description' => '节点响应数据', + 'type' => 'array', + 'items' => [ + 'title' => '根节点响应元素', + 'description' => '根节点响应元素', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'title' => '节点响应码', + 'description' => '节点响应码', + 'type' => 'string', + 'enumValueTitles' => [ + 'STATE_INVALID' => '节点状态不对', + 'NOT_SUPPORT' => '节点不支持该目标规格变配', + 'RESOURCE_INSUFFICIENT' => '节点资源不满足目标规格限制', + 'PASSED' => '检查通过', + ], + 'example' => 'PASSED', + ], + 'Message' => [ + 'title' => '节点响应中的消息内容', + 'description' => '节点响应中的消息内容', + 'type' => 'string', + 'example' => 'success', + ], + 'NodeId' => [ + 'title' => '节点响应中节点ID', + 'description' => '节点响应中节点ID', + 'type' => 'string', + 'example' => 'e01-in-067da4ca9c2', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"887FA855-89F4-5DB3-B305-C5879EC480E6\\",\\n \\"TaskId\\": \\"i158475611663639202234\\",\\n \\"NodeResponse\\": [\\n {\\n \\"Code\\": \\"PASSED\\",\\n \\"Message\\": \\"success\\",\\n \\"NodeId\\": \\"e01-in-067da4ca9c2\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '节点规格修改', + 'requestParamsDescription' => '发起变更规格的所有节点需要在Using状态,并且在同一个节点组。只有所有节点都能通过前置检查,才会返回相关异步任务ID。当任何一个节点不能进行变配,都不会生成异步任务。当前限制一批最多10台机器提交。', + ], + 'DeleteHyperNode' => [ + 'summary' => '删除一个未使用超节点。', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'high', + 'chargeType' => 'paid', + 'abilityTreeNodes' => [ + 'FEATUREbcclusterSIOTA6', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '接口依赖于灵骏机器资源。灵骏机器资源紧张,无法做跨账号的企业级能力验证', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'HyperNodeId', + 'in' => 'formData', + 'schema' => [ + 'description' => '超节点ID', + 'type' => 'string', + 'required' => true, + 'example' => 'e01-cn-zvp2tgykr08', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回信息', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => '041724FC-2BD7-58B1-863B-B42022D4B351', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"041724FC-2BD7-58B1-863B-B42022D4B351\\"\\n}","type":"json"}]', + 'title' => '释放超节点', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'eflo-controller.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'eflo-controller.cn-beijing.aliyuncs.com ', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'eflo-controller.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'eflo-controller.cn-wulanchabu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'eflo-controller.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'eflo-controller.cn-shanghai.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'eflo-controller.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-heyuan', + 'endpoint' => 'eflo-controller.cn-heyuan.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'eflo-controller.cn-guangzhou.aliyuncs.com ', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'eflo-controller.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-7', + 'endpoint' => 'eflo-controller.ap-southeast-7.aliyuncs.com ', + ], + ], +]; |
