'1.0', 'info' => [ 'style' => 'ROA', 'product' => 'eas', 'version' => '2021-07-01', ], 'directories' => [ [ 'id' => 360783, 'title' => '服务', 'type' => 'directory', 'children' => [ 'CreateService', 'CreateServiceAutoScaler', 'CreateServiceCronScaler', 'CreateServiceMirror', 'CreateAppService', 'DescribeGroupEndpoints', 'DescribeServiceEndpoints', 'DescribeServiceSignedUrl', 'CloneService', 'DeleteService', 'DeleteServiceLabel', 'DeleteServiceAutoScaler', 'DeleteServiceCronScaler', 'DeleteServiceInstances', 'DeleteServiceMirror', 'UpdateService', 'UpdateServiceLabel', 'StartService', 'StopService', 'RestartService', 'UpdateServiceAutoScaler', 'UpdateServiceCronScaler', 'DevelopService', 'CommitService', 'UpdateServiceMirror', 'UpdateServiceVersion', 'UpdateServiceSafetyLock', 'UpdateServiceInstance', 'UpdateAppService', 'UpdateGroup', 'ReleaseService', 'DescribeService', 'DescribeServiceAutoScaler', 'DescribeServiceCronScaler', 'DescribeServiceDiagnosis', 'DescribeServiceInstanceDiagnosis', 'DescribeServiceLog', 'DescribeServiceEvent', 'DescribeServiceMirror', 'DescribeGroup', 'DescribeSpotDiscountHistory', 'ListServiceInstances', 'ListServiceVersions', 'ListServiceContainers', 'ListServices', 'ListGroups', 'DescribeMachineSpec', ], ], [ 'id' => 360831, 'title' => '资源组', 'type' => 'directory', 'children' => [ 'UpdateVirtualResource', 'ListVirtualResource', 'DescribeVirtualResource', 'DeleteVirtualResource', 'CreateVirtualResource', 'CreateResource', 'CreateResourceInstances', 'CreateResourceLog', 'DeleteResource', 'DeleteResourceDLink', 'DeleteResourceInstances', 'DeleteResourceLog', 'DeleteResourceInstanceLabel', 'MigrateResourceInstance', 'UpdateResourceInstanceLabel', 'UpdateResource', 'UpdateResourceDLink', 'UpdateResourceInstance', 'DescribeResource', 'DescribeResourceDLink', 'DescribeResourceLog', 'ListResourceInstances', 'ListResourceInstanceWorker', 'ListResources', 'ListResourceServices', ], ], [ 'id' => 360857, 'title' => '压测任务', 'type' => 'directory', 'children' => [ 'CreateBenchmarkTask', 'DeleteBenchmarkTask', 'DescribeBenchmarkTask', 'DescribeBenchmarkTaskReport', 'ListBenchmarkTask', 'StartBenchmarkTask', 'StopBenchmarkTask', 'UpdateBenchmarkTask', ], ], [ 'id' => 360866, 'title' => '私有网关', 'type' => 'directory', 'children' => [ 'DeleteGatewayLabel', 'UpdateGatewayLabel', 'DetachGatewayDomain', 'AttachGatewayDomain', 'ListGatewayDomains', 'ListGateway', 'ListAclPolicy', 'DeleteAclPolicy', 'CreateAclPolicy', 'CreateGateway', 'DescribeGateway', 'UpdateGateway', 'CreateGatewayIntranetLinkedVpc', 'ListGatewayIntranetLinkedVpc', 'ListGatewayIntranetSupportedZone', 'ListGatewayIntranetSupportedZone', 'DeleteGatewayIntranetLinkedVpc', 'DeleteGateway', 'ListGatewayIntranetLinkedVpcPeer', 'CreateGatewayIntranetLinkedVpcPeer', 'DeleteGatewayIntranetLinkedVpcPeer', ], ], [ 'id' => 360887, 'title' => '其他', 'type' => 'directory', 'children' => [ 'DescribeRegions', 'ReinstallTenantAddon', 'ListServiceInstanceFaultInjectionInfo', 'CreateFaultInjection', 'DeleteFaultInjection', 'ListTenantAddons', ], ], ], 'components' => [ 'schemas' => [ 'ContainerInfo' => [ 'title' => '容器信息', 'description' => '实例容器信息。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '容器名称', 'description' => '容器名称。', 'type' => 'string', 'example' => 'worker0', ], 'Image' => [ 'title' => '镜像', 'description' => '镜像。', 'type' => 'string', 'example' => 'registry.cn-shanghai.aliyuncs.com/eas/echo_cn-shanghai:v0.0.1-20210129111320', ], 'Port' => [ 'title' => '端口', 'description' => '端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', ], 'RestartCount' => [ 'title' => '重启次数', 'description' => '重启次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Ready' => [ 'title' => '健康检查是否通过', 'description' => '健康检查是否通过。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => '是', 'false' => '否', ], 'example' => 'true', ], 'CurrentStatus' => [ 'title' => '当前状态-状态', 'description' => '当前状态，取值如下：'."\n" .'- Waiting：等待中'."\n" .'- Running：运行中'."\n" .'- Terminated：已停止', 'type' => 'string', 'example' => 'Waiting', ], 'CurrentReaon' => [ 'title' => '当前状态-原因', 'description' => '出现当前状态的原因。', 'type' => 'string', 'example' => 'PodInitializing', ], 'CurrentTimestamp' => [ 'title' => '当前状态-时间', 'description' => '出现当前状态的时间。', 'type' => 'string', 'example' => '2022-03-21T06:17:57Z', ], 'LastStatus' => [ 'title' => '上次状态-状态', 'description' => '上次状态，取值如下：'."\n" .'- Waiting：等待中'."\n" .'- Running：运行中'."\n" .'- Terminated：已停止', 'type' => 'string', 'example' => 'Terminated', ], 'LastReason' => [ 'title' => '上次状态-原因', 'description' => '出现上次状态的原因。', 'type' => 'string', 'example' => 'Error', ], 'LastTimestamp' => [ 'title' => '上次状态-时间', 'description' => '出现上次状态的时间。', 'type' => 'string', 'example' => '2022-03-21T05:17:57Z', ], ], ], 'Group' => [ 'title' => '服务组', 'description' => '服务群组。', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => '服务组名称', 'description' => '服务群组名称。', 'type' => 'string', 'example' => 'foo', ], 'ClusterId' => [ 'title' => '服务组所在集群', 'description' => '服务群组所在地域。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'CreateTime' => [ 'title' => '服务组创建时间', 'description' => '服务群组创建时间。使用UTC时间格式。', 'type' => 'string', 'example' => '2020-05-19T14:19:42Z', ], 'UpdateTime' => [ 'title' => '服务组更新时间', 'description' => '服务群组更新时间。使用UTC时间格式。', 'type' => 'string', 'example' => '2021-01-29T11:13:20Z', ], 'QueueService' => [ 'title' => '服务组包含的队列服务', 'description' => '服务群组包含的队列服务。', 'type' => 'string', 'example' => 'qservice', ], 'InternetEndpoint' => [ 'title' => '服务组公网地址', 'description' => '服务群组公网地址。', 'type' => 'string', 'example' => 'http://1110*****.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/test_group', ], 'IntranetEndpoint' => [ 'title' => '服务组内网地址', 'description' => '服务群组内网地址。', 'type' => 'string', 'example' => 'http://1110*****.vpc.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/test_group', ], 'AccessToken' => [ 'title' => '服务组流量入口Token', 'description' => '服务组流量入口Token。', 'type' => 'string', 'example' => 'MzJiMDI5MDliODc0MTlkYmI0ZDhlYmExYjczYTIyZTE3Zm********', ], 'TrafficMode' => [ 'title' => '流量模式', 'description' => '流量模式', 'type' => 'string', 'enumValueTitles' => [ 'auto' => '根据实例数量自动分配流量', 'customized' => '自定义流量分配', ], 'example' => 'auto', ], ], ], 'Instance' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'HostIP' => [ 'title' => '实例所在的宿主机IP', 'description' => '实例所在的宿主机IP。', 'type' => 'string', 'example' => '11.0.XX.XX', ], 'HostName' => [ 'title' => '实例所在的宿主机名字', 'description' => '实例所在的宿主机名字。', 'type' => 'string', 'example' => 'smart-scene-cls-854dbdc99d-****', ], 'InnerIP' => [ 'title' => '实例的内网IP', 'description' => '实例的内网IP。', 'type' => 'string', 'example' => '172.17.0.17', ], 'InstanceName' => [ 'title' => '实例的名字', 'description' => '实例的名字。', 'type' => 'string', 'example' => 'foo-5fc8946767-v****', ], 'InstancePort' => [ 'title' => '实例的网络端口', 'description' => '实例的网络端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', ], 'LastState' => [ 'title' => '实例上一次退出的状态', 'description' => '实例上一次退出的状态。', 'type' => 'array', 'items' => [ 'description' => '状态详情。', 'type' => 'object', 'example' => '[]', ], ], 'Namespace' => [ 'title' => '实例的命名空间', 'description' => '实例的命名空间。', 'type' => 'string', 'example' => 'foo', ], 'Reason' => [ 'title' => '实例当前状态的标识', 'description' => '实例当前状态的标识。', 'type' => 'string', 'example' => 'RUNNING', ], 'RestartCount' => [ 'title' => '实例重启次数', 'description' => '实例重启次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Status' => [ 'title' => '实例状态', 'description' => '实例状态。', 'type' => 'string', 'enumValueTitles' => [ 'Terminating' => '结束中', 'Succeeded' => '成功结束', 'Unknown' => '未知', 'Failed' => '失败结束', 'Running' => '运行中', 'Pending' => '等待中', ], 'example' => 'Running', ], 'TotalProcesses' => [ 'title' => '实例总的进程数', 'description' => '实例总的进程数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ReadyProcesses' => [ 'title' => '实例已经启动完成的进程数', 'description' => '实例已经启动完成的进程数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'StartAt' => [ 'title' => '实例的启动时间', 'description' => '实例的启动时间。（弃用，使用StartTime代替）', 'type' => 'string', 'deprecated' => true, 'example' => '2021-05-27T09:46:05Z', ], 'Role' => [ 'title' => '实例所属的服务角色，包括Queue, DataLoader, Standard等角色', 'description' => '实例所属的服务角色，包括Queue, DataLoader, Standard等角色。', 'type' => 'string', 'example' => 'Standard', ], 'ResourceType' => [ 'title' => '实例所属的资源组类型，包括PublicResource和PrivateResource', 'description' => '实例所属的资源组类型，包括PublicResource和PrivateResource。', 'type' => 'string', 'example' => 'PublicResource', ], 'TenantInstanceIP' => [ 'title' => '实例所在的VPC分配的IP', 'description' => '实例所在的专属网络IP。', 'type' => 'string', 'example' => '192.168.xx.xx', ], 'TenantHostIP' => [ 'title' => '宿主机所在的vpc分配的地址', 'description' => '宿主机所在的专属网络IP。', 'type' => 'string', 'example' => '192.168.xx.xx', ], 'IsSpot' => [ 'title' => '是否为竞价实例', 'description' => '是否为竞价实例。', 'type' => 'boolean', 'example' => 'false', ], 'CurrentAmount' => [ 'title' => '竞价实例当前小时价', 'description' => '竞价实例当前小时价。', 'type' => 'number', 'format' => 'float', 'example' => '0.444', ], 'OriginalAmount' => [ 'title' => '竞价实例折前原价', 'description' => '竞价实例折前原价。', 'type' => 'number', 'format' => 'float', 'example' => '2.2', ], 'Isolated' => [ 'title' => '实例是否被隔离', 'description' => '实例是否承接流量。', 'type' => 'boolean', 'example' => 'false', ], 'Zone' => [ 'title' => '实例所属可用区', 'description' => '实例所属可用区。', 'type' => 'string', 'example' => 'cn-shanghai-a', ], 'ExternalIP' => [ 'title' => '实例在用户vpc中的ip地址', 'description' => '实例在用户VPC中的IP地址。', 'type' => 'string', 'example' => '192.168.1.100', ], 'ExternalInstancePort' => [ 'title' => '实例在用户vpc中的端口号', 'description' => '实例在用户VPC中的端口号。', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', ], 'StartTime' => [ 'title' => '实例的启动时间', 'description' => '实例的启动时间。', 'type' => 'string', 'example' => '2021-05-27T09:46:05Z', ], 'InstanceType' => [ 'title' => '实例规格', 'description' => '实例规格。', 'type' => 'string', 'example' => 'ecs.c7.large', ], 'IsLatest' => [ 'description' => '实例是否为最新版本。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'Detached' => [ 'description' => '实例是否被隔离。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'IsReplica' => [ 'description' => '实例是否是实例单元。', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'false', ], 'ReplicaName' => [ 'description' => '实例单元名称。', 'type' => 'string', 'example' => 'xwq-sglang-dist-7dff0', ], ], ], 'Resource' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '资源组的状态', 'description' => '资源组状态。', 'type' => 'string', 'example' => 'ResourceReady', ], 'PrePaidInstanceCount' => [ 'title' => '资源组预付费实例个数', 'description' => '预付费机器实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'Message' => [ 'title' => '资源组摘要信息', 'description' => '资源组最新消息。', 'type' => 'string', 'example' => 'Resource is ready', ], 'ClusterId' => [ 'title' => '资源组所在的集群', 'description' => '集群信息。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'ResourceName' => [ 'title' => '资源组名字', 'description' => '资源组名称。', 'type' => 'string', 'example' => 'iot', ], 'Memory' => [ 'title' => '资源组总内存，单位为 MB', 'description' => '资源组总内存，单位为 MB', 'type' => 'integer', 'format' => 'int32', 'example' => '8192', ], 'CreateTime' => [ 'title' => '资源组创建时间', 'description' => '创建时间。', 'type' => 'string', 'example' => '2019-02-26T17:52:49Z', ], 'ResourceType' => [ 'title' => '资源组类型', 'description' => '资源组的类型，取值如下：'."\n" .'- Dedicated：专属资源组。'."\n" .'- SelfManaged：用户自运维资源组。', 'type' => 'string', 'example' => 'Dedicated', ], 'PostPaidInstanceCount' => [ 'title' => '资源组按量付费实例个数', 'description' => '后付费机器实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'ExtraData' => [ 'title' => '资源组自定义数据', 'description' => '额外信息。', 'type' => 'object', 'example' => '{}', ], 'Vendor' => [ 'title' => '资源组机器来源', 'description' => '资源组机器来源。', 'type' => 'string', 'enumValueTitles' => [ 'ECS' => 'ECS通用算力', 'BareMetal' => '裸金属算力', ], 'example' => 'ECS', 'enum' => [ 'ECS', 'BareMetal', ], ], 'InstanceCount' => [ 'title' => '资源组实例个数', 'description' => '机器实例总数，等于预付费机器实例数加上后付费机器实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'CpuCount' => [ 'title' => '资源组CPU数量', 'description' => '资源组 CPU 总核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '64', ], 'InstanceMaxAllocatableCPU' => [ 'description' => '资源组单节点最大可分配CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'ResourceId' => [ 'title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'eas-r-asdasdasd', ], 'UpdateTime' => [ 'title' => '资源组更新时间', 'description' => '最后更新时间。', 'type' => 'string', 'example' => '2019-02-26T19:52:49Z', ], 'InstanceMaxAllocatableGPU' => [ 'description' => '资源组单节点最大可分配GPU数。', 'type' => 'number', 'format' => 'float', 'example' => '2', ], 'InstanceMaxAllocatableMemory' => [ 'description' => '资源组单节点最大可分配Memory大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', ], 'MemoryUsed' => [ 'title' => '资源组已使用内存，单位为 MB', 'description' => '资源组已使用内存，单位为 MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', ], 'Features' => [ 'description' => '资源组的功能集合，用于标识该资源组支持的特性。', 'type' => 'array', 'items' => [ 'description' => '资源组所支持的具体特性。目前只支持GpuShare(GPU共享)。', 'type' => 'string', 'example' => 'GpuShare', ], ], 'GpuCount' => [ 'title' => '资源组GPU个数', 'description' => '资源组 GPU 总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GpuUsed' => [ 'title' => '资源组已使用 GPU 数', 'description' => '资源组已使用 GPU 数。', 'type' => 'number', 'format' => 'float', 'example' => '1', ], 'CpuUsed' => [ 'title' => '资源组已使用 CPU 核数', 'description' => '资源组已使用 CPU 核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], ], ], 'ResourceInstance' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'InstanceId' => [ 'title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'eas-i-1800z74n30kao****', ], 'InstanceName' => [ 'title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'eas01122713204*****', ], 'InstanceIp' => [ 'title' => '实例IP', 'description' => '实例IP。', 'type' => 'string', 'example' => '11.227.XX.XX', ], 'InstanceStatus' => [ 'title' => '实例状态', 'description' => '实例状态。', 'type' => 'string', 'enumValueTitles' => [ 'Ready-SchedulingDisabled' => '不可调度', 'Ready' => '就绪', 'NotReady' => '未就绪', ], 'example' => 'Ready', ], 'InstancePhase' => [ 'type' => 'string', ], 'InstanceCpuCount' => [ 'title' => '实例的Cpu个数', 'description' => '实例的CPU个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'InstanceGpuCount' => [ 'title' => '实例的Gpu个数', 'description' => '实例的GPU个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'InstanceMemory' => [ 'title' => '实例的内存大小', 'description' => '实例的内存大小。', 'type' => 'string', 'example' => '8192M', ], 'InstanceSystemDiskSize' => [ 'title' => '实例的系统盘大小', 'description' => '实例的系统盘大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'InstanceGpuMemory' => [ 'title' => '实例的显存大小', 'description' => '实例的显存大小', 'type' => 'string', 'example' => '0G', ], 'InstanceUsedCpu' => [ 'title' => '实例已使用的CPU数量', 'description' => '实例被使用的CPU数量。', 'type' => 'number', 'format' => 'float', 'example' => '2.4', ], 'InstanceUsedGpu' => [ 'title' => '实例已使用的GPU数量', 'description' => '实例被使用的GPU数量。', 'type' => 'number', 'format' => 'float', 'example' => '0', ], 'InstanceUsedMemory' => [ 'title' => '实例已使用的内存大小', 'description' => '实例被使用的内存大小。', 'type' => 'string', 'example' => '1000M', ], 'InstanceType' => [ 'title' => '实例的机型', 'description' => '实例的机型。', 'type' => 'string', 'example' => 'ecs.s6-c1m2.xlarge', ], 'CreateTime' => [ 'title' => '实例的创建时间', 'description' => '实例的创建时间。', 'type' => 'string', 'example' => '2020-07-05T22:51:32Z', ], 'ChargeType' => [ 'title' => '实例的计费类型', 'description' => '实例的计费类型。', 'type' => 'string', 'example' => 'PrePaid', ], 'ExpiredTime' => [ 'title' => '实例过期时间', 'description' => '实例过期时间。', 'type' => 'string', 'example' => '2020-08-05T22:51:32Z', ], 'AutoRenewal' => [ 'title' => '实例是否自动续费', 'description' => '实例是否自动续费。', 'type' => 'boolean', 'example' => 'false', ], 'Arch' => [ 'title' => '实例系统架构', 'description' => '实例系统架构。', 'type' => 'string', 'example' => 'arm64', ], 'Region' => [ 'title' => '实例所属区域', 'description' => '实例所属区域。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Zone' => [ 'title' => '实例所属可用区', 'description' => '实例所属可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-b', ], 'ResourceId' => [ 'title' => '实例所属资源组ID', 'description' => '实例所属资源组ID', 'type' => 'string', 'example' => 'eas-r-xxxxx', ], 'InstanceTenantIp' => [ 'title' => '实例专属网络IP', 'description' => '实例专属网络IP。', 'type' => 'string', 'example' => '192.168.XX.XX', ], 'InstanceUsedGpuMemory' => [ 'title' => '实例已使用的显存大小', 'description' => '实例已使用的显存大小。', 'type' => 'string', 'example' => '470M', ], 'Labels' => [ 'title' => '实例标签', 'description' => '实例标签', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'LabelKey' => [ 'title' => '实例标签键', 'description' => '实例标签键', 'type' => 'string', 'example' => 'key', ], 'LabelValue' => [ 'title' => '实例标签值', 'description' => '实例标签值', 'type' => 'string', 'example' => 'value', ], ], ], ], 'LastCordonOperator' => [ 'title' => '最后一次停止调度操作人。', 'description' => '最后一次停止调度操作人。', 'type' => 'string', ], 'LastCordonReason' => [ 'title' => '最后一次停止调度操作原因。', 'description' => '最后一次停止调度操作原因。', 'type' => 'string', ], ], ], 'ResourceInstanceWorker' => [ 'title' => 'A short description of struct', 'description' => 'A short description of struct', 'type' => 'object', 'properties' => [ 'Name' => [ 'title' => 'pod名', 'description' => '服务实例的名字。', 'type' => 'string', 'example' => 'test-india-5bbbfdbc98-****', ], 'ServiceName' => [ 'title' => '服务名', 'description' => '服务的名字。', 'type' => 'string', 'example' => 'test-in****', ], 'Status' => [ 'title' => 'pod状态', 'description' => '实例的状态。', 'type' => 'string', 'enumValueTitles' => [ 'Terminating' => '结束中', 'Succeeded' => '成功运行', 'Unknown' => '未知', 'Failed' => '失败结束', 'Running' => '运行中', 'Pending' => '等待中', ], 'example' => 'Running', ], 'Ready' => [ 'title' => '是否ready', 'description' => '是否已就绪。', 'type' => 'boolean', 'example' => 'true', ], 'CpuRequest' => [ 'title' => 'CpuRequest', 'description' => '申请的CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GpuRequest' => [ 'title' => 'GpuRequest', 'description' => '申请的GPU数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'MemoryRquest' => [ 'title' => 'MemoryRquest', 'description' => '申请的内存数。', 'type' => 'integer', 'format' => 'int32', 'example' => '200', ], 'CpuLimit' => [ 'title' => 'CpuLimit', 'description' => '限制的CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'GpuLimit' => [ 'title' => 'GpuLimit', 'description' => '限制的GPU数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'MemoryLimit' => [ 'title' => 'MemoryLimit', 'description' => '限制的内存数。', 'type' => 'integer', 'format' => 'int32', 'example' => '400', ], 'RestartCount' => [ 'title' => 'RestartCount', 'description' => '重启次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'StartTime' => [ 'title' => 'StartTime', 'description' => '启动时间。', 'type' => 'string', 'example' => '2021-05-09T09:56:19Z', ], ], ], 'Service' => [ 'title' => 'A short description of struct', 'description' => '服务详情。', 'type' => 'object', 'properties' => [ 'ServiceGroup' => [ 'title' => '服务所在分组', 'description' => '服务所在分组。', 'type' => 'string', 'example' => 'my_group', ], 'Memory' => [ 'title' => '每个worker需要的内存大小，单位为M', 'description' => '每个实例申请的内存，单位为MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', ], 'Cpu' => [ 'title' => '每个实例申请的cpu', 'description' => '每个实例申请的CPU。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Image' => [ 'title' => '服务的数据镜像', 'description' => '服务的数据镜像。', 'type' => 'string', 'example' => 'registry.cn-shanghai.aliyuncs.com/eas/echo_cn-shanghai:v0.0.1-20210129111320', ], 'Gpu' => [ 'title' => '每个实例申请的gpu', 'description' => '每个实例申请的GPU。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TotalInstance' => [ 'title' => '服务的所有实例总个数', 'description' => '服务的所有实例总个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'AccessToken' => [ 'title' => '服务的请求Token', 'description' => '服务的请求Token。', 'type' => 'string', 'example' => 'MzJiMDI5MDliODc0MTlkYmI0ZDhlYmExYjczYTIyZTE3Zm********', ], 'ResourceBurstable' => [ 'description' => '服务是否开启弹性资源池', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'InternetEndpoint' => [ 'title' => '服务的公网endpoint', 'description' => '服务的公网Endpoint。该字段仅在DescribeService接口中返回。', 'type' => 'string', 'example' => 'http://10123*****.cn-shanghai.aliyuncs.com/api/predict/echo', ], 'ResourceAlias' => [ 'title' => '服务所在的资源组别名', 'description' => '服务所在的资源组别名。', 'type' => 'string', 'example' => 'my_resource', ], 'Status' => [ 'title' => '服务的状态', 'description' => '服务的状态。', 'type' => 'string', 'enumValueTitles' => [ 'Creating' => '创建中', 'Deploying' => '等待中（等待部署完毕）', 'Stopped' => '已停止', 'Failed' => '部署失败', 'Updating' => '升级中（实例会被更新）', 'Stopping' => '停止中', 'Waiting' => '等待中（等待实例启动完毕）', 'HotUpdate' => '升级中（热更新，不更新实例）', 'Starting' => '启动中', 'DeleteFailed' => '删除失败', 'Running' => '运行中', 'Scaling' => '升级中（实例扩缩容中）', 'Pending' => '等待中（等待具体处理）', 'Deleting' => '删除中', ], 'example' => 'Running', ], 'TrafficState' => [ 'title' => '流量状态', 'description' => '流量状态', 'type' => 'string', 'enumValueTitles' => [ 'standalone' => '独立接入流量', 'grouping' => '接入分组流量', ], 'example' => 'standalone', ], 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82********', ], 'Resource' => [ 'title' => '服务所在的资源组', 'description' => '服务所在的资源组。', 'type' => 'string', 'example' => 'eas-r-xxxxxxx', ], 'SecondaryInternetEndpoint' => [ 'title' => '异步服务同步请求的公网Endpoint', 'description' => '异步服务同步请求的公网Endpoint。该字段仅在DescribeService接口中返回。', 'type' => 'string', 'example' => 'http://10123*****.cn-shanghai.aliyuncs.com/api/predict/async_path.echo'."\n", ], 'Labels' => [ 'title' => '服务标签列表', 'description' => '服务标签列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'LabelValue' => [ 'title' => '服务标签值', 'description' => '服务标签值。', 'type' => 'string', 'example' => 'value1', ], 'LabelKey' => [ 'title' => '服务标签键', 'description' => '服务标签键。', 'type' => 'string', 'example' => 'key1', ], ], ], ], 'Namespace' => [ 'title' => '服务所在的命名空间', 'description' => '服务所在的命名空间。', 'type' => 'string', 'example' => 'echo', ], 'Weight' => [ 'title' => '服务灰度发布的权重值', 'description' => '服务灰度发布的权重值。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'Role' => [ 'title' => '服务角色', 'description' => '服务角色。', 'type' => 'string', 'example' => 'Queue', ], 'SecondaryIntranetEndpoint' => [ 'title' => '异步服务同步请求的内网Endpoint', 'description' => '异步服务同步请求的内网Endpoint。该字段仅在DescribeService接口中返回。', 'type' => 'string', 'example' => 'http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/async_path.echo'."\n", ], 'PendingInstance' => [ 'title' => '被挂起的服务的实例个数', 'description' => '被挂起的服务的实例个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'ServiceName' => [ 'title' => '服务的名字', 'description' => '服务的名称。', 'type' => 'string', 'example' => 'echo', ], 'SafetyLock' => [ 'title' => '服务安全锁', 'description' => '服务安全锁。', 'type' => 'string', 'enumValueTitles' => [ 'all' => '禁止所有操作', 'dangerous' => '禁止删除/停止服务', 'none' => '不加锁', ], 'example' => 'dangerous', 'enum' => [ 'none', 'dangerous', 'all', ], ], 'Region' => [ 'title' => '服务所在的区域', 'description' => '服务所在的区域。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'AppType' => [ 'title' => '应用服务类型', 'description' => '应用服务类型', 'type' => 'string', 'example' => 'LLM', ], 'InstanceCountInResource' => [ 'description' => '实例在各个资源类型上的数量分布', 'type' => 'object', 'properties' => [ 'Quota' => [ 'description' => '使用灵骏quota的实例数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Public' => [ 'description' => '使用公共资源组的实例数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'Dedicated' => [ 'description' => '使用专属资源组、自运维资源组的实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], ], ], 'IntranetEndpoint' => [ 'title' => '服务内网endpoint', 'description' => '服务内网Endpoint。该字段仅在DescribeService接口中返回。', 'type' => 'string', 'example' => 'http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/echo', ], 'QuotaId' => [ 'description' => '服务的配额 Id。只有部署在灵骏资源配额上的服务才会有此信息。', 'type' => 'string', 'example' => 'quotaxxxxx', ], 'Message' => [ 'title' => '服务的摘要信息', 'description' => '服务的摘要信息。', 'type' => 'string', 'example' => 'Service start successfully', ], 'CurrentVersion' => [ 'title' => '当前运行的模型版本', 'description' => '当前运行的模型版本。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'RunningInstance' => [ 'title' => '正在运行的服务的实例个数', 'description' => '正在运行的服务的实例个数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'WorkspaceId' => [ 'title' => '服务所属工作空间ID', 'description' => '服务所属工作空间ID', 'type' => 'string', 'example' => '123445', ], 'CallerUid' => [ 'title' => '服务创建账号的UID', 'description' => '服务创建账号的UID。', 'type' => 'string', 'example' => '20123*******', ], 'Reason' => [ 'title' => '服务的状态信息', 'description' => '服务的状态原因。', 'type' => 'string', 'example' => 'RUNNING', ], 'Source' => [ 'title' => '服务的部署来源', 'description' => '服务的部署来源。', 'type' => 'string', 'example' => 'dsw', ], 'ServiceId' => [ 'title' => '服务ID', 'description' => '服务的唯一ID。', 'type' => 'string', 'example' => 'eas-m-xxasdat', ], 'AppVersion' => [ 'title' => '应用服务版本', 'description' => '应用服务版本', 'type' => 'string', 'example' => 'v1', ], 'CronscalerEnabled' => [ 'description' => '服务是否开启定时扩缩容', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'ServiceConfig' => [ 'title' => '服务的配置信息', 'description' => '服务的配置信息。', 'type' => 'string', 'example' => '{"metadata":{"cpu":1,"instance":1,"memory":1024},"name":"echo","processor_entry":"libecho.so","processor_path":"http://oss-cn-hangzhou-zmf.aliyuncs.com/059247/echo_processor_release.tar.gz","processor_type":"cpp"}', ], 'Gateway' => [ 'description' => '服务的专属网关 Id。只有绑定了专属网关的服务才有此信息。', 'type' => 'string', 'example' => 'gw-xxxxxx', ], 'AppSpecName' => [ 'title' => '应用服务规格名称', 'description' => '应用服务规格名称', 'type' => 'string', 'example' => 'llama_7b_fp16', ], 'GPUCorePercentage' => [ 'description' => '开启GPU共享之后，每个实例所申请的GPU算力大小', 'type' => 'integer', 'format' => 'int32', 'example' => '50', ], 'GPUMemory' => [ 'description' => '开启GPU共享后，每个实例所申请的GPU显存大小', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'AppConfig' => [ 'title' => '应用服务配置信息', 'description' => '应用服务配置信息', 'type' => 'string', 'example' => '{"ModelStorage":"oss"}', ], 'CreateTime' => [ 'title' => '服务的创建时间', 'description' => '服务的创建时间。UTC时间，RFC3339格式。', 'type' => 'string', 'example' => '2021-01-29T11:13:20Z', ], 'AutoscalerEnabled' => [ 'description' => '服务是否开启弹性伸缩', 'type' => 'boolean', 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], 'ExtraData' => [ 'title' => '服务的额外信息', 'description' => '服务的额外信息。', 'type' => 'string', 'example' => '{"blue_green_services":["test","testxxxx"]}', ], 'LatestVersion' => [ 'title' => '服务最新版本号', 'description' => '服务最新版本号。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'UpdateTime' => [ 'title' => '服务的更新时间', 'description' => '服务的更新时间。UTC时间，RFC3339格式。', 'type' => 'string', 'example' => '2021-01-29T11:13:20Z', ], 'ServiceUid' => [ 'title' => '服务ID，同ServiceId', 'description' => '服务ID，同ServiceId。', 'type' => 'string', 'example' => 'eas-m-xxasdat'."\n", ], 'ParentUid' => [ 'title' => '服务创建账号的主账号UID', 'description' => '服务创建账号的主账号UID。', 'type' => 'string', 'example' => '11234*******', ], 'RoleAttrs' => [ 'title' => '服务角色额外属性', 'description' => '服务角色额外属性。该字段仅在DescribeService接口中返回。', 'type' => 'string', 'example' => '{"ApproxMaxLength":null,"Length":null,"MaxPayloadBytes":null}', ], ], ], ], ], 'apis' => [ 'CreateService' => [ 'summary' => '创建PAI-EAS服务。', 'path' => '/api/v2/services', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '37002', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '请求body。其中关键请求参数配置说明，请参见下方的**表 1. 请求 Body 参数**和**表 2. metadata 参数**。更多参数配置详情，请参见[服务模型所有相关参数说明](~~450525~~)。', 'type' => 'string', 'required' => false, 'example' => '镜像部署服务：'."\n" .'{'."\n" .' "name": "foo",'."\n" .' "metadata": {'."\n" .' "instance": 2,'."\n" .' "memory": 7000,'."\n" .' "cpu": 4'."\n" .' },'."\n" .' "containers": ['."\n" .' {'."\n" .' "image": "****",'."\n" .' "script": "**** --listen=0.0.0.0 --server_port=8000 --headless",'."\n" .' "port": 8000'."\n" .' }'."\n" .' ],'."\n" .' "storage": ['."\n" .' {'."\n" .' "oss": {'."\n" .' "path": "oss://examplebuket/data111/",'."\n" .' "readOnly": false'."\n" .' },'."\n" .' "properties": {'."\n" .' "resource_type": "model"'."\n" .' },'."\n" .' "mount_path": "/data"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'镜像部署AI-Web应用：'."\n" .'{'."\n" .' "name": "foo",'."\n" .' "metadata": {'."\n" .' "instance": 1,'."\n" .' "memory": 7000,'."\n" .' "cpu": 4,'."\n" .' "enable_webservice": true'."\n" .' },'."\n" .' "containers": ['."\n" .' {'."\n" .' "image": "****",'."\n" .' "script": "**** --listen=0.0.0.0 --server_port=8000 --headless",'."\n" .' "port": 8000'."\n" .' }'."\n" .' ],'."\n" .' "storage": ['."\n" .' {'."\n" .' "oss": {'."\n" .' "path": "oss://examplebucket/data111/",'."\n" .' "readOnly": false'."\n" .' },'."\n" .' "properties": {'."\n" .' "resource_type": "model"'."\n" .' },'."\n" .' "mount_path": "/data"'."\n" .' }'."\n" .' ]'."\n" .'}'."\n" .'模型+processor部署服务：'."\n" .'{'."\n" .' "metadata": {'."\n" .' "instance": 1,'."\n" .' "memory": 7000,'."\n" .' "cpu": 4'."\n" .' },'."\n" .' "name": "foo",'."\n" .' "model_config": {},'."\n" .' "processor_type": "python",'."\n" .' "processor_path": "oss://****",'."\n" .' "processor_entry": "a.py",'."\n" .' "model_path": "oss://****"'."\n" .'}', ], ], [ 'name' => 'Develop', 'in' => 'query', 'schema' => [ 'title' => '是否进入开发模式。', 'description' => '是否进入开发模式。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'true' => '进入开发模式', 'false' => '不进入开发模式', ], 'example' => 'true', ], ], [ 'name' => 'Labels', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '用户自定义标签。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '标签。', 'example' => '{"key":"value"}', ], ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '123456', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ServiceId' => [ 'description' => '新创建服务的服务ID。', 'type' => 'string', 'example' => 'eas-m-aaxxxddf', ], 'ServiceName' => [ 'description' => '新创建服务的服务名字。', 'type' => 'string', 'example' => 'yourname', ], 'Status' => [ 'description' => '新服务的当前状态。', 'type' => 'string', 'example' => 'Creating', ], 'Region' => [ 'description' => '新创建服务所属的区域ID。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'InternetEndpoint' => [ 'description' => '新创建服务的公网Endpoint。', 'type' => 'string', 'example' => 'http://pai-eas.vpc.cn-shanghai.****', ], 'IntranetEndpoint' => [ 'description' => '新创建服务的内网Endpoint。', 'type' => 'string', 'example' => 'http://pai-eas.cn-shanghai.****', ], ], ], ], 400 => [], 403 => [], 409 => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ServiceId\\": \\"eas-m-aaxxxddf\\",\\n \\"ServiceName\\": \\"yourname\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"InternetEndpoint\\": \\"http://pai-eas.vpc.cn-shanghai.****\\",\\n \\"IntranetEndpoint\\": \\"http://pai-eas.cn-shanghai.****\\"\\n}","type":"json"}]', 'title' => '创建服务', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', 'requestParamsDescription' => '**表 1. 请求Body参数**'."\n" ."\n" .'|名称|类型|是否必选|说明|'."\n" .'|---|---|---|---|'."\n" .'|name|String|是|服务名称，在同一个地域内全局唯一。|'."\n" .'|token|String|否|指定用于访问鉴权的Token字符串，若不指定则按**generate_token**自动生成。|'."\n" .'|model_path|String|否|模型相关的文件，支持HTTP和OSS两种格式，HTTP地址需为Public可访问的。若为OSS地址，则输入可以是目录或者文件；若文件为`.tar.gz`、`.tar.bz2`、`.zip`等压缩包，会自动解压。|'."\n" .'|role_arn|string|否|**model_path**或**processor_path**为OSS地址时，需要指定用于OSS授权的role_arn，role_arn的获取参数Role_ARN。|'."\n" .'|oss_endpoint|String|否|**model_path**或**processor_path**为OSS地址时，需要指定OSS Bucket对应的endpoint。|'."\n" .'|model_entry|String|否|模型的入口文件，若不指定，则使用**model_path**中的文件名，可以包含任意文件，主文件的路径会传递给Processor中的`Load()`函数。|'."\n" .'|processor_path|String|是|Processor相关的文件包，支持本地文件和HTTP链接地址，若文件为`.tar.gz`、`.tar.bz2`、`.zip`等压缩包，会自动解压。|'."\n" .'|processor_entry|String|否|**C、C++、Python类型必选**。Processor的主文件，其中包含了预测所需要`Load()`函数和`Process()`函数的实现。|'."\n" .'|processor_mainclass|String|否|**Java类型必选**。Processor的主文件，JAR包中的mainclass。|'."\n" .'|processor_type|String|是|processor实现的语言，目前已支持C、C++、Java、Python。|'."\n" .'|metadata|Dict|否|服务的meta信息。详见下表2。|'."\n" .'|cloud|Dict|否|目前只有指定机型部署时会用到，传参的样式为`"cloud":{"computing":{"instance_type": "ecs.gxxxxxx.large"}}`。|'."\n" .'|containers|List|否|自定义镜像部署。如果Processor部署无法满足需求，可以使用自定义镜像部署，详情请参见[服务部署：自定义镜像](~~258246~~)。|'."\n" .'>model_path和processor_path为输入模型数据和processor数据的数据来源，支持HTTP和OSS两种数据源，使用test命令进行本地调试时支持本地文件和目录。'."\n" .'- 若使用HTTP地址，则需要将相关文件打包成.tar.gz、.tar.bz2、.zip等压缩包，可上传至OSS并生成HTTP地址。'."\n" .'- 若使用OSS地址，则输入可以是目录，也可以是文件。'."\n" ."\n\n" .'**表 2. metadata参数**'."\n" .'|名称|类型|是否必选|描述|示例值|'."\n" .'|---|---|---|---|---|'."\n" .'|instance|Int|否|服务启动的Worker数目。|1|'."\n" .'|cpu|Int|否|每个Worker需要的CPU数目。|1|'."\n" .'|gpu|Int|否|每个Worker需要的GPU数目。|0|'."\n" .'|memory|Int|否|每个Worker需要的内存大小，单位为MB。|1000|'."\n" .'|resource|String|否|服务所属的资源组。|eas-r-aaabbbccc|'."\n" .'|rpc.worker_threads|Int|否|每个Instance中用于并发处理请求的线程数。|5|'."\n" .'|rpc.max_queue_size|Int|否|请求处理时队列的最大长度，队列满时新请求会被以450状态码丢弃。|64|'."\n" .'|rpc.keepalive|Int|否|请求的超时时间，单位为毫秒。|5000|'."\n" .'|rpc.rate_limit|Int|否|单实例请求限流的QPS值，单实例QPS超出该值后的请求会被返回429丢弃。|0|'."\n" .'|release|Bool|否|若为true，则要创建一个灰度发布服务。|false|', ], 'CreateServiceAutoScaler' => [ 'summary' => '开通服务自动扩缩容功能，为服务创建自动扩缩控制器。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/autoscaler', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'min' => [ 'title' => '最小 replica 数，需要大于0', 'description' => '最小实例数，需要大于0。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], 'max' => [ 'title' => '最大 replica 数，需要大于MinReplica', 'description' => '最大实例数，需要大于Min Replica。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8', ], 'scaleStrategies' => [ 'description' => '伸缩策略列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'metricName' => [ 'description' => '指标名称，取值如下：'."\n" .'- qps：单实例qps伸缩阈值。'."\n" .'- cpu：cpu利用率阈值。'."\n" .'- gpu[util]：gpu利用率阈值。', 'type' => 'string', 'required' => true, 'example' => 'qps', ], 'threshold' => [ 'description' => '触发自动伸缩阈值。'."\n" .'- 指标名称配置为qps：当单实例的平均qps大于该值时会触发扩容。'."\n" .'- 指标名称配置为cpu：当单实例的平均cpu使用率大于该值时会触发扩容。'."\n" .'- 指标名称配置为gpu[util]：当单实例的平均gpu使用率大于该值时会触发扩容。', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '10', ], 'service' => [ 'description' => '指标所属服务，不配置默认为当前服务。', 'type' => 'string', 'required' => false, 'example' => 'demo_svc', ], ], 'required' => false, ], 'required' => true, ], 'behavior' => [ 'description' => '自动扩缩容时的行为。', 'type' => 'object', 'properties' => [ 'scaleUp' => [ 'description' => '扩容时的行为。', 'type' => 'object', 'properties' => [ 'stabilizationWindowSeconds' => [ 'description' => '扩容稳定窗口期时间，默认值为0。'."\n" .'只有当过去一段时间内的指标均满足条件，才会执行扩容。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], 'required' => false, ], 'scaleDown' => [ 'description' => '缩容时的行为。', 'type' => 'object', 'properties' => [ 'stabilizationWindowSeconds' => [ 'description' => '缩容稳定窗口期时间，默认值为300。'."\n" .'只有当过去一段时间内的指标均不满足条件，才会执行缩容。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', ], ], 'required' => false, ], 'onZero' => [ 'description' => '缩容到0时的行为。', 'type' => 'object', 'properties' => [ 'scaleDownGracePeriodSeconds' => [ 'description' => '缩容到0之前的等待期。'."\n" .'当指标满足缩容到0的条件时，需要经过等待期的时间，才会执行缩容到0。默认值为600。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600', ], 'scaleUpActivationReplicas' => [ 'description' => '当从0开始扩容时，一次性创建的实例数。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Succeed to auto scale service [foo]', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Succeed to auto scale service [foo]\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '开通服务自动扩缩容', ], 'CreateServiceCronScaler' => [ 'summary' => '开通服务定时扩缩容功能。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/cronscaler', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123919', 'abilityTreeNodes' => [ 'FEATURElearnZ3WNW7', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'ScaleJobs' => [ 'title' => '定时伸缩任务描述', 'description' => '定时伸缩任务描述。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TargetSize' => [ 'title' => '执行伸缩任务的目标replica', 'description' => '执行伸缩任务的目标实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'Schedule' => [ 'title' => '要执行伸缩任务的cron表达式', 'description' => '要执行伸缩任务的Cron表达式。如何配置Cron表达式，请参见**请求参数补充说明**章节。', 'type' => 'string', 'required' => true, 'example' => '0 18 * * * *', ], 'Name' => [ 'description' => '定时扩缩容任务名称。', 'type' => 'string', 'required' => false, 'example' => 'scale-job-1', ], 'TimeZone' => [ 'description' => '时区配置，用于解析定时伸缩任务的执行时间', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', ], ], 'required' => false, ], 'required' => true, ], 'ExcludeDates' => [ 'title' => '需要排除的时间点的cron表达式', 'description' => '需要排除的时间点的Cron表达式列表。', 'type' => 'array', 'items' => [ 'description' => 'Cron表达式。如何配置Cron表达式，请参见**请求参数补充说明**章节。', 'type' => 'string', 'required' => false, 'example' => '* * * * * 0,6', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回body。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '操作成功消息', 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Create cron scaler for service [foo] successfully', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Create cron scaler for service [foo] successfully\\"\\n}","type":"json"}]', 'title' => '开通服务定时扩缩容', 'requestParamsDescription' => '### Cron表达式'."\n" .'![未命名绘图.drawio.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/72178/1645094436048-953c2592-1017-4597-855d-22e6e78afee0.png#clientId=ua661de8e-75b1-4&crop=0&crop=0&crop=1&crop=1&from=ui&height=120&id=ufb1b2c04&margin=%5Bobject%20Object%5D&name=%E6%9C%AA%E5%91%BD%E5%90%8D%E7%BB%98%E5%9B%BE.drawio.png&originHeight=215&originWidth=547&originalType=binary&ratio=1&rotation=0&showTitle=false&size=17762&status=done&style=none&taskId=ue641ee0e-20dd-462b-ae2e-102a58eae0e&title=&width=305)'."\n" ."\n" .'| 名称 | 可用值 | 可用特殊符号 |'."\n" .'| --- | --- | --- |'."\n" .'| 秒 | 0-59 | * / , - |'."\n" .'| 分 | 0-59 | * / , - |'."\n" .'| 小时 | 0-23 | * / , - |'."\n" .'| 日 | 1-31 | * / , - |'."\n" .'| 月 | 1-12 或 JAN-DEC | * / , - |'."\n" .'| 星期 | 0-6 或 SUN-SAT | * / , - |'."\n" ."\n" .'#### 特殊符号说明'."\n" .'**星号(*)**'."\n" .'星号代表任意值，例如：0 0 0 1 * * 代表每月1号的0点整。'."\n" .'​'."\n" ."\n" .'**连字符(-)**'."\n" .'连字符代表一段连续的取值范围，例如：0 0 12-14 * * * 代表每天的12:00、13:00和14:00。'."\n" .'​'."\n" ."\n" .'**逗号(,)**'."\n" .'逗号代表一段取值范围，例如：0 0 12,14 * * * 代表每天的12:00和14:00。'."\n" .'​'."\n" ."\n" .'**斜杠(/)**'."\n" .'斜杠用来代表一段增量的区间，例如：0 */15 * * * * 代表每小时的 0分、15分、30分和45分。'."\n" .'斜杠可以和连字符配合使用，例如：0 5-40/15 * * * * 代表每小时从5分到40分钟之间，每隔15分钟取一个值，有效时间点可以是0:05, 0:20, 0:35。', ], 'CreateServiceMirror' => [ 'summary' => '开启服务流量镜像功能，可以将一个服务接受到的请求镜像到另一个服务上。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/mirror', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域。例如华东2（上海）为cn-shanghai。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Ratio' => [ 'title' => '比例 [0, 100]', 'description' => '比例0~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], 'Target' => [ 'title' => '服务实例列表', 'description' => '服务实例列表。', 'type' => 'array', 'items' => [ 'description' => '目标服务名称。', 'type' => 'string', 'required' => false, 'example' => 'echo', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Traffic mirroring is ON for service [foo] in region [cn-shanghai], ratio [70%]', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Traffic mirroring is ON for service [foo] in region [cn-shanghai], ratio [70%]\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '开通服务流量镜像', ], 'CreateAppService' => [ 'summary' => '介绍如何创建应用服务，获取大模型推理能力。', 'path' => '/api/v2/app_services', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '12****', ], ], [ 'name' => 'QuotaId', 'in' => 'query', 'schema' => [ 'description' => '归属额度ID。', 'type' => 'string', 'required' => false, 'example' => 'abcdef', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'ServiceName' => [ 'description' => '服务名字。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], 'AppType' => [ 'description' => '应用服务类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'LLM' => 'LLM', ], 'example' => 'LLM', ], 'AppVersion' => [ 'description' => '应用版本。', 'type' => 'string', 'required' => false, 'example' => 'v1', ], 'ServiceSpec' => [ 'description' => '服务规格。取值如下：'."\n" .'- llama_7b_fp16'."\n" .'- llama_7b_int8'."\n" .'- llama_13b_fp16'."\n" .'- llama_7b_int8'."\n" .'- chatglm_6b_fp16'."\n" .'- chatglm_6b_int8'."\n" .'- chatglm2_6b_fp16'."\n" .'- baichuan_7b_int8'."\n" .'- baichuan_13b_fp16'."\n" .'- baichuan_7b_fp16', 'type' => 'string', 'required' => true, 'example' => 'llama_7b_fp16', ], 'Replicas' => [ 'description' => '实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], 'Config' => [ 'description' => '部署时需要的其他配置信息。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'example' => ' { "ModelStorage": "oss", "OssPath": "oss://examplebucket/xxxx/" }', 'description' => '模型挂载等应用信息。支持以下两种挂载方式：'."\n" .'- OSS挂载，参数配置如下：'."\n" .'{'."\n" .' "ModelStorage": "oss",'."\n" .' "OssPath": "oss://examplebucket/xxxx/"'."\n" .'} '."\n" .'- NAS挂载，参数配置如下：'."\n" .'{'."\n" .' "ModelStorage": "nas",'."\n" .' "NasMountTarget": "317d14****-****.cn-shanghai.nas.aliyuncs.com",'."\n" .' "NasPath": "/",'."\n" .' "SecurityGroupID": "sg-uf6e50fazt4u7smt****",'."\n" .' "VpcID": "vpc-uf66zxxrlv0l4nj49****",'."\n" .' "VswitchID": "vsw-uf6fg76uu2bx84tci****"'."\n" .'} '."\n" .'其中关键参数说明如下：'."\n" .'- ModelStorage：表示挂载方式。'."\n" .'- OssPath：表示模型所在的OSS Bucket目录。'."\n" .'- NasMountTarget：表示NAS挂载点。'."\n" .'- NasPath：表示NAS源路径。'."\n" .'- SecurityGroupID：表示创建NAS文件系统使用的安全组ID。'."\n" .'- VpcID：表示创建NAS文件系统使用的专有网络VPC ID。'."\n" .'- VswitchID：表示创建NAS文件系统使用的交换机ID。', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ServiceId' => [ 'description' => '服务ID。', 'type' => 'string', 'example' => 'eas-m-aaxxxddf', ], 'ServiceName' => [ 'description' => '服务名字。', 'type' => 'string', 'example' => 'foo', ], 'Status' => [ 'description' => '服务的状态。', 'type' => 'string', 'example' => 'Creating', ], 'Region' => [ 'description' => '服务所在的区域。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'InternetEndpoint' => [ 'description' => '服务的公网Endpoint。', 'type' => 'string', 'example' => 'http://pai-eas.cn-shanghai.****', ], 'IntranetEndpoint' => [ 'description' => '服务内网Endpoint。', 'type' => 'string', 'example' => 'http://pai-eas-vpc.cn-shanghai.****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ServiceId\\": \\"eas-m-aaxxxddf\\",\\n \\"ServiceName\\": \\"foo\\",\\n \\"Status\\": \\"Creating\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"InternetEndpoint\\": \\"http://pai-eas.cn-shanghai.****\\",\\n \\"IntranetEndpoint\\": \\"http://pai-eas-vpc.cn-shanghai.****\\"\\n}","type":"json"}]', 'title' => '创建应用服务', ], 'DescribeGroupEndpoints' => [ 'summary' => '获取群组端点列表。', 'path' => '/api/v2/groups/{ClusterId}/{GroupName}/endpoints', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '254853', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '区域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'GroupName', 'in' => 'path', 'schema' => [ 'description' => '群组名称。如何获取群组名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'xx_test_group', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '890772EF-3AD6-129A-8E15-8F349C944783', ], 'Message' => [ 'description' => '返回结果说明。', 'type' => 'string', 'example' => '执行成功。', ], 'AccessToken' => [ 'description' => '服务Token。', 'type' => 'string', 'example' => 'Nzc5N2FhNTM4OTQ0YzBmYTIy****ZTUxN2NkYjg4MTJmMWQxZmY1****', ], 'Endpoints' => [ 'description' => '群组端点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'description' => '服务端点接入方式，可能值为：'."\n" .'- DefaultGateway：共享网关。'."\n" .'- PrivateGateway：专属网关。'."\n" .'- Nlb：挂载NLB。'."\n" .'- Nacos：挂载Nacos。', 'type' => 'string', 'example' => 'PrivateGateway', ], 'BackendId' => [ 'description' => '后端接入ID，取决于EndpointType：'."\n" .'- DefaultGateway：为default。'."\n" .'- PrivateGateway：为专属网关ID。'."\n" .'- Nlb：为NLB实例ID。'."\n" .'- Nacos：为Nacos实例ID。', 'type' => 'string', 'example' => 'gw-26340kjxjx8l3r****', ], 'PathType' => [ 'description' => '地址类型，可能值为：'."\n" .'- Group：服务群组地址。', 'type' => 'string', 'example' => 'Group', ], 'IntranetEndpoints' => [ 'description' => '完整的访问地址。', 'type' => 'array', 'items' => [ 'description' => '完整的访问地址。', 'type' => 'string', 'example' => 'http://gw-26340kjxjx8l3r****-vpc.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/xx_test_group', ], ], 'InternetEndpoints' => [ 'description' => '完整的访问地址。', 'type' => 'array', 'items' => [ 'description' => '完整的访问地址。', 'type' => 'string', 'example' => 'http://gw-26340kjxjx8l3r****.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/xx_test_group', ], ], 'Port' => [ 'description' => '端口。仅挂载NlB和Nacos时，Port才有值。', 'type' => 'integer', 'format' => 'int32', 'example' => '8080', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"890772EF-3AD6-129A-8E15-8F349C944783\\",\\n \\"Message\\": \\"执行成功。\\",\\n \\"AccessToken\\": \\"Nzc5N2FhNTM4OTQ0YzBmYTIy****ZTUxN2NkYjg4MTJmMWQxZmY1****\\",\\n \\"Endpoints\\": [\\n {\\n \\"EndpointType\\": \\"PrivateGateway\\",\\n \\"BackendId\\": \\"gw-26340kjxjx8l3r****\\",\\n \\"PathType\\": \\"Group\\",\\n \\"IntranetEndpoints\\": [\\n \\"http://gw-26340kjxjx8l3r****-vpc.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/xx_test_group\\"\\n ],\\n \\"InternetEndpoints\\": [\\n \\"http://gw-26340kjxjx8l3r****.cn-hangzhou.pai-eas.aliyuncs.com/api/predict/xx_test_group\\"\\n ],\\n \\"Port\\": 8080\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取群组端点列表', ], 'DescribeServiceEndpoints' => [ 'summary' => '获取服务端点列表。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/endpoints', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '251429', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '区域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何获取服务名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'service_name', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '739998B5-FB39-12A3-8323-0FA340317298', ], 'Message' => [ 'description' => '返回结果说明。', 'type' => 'string', 'example' => '执行成功。', ], 'AccessToken' => [ 'description' => '服务Token。', 'type' => 'string', 'example' => 'Nzc5N2FhN****TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1****', ], 'Endpoints' => [ 'description' => '服务端点列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndpointType' => [ 'description' => '服务端点接入方式，可能值为：'."\n" ."\n" .'- DefaultGateway：共享网关。'."\n" .'- PrivateGateway：专属网关。'."\n" .'- Nlb：挂载 NLB。'."\n" .'- Nacos：挂载 Nacos。', 'type' => 'string', 'example' => 'Nlb', ], 'BackendId' => [ 'description' => '后端接入 ID，取决于 EndpointType：'."\n" ."\n" .'- DefaultGateway：为 default。'."\n" .'- PrivateGateway：为专属网关 ID。'."\n" .'- Nlb：为 NLB 实例 ID。'."\n" .'- Nacos：为 Nacos 实例 ID。', 'type' => 'string', 'example' => 'nlb-5q4sp7u6oorkha****', ], 'PathType' => [ 'description' => '地址类型，可能值为：'."\n" ."\n" .'- Group：服务群组地址。'."\n" .'- Service：服务地址。', 'type' => 'string', 'example' => 'Service', ], 'IntranetEndpoints' => [ 'description' => '内网地址列表。', 'type' => 'array', 'items' => [ 'description' => '完整的访问地址。', 'type' => 'string', 'example' => 'nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com', ], ], 'InternetEndpoints' => [ 'description' => '公网地址列表。', 'type' => 'array', 'items' => [ 'description' => '完整的访问地址。', 'type' => 'string', 'example' => 'null', ], ], 'Port' => [ 'description' => '端口。仅挂载 NlB 和 Nacos 时，Port 才有值。', 'type' => 'integer', 'format' => 'int32', 'example' => '9090', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"739998B5-FB39-12A3-8323-0FA340317298\\",\\n \\"Message\\": \\"执行成功。\\",\\n \\"AccessToken\\": \\"Nzc5N2FhN****TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1****\\",\\n \\"Endpoints\\": [\\n {\\n \\"EndpointType\\": \\"Nlb\\",\\n \\"BackendId\\": \\"nlb-5q4sp7u6oorkha****\\",\\n \\"PathType\\": \\"Service\\",\\n \\"IntranetEndpoints\\": [\\n \\"nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com\\"\\n ],\\n \\"InternetEndpoints\\": [\\n \\"null\\"\\n ],\\n \\"Port\\": 9090\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取服务端点列表', ], 'DescribeServiceSignedUrl' => [ 'summary' => '获取服务免登录Web访问链接。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/signed_url', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在区域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名字。', 'type' => 'string', 'required' => false, 'example' => 'foo', ], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => '页面类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'webview' => 'webview', 'monitor' => 'monitor', ], 'example' => 'webview', ], ], [ 'name' => 'Expire', 'in' => 'query', 'schema' => [ 'description' => '过期时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '43200', ], ], [ 'name' => 'Internal', 'in' => 'query', 'schema' => [ 'description' => '是否为VPC链接。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'SignedUrl' => [ 'description' => '服务访问Web链接。', 'type' => 'string', 'example' => 'https://foo-115**.console.cn-hangzhou.eas.pai-ml.com?expire=1735202661&signature=ey*******', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"SignedUrl\\": \\"https://foo-115**.console.cn-hangzhou.eas.pai-ml.com?expire=1735202661&signature=ey*******\\"\\n}","type":"json"}]', 'title' => '获取服务免登录Web链接', ], 'CloneService' => [ 'summary' => '复制服务。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/clone', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '217114', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '集群Id', 'description' => '服务所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名', 'description' => '服务名。如何查看服务名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'title' => '复制服务覆盖的参数。', 'description' => '请求body。参数配置说明，请参见[CreateService](~~412086~~)。', 'type' => 'string', 'required' => false, 'example' => '{ "name": "foo", "model_path": "http://path/to/model.tar.gz", "processor": "tensorflow_cpu", "metadata": { "instance": 2, "memory": 7000, "cpu": 4 } }', ], ], [ 'name' => 'Labels', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '复制服务对应的Label。', 'description' => '复制服务对应的Label。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '用户定义标签。', 'example' => '{"key":"value"}'."\n", ], ], ], ], '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' => '40325405-579C-4D82****', ], 'ServiceId' => [ 'title' => '服务Id', 'description' => '服务Id。', 'type' => 'string', 'example' => 'eas-m-r9knx7n9guf2p*****', ], 'ServiceName' => [ 'title' => '服务名', 'description' => '服务名。', 'type' => 'string', 'example' => 'foo', ], 'Status' => [ 'title' => '服务状态', 'description' => '服务状态。', 'type' => 'string', 'example' => 'Creating', ], 'InternetEndpoint' => [ 'title' => '公网访问地址', 'description' => '公网访问地址。', 'type' => 'string', 'example' => 'http://10123*****.cn-shanghai.aliyuncs.com/api/predict/echo', ], 'IntranetEndpoint' => [ 'title' => '快速访问地址', 'description' => '快速访问地址。', 'type' => 'string', 'example' => 'http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/echo', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ServiceId\\": \\"eas-m-r9knx7n9guf2p*****\\",\\n \\"ServiceName\\": \\"foo\\",\\n \\"Status\\": \\"Creating\\",\\n \\"InternetEndpoint\\": \\"http://10123*****.cn-shanghai.aliyuncs.com/api/predict/echo\\",\\n \\"IntranetEndpoint\\": \\"http://10123*****.vpc.cn-shanghai.aliyuncs.com/api/predict/echo\\"\\n}","type":"json"}]', 'title' => '复制服务', ], 'DeleteService' => [ 'summary' => '删除指定的服务。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在区域。例如华东2（上海）为cn-shanghai。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回消息。', 'type' => 'string', 'example' => 'Service [foo] in region [cn-shanghai] is terminating', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Service [foo] in region [cn-shanghai] is terminating\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '删除服务', ], 'DeleteServiceLabel' => [ 'summary' => '删除已有的服务标签。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/label', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '167565', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域。', 'description' => '服务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字。', 'description' => '服务名称。如何查看服务名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'Keys', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'title' => '要删除的服务标签。', 'description' => '要删除的服务标签。（废弃，请使用 LabelKeys）', 'type' => 'array', 'items' => [ 'title' => '服务标签key列表。', 'description' => '服务标签key列表。', 'type' => 'string', 'required' => false, 'example' => 'key1,key2', ], 'deprecated' => true, 'required' => false, ], ], [ 'name' => 'LabelKeys', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '要删除的服务标签。', 'type' => 'array', 'items' => [ 'description' => '服务标签key列表。', 'type' => 'string', 'required' => false, 'example' => 'key1', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '返回信息。', 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Succeed to delete service [service_from_zxxx] labels.', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Succeed to delete service [service_from_zxxx] labels.\\"\\n}","type":"json"}]', 'title' => '删除服务标签', ], 'DeleteServiceAutoScaler' => [ 'summary' => '删除服务已有的弹性伸缩控制器，关闭自动弹性伸缩功能。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/autoscaler', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Autoscaler for service [foo] deleted successfully', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Autoscaler for service [foo] deleted successfully\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '关闭服务自动扩缩容', ], 'DeleteServiceCronScaler' => [ 'summary' => '关闭服务定时扩缩容功能。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/cronscaler', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回body。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Cronscaler for service [foo] deleted successfully', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Cronscaler for service [foo] deleted successfully\\"\\n}","type":"json"}]', 'title' => '关闭服务定时扩缩容', ], 'DeleteServiceInstances' => [ 'summary' => '调用DeleteServiceInstances重启服务的指定实例。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/instances', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '39632', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'InstanceList', 'in' => 'query', 'schema' => [ 'title' => '删除的实例列表，多个实例名字之间逗号隔开', 'description' => '重启的实例列表，多个实例名称之间使用半角逗号（,）分隔。如何查看实例名称，请参见[ListServiceInstances](~~412108~~)。', 'type' => 'string', 'required' => false, 'example' => 'foo-rdsbxxxx,foo-rdsaxxxx', ], ], [ 'name' => 'SoftRestart', 'in' => 'query', 'schema' => [ 'description' => '是否只重启容器进程，不重建实例。默认为false。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Container', 'in' => 'query', 'schema' => [ 'description' => '需要重启进程的容器名称。只有在SoftRestart参数为true，该参数才会生效。', 'type' => 'string', 'required' => false, 'example' => 'worker0', ], ], [ 'name' => 'IsReplica', 'in' => 'query', 'schema' => [ 'description' => '当前实例是否为实例单元。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结构体。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Instance(s) [foo-rdsb,foo-rdsa] for service [foo] in region [cn-shanghai] was deleted successfully', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Instance(s) [foo-rdsb,foo-rdsa] for service [foo] in region [cn-shanghai] was deleted successfully\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '重启服务实例', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'DeleteServiceMirror' => [ 'summary' => '关闭服务流量镜像功能。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/mirror', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何获取服务名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Traffic mirroring is OFF for service [foo] in region [cn-shanghia], ratio [70%]', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Traffic mirroring is OFF for service [foo] in region [cn-shanghia], ratio [70%]\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '关闭服务流量镜像', ], 'UpdateService' => [ 'summary' => '用于服务的模型或Processor更新。如果只更新metadata.instance字段，则用于服务扩缩容功能。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '37044', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'UpdateType', 'in' => 'query', 'schema' => [ 'description' => '服务更新类型，目前支持合并模式和替换模式。不传默认为合并模式。'."\n" ."\n" .'- merge（合并模式）：若原服务配置JSON为'."\n" .'`{"a":"b"}`，更新配置为`{"c":"d"}` ，则合并模式下最终配置为`{"a":"b","c":"d"}`。'."\n" .'- replace（替换模式）：若原服务配置JSON为'."\n" .'`{"a":"b"}`，更新配置为`{"c":"d"}` ，则替换模式下最终配置为`{"c":"d"}`。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'merge' => '合并模式', 'replace' => '替换模式', ], 'example' => 'merge', ], ], [ 'name' => 'MemberToUpdate', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '更新配置。参数配置说明，请参见[CreateService](~~412086~~)。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "name": "foo",'."\n" .' "model_path": "http://path/to/model.tar.gz",'."\n" .' "processor": "tensorflow_cpu",'."\n" .' "metadata": {'."\n" .' "instance": 2,'."\n" .' "memory": 7000,'."\n" .' "cpu": 4'."\n" .' }'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '请求返回消息。', 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Succeed to update service [foo] in region [cn-shanghai]', ], ], ], ], 400 => [], 403 => [], 409 => [], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Succeed to update service [foo] in region [cn-shanghai]\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '更新服务', 'requestParamsDescription' => '> 请参考CreateService文档，获取更多请求参数介绍。', ], 'UpdateServiceLabel' => [ 'summary' => '新增服务标签，或更新已有的服务标签。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/label', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '167564', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '请求Body', 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Labels' => [ 'title' => '自定义服务标签', 'description' => '自定义服务标签。', 'type' => 'object', 'required' => true, 'additionalProperties' => [ 'title' => '标签对象', 'description' => '用户定义标签。', 'type' => 'string', 'example' => '{"key":"value"}', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '返回信息。', 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Succeed to update service [service_from_XXXX] labels.', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Succeed to update service [service_from_XXXX] labels.\\"\\n}","type":"json"}]', 'title' => '更新服务标签', ], 'StartService' => [ 'summary' => '启动一个已停止状态的服务。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/start', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '37048', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回消息。', 'type' => 'string', 'example' => 'Service [foo] in region [cn-shanghai] is starting', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Service [foo] in region [cn-shanghai] is starting\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '启动服务', ], 'StopService' => [ 'summary' => '停止一个运行中的服务。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/stop', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '37049', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Succeed to auto scale service [foo]', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Succeed to auto scale service [foo]\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '停止服务', ], 'RestartService' => [ 'summary' => '重启服务。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/restart', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域。', 'description' => '服务所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id。', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '请求消息。', 'description' => '请求返回消息。', 'type' => 'string', 'example' => 'Service is restarting', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Service is restarting\\"\\n}","type":"json"}]', 'title' => '重启服务', ], 'UpdateServiceAutoScaler' => [ 'summary' => '修改服务已有的自动扩缩控制器配置。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/autoscaler', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'min' => [ 'title' => '最小 replica 数，需要大于0', 'description' => '最小实例数，需要大于0。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], 'max' => [ 'title' => '最大 replica 数，需要大于MinReplica', 'description' => '最大实例数，需要大于Min Replica。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8', ], 'scaleStrategies' => [ 'description' => '伸缩策略列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'metricName' => [ 'description' => '指标名称，取值如下：'."\n" .'- qps：单实例QPS伸缩阈值。'."\n" .'- cpu：CPU利用率阈值。', 'type' => 'string', 'required' => true, 'example' => 'qps', ], 'threshold' => [ 'description' => '触发自动伸缩阈值。'."\n" .'- 指标名称配置为qps：当单实例的平均QPS大于该值时会触发扩容。'."\n" .'- 指标名称配置为cpu：当单实例的平均CPU使用率大于该值时会触发扩容。', 'type' => 'number', 'format' => 'float', 'required' => true, 'example' => '100', ], 'service' => [ 'description' => '指标所属服务，不配置默认为当前服务。', 'type' => 'string', 'required' => false, 'example' => 'demo_svc', ], ], 'required' => false, ], 'required' => true, ], 'behavior' => [ 'description' => '自动扩缩容时的行为。', 'type' => 'object', 'properties' => [ 'scaleUp' => [ 'description' => '扩容时的行为', 'type' => 'object', 'properties' => [ 'stabilizationWindowSeconds' => [ 'description' => '扩容稳定窗口期时间，默认值为0。'."\n" .'只有当过去一段时间内的指标均满足条件，才会执行扩容。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], ], 'required' => false, ], 'scaleDown' => [ 'description' => '缩容时的行为。', 'type' => 'object', 'properties' => [ 'stabilizationWindowSeconds' => [ 'description' => '缩容稳定窗口期时间，默认值为300。'."\n" .'只有当过去一段时间内的指标均不满足条件，才会执行缩容。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '300', ], ], 'required' => false, ], 'onZero' => [ 'description' => '缩容到0时的行为。', 'type' => 'object', 'properties' => [ 'scaleDownGracePeriodSeconds' => [ 'description' => '缩容到0之前的等待期，默认为600。'."\n" .'当指标满足缩容到0的条件时，需要经过等待期的时间，才会执行缩容到0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '600', ], 'scaleUpActivationReplicas' => [ 'description' => '当从0开始扩容时，一次性创建的实例数。默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Update auto scale for service [foo] successfully', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Update auto scale for service [foo] successfully\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '更新服务自动扩缩容配置', ], 'UpdateServiceCronScaler' => [ 'summary' => '更新服务定时扩缩容配置信息。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/cronscaler', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATURElearnZ3WNW7', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名字。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'ScaleJobs' => [ 'title' => '定时伸缩任务描述', 'description' => '定时伸缩任务描述。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TargetSize' => [ 'title' => '执行伸缩任务的目标replica', 'description' => '执行伸缩任务的目标实例数。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', ], 'Schedule' => [ 'title' => '要执行伸缩任务的cron表达式', 'description' => '要执行伸缩任务的Cron表达式。如何配置Cron表达式，请参见**请求参数补充说明**。', 'type' => 'string', 'required' => true, 'example' => '0 18 * * * *'."\n", ], 'Name' => [ 'description' => '定时扩缩容任务的名称。', 'type' => 'string', 'required' => false, 'example' => 'scale-job-1'."\n", ], 'TimeZone' => [ 'description' => '时区配置，用于解析定时伸缩任务的执行时间', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', ], ], 'required' => false, ], 'required' => true, ], 'ExcludeDates' => [ 'title' => '需要排除的时间点的cron表达式', 'description' => '需要排除的时间点的Cron表达式。', 'type' => 'array', 'items' => [ 'description' => 'Cron表达式。如何配置Cron表达式，请参见**请求参数补充说明**。', 'type' => 'string', 'required' => false, 'example' => '* * * * * 0,6'."\n", ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回Body。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回消息。', 'type' => 'string', 'example' => 'Update cron scaler for service [foo] successfully', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Update cron scaler for service [foo] successfully\\"\\n}","type":"json"}]', 'title' => '更新服务定时扩缩容配置', 'requestParamsDescription' => '### Cron表达式'."\n" .'![未命名绘图.drawio.png](https://intranetproxy.alipay.com/skylark/lark/0/2022/png/72178/1645094436048-953c2592-1017-4597-855d-22e6e78afee0.png#clientId=ua661de8e-75b1-4&crop=0&crop=0&crop=1&crop=1&from=ui&height=120&id=ufb1b2c04&margin=%5Bobject%20Object%5D&name=%E6%9C%AA%E5%91%BD%E5%90%8D%E7%BB%98%E5%9B%BE.drawio.png&originHeight=215&originWidth=547&originalType=binary&ratio=1&rotation=0&showTitle=false&size=17762&status=done&style=none&taskId=ue641ee0e-20dd-462b-ae2e-102a58eae0e&title=&width=305)'."\n" ."\n" .'| 名称 | 可用值 | 可用特殊符号 |'."\n" .'| --- | --- | --- |'."\n" .'| 秒 | 0-59 | * / , - |'."\n" .'| 分 | 0-59 | * / , - |'."\n" .'| 小时 | 0-23 | * / , - |'."\n" .'| 日 | 1-31 | * / , - |'."\n" .'| 月 | 1-12 或 JAN-DEC | * / , - |'."\n" .'| 星期 | 0-6 或 SUN-SAT | * / , - |'."\n" ."\n" .'#### 特殊符号说明'."\n" .'**星号(*)**'."\n" .'星号代表任意值，例如：0 0 0 1 * * 代表每月1号的0点整。'."\n" .'​'."\n" ."\n" .'**连字符(-)**'."\n" .'连字符代表一段连续的取值范围，例如 0 0 12-14 * * * 代表每天的12:00、13:00 和14:00'."\n" .'​'."\n" ."\n" .'**逗号(,)**'."\n" .'连字符代表一段取值范围，例如 0 0 12,14 * * * 代表每天的12:00 和14:00'."\n" .'​'."\n" ."\n" .'**斜杠(/)**'."\n" .'斜杠用来代表一段增量的区间，例如 0 */15 * * * * 代表每小时的0分、15分、30分、和45分。'."\n" .'斜杠可以和连字符配合使用，例如 0 5-40/15 * * * * 代表每小时从5分到40分钟之间，每隔15分钟取一个值，有效时间点可以是 0:05, 0:20, 0:35', ], 'DevelopService' => [ 'summary' => '将容器服务转为开发模式，或退出开发模式。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/develop', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '161121', 'abilityTreeNodes' => [ 'FEATURElearnO4KXYN', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '集群Id。', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'echo', ], ], [ 'name' => 'Exit', 'in' => 'query', 'schema' => [ 'title' => '是否退出开发模式', 'description' => '是否退出开发模式。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'true' => '退出开发模式', 'false' => '进入开发模式（默认值，可不填）', ], 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '执行结果消息', 'description' => '返回结果信息。', 'type' => 'string', 'example' => 'Success', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', 'title' => '开发服务', ], 'CommitService' => [ 'summary' => '将自定义容器服务中Worker0容器提交为新镜像，并重新部署服务。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/commit', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '161122', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '集群Id。', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名。', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => false, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '执行结果。', 'description' => '返回结果信息。', 'type' => 'string', 'example' => 'Success', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', 'title' => 'Commit容器并发布', ], 'UpdateServiceMirror' => [ 'summary' => '更新服务流量镜像配置。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/mirror', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Ratio' => [ 'title' => '比例 [0, 100]', 'description' => '流量比例，取值范围0~100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], 'Target' => [ 'title' => '服务实例列表', 'description' => '服务实例列表。', 'type' => 'array', 'items' => [ 'description' => '服务实例名。如何查看服务实例名称，请参见[ListServiceInstances ](~~412108~~)。', 'type' => 'string', 'required' => false, 'example' => 'foo-xxxx', ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'description' => '返回结果信息。', 'type' => 'string', 'enumValueTitles' => [], 'example' => 'Traffic mirroring is updating for service [foo] in region [cn-shanghai], ratio [70%]', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Traffic mirroring is updating for service [foo] in region [cn-shanghai], ratio [70%]\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '更新服务流量镜像配置', ], 'UpdateServiceVersion' => [ 'summary' => '更新服务的当前版本，用于服务在历史版本的切换，可实现回滚功能。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/version', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名字。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'echo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Version' => [ 'description' => '服务要切换的目标版本，INT类型，取值需要大于0且小于服务当前的版本。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '返回结果信息。', 'type' => 'string', 'example' => 'Service [foo] in region [cn-shanghai] is starting', ], ], ], ], 400 => [], 403 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Service [foo] in region [cn-shanghai] is starting\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '切换服务版本', ], 'UpdateServiceSafetyLock' => [ 'summary' => '更新服务安全锁，可以一定程度上避免对服务的误操作。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/lock', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [ 'application/json', ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '161176', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Lock' => [ 'description' => '安全锁级别。'."\n" .'- all：锁所有操作。'."\n" .'- dangerous：锁危险操作（例如：删除、停止）。'."\n" .'- none：不加锁。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'all' => '锁所有操作', 'dangerous' => '锁危险操作（删除、停止）', 'none' => '不加锁', ], 'example' => 'dangerous', 'enum' => [ 'none', 'dangerous', 'all', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'E089D584-B6F4-50C4-9902-DA2295B7****', ], 'Message' => [ 'description' => '返回结果信息。', 'type' => 'string', 'example' => 'service safety lock updated to dangerous', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E089D584-B6F4-50C4-9902-DA2295B7****\\",\\n \\"Message\\": \\"service safety lock updated to dangerous\\"\\n}","type":"json"}]', 'title' => '更新服务安全锁', ], 'UpdateServiceInstance' => [ 'summary' => '更新服务实例属性，目前只支持隔离服务实例。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/instances/{InstanceName}', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '200711', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名字。如何查看服务名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'InstanceName', 'in' => 'path', 'schema' => [ 'description' => '服务实例的名字。如何查看实例名称，请参见[ListServiceInstances](~~412108~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo-69xxxx4f4-5w9r9', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Hibernate' => [ 'description' => '>该参数正在邀测中，暂不支持使用。'."\n", 'type' => 'boolean', 'required' => false, 'example' => '0', ], 'Isolate' => [ 'description' => '是否承接流量。取值如下：'."\n" .'- true：表示承接流量。'."\n" .'- false：表示不承接流量。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Detach' => [ 'description' => '是否隔离服务实例，实例隔离后，当前实例不再被控制器控制，会创建新的实例，被隔离的实例用于保留现场或者进行调试。注意：实例隔离后，不能接触隔离。取值如下：'."\n" .'- true：表示隔离实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], ], [ 'name' => 'IsReplica', 'in' => 'query', 'schema' => [ 'description' => '当前实例是否是实例单元。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作成功信息。', 'type' => 'string', 'example' => 'instance xxxx isolation updated to true。', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"instance xxxx isolation updated to true。\\"\\n}","type":"json"}]', 'title' => '更新服务实例属性', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'UpdateAppService' => [ 'summary' => '更新应用服务。', 'path' => '/api/v2/app_services/{ClusterId}/{ServiceName}', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名字。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '1234**', ], ], [ 'name' => 'QuotaId', 'in' => 'query', 'schema' => [ 'description' => '归属额度ID。', 'type' => 'string', 'required' => false, 'example' => 'abcdef', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'AppType' => [ 'description' => '应用类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'LLM' => 'LLM', ], 'example' => 'LLM', ], 'AppVersion' => [ 'description' => '应用版本。', 'type' => 'string', 'required' => false, 'example' => 'v1', ], 'ServiceSpec' => [ 'description' => '服务规格。取值如下：'."\n" .'- llama_7b_fp16'."\n" .'- llama_7b_int8'."\n" .'- llama_13b_fp16'."\n" .'- llama_7b_int8'."\n" .'- chatglm_6b_fp16'."\n" .'- chatglm_6b_int8'."\n" .'- chatglm2_6b_fp16'."\n" .'- baichuan_7b_int8'."\n" .'- baichuan_13b_fp16'."\n" .'- baichuan_7b_fp16', 'type' => 'string', 'required' => false, 'example' => 'llama_7b_fp16', ], 'Replicas' => [ 'description' => '实例数。必须大于0。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], 'Config' => [ 'description' => '部署时需要的其他配置信息。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'any', 'example' => '{ "ModelStorage": "oss", "OssPath": "oss://examplebucket/xxxx/" }', 'description' => '模型挂载等应用信息。配置方法，请参见[创建应用服务](~~2621216~~)。', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'Success', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', 'title' => '更新应用服务', ], 'UpdateGroup' => [ 'summary' => '更新服务组的部分字段。', 'path' => '/api/v2/groups/{ClusterId}/{GroupName}', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260902', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '所属所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GroupName', 'in' => 'path', 'schema' => [ 'description' => '服务群组名称。如何获取群组名称，请参见ListServices 。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求内容', 'type' => 'object', 'properties' => [ 'TrafficMode' => [ 'title' => '流量模式，枚举值为auto和customized。', 'description' => '流量模式，枚举值为auto和customized。auto模式根据实例数量所占总比重自动分配权重，customized根据自定义固定权重分配流量。', 'type' => 'string', 'required' => false, 'example' => 'auto', 'enum' => [ 'auto', 'customized', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\"\\n}","type":"json"}]', 'title' => '更新服务组', ], 'ReleaseService' => [ 'summary' => '修复服务的流量状态和权重。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/release', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '37054', 'abilityTreeNodes' => [ 'FEATURElearnO4KXYN', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Weight' => [ 'title' => '权重值，取值范围[-1, 1000]', 'description' => '灰度权重，范围为[-1~1000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], 'TrafficState' => [ 'description' => '流量状态，取值如下：'."\n" .'- standalone：独立流量。'."\n" .'- grouping：分组流量。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'standalone' => '独立流量', 'grouping' => '分组流量', ], 'example' => 'grouping', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回消息。', 'type' => 'string', 'example' => 'Releasing service [foo] in region [cn-shanghai] with weight [40], service status: [Running]', ], ], ], ], 400 => [], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Releasing service [foo] in region [cn-shanghai] with weight [40], service status: [Running]\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '调整服务流量权重和流量状态', ], 'DescribeService' => [ 'summary' => '获取指定服务的详细信息。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '37005', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '返回的服务详情。', '$ref' => '#/components/schemas/Service', ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"ServiceGroup\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"Cpu\\": 0,\\n \\"Image\\": \\"\\",\\n \\"Gpu\\": 0,\\n \\"TotalInstance\\": 0,\\n \\"AccessToken\\": \\"\\",\\n \\"ResourceBurstable\\": true,\\n \\"InternetEndpoint\\": \\"\\",\\n \\"ResourceAlias\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"TrafficState\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Resource\\": \\"\\",\\n \\"SecondaryInternetEndpoint\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"LabelValue\\": \\"\\",\\n \\"LabelKey\\": \\"\\"\\n }\\n ],\\n \\"Namespace\\": \\"\\",\\n \\"Weight\\": 0,\\n \\"Role\\": \\"\\",\\n \\"SecondaryIntranetEndpoint\\": \\"\\",\\n \\"PendingInstance\\": 0,\\n \\"ServiceName\\": \\"\\",\\n \\"SafetyLock\\": \\"\\",\\n \\"Region\\": \\"\\",\\n \\"AppType\\": \\"\\",\\n \\"InstanceCountInResource\\": {\\n \\"Quota\\": 0,\\n \\"Public\\": 0,\\n \\"Dedicated\\": 0\\n },\\n \\"IntranetEndpoint\\": \\"\\",\\n \\"QuotaId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"CurrentVersion\\": 0,\\n \\"RunningInstance\\": 0,\\n \\"WorkspaceId\\": \\"\\",\\n \\"CallerUid\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Source\\": \\"\\",\\n \\"ServiceId\\": \\"\\",\\n \\"AppVersion\\": \\"\\",\\n \\"CronscalerEnabled\\": true,\\n \\"ServiceConfig\\": \\"\\",\\n \\"Gateway\\": \\"\\",\\n \\"AppSpecName\\": \\"\\",\\n \\"GPUCorePercentage\\": 0,\\n \\"GPUMemory\\": 0,\\n \\"AppConfig\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"AutoscalerEnabled\\": true,\\n \\"ExtraData\\": \\"\\",\\n \\"LatestVersion\\": 0,\\n \\"UpdateTime\\": \\"\\",\\n \\"ServiceUid\\": \\"\\",\\n \\"ParentUid\\": \\"\\",\\n \\"RoleAttrs\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询服务详情', ], 'DescribeServiceAutoScaler' => [ 'summary' => '查看服务的自动扩缩配置详情。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/autoscaler', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'echo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ServiceName' => [ 'title' => '服务名字', 'description' => '服务名称。', 'type' => 'string', 'example' => 'foo', ], 'MinReplica' => [ 'title' => '服务最小实例数', 'description' => '服务最小实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'MaxReplica' => [ 'title' => '服务最大实例数', 'description' => '服务最大实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'Behavior' => [ 'description' => '额外扩缩容策略。例如触发扩缩容前的等待时间。', 'type' => 'object', 'example' => '{'."\n" .' "behavior": {'."\n" .' "scaleDown": {'."\n" .' "stabilizationWindowSeconds": 150'."\n" .' }'."\n" .' }'."\n" .'}', ], 'ScaleStrategies' => [ 'description' => '伸缩策略列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'metricName' => [ 'description' => '指标名称，可能值：'."\n" .'- QPS：单实例QPS伸缩阈值。'."\n" .'- CPU：CPU利用率阈值。', 'type' => 'string', 'example' => 'QPS', ], 'threshold' => [ 'description' => '触发自动伸缩阈值。'."\n" .'- 指标名称配置为QPS：当单实例的平均QPS大于该值时会触发扩容。'."\n" .'- 指标名称配置为CPU：当单实例的平均CPU使用率大于该值时会触发扩容。', 'type' => 'number', 'format' => 'float', 'example' => '10', ], 'service' => [ 'description' => '指标所属服务，不配置默认为当前服务。', 'type' => 'string', 'example' => 'demo_svc', ], ], ], ], 'CurrentMetrics' => [ 'description' => '当前指标列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'metricName' => [ 'description' => '指标名称。可能值：'."\n" .'- QPS'."\n" .'- CPU', 'type' => 'string', 'example' => 'QPS', ], 'value' => [ 'description' => '当前指标值。', 'type' => 'number', 'format' => 'float', 'example' => '10', ], 'service' => [ 'description' => '指标所属服务。', 'type' => 'string', 'example' => 'demo_svc', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ServiceName\\": \\"foo\\",\\n \\"MinReplica\\": 3,\\n \\"MaxReplica\\": 8,\\n \\"Behavior\\": {\\n \\"behavior\\": {\\n \\"scaleDown\\": {\\n \\"stabilizationWindowSeconds\\": 150\\n }\\n }\\n },\\n \\"ScaleStrategies\\": [\\n {\\n \\"metricName\\": \\"QPS\\",\\n \\"threshold\\": 10,\\n \\"service\\": \\"demo_svc\\"\\n }\\n ],\\n \\"CurrentMetrics\\": [\\n {\\n \\"metricName\\": \\"QPS\\",\\n \\"value\\": 10,\\n \\"service\\": \\"demo_svc\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查看服务自动扩缩容信息', ], 'DescribeServiceCronScaler' => [ 'summary' => '查看服务的定时扩缩容配置详情。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/cronscaler', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '123960', 'abilityTreeNodes' => [ 'FEATURElearnZ3WNW7', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ServiceName' => [ 'description' => '服务名称。', 'type' => 'string', 'example' => 'foo', ], 'ExcludeDates' => [ 'description' => '已排除的时间点的Cron表达式列表。', 'type' => 'array', 'items' => [ 'description' => 'Cron表达式。', 'type' => 'string', 'example' => '* * * * * 0,6'."\n", ], ], 'ScaleJobs' => [ 'description' => '定时伸缩任务列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Schedule' => [ 'description' => '伸缩任务的Cron表达式。', 'type' => 'string', 'example' => '0 18 * * * *', ], 'TargetSize' => [ 'description' => '伸缩任务的目标实例数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Name' => [ 'description' => '伸缩任务的名称。', 'type' => 'string', 'example' => 'scale-job-1', ], 'Message' => [ 'description' => '最后一次定时任务的详细信息。', 'type' => 'string', 'example' => '"cron hpa job scale-jobs-0 executed successfully. current replicas:3, desired replicas:2."', ], 'State' => [ 'description' => '最后一次定时任务的状态。', 'type' => 'string', 'example' => 'Succeed', ], 'LastProbeTime' => [ 'description' => '最后一次定时任务的运行UTC时间。', 'type' => 'string', 'example' => '2022-02-24T06:31:00Z', ], 'CreateTime' => [ 'description' => '最后一次定时任务创建UTC时间。', 'type' => 'string', 'example' => '2020-06-24T02:11:30Z', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ServiceName\\": \\"foo\\",\\n \\"ExcludeDates\\": [\\n \\"* * * * * 0,6\\\\n\\"\\n ],\\n \\"ScaleJobs\\": [\\n {\\n \\"Schedule\\": \\"0 18 * * * *\\",\\n \\"TargetSize\\": 1,\\n \\"Name\\": \\"scale-job-1\\",\\n \\"Message\\": \\"\\\\\\"cron hpa job scale-jobs-0 executed successfully. current replicas:3, desired replicas:2.\\\\\\"\\",\\n \\"State\\": \\"Succeed\\",\\n \\"LastProbeTime\\": \\"2022-02-24T06:31:00Z\\",\\n \\"CreateTime\\": \\"2020-06-24T02:11:30Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看服务定时扩缩容信息', ], 'DescribeServiceDiagnosis' => [ 'summary' => '查看服务的诊断详情。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/diagnosis', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '181894', 'abilityTreeNodes' => [ 'FEATURElearnO4KXYN', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'DiagnosisList' => [ 'description' => '诊断信息列表。', 'type' => 'array', 'items' => [ 'description' => '诊断信息。', 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '识别到的异常。', 'type' => 'string', 'example' => 'Container worker0 failed to pull image.', ], 'Causes' => [ 'description' => '异常原因列表。', 'type' => 'array', 'items' => [ 'description' => '异常原因。', 'type' => 'string', 'example' => 'Failed to pull image "busybox:no_exist_tag": rpc error: code = NotFound.', ], ], 'Advices' => [ 'description' => '修复建议列表。', 'type' => 'array', 'items' => [ 'description' => '修复建议。', 'type' => 'string', 'example' => 'Please make sure the container image exists.', ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"DiagnosisList\\": [\\n {\\n \\"Error\\": \\"Container worker0 failed to pull image.\\",\\n \\"Causes\\": [\\n \\"Failed to pull image \\\\\\"busybox:no_exist_tag\\\\\\": rpc error: code = NotFound.\\"\\n ],\\n \\"Advices\\": [\\n \\"Please make sure the container image exists.\\"\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看服务诊断详情', ], 'DescribeServiceInstanceDiagnosis' => [ 'summary' => '查看服务实例的诊断详情。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/instances/{InstanceName}/diagnosis', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '181910', 'abilityTreeNodes' => [ 'FEATURElearnO4KXYN', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务的名称。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'InstanceName', 'in' => 'path', 'schema' => [ 'description' => '服务实例的名称。', 'type' => 'string', 'required' => true, 'example' => 'foo-69xxxx4f4-5w9r9', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Diagnosis' => [ 'description' => '诊断信息。', 'type' => 'object', 'properties' => [ 'Error' => [ 'description' => '识别到的异常。', 'type' => 'string', 'example' => 'Container worker0 failed to pull image.', ], 'Causes' => [ 'description' => '异常原因列表。', 'type' => 'array', 'items' => [ 'description' => '异常原因。', 'type' => 'string', 'example' => 'Failed to pull image "busybox:no_exist_tag": rpc error: code = NotFound.', ], ], 'Advices' => [ 'description' => '修复建议列表。', 'type' => 'array', 'items' => [ 'description' => '修复建议。', 'type' => 'string', 'example' => 'Please make sure the container image exists.', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Diagnosis\\": {\\n \\"Error\\": \\"Container worker0 failed to pull image.\\",\\n \\"Causes\\": [\\n \\"Failed to pull image \\\\\\"busybox:no_exist_tag\\\\\\": rpc error: code = NotFound.\\"\\n ],\\n \\"Advices\\": [\\n \\"Please make sure the container image exists.\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '查看服务实例诊断详情', ], 'DescribeServiceLog' => [ 'summary' => '获取指定服务的日志信息。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/logs', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'title' => '请求的页码（默认为1）', 'description' => '服务日志的页码，默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为500）', 'description' => '分页查询时设置的每页显示的日志行数，默认值为500。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', ], ], [ 'name' => 'Ip', 'in' => 'query', 'schema' => [ 'title' => '要查询的机器ip', 'description' => '要查询的机器IP。如何获取机器IP，请参见[ListServiceInstances](~~412108~~)。', 'type' => 'string', 'required' => false, 'example' => '10.0.0.1', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'title' => '查询的关键字', 'description' => '查询的关键字。', 'type' => 'string', 'required' => false, 'example' => 'key', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '查询的开始时间', 'description' => '查询的开始UTC时间。', 'type' => 'string', 'required' => false, 'example' => '2006-01-02 15:04:05', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '查询的结束时间', 'description' => '查询的结束UTC时间。', 'type' => 'string', 'required' => false, 'example' => '2006-01-02 15:04:05', ], ], [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何获取服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'echo', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => '服务实例的名称。如何获取实例名称，请参见[ListServiceInstances](~~412108~~)。', 'type' => 'string', 'required' => false, 'example' => 'echo-da290ac8-7fckm', ], ], [ 'name' => 'ContainerName', 'in' => 'query', 'schema' => [ 'description' => '服务实例的容器名称。', 'type' => 'string', 'required' => false, 'example' => 'worker0', ], ], [ 'name' => 'Previous', 'in' => 'query', 'schema' => [ 'description' => '查看实例上次重启前的日志。注意：仅在实例出现重启时可用。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82********', ], 'Logs' => [ 'title' => '返回的日志信息', 'description' => '返回的日志信息。', 'type' => 'array', 'items' => [ 'description' => '日志信息。', 'type' => 'string', 'example' => 'echo_test', ], ], 'PageNum' => [ 'title' => '当前页码', 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalCount' => [ 'title' => '总计数量', 'description' => '总计数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalPageNum' => [ 'title' => '总计页码', 'description' => '总计页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '500', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82********\\",\\n \\"Logs\\": [\\n \\"echo_test\\"\\n ],\\n \\"PageNum\\": 1,\\n \\"TotalCount\\": 1,\\n \\"TotalPageNum\\": 500\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查看服务日志', ], 'DescribeServiceEvent' => [ 'summary' => '查询服务近期部署事件。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/events', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '152928', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'PageNum', 'in' => 'query', 'schema' => [ 'title' => '请求页码（默认1）', 'description' => '服务事件列表的页码，默认为1。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为100）', 'description' => '分页查询时设置的每页显示的事件数量，默认为100。', 'type' => 'string', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务对应区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务对应名称', 'description' => '服务对应名称。如何获取服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'title' => '日志查询起始时刻（默认7天前）', 'description' => '查询起始UTC时间。默认为7天前。', 'type' => 'string', 'required' => false, 'example' => '2006-01-02 15:04:05', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'title' => '日志查询终止时刻（默认当前时刻）', 'description' => '查询终止时间，默认当前时刻。', 'type' => 'string', 'required' => false, 'example' => '2006-01-02 15:04:05', ], ], [ 'name' => 'EventType', 'in' => 'query', 'schema' => [ 'description' => '事件类型：'."\n" ."\n" .'- Normal：正常事件。'."\n" .'- Warning：异常事件。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Warning' => 'Warning', 'Normal' => 'Normal', ], 'example' => 'Normal', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => '服务实例的名字。如何获取实例名称，请参见[ListServiceInstances](~~412108~~)。', 'type' => 'string', 'required' => false, 'example' => 'echo-test-784xxxx85d-hhnd8', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '3D491C94-6239-5318-B4B4-799D859***', ], 'Events' => [ 'description' => '事件列表。', 'type' => 'array', 'items' => [ 'description' => '事件信息。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '事件类型，可能值：'."\n" .'- Normal：正常事件。'."\n" .'- Warning：异常事件。', 'type' => 'string', 'example' => 'Normal', ], 'Reason' => [ 'description' => '事件原因（服务状态变化信息）。', 'type' => 'string', 'example' => 'Updating', ], 'Message' => [ 'description' => '事件信息（格式化后的JSON字符串）。', 'type' => 'string', 'example' => '{\\"versionId\\":1,\\"message\\":\\"Stage scale complete\\",\\"availableInstance\\":1,\\"unavailableInstance\\":0}', ], 'Time' => [ 'description' => '事件发生UTC时间。', 'type' => 'string', 'example' => '2022-04-09 06:30:00', ], ], ], ], 'TotalCount' => [ 'description' => '总计数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '29', ], 'TotalPageNum' => [ 'description' => '总计页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '12', ], 'PageNum' => [ 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D491C94-6239-5318-B4B4-799D859***\\",\\n \\"Events\\": [\\n {\\n \\"Type\\": \\"Normal\\",\\n \\"Reason\\": \\"Updating\\",\\n \\"Message\\": \\"{\\\\\\\\\\\\\\"versionId\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Stage scale complete\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"availableInstance\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"unavailableInstance\\\\\\\\\\\\\\":0}\\",\\n \\"Time\\": \\"2022-04-09 06:30:00\\"\\n }\\n ],\\n \\"TotalCount\\": 29,\\n \\"TotalPageNum\\": 12,\\n \\"PageNum\\": 1\\n}","type":"json"}]', 'title' => '查询服务事件', ], 'DescribeServiceMirror' => [ 'summary' => '查看指定服务的流量镜像配置详情。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/mirror', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名字。如何获取服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ServiceName' => [ 'title' => '服务名字', 'description' => '服务名称。', 'type' => 'string', 'example' => 'foo', ], 'Target' => [ 'title' => '设置流量镜像对服务列表', 'description' => '设置流量镜像对服务列表。', 'type' => 'string', 'example' => 'foo2,foo3', ], 'Ratio' => [ 'title' => '比例[0,100]', 'description' => '流量比例，取值范围0~100。', 'type' => 'string', 'example' => '50', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ServiceName\\": \\"foo\\",\\n \\"Target\\": \\"foo2,foo3\\",\\n \\"Ratio\\": \\"50\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查看服务流量镜像信息', ], 'DescribeGroup' => [ 'summary' => '查看服务群组信息。', 'path' => '/api/v2/groups/{ClusterId}/{GroupName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '154833', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '所属所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'GroupName', 'in' => 'path', 'schema' => [ 'description' => '服务群组名称。如何获取群组名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '服务群组详情信息。', '$ref' => '#/components/schemas/Group', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Name\\": \\"\\",\\n \\"ClusterId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"QueueService\\": \\"\\",\\n \\"InternetEndpoint\\": \\"\\",\\n \\"IntranetEndpoint\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"TrafficMode\\": \\"\\"\\n}","type":"json"}]', 'title' => '查看服务群组详情', ], 'DescribeSpotDiscountHistory' => [ 'summary' => '查询抢占式实例历史价格。关于抢占式实例，请参考高级配置：抢占型实例选择。', 'path' => '/api/v2/public/spot_discount', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '183027', 'abilityTreeNodes' => [ 'FEATURElearnPKQVPS', ], ], 'parameters' => [ [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => '实例规格。', 'type' => 'string', 'required' => true, 'example' => 'ecs.c6.4xlarge', ], ], [ 'name' => 'IsProtect', 'in' => 'query', 'schema' => [ 'description' => '是否有保护期。如果有保护期，在抢占式实例创建1小时内，实例不会被抢占。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'SpotDiscounts' => [ 'description' => '抢占式实例折扣。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ZoneId' => [ 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-i', ], 'SpotDiscount' => [ 'description' => '抢占式实例折扣。0.1代表一折。', 'type' => 'string', 'example' => '0.1', ], 'Timestamp' => [ 'description' => '此折扣的UTC时间。', 'type' => 'string', 'example' => '2024-04-10T10:00:00Z', ], 'InstanceType' => [ 'description' => '实例规格。', 'type' => 'string', 'example' => 'ecs.c7.large', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"SpotDiscounts\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"SpotDiscount\\": \\"0.1\\",\\n \\"Timestamp\\": \\"2024-04-10T10:00:00Z\\",\\n \\"InstanceType\\": \\"ecs.c7.large\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询抢占式实例历史价格', ], 'ListServiceInstances' => [ 'summary' => '获取指定服务的实例列表。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/instances', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何获取服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '请求的页码（默认为1）', 'description' => '服务实例列表的页，默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为100）', 'description' => '分页查询时设置的每页显示的实例数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'Filter', 'in' => 'query', 'schema' => [ 'description' => '关键字搜索。支持按实例名、实例IP、实例所在的机器的IP、实例规格搜索。', 'type' => 'string', 'required' => false, 'example' => '10.118.xx.xx', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => '服务实例所在的资源组类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PublicResource' => '公共资源组', 'DedicatedResource' => '专属资源组', ], 'example' => 'PublicResource', ], ], [ 'name' => 'InstanceType', 'in' => 'query', 'schema' => [ 'description' => '实例规格。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c7.large', ], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => [ 'description' => '服务实例的状态。', 'type' => 'string', 'required' => false, 'example' => 'Running', ], ], [ 'name' => 'InstanceIP', 'in' => 'query', 'schema' => [ 'description' => '服务实例的IP。', 'type' => 'string', 'required' => false, 'example' => '10.224.xx.xx', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => '服务实例的名字。', 'type' => 'string', 'required' => false, 'example' => 'foo-bdc5xxxx-8l7rk', ], ], [ 'name' => 'HostIP', 'in' => 'query', 'schema' => [ 'description' => '服务实例所在机器的IP。', 'type' => 'string', 'required' => false, 'example' => '10.224.xx.xx', ], ], [ 'name' => 'IsSpot', 'in' => 'query', 'schema' => [ 'description' => '是否为抢占式实例。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'Role', 'in' => 'query', 'schema' => [ 'description' => '服务的角色。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'DataSet' => '数据集服务', 'SDProxy' => 'Stable-Diffusion代理服务', 'Standard' => '普通预测服务', 'Queue' => '队列服务', ], 'example' => 'Queue', ], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'description' => '排序字段。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'StartTime' => '创建时间', ], 'example' => 'StartTime', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => '排序顺序。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'asc' => '升序', 'desc' => '降序', ], 'example' => 'desc', ], ], [ 'name' => 'MemberType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => [ 'description' => '子服务的类型(只有在聚合服务的场景下有效)。', 'type' => 'string', 'required' => false, 'example' => 'LLMDecode', ], ], [ 'name' => 'ListReplica', 'in' => 'query', 'schema' => [ 'description' => '是否查询实例单元列表。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ReplicaName', 'in' => 'query', 'schema' => [ 'description' => '实例单元的名称。', 'type' => 'string', 'required' => false, 'example' => 'cbh-qwen3-a1bc-prefill-ep1tp4dp', ], ], [ 'name' => 'QuotaId', 'in' => 'query', 'schema' => [ 'description' => '配额ID。', 'type' => 'string', 'required' => false, 'example' => 'quota1****'."\n", ], ], [ 'name' => 'Resource', 'in' => 'query', 'schema' => [ 'description' => '实例所在的资源组。', 'type' => 'string', 'required' => false, 'example' => 'eas-r-xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Instances' => [ 'description' => '服务实例列表。', 'type' => 'array', 'items' => [ 'description' => '服务实例。', '$ref' => '#/components/schemas/Instance', ], ], 'PageNumber' => [ 'description' => '返回查询的实例列表的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Instances\\": [\\n {\\n \\"HostIP\\": \\"\\",\\n \\"HostName\\": \\"\\",\\n \\"InnerIP\\": \\"\\",\\n \\"InstanceName\\": \\"\\",\\n \\"InstancePort\\": 0,\\n \\"LastState\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"Namespace\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"RestartCount\\": 0,\\n \\"Status\\": \\"\\",\\n \\"TotalProcesses\\": 0,\\n \\"ReadyProcesses\\": 0,\\n \\"StartAt\\": \\"\\",\\n \\"Role\\": \\"Standard\\",\\n \\"ResourceType\\": \\"PublicResource\\",\\n \\"TenantInstanceIP\\": \\"192.168.0.39\\",\\n \\"TenantHostIP\\": \\"192.168.0.39\\",\\n \\"IsSpot\\": false,\\n \\"CurrentAmount\\": 0.444,\\n \\"OriginalAmount\\": 2.2,\\n \\"Isolated\\": false,\\n \\"Zone\\": \\"cn-shanghai-a\\",\\n \\"ExternalIP\\": \\"192.168.1.100\\",\\n \\"ExternalInstancePort\\": 8080,\\n \\"StartTime\\": \\"\\",\\n \\"InstanceType\\": \\"ecs.c7.large\\",\\n \\"IsLatest\\": true,\\n \\"Detached\\": true,\\n \\"IsReplica\\": true,\\n \\"ReplicaName\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询服务实例列表', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'ListServiceVersions' => [ 'summary' => '查询服务历史版本。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/versions', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '152269', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '服务所在区域', 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'title' => '服务名字', 'description' => '服务名称。如何获取服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'test_oss', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '请求的页码（默认为1）', 'description' => '请求的页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为100）', 'description' => '分页查询时设置的每页显示的版本数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'E089D584-B6F4-50C4-9902-DA2295B7****', ], 'PageNumber' => [ 'description' => '返回查询的历史版本的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的历史版本数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', ], 'TotalCount' => [ 'description' => '总计数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '166', ], 'Versions' => [ 'description' => '版本信息列表。', 'type' => 'array', 'items' => [ 'description' => '版本信息集合。', 'type' => 'object', 'properties' => [ 'BuildTime' => [ 'description' => '版本创建UTC时间。', 'type' => 'string', 'example' => '2022-08-29T22:02:14Z', ], 'ImageAvailable' => [ 'description' => '镜像可用性。可能值：'."\n" .'- true：可用。'."\n" .'- false：不可用。'."\n" .'- unknown：未知。', 'type' => 'string', 'example' => 'true', ], 'ImageId' => [ 'description' => '镜像ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'Message' => [ 'description' => '服务的摘要信息。', 'type' => 'string', 'example' => 'Service is Running', ], 'ServiceRunnable' => [ 'description' => 'eas服务是否启用，可能值：'."\n" .'- true：启用。'."\n" .'- false：未启用。'."\n" .'- unknown：未知。', 'type' => 'string', 'example' => 'true', ], 'ServiceConfig' => [ 'description' => '服务部署配置。只有自定义镜像部署才会返回此字段。', 'type' => 'string', 'example' => '{'."\n" .' "metadata": {'."\n" .' "cpu": 1,'."\n" .' "instance": 1,'."\n" .' "memory": 1024'."\n" .' },'."\n" .' "name": "echo"'."\n" .'}', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E089D584-B6F4-50C4-9902-DA2295B7****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 166,\\n \\"Versions\\": [\\n {\\n \\"BuildTime\\": \\"2022-08-29T22:02:14Z\\",\\n \\"ImageAvailable\\": \\"true\\",\\n \\"ImageId\\": 4,\\n \\"Message\\": \\"Service is Running\\",\\n \\"ServiceRunnable\\": \\"true\\",\\n \\"ServiceConfig\\": \\"{\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"cpu\\\\\\": 1,\\\\n \\\\\\"instance\\\\\\": 1,\\\\n \\\\\\"memory\\\\\\": 1024\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"echo\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询服务历史版本', ], 'ListServiceContainers' => [ 'summary' => '查询服务的容器列表。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/instances/{InstanceName}/containers', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '172666', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'InstanceName', 'in' => 'path', 'schema' => [ 'description' => '服务实例的名称。', 'type' => 'string', 'required' => true, 'example' => 'foo-69xxxx4f4-5w9r9', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ServiceName' => [ 'description' => '服务名称。', 'type' => 'string', 'example' => 'foo', ], 'Containers' => [ 'description' => '服务实例的容器列表。', 'type' => 'array', 'items' => [ 'description' => '容器的详细信息。', '$ref' => '#/components/schemas/ContainerInfo', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ServiceName\\": \\"foo\\",\\n \\"Containers\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"Image\\": \\"\\",\\n \\"Port\\": 0,\\n \\"RestartCount\\": 0,\\n \\"Ready\\": true,\\n \\"CurrentStatus\\": \\"\\",\\n \\"CurrentReaon\\": \\"\\",\\n \\"CurrentTimestamp\\": \\"\\",\\n \\"LastStatus\\": \\"\\",\\n \\"LastReason\\": \\"\\",\\n \\"LastTimestamp\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询服务的容器列表', ], 'ListServices' => [ 'summary' => '列举服务。', 'path' => '/api/v2/services', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '37031', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'title' => '排序字段 （时间戳类型默认倒序排序）', 'description' => '排序字段。按时间戳类型默认倒序排序。', 'type' => 'string', 'required' => false, 'example' => 'CreateTime', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'title' => '排序方式（默认降序）', 'description' => '排序方式，取值如下：'."\n" .'- desc（默认值）：降序。'."\n" .'- asc：升序。', 'type' => 'string', 'required' => false, 'example' => 'asc', ], ], [ 'name' => 'Filter', 'in' => 'query', 'schema' => [ 'title' => '模糊匹配字段（只支持按服务名字模糊匹配）', 'description' => '模糊匹配字段。只支持按服务名字模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'foo', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '请求的页码（默认为1）', 'description' => '服务列表的请求页码，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为100）', 'description' => '分页查询时设置的每页显示的服务数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'title' => '服务组名称过滤', 'description' => '服务群组名称，如何获取服务群组名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => false, 'example' => 'foo', ], ], [ 'name' => 'ParentServiceUid', 'in' => 'query', 'schema' => [ 'description' => 'Band成员服务对应的主服务ID。', 'type' => 'string', 'required' => false, 'example' => 'eas-m-ijafy3c8cxxxx', ], ], [ 'name' => 'ServiceType', 'in' => 'query', 'schema' => [ 'description' => '服务类型，取值如下：'."\n" .'- Async'."\n" .'- Standard'."\n" .'- Queue'."\n" .'- LLM'."\n" .'- RAG'."\n" .'- Serverless'."\n" .'- LLMGatewayService'."\n" .'- Offline Task'."\n" .'- SDCluster'."\n" .'- ScalableJob'."\n" .'- ScalableJobService'."\n" .'- AssistantJob', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'AssistantJob' => 'AssistantJob', 'Async' => '异步服务', 'LLMGatewayService' => 'LLM智能路由', 'RAG' => 'RAG场景化部署', 'Standard' => '标准部署', 'SDCluster' => 'SDCluster', 'ScalableJob' => '可伸缩任务', 'ScalableJobService' => '可伸缩任务服务', 'OfflineTask' => '离线任务', 'Serverless' => 'Serverless', 'LLM' => 'LLM场景化部署', 'Queue' => '队列服务', ], 'example' => 'Standard', ], ], [ 'name' => 'Label', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '按标签过滤。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '按`{"key":"value"}`格式填写。Value可为null或空字符，代表只按Key过滤，Value可为任意值。', 'example' => '{"key1":"value1","key2":null}', ], ], ], [ 'name' => 'ServiceStatus', 'in' => 'query', 'schema' => [ 'description' => '服务运行的状态。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Creating' => 'Creating', 'Stopped' => 'Stopped', 'Failed' => 'Failed', 'Complete' => 'Complete', 'Cloning' => 'Cloning', 'Stopping' => 'Stopping', 'Updating' => 'Updating', 'Waiting' => 'Waiting', 'HotUpdate' => 'HotUpdate', 'Committing' => 'Committing', 'Starting' => 'Starting', 'DeleteFailed' => 'DeleteFailed', 'Running' => 'Running', 'Developing' => 'Developing', 'Scaling' => 'Scaling', 'Deleted' => 'Deleted', 'Pending' => 'Pending', 'Deleting' => 'Deleting', ], 'example' => 'Running', ], ], [ 'name' => 'ServiceName', 'in' => 'query', 'schema' => [ 'description' => '服务名。', 'type' => 'string', 'required' => false, 'example' => 'echo_test', ], ], [ 'name' => 'ServiceUid', 'in' => 'query', 'schema' => [ 'description' => '服务UID。', 'type' => 'string', 'required' => false, 'example' => 'eas-m-c9iw3yitxxxx', ], ], [ 'name' => 'ResourceName', 'in' => 'query', 'schema' => [ 'description' => '服务所属的资源组名称或ID。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'eas-r-hd0qwy8cxxxx', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '1234**', ], ], [ 'name' => 'QuotaId', 'in' => 'query', 'schema' => [ 'description' => '配额ID。', 'type' => 'string', 'required' => false, 'example' => 'quota1****', ], ], [ 'name' => 'Gateway', 'in' => 'query', 'schema' => [ 'description' => '私有网关ID。', 'type' => 'string', 'required' => false, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'Role', 'in' => 'query', 'schema' => [ 'description' => '服务角色。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'DataLoader' => 'DataLoader', 'FrontEnd' => 'FrontEnd', 'DataSet' => 'DataSet', 'SDProxy' => 'SDProxy', 'LLMScheduler' => 'LLMScheduler', 'ScalableJob' => 'ScalableJob', 'LLMGateway' => 'LLMGateway', 'Job' => 'Job', 'Queue' => 'Queue', ], 'example' => 'LLMGateway', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => '服务所使用的资源类型，取值如下：'."\n" .'- PublicResource'."\n" .'- DedicatedResource'."\n" .'- Lingjun'."\n" .'- SelfManagedLingjun', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Lingjun' => '灵骏资源配额', 'PublicResource' => '公共资源组', 'DedicatedResource' => '专属资源组', 'SelfManagedLingjun' => '灵骏自运维资源组', ], 'example' => 'PublicResource', ], ], [ 'name' => 'IncludeNoWorkspace', 'in' => 'query', 'schema' => [ 'description' => '是否包含不属于任何工作空间的服务。默认为 true。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'ResourceAliasName', 'in' => 'query', 'schema' => [ 'description' => '资源组的自定义名称。', 'type' => 'string', 'required' => false, 'example' => 'example', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => false, 'example' => 'eas-r-asdas****', ], ], [ 'name' => 'ResourceBurstable', 'in' => 'query', 'schema' => [ 'description' => '服务是否开启弹性资源池。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], [ 'name' => 'CronscalerEnabled', 'in' => 'query', 'schema' => [ 'description' => '服务是否开启定时扩缩容。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], [ 'name' => 'AutoscalerEnabled', 'in' => 'query', 'schema' => [ 'description' => '服务是否开启弹性伸缩。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], [ 'name' => 'TrafficState', 'in' => 'query', 'schema' => [ 'description' => '是否承接群组流量(仅对群组服务有效)', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'standalone' => '否', 'grouping' => '是', ], 'example' => 'grouping', ], ], [ 'name' => 'CallerUid', 'in' => 'query', 'schema' => [ 'title' => '服务创建账号的 UID', 'description' => '服务创建账号的 UID', 'type' => 'string', 'required' => false, 'example' => '19989224166xxxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Services' => [ 'description' => '服务列表。', 'type' => 'array', 'items' => [ 'description' => '服务实例。', '$ref' => '#/components/schemas/Service', ], ], 'PageNumber' => [ 'description' => '返回查询的服务列表的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的服务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'TotalCount' => [ 'description' => '服务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Services\\": [\\n {\\n \\"ServiceGroup\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"Cpu\\": 0,\\n \\"Image\\": \\"\\",\\n \\"Gpu\\": 0,\\n \\"TotalInstance\\": 0,\\n \\"AccessToken\\": \\"\\",\\n \\"ResourceBurstable\\": true,\\n \\"InternetEndpoint\\": \\"\\",\\n \\"ResourceAlias\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"TrafficState\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Resource\\": \\"\\",\\n \\"SecondaryInternetEndpoint\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"LabelValue\\": \\"\\",\\n \\"LabelKey\\": \\"\\"\\n }\\n ],\\n \\"Namespace\\": \\"\\",\\n \\"Weight\\": 0,\\n \\"Role\\": \\"\\",\\n \\"SecondaryIntranetEndpoint\\": \\"\\",\\n \\"PendingInstance\\": 0,\\n \\"ServiceName\\": \\"\\",\\n \\"SafetyLock\\": \\"\\",\\n \\"Region\\": \\"\\",\\n \\"AppType\\": \\"\\",\\n \\"InstanceCountInResource\\": {\\n \\"Quota\\": 0,\\n \\"Public\\": 0,\\n \\"Dedicated\\": 0\\n },\\n \\"IntranetEndpoint\\": \\"\\",\\n \\"QuotaId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"CurrentVersion\\": 0,\\n \\"RunningInstance\\": 0,\\n \\"WorkspaceId\\": \\"\\",\\n \\"CallerUid\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Source\\": \\"\\",\\n \\"ServiceId\\": \\"\\",\\n \\"AppVersion\\": \\"\\",\\n \\"CronscalerEnabled\\": true,\\n \\"ServiceConfig\\": \\"\\",\\n \\"Gateway\\": \\"\\",\\n \\"AppSpecName\\": \\"\\",\\n \\"GPUCorePercentage\\": 0,\\n \\"GPUMemory\\": 0,\\n \\"AppConfig\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"AutoscalerEnabled\\": true,\\n \\"ExtraData\\": \\"\\",\\n \\"LatestVersion\\": 0,\\n \\"UpdateTime\\": \\"\\",\\n \\"ServiceUid\\": \\"\\",\\n \\"ParentUid\\": \\"\\",\\n \\"RoleAttrs\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询服务列表', ], 'ListGroups' => [ 'summary' => '列举已创建的服务群组。', 'path' => '/api/v2/groups', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '153481', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页大小，默认100', 'description' => '分页查询时设置的每页显示的服务群组数量，默认为100。', 'type' => 'string', 'required' => false, 'example' => '20', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码数，默认1', 'description' => '服务群组列表的当前页码，默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'Filter', 'in' => 'query', 'schema' => [ 'title' => '名字过滤', 'description' => '设置的过滤名称，支持模糊匹配。', 'type' => 'string', 'required' => false, 'example' => 'foo', ], ], [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => [ 'description' => '工作空间ID。', 'type' => 'string', 'required' => false, 'example' => '123***', ], ], [ 'name' => 'TrafficMode', 'in' => 'query', 'schema' => [ 'title' => '流量分配方式筛选', 'description' => '流量分配方式筛选', 'type' => 'string', 'required' => false, 'example' => 'auto', ], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'CreateTime', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'title' => '排序顺序', 'description' => '排序顺序', 'type' => 'string', 'required' => false, 'example' => 'desc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Groups' => [ 'description' => '服务群组列表。', 'type' => 'array', 'items' => [ 'description' => '服务群组信息。', '$ref' => '#/components/schemas/Group', ], ], 'PageSize' => [ 'description' => '返回每页显示的群组数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20', ], 'PageNumber' => [ 'description' => '返回查询的群组列表的当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'TotalCount' => [ 'description' => '总计数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Groups\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"ClusterId\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"QueueService\\": \\"\\",\\n \\"InternetEndpoint\\": \\"\\",\\n \\"IntranetEndpoint\\": \\"\\",\\n \\"AccessToken\\": \\"\\",\\n \\"TrafficMode\\": \\"\\"\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 5\\n}","type":"json"}]', 'title' => '查看服务组列表', ], 'DescribeMachineSpec' => [ 'summary' => '查询可用机器规格列表', 'path' => '/api/v2/public/instance_types', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '146280', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => '资源类型，默认为公共资源组。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Public' => '公共资源组', 'Dedicated' => '专属资源组', ], 'example' => 'Public', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => '付费方式，默认为按量付费。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PostPaid' => '按量付费', 'PrePaid' => '包年包月', ], 'example' => 'PostPaid', ], ], [ 'name' => 'InstanceTypes', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => '参数已废弃。', 'type' => 'array', 'items' => [ 'description' => '参数已废弃。', 'type' => 'string', 'required' => false, 'example' => '无需填写', ], 'deprecated' => true, 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Types' => [ 'description' => '当指定 CPU Memory 部署时，可以支持的组合值。', 'type' => 'array', 'items' => [ 'description' => '支持的组合列表。'."\n" .'例如:'."\n" .'```'."\n" .'{"CPU":1,"Memory":[1000,2000,4000]}'."\n" .'```'."\n" .'代表当 CPU 为 1 核时，内存可选值为1000,2000 或4000', 'type' => 'object', 'properties' => [ 'CPU' => [ 'description' => 'CPU 的可选值', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'Memory' => [ 'description' => '当CPU为上面的指定值时，内存的可选值。', 'type' => 'array', 'items' => [ 'description' => '内存的可选值列表。', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', ], ], ], ], ], 'InstanceMetas' => [ 'description' => '当指定机型部署时，可用的机型列表。', 'type' => 'array', 'items' => [ 'description' => '可用机型相关信息。', 'type' => 'object', 'properties' => [ 'CPU' => [ 'description' => '机型的 CPU 核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '32', ], 'Memory' => [ 'description' => '该机型的内存数(单位 G)。', 'type' => 'number', 'format' => 'float', 'example' => '188', ], 'GPU' => [ 'description' => '机型的 GPU 型号。若非 GPU 机型，则无此字段。', 'type' => 'string', 'example' => 'GU30', ], 'GPUAmount' => [ 'description' => '机型的 GPU 卡数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'GPUMemory' => [ 'description' => '机型的 GPU 显存数(单位 G)', 'type' => 'number', 'format' => 'float', 'example' => '24', ], 'InstanceType' => [ 'description' => '机型名称。', 'type' => 'string', 'example' => 'ml.gu7i.c32m188.1-gu30', ], 'SpotDiscount' => [ 'description' => '机型使用1小时保护模式竞价实例时，当前能接受的最低折扣。0.1 代表 1 折。若无此字段，代表不支持购买竞价实例。', 'type' => 'number', 'format' => 'float', 'example' => '0.12', ], 'NonProtectSpotDiscount' => [ 'description' => '机型使用无保护模式竞价实例时，当前能接受的最低折扣。0.1 代表 1 折。若无此字段，代表不支持购买竞价实例。', 'type' => 'number', 'format' => 'float', 'example' => '0.1', ], 'IsAvailable' => [ 'description' => '机型当前是否可用。', 'type' => 'boolean', 'example' => 'true', ], 'Vendor' => [ 'description' => '机型供应来源。', 'type' => 'string', 'enumValueTitles' => [ 'ECS' => 'ECS', 'BareMetal' => '裸金属计算集群', 'Lingjun' => '灵骏智算集群', ], 'example' => 'ECS', ], 'StockStatus' => [ 'description' => '机型库存状态。', 'type' => 'string', 'enumValueTitles' => [ 'WithStock' => '有库存', 'ClosedWithStock' => '库存较少', 'NoStock' => '无库存', ], 'example' => 'WithStock', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Types\\": [\\n {\\n \\"CPU\\": 1,\\n \\"Memory\\": [\\n 1000\\n ]\\n }\\n ],\\n \\"InstanceMetas\\": [\\n {\\n \\"CPU\\": 32,\\n \\"Memory\\": 188,\\n \\"GPU\\": \\"GU30\\",\\n \\"GPUAmount\\": 1,\\n \\"GPUMemory\\": 24,\\n \\"InstanceType\\": \\"ml.gu7i.c32m188.1-gu30\\",\\n \\"SpotDiscount\\": 0.12,\\n \\"NonProtectSpotDiscount\\": 0.1,\\n \\"IsAvailable\\": true,\\n \\"Vendor\\": \\"ECS\\",\\n \\"StockStatus\\": \\"WithStock\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询可用机器规格列表', ], 'UpdateVirtualResource' => [ 'summary' => '更新虚拟资源组信息。', 'path' => '/api/v2/virtualresources/{ClusterId}/{VirtualResourceId}', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '238299', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '虚拟资源所在的集群ID', 'description' => '虚拟资源组所在的地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'VirtualResourceId', 'in' => 'path', 'schema' => [ 'title' => '虚拟资源的ID', 'description' => '虚拟资源组ID。', 'type' => 'string', 'required' => true, 'example' => 'eas-vr-npovr28onap1xxxxxx'."\n", ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Resources' => [ 'title' => '虚拟资源所包含的资源列表，如果指定，将会覆盖先前的数据', 'description' => '虚拟资源组包含的资源列表。'."\n" .'>如果指定，将会覆盖先前的数据。>', 'type' => 'array', 'items' => [ 'description' => '资源详情。', 'type' => 'object', 'properties' => [ 'Region' => [ 'title' => '资源所在的集群ID', 'description' => '资源所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'Priority' => [ 'title' => '资源的使用优先级', 'description' => '资源调度优先级。数字越大，调度优先级越高。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', ], 'InstanceType' => [ 'title' => '资源所使用的实例规格，如果使用公共资源组，则必须指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。）', 'description' => '公共资源组机型规格。'."\n" .'>用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。>', 'type' => 'string', 'required' => false, 'example' => 'ecs.s6-c1m2.xlarge'."\n", ], 'ResourceId' => [ 'title' => '资源ID，如果该资源组为EAS专属资源组，则需要指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId其中的一个字段，且只能指定一个。）', 'description' => '专属资源组ID。如何查询专属资源组ID，请参见[ListResources](~~412133~~)。'."\n" .'>用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。>', 'type' => 'string', 'required' => false, 'example' => 'eas-r-g55ieatgg3butwrn7a', ], 'QuotaId' => [ 'title' => '灵骏资源的ID，如果该资源为灵骏智算资源组，则需要指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。）', 'description' => '灵骏资源配额ID。'."\n" .'>用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。>', 'type' => 'string', 'required' => false, 'example' => 'quota185lqf994k6', ], 'SpotPriceLimit' => [ 'title' => '实例规格的竞拍价格，如果资源为抢占类型，则需要指定该字段。', 'description' => '公共资源组抢占实例价格上限。'."\n" .'不设置代表不使用抢占式实例。>', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '10.05', ], ], 'required' => false, ], 'required' => false, ], 'VirtualResourceName' => [ 'title' => '虚拟资源的名称，如果不指定，默认和虚拟资源的ID相同', 'description' => '新的虚拟资源组名称。', 'type' => 'string', 'required' => false, 'example' => 'NewMyVirtualResource', ], 'DisableSpotProtectionPeriod' => [ 'description' => '是否关闭竞价型实例保留时长', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Successfully updated virtual resource eas-vr-npovr28onap1xxxxxx', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Successfully updated virtual resource eas-vr-npovr28onap1xxxxxx\\"\\n}","type":"json"}]', 'title' => '更新虚拟资源组信息', ], 'ListVirtualResource' => [ 'summary' => '获取当前用户的虚拟资源组列表。', 'path' => '/api/v2/virtualresources', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238285', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '请求的页码（默认为1）', 'description' => '虚拟资源组列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为100）', 'description' => '分页查询时设置的每页显示的虚拟资源组数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'VirtualResourceId', 'in' => 'query', 'schema' => [ 'title' => '虚拟资源的ID，如果指定，将会返回对应的虚拟资源信息', 'description' => '虚拟资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'eas-vr-npovr28onap1xxxxxx'."\n", ], ], [ 'name' => 'VirtualResourceName', 'in' => 'query', 'schema' => [ 'title' => '虚拟资源的名称，如果指定，将会返回名称相近的虚拟资源的信息', 'description' => '虚拟资源组名称。', 'type' => 'string', 'required' => false, 'example' => 'MyVirtualResource', ], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'description' => '排序字段。按时间戳类型默认倒序排序。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'VirtualResourceName' => 'VirtualResourceName', 'CreateTime' => 'CreateTime', 'UpdateTime' => 'UpdateTime', ], 'example' => 'CreateTime', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => '排序方式，取值如下：'."\n" .'- Desc：降序。'."\n" .'- Asc：升序。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Asc' => 'Asc', 'Desc' => 'Desc', ], 'example' => 'Desc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回Body。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'PageNumber' => [ 'description' => '返回查询的虚拟资源组列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的虚拟资源组数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'title' => '虚拟资源的总数', 'description' => '虚拟资源组总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'VirtualResources' => [ 'title' => '虚拟资源列表', 'description' => '虚拟资源组列表。', 'type' => 'array', 'items' => [ 'description' => '虚拟资源组详情。', 'type' => 'object', 'properties' => [ 'VirtualResourceName' => [ 'title' => '虚拟资源的名称，如果没有指定，默认和虚拟资源ID相同', 'description' => '虚拟资源组名称。', 'type' => 'string', 'example' => 'MyVirtualResource', ], 'VirtualResourceId' => [ 'title' => '虚拟资源的ID', 'description' => '虚拟资源组ID。', 'type' => 'string', 'example' => 'eas-vr-npovr28onap1xxxxxx'."\n", ], 'CreateTime' => [ 'title' => '虚拟资源的创建时间', 'description' => '虚拟资源组的创建时间。', 'type' => 'string', 'example' => '2024-10-16T17:52:49Z'."\n", ], 'UpdateTime' => [ 'title' => '虚拟资源的更新时间', 'description' => '虚拟资源组的最后更新时间。', 'type' => 'string', 'example' => '2024-10-16T19:52:49Z'."\n", ], 'ServiceCount' => [ 'description' => '部署服务数', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"VirtualResources\\": [\\n {\\n \\"VirtualResourceName\\": \\"MyVirtualResource\\",\\n \\"VirtualResourceId\\": \\"eas-vr-npovr28onap1xxxxxx\\\\n\\",\\n \\"CreateTime\\": \\"2024-10-16T17:52:49Z\\\\n\\",\\n \\"UpdateTime\\": \\"2024-10-16T19:52:49Z\\\\n\\",\\n \\"ServiceCount\\": 1\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询虚拟资源组列表', ], 'DescribeVirtualResource' => [ 'summary' => '查看虚拟资源组详情。', 'path' => '/api/v2/virtualresources/{ClusterId}/{VirtualResourceId}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '238272', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '虚拟资源的集群ID', 'description' => '虚拟资源组所在的地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'VirtualResourceId', 'in' => 'path', 'schema' => [ 'title' => '虚拟资源的ID', 'description' => '虚拟资源组ID。', 'type' => 'string', 'required' => true, 'example' => 'eas-vr-npovr28onap1xxxxxx'."\n", ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '虚拟资源组详细信息。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Resources' => [ 'title' => '虚拟资源所包含的资源列表', 'description' => '虚拟资源组包含的资源列表。', 'type' => 'array', 'items' => [ 'description' => '资源详情。', 'type' => 'object', 'properties' => [ 'Region' => [ 'title' => '资源所在的集群ID', 'description' => '资源所在地域。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'Priority' => [ 'title' => '资源的使用优先级', 'description' => '资源调度优先级。数字越大，调度优先级越高。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'InstanceType' => [ 'title' => '资源所使用的实例规格，如果使用公共资源组，则必须指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId其中的一个字段，且只能指定一个。）', 'description' => '公共资源组机型规格。', 'type' => 'string', 'example' => 'ecs.s6-c1m2.xlarge'."\n", ], 'QuotaId' => [ 'title' => '灵骏ID，如果该资源为灵骏智算资源组，则需要指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。）', 'description' => '灵骏资源配额ID。', 'type' => 'string', 'example' => 'quota185lqxxxxxx'."\n", ], 'SpotPriceLimit' => [ 'title' => '实例规格的竞拍价格，如果资源为抢占类型，则需要指定该字段。', 'description' => '公共资源组抢占实例价格上限。', 'type' => 'number', 'format' => 'float', 'example' => '10.05', ], 'ResourceId' => [ 'title' => '资源ID，如果该资源为EAS专属资源组，则需要指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。）', 'description' => '专属资源组ID。', 'type' => 'string', 'example' => 'eas-r-g55ieatgg3buxxxxxx'."\n", ], ], ], ], 'CreateTime' => [ 'title' => '虚拟资源的创建时间', 'description' => '虚拟资源组的创建时间。', 'type' => 'string', 'example' => '2024-10-16T17:52:49Z'."\n", ], 'UpdateTime' => [ 'title' => '虚拟资源的更新时间', 'description' => '虚拟资源组的最后更新时间。', 'type' => 'string', 'example' => '2024-10-16T19:52:49Z'."\n", ], 'VirtualResourceId' => [ 'title' => '虚拟资源的ID', 'description' => '虚拟资源组ID。', 'type' => 'string', 'example' => 'eas-vr-npovr28onap1xxxxxx'."\n", ], 'VirtualResourceName' => [ 'title' => '虚拟资源的名称', 'description' => '虚拟资源组名称。', 'type' => 'string', 'example' => 'MyVirtualResource'."\n", ], 'ServiceCount' => [ 'description' => '部署服务数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DisableSpotProtectionPeriod' => [ 'description' => '是否关闭竞价型实例保留时长。', 'type' => 'boolean', 'example' => 'true', ], 'Features' => [ 'description' => '虚拟资源组的功能集合，用于标识该资源组支持的特性。', 'type' => 'array', 'items' => [ 'description' => '虚拟资源组所支持的具体特性。目前只支持GpuShare(GPU共享)。', 'type' => 'string', 'example' => 'GpuShare', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Resources\\": [\\n {\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"Priority\\": 3,\\n \\"InstanceType\\": \\"ecs.s6-c1m2.xlarge\\\\n\\",\\n \\"QuotaId\\": \\"quota185lqxxxxxx\\\\n\\",\\n \\"SpotPriceLimit\\": 10.05,\\n \\"ResourceId\\": \\"eas-r-g55ieatgg3buxxxxxx\\\\n\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-10-16T17:52:49Z\\\\n\\",\\n \\"UpdateTime\\": \\"2024-10-16T19:52:49Z\\\\n\\",\\n \\"VirtualResourceId\\": \\"eas-vr-npovr28onap1xxxxxx\\\\n\\",\\n \\"VirtualResourceName\\": \\"MyVirtualResource\\\\n\\",\\n \\"ServiceCount\\": 1,\\n \\"DisableSpotProtectionPeriod\\": true,\\n \\"Features\\": [\\n \\"GpuShare\\"\\n ]\\n}","type":"json"}]', 'title' => '查看虚拟资源组详情', ], 'DeleteVirtualResource' => [ 'summary' => '删除一个已有的虚拟资源组，仅当虚拟资源组中无服务任务的情况下才允许删除。', 'path' => '/api/v2/virtualresources/{ClusterId}/{VirtualResourceId}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '238260', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '虚拟资源所在的集群ID', 'description' => '虚拟资源组所在的地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'VirtualResourceId', 'in' => 'path', 'schema' => [ 'title' => '虚拟资源的ID', 'description' => '虚拟资源组ID。', 'type' => 'string', 'required' => true, 'example' => 'eas-vr-npovr28onap1xxxxxx', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'title' => '', 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Successfully deleted virtual resource eas-vr-npovr28onap1xxxxxx', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Successfully deleted virtual resource eas-vr-npovr28onap1xxxxxx\\"\\n}","type":"json"}]', 'title' => '删除虚拟资源组', ], 'CreateVirtualResource' => [ 'summary' => '创建一个新的虚拟资源组。', 'path' => '/api/v2/virtualresources', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '238222', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Resources' => [ 'title' => '虚拟资源所包含的资源列表', 'description' => '虚拟资源组包含的资源列表。', 'type' => 'array', 'items' => [ 'description' => '资源详情。', 'type' => 'object', 'properties' => [ 'Region' => [ 'title' => '资源所在的集群ID', 'description' => '资源所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], 'InstanceType' => [ 'title' => '资源所使用的实例规格，如果使用公共资源组，则必须指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。）', 'description' => '公共资源组机型规格。'."\n" .'>用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。>', 'type' => 'string', 'required' => false, 'example' => 'ecs.s6-c1m2.xlarge'."\n", ], 'Priority' => [ 'title' => '资源的使用优先级', 'description' => '资源调度优先级。数字越大，调度优先级越高。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '6', ], 'QuotaId' => [ 'title' => '灵骏ID，如果该资源为灵骏智算资源组，则需要指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。）', 'description' => '灵骏资源配额ID。'."\n" .'>用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。>', 'type' => 'string', 'required' => false, 'example' => 'quota185lqxxxxxx', ], 'SpotPriceLimit' => [ 'title' => '实例规格的竞拍价格，如果资源为抢占类型，则需要指定该字段。', 'description' => '公共资源组抢占实例价格上限。'."\n" .'不设置代表不使用抢占式实例。>', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '10.05', ], 'ResourceId' => [ 'title' => '资源ID，如果该资源为EAS专属资源组，则需要指定该字段。（注意: 用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。）', 'description' => '专属资源组ID。如何查询专属资源组ID，请参见[ListResources](~~412133~~)。'."\n" .'>用户必须指定InstanceType、ResourceId和QuotaId中的一个字段，且只能指定一个。>', 'type' => 'string', 'required' => false, 'example' => 'eas-r-g55ieatgg3buxxxxxx', ], ], 'required' => false, ], 'required' => false, ], 'VirtualResourceName' => [ 'title' => '虚拟资源的名称，默认为虚拟资源的ID', 'description' => '虚拟资源组名称，默认为虚拟资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'MyVirtualResource', ], 'DisableSpotProtectionPeriod' => [ 'description' => '是否关闭竞价型实例保留时长', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'description' => '返回结果信息。', 'type' => 'string', 'example' => 'Successfully created virtual resource eas-vr-npovr28onap1xxxxxx', ], 'VirtualResourceId' => [ 'title' => '虚拟资源的ID', 'description' => '虚拟资源组ID。', 'type' => 'string', 'example' => 'eas-vr-npovr28onap1xxxxxx', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Successfully created virtual resource eas-vr-npovr28onap1xxxxxx\\",\\n \\"VirtualResourceId\\": \\"eas-vr-npovr28onap1xxxxxx\\"\\n}","type":"json"}]', 'title' => '创建虚拟资源组', ], 'CreateResource' => [ 'summary' => '创建一个新的资源组。', 'path' => '/api/v2/resources', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '37055', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'EcsInstanceType' => [ 'title' => '实例机型，对应ecs机型', 'description' => '实例机型，对应ECS机型。'."\n" .'>当ResourceType选择Dedicated时，该参数为必填。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c6.8xlarge', ], 'SystemDiskSize' => [ 'title' => '系统盘大小(200-2000GB)。不传默认为200。', 'description' => '系统盘大小，单位为GiB。取值范围为200-2000GiB，不配置默认为200GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2000', 'minimum' => '200', 'example' => '200', 'default' => '200', ], 'EcsInstanceCount' => [ 'title' => '实例数量', 'description' => '实例数量。'."\n" .'> 当ResourceType选择Dedicated时，该参数为必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', ], 'ChargeType' => [ 'title' => '付费类型，预付费PrePaid，后付费PostPaid', 'description' => '付费类型，取值如下：'."\n" .'- PrePaid：预付费。'."\n" .'- PostPaid：后付费。'."\n" .'> 当ResourceType选择Dedicated时，该参数为必填。'."\n" .'>', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PostPaid' => '后付费', 'PrePaid' => '预付费', ], 'example' => 'PostPaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], 'AutoRenewal' => [ 'title' => '是否自动续费', 'description' => '是否自动续费，取值如下：'."\n" .'- false（默认值）：表示不自动续费。'."\n" .'- true：表示自动续费。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'Zone' => [ 'description' => '实例所属可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-f', ], 'ResourceType' => [ 'description' => '资源组类型，取值如下：'."\n" ."\n" .'- Dedicated：专属资源组。'."\n" .'- SelfManaged：自运维资源组。'."\n" .'> 使用自运维资源组时，需要申请添加白名单。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'SelfManaged' => 'SelfManaged', 'Dedicated' => 'Dedicated', ], 'example' => 'Dedicated', ], 'SelfManagedResourceOptions' => [ 'description' => '自运维资源组配置选项。', 'type' => 'object', 'properties' => [ 'ExternalClusterId' => [ 'description' => '自运维集群Id。', 'type' => 'string', 'required' => false, 'example' => 'cf0386f250f2545689ca7fdd1cd******', ], 'RoleName' => [ 'description' => '授予云服务PAI-EAS相关权限的RAM角色名称。', 'type' => 'string', 'required' => false, 'example' => 'clusterrole', ], 'NodeMatchLabels' => [ 'description' => '节点的标签键值对集合。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '"key1": "value1"', 'description' => '节点的标签键值对。', ], ], 'NodeTolerations' => [ 'description' => '节点污点的容忍度列表。', 'type' => 'array', 'items' => [ 'description' => '节点污点的容忍度。', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '键名。', 'type' => 'string', 'required' => false, 'example' => 'key1', ], 'value' => [ 'description' => '键值。', 'type' => 'string', 'required' => false, 'example' => 'value1', ], 'operator' => [ 'description' => '键名和键值的关系。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Equal' => 'Equal', 'Exists' => 'Exists', ], 'example' => 'Equal', ], 'effect' => [ 'description' => '效果。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PreferNoSchedule' => 'PreferNoSchedule', 'NoSchedule' => 'NoSchedule', 'NoExecute' => 'NoExecute', ], 'example' => 'NoSchedule', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], 'Labels' => [ 'description' => '用户定义标签。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '标签。', 'example' => '{"key":"value"}', ], ], 'ResourceName' => [ 'description' => '资源组名称。', 'type' => 'string', 'required' => false, 'example' => 'MyResource', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ResourceId' => [ 'title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'eas-r-h7lcw24dyqztwxxxxxx', ], 'ResourceName' => [ 'title' => '资源组名称', 'description' => '资源组名称。', 'type' => 'string', 'example' => 'MyResource', ], 'ClusterId' => [ 'title' => '资源组所在集群ID', 'description' => '资源组所在集群ID。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'OwnerUid' => [ 'title' => '资源组的Owner UID', 'description' => '资源组的Owner UID。', 'type' => 'string', 'example' => '14401087478****', ], 'InstanceIds' => [ 'description' => '机器实例ID列表。', 'type' => 'array', 'items' => [ 'description' => '机器实例ID。', 'type' => 'string', 'example' => 'eas-i-xxxxx', ], ], ], ], ], 400 => [], [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ResourceId\\": \\"eas-r-h7lcw24dyqztwxxxxxx\\",\\n \\"ResourceName\\": \\"MyResource\\",\\n \\"ClusterId\\": \\"cn-shanghai\\",\\n \\"OwnerUid\\": \\"14401087478****\\",\\n \\"InstanceIds\\": [\\n \\"eas-i-xxxxx\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '创建资源组', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'CreateResourceInstances' => [ 'summary' => '在专属资源组中创建新的机器实例。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/instances', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '39655', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组ID', 'description' => '资源组ID，如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'EcsInstanceType' => [ 'title' => '实例机型，对应ecs机型', 'description' => '实例机型，对应ECS机型。', 'type' => 'string', 'required' => true, 'example' => 'ecs.s6-c1m2.xlarge', ], 'SystemDiskSize' => [ 'title' => '系统盘大小(200-2000)GB，不传默认为200', 'description' => '系统盘的磁盘大小，单位为GiB。取值范围为200-2000 GiB，不配置默认为200GiB。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2000', 'minimum' => '200', 'example' => '200', 'default' => '200', ], 'EcsInstanceCount' => [ 'title' => '新创建的实例个数，(0, 100]', 'description' => '新创建的实例个数，取值范围1~100。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '5', ], 'ChargeType' => [ 'title' => '付费类型，预付费PrePaid，后付费PostPaid', 'description' => '付费类型，取值如下：'."\n" .'- PrePaid：预付费。'."\n" .'- PostPaid：后付费。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'PostPaid' => '后付费', 'PrePaid' => '预付费', ], 'example' => 'PrePaid', 'enum' => [ 'PrePaid', 'PostPaid', ], ], 'UserData' => [ 'title' => '用户自这义数据，小于 16KB', 'description' => '自定义用户信息，目前暂未使用。', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'x112223333', ], 'AutoRenewal' => [ 'title' => '是否自动续费', 'description' => '是否自动续费，取值如下：'."\n" .'- false（默认值）：表示不自动续费。'."\n" .'- true：表示自动续费。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'Zone' => [ 'description' => '实例所属可用区。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-f', ], 'Labels' => [ 'description' => '用户定义标签。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'description' => '标签。', 'example' => '{"key":"value"}', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'InstanceIds' => [ 'description' => '机器实例ID列表。', 'type' => 'array', 'items' => [ 'description' => '机器实例ID。', 'type' => 'string', 'example' => 'eas-i-xxxxxx', ], ], 'Message' => [ 'description' => '操作成功返回信息。', 'type' => 'string', 'example' => 'Create 5 new ecs instance(s) in resource [eas-r-asdasdasd] successfully', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"InstanceIds\\": [\\n \\"eas-i-xxxxxx\\"\\n ],\\n \\"Message\\": \\"Create 5 new ecs instance(s) in resource [eas-r-asdasdasd] successfully\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '创建资源组机器', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'CreateResourceLog' => [ 'summary' => '开通资源组SLS日志投递功能。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/log', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '39659', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '资源组所在的地域ID。例如华东2（上海）为cn-shanghai。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'ProjectName' => [ 'title' => '资源组对应的sls日志管理项目', 'description' => '资源组对应的SLS日志管理项目。如何查询项目，请参见[ListProject](~~74955~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd-sls', ], 'LogStore' => [ 'title' => 'sls日志库', 'description' => 'SLS日志库，如何查询日志库，请参见[ListLogStores](~~426970~~)。', 'type' => 'string', 'required' => true, 'example' => 'access_log', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Resource [eas-r-asdasdasd****] is deleted.', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Resource [eas-r-asdasdasd****] is deleted.\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '开通资源组日志投递 ', ], 'DeleteResource' => [ 'summary' => '删除一个已有的资源组，仅当资源组中无任务服务和资源实例的情况下才允许删除。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的地域ID。例如华东2（上海）为cn-shanghai。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的ID', 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82-9624-EC2B1779****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Resource [eas-r-asdasdasd****] is deleted.', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82-9624-EC2B1779****\\",\\n \\"Message\\": \\"Resource [eas-r-asdasdasd****] is deleted.\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '删除资源组', ], 'DeleteResourceDLink' => [ 'summary' => '关闭专属资源组VPC直连功能。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/dlink', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的地域ID。例如华东2（上海）为cn-shanghai。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的ID', 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Network interfaces are deleting', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Network interfaces are deleting\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '关闭资源组VPC直连', ], 'DeleteResourceInstances' => [ 'summary' => '删除专属资源组中的机器实例，普通用户仅允许删除后付费实例。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/instances', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '37103', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '资源组所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd****', ], ], [ 'name' => 'InstanceList', 'in' => 'query', 'schema' => [ 'description' => '实例列表，多个实例之间以半角逗号（,）分割。例如：`instanceId1,instanceId2`。如何获取实例列表，请参见[ListResourceInstances](~~412129~~)。', 'type' => 'string', 'required' => false, 'example' => 'eas-i-xxxxxxx,eas-i-xxxxxxx', ], ], [ 'name' => 'AllFailed', 'in' => 'query', 'schema' => [ 'description' => '是否删除全部创建失败实例。'."\n" .'- true：表示删除全部失败实例。'."\n" .'- false：表示不删除失败实例。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Instances eas-i-01122713****,eas-i-01122713**** are deleting', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Instances eas-i-01122713****,eas-i-01122713**** are deleting\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '删除资源组机器实例', ], 'DeleteResourceLog' => [ 'summary' => '关闭专属资源组SLS日志投递功能。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/log', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '资源组所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdas****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Log service for resource [eas-r-asdas****] is deleting', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Log service for resource [eas-r-asdas****] is deleting\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '关闭资源组日志投递', ], 'DeleteResourceInstanceLabel' => [ 'summary' => '删除资源组实例标签。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/label', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '260412', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '资源组所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-h7lcw24dyqztwxxxxxx', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => '机器实例ID。', 'type' => 'array', 'items' => [ 'description' => '机器实例ID。', 'type' => 'string', 'required' => false, 'example' => 'eas-i-xxxxx', ], 'required' => false, ], ], [ 'name' => 'AllInstances', 'in' => 'query', 'schema' => [ 'description' => '是否对资源组下所有实例生效。如果为 true，则 InstanceIds 参数不生效。', 'type' => 'boolean', 'required' => false, ], ], [ 'name' => 'Keys', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => '要删除的标签。（废弃，请使用 LabelKeys）', 'type' => 'array', 'items' => [ 'description' => '要删除的标签键。', 'type' => 'string', 'required' => false, 'example' => 'key', ], 'deprecated' => true, 'required' => false, ], ], [ 'name' => 'LabelKeys', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '要删除的标签。', 'type' => 'array', 'items' => [ 'description' => '要删除的标签键。', 'type' => 'string', 'required' => false, 'example' => 'key', ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82********', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'success', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82********\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', 'title' => '删除资源组机器实例标签', ], 'MigrateResourceInstance' => [ 'summary' => '资源组机器迁移', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/instances/migrate', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '227413', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '资源组所在的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'description' => '资源组ID。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'InstanceIds' => [ 'description' => '机器实例ID。', 'type' => 'array', 'items' => [ 'description' => '机器实例ID。', 'type' => 'string', 'required' => false, 'example' => '[\'eas-i-4ybm1bin7gygx67umh\', \'eas-i-iy6dfaag7qals6g4i2\']', ], 'required' => true, ], 'DestResourceId' => [ 'description' => '目标资源组ID', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd****', ], 'MigrateToHybrid' => [ 'description' => '是否迁移到通用计算资源组。如果为true，需要传入通用计算资源组 ID。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Success', ], 'InstanceIds' => [ 'description' => '机器实例ID', 'type' => 'array', 'items' => [ 'description' => '机器实例ID', 'type' => 'string', 'example' => '[\'eas-i-1l3saj0kfhz5lp6p5m\', \'eas-i-hgjztp6rsw5pmyko9n\']', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Success\\",\\n \\"InstanceIds\\": [\\n \\"[\'eas-i-1l3saj0kfhz5lp6p5m\', \'eas-i-hgjztp6rsw5pmyko9n\']\\"\\n ]\\n}","type":"json"}]', 'title' => '资源组机器实例迁移', ], 'UpdateResourceInstanceLabel' => [ 'summary' => '更新资源组实例标签。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/label', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '260413', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '区域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'description' => '资源组的ID。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd', ], ], [ 'name' => 'InstanceIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ 'description' => '机器实例ID。', 'type' => 'array', 'items' => [ 'description' => '机器实例ID。', 'type' => 'string', 'required' => false, 'example' => 'eas-i-xxxxxx', ], 'required' => false, ], ], [ 'name' => 'AllInstances', 'in' => 'query', 'schema' => [ 'description' => '是否对资源组下所有实例生效。如果为 true，则 InstanceIds 参数不生效。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'Labels' => [ 'description' => '用户定义标签。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '{"key":"value"}'."\n", 'description' => '标签。', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Success', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Success\\"\\n}","type":"json"}]', 'title' => '更新资源组机器实例标签', ], 'UpdateResource' => [ 'summary' => '更新专属资源组信息。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的ID', 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'ResourceName' => [ 'title' => '', 'description' => '新的资源组名称，不能超过27个字符。', 'type' => 'string', 'required' => false, 'example' => 'iot', ], 'SelfManagedResourceOptions' => [ 'description' => '自运维资源组配置选项', 'type' => 'object', 'properties' => [ 'NodeMatchLabels' => [ 'description' => '节点的标签键值对集合', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '"key1": "value1"', 'description' => '节点的标签键值对', ], ], 'NodeTolerations' => [ 'description' => '节点污点的容忍度列表', 'type' => 'array', 'items' => [ 'description' => '节点污点的容忍度', 'type' => 'object', 'properties' => [ 'key' => [ 'description' => '键名', 'type' => 'string', 'required' => false, 'example' => 'key1', ], 'value' => [ 'description' => '键值', 'type' => 'string', 'required' => false, 'example' => 'value1', ], 'operator' => [ 'description' => '键名和键值的关系', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Equal' => 'Equal', 'Exists' => 'Exists', ], 'example' => 'Equal', ], 'effect' => [ 'description' => '效果', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PreferNoSchedule' => 'PreferNoSchedule', 'NoSchedule' => 'NoSchedule', 'NoExecute' => 'NoExecute', ], 'example' => 'NoSchedule', ], ], 'required' => false, ], 'required' => false, ], ], 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ResourceId' => [ 'description' => '资源组ID。', 'type' => 'string', 'example' => 'eas-r-asdasdasd****', ], 'ResourceName' => [ 'description' => '资源组名称。', 'type' => 'string', 'example' => 'iot', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ResourceId\\": \\"eas-r-asdasdasd****\\",\\n \\"ResourceName\\": \\"iot\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '更新资源组信息', ], 'UpdateResourceDLink' => [ 'summary' => '更新指定专属资源组的VPC直连配置。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/dlink', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的Id', 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-w1ttszneb9n994****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'VSwitchId' => [ 'title' => '对端的主VSwitchID，会在该vswitch中创建ENI', 'description' => '对端的主vSwitchID，会在该vSwitch中创建ENI。', 'type' => 'string', 'required' => true, 'example' => 'vpc-uf66uio7md****', ], 'SecurityGroupId' => [ 'title' => '客户端ECS归属的安全组', 'description' => '客户端ECS归属的安全组。', 'type' => 'string', 'required' => true, 'example' => 'sg-bp149cedsfx2rfs****', ], 'VSwitchIdList' => [ 'title' => '要打通的客户端的vswitch列表，会将这些vswitch对应的网段加入到服务端的回包路由中', 'description' => '要打通的客户端的vSwitch列表，会将这些vSwitch对应的网段加入到服务端的回包路由中。', 'type' => 'array', 'items' => [ 'description' => 'vSwitch ID。', 'type' => 'string', 'required' => false, 'example' => '["vsw-8ersw98sgmlgkxxxxxx","vsw-4dsgg2at0kljjxxxxxxxx"]', ], 'required' => false, ], 'DestinationCIDRs' => [ 'title' => '要打通的客户端的网段信息，会将该网段加入到服务端的回包路由中，与VSwitchIdList可二选一', 'description' => '要打通的客户端的网段信息，会将该网段加入到服务端的回包路由中，与vSwitchIdList可二选一。', 'type' => 'string', 'required' => false, 'example' => '172.16.0.0/16', ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Network interfaces are updating', ], ], ], ], 404 => [], 409 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Network interfaces are updating\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '更新资源组VPC直连配置', ], 'UpdateResourceInstance' => [ 'summary' => '更新专属资源组机器实例的调度状态。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/instances/{InstanceId}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '155033', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '实例所属集群', 'description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '实例所属资源组Id', 'description' => '实例所属资源组ID，如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdas****', ], ], [ 'name' => 'InstanceId', 'in' => 'path', 'schema' => [ 'title' => '实例Id', 'description' => '实例ID，如何获取实例ID，请参见[ListResourceInstances](~~412129~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-i-asdas****', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求body参数。', 'type' => 'object', 'properties' => [ 'Action' => [ 'title' => '更新服务的行为：Cordon, Uncordon, Drain', 'description' => '更新专属资源组机器实例的可调度行为。取值如下：'."\n" .'- Uncordon：取消禁止服务调度到此实例。'."\n" .'- Cordon：禁止服务调度到此实例。'."\n" .'- Drain：驱逐已调度到此实例的服务实例。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'Uncordon' => '取消禁止服务调度到此实例', 'Cordon' => '禁止服务调度到此实例', 'Drain' => '驱逐已调度到此实例的服务实例', ], 'example' => 'Cordon', ], 'NewDiskSize' => [ 'type' => 'string', 'required' => false, ], 'Reason' => [ 'title' => 'Action 为 Cordon 和 Drain 时生效，记录操作原因。', 'type' => 'string', 'required' => false, 'maxLength' => 200, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ResourceId' => [ 'title' => '资源组ID', 'description' => '资源组ID。', 'type' => 'string', 'example' => 'eas-r-asdasdasd', ], 'InstanceId' => [ 'title' => '实例名', 'description' => '实例名。', 'type' => 'string', 'example' => 'eas-i-asdasdasd'."\n", ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ResourceId\\": \\"eas-r-asdasdasd\\",\\n \\"InstanceId\\": \\"eas-i-asdasdasd\\\\n\\"\\n}","type":"json"}]', 'title' => '更新资源组机器实例', ], 'DescribeResource' => [ 'summary' => '查看资源组详情。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '37069', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的ID', 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdasdasd', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '资源组详细信息。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '902976F2-6FAF-5404-8A4D-6CC223***', ], 'ResourceId' => [ 'description' => 'EAS资源ID。', 'type' => 'string', 'example' => 'eas-r-glkfpsxuw57x1h*****', ], 'ResourceName' => [ 'description' => 'EAS资源名称。', 'type' => 'string', 'example' => 'my-resouce****', ], 'ClusterId' => [ 'description' => '资源组所在的集群ID。', 'type' => 'string', 'example' => 'cn-beijing', ], 'CreateTime' => [ 'description' => '资源组创建时间。', 'type' => 'string', 'example' => '2020-05-19T14:19:42Z', ], 'UpdateTime' => [ 'description' => '资源组最后更新时间。', 'type' => 'string', 'example' => '2021-02-24T11:52:17Z', ], 'OwnerUid' => [ 'description' => '资源组负责人ID。', 'type' => 'string', 'example' => '14401087478****', ], 'InstanceCount' => [ 'description' => '资源组中机器实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'PrePaidInstanceCount' => [ 'description' => '资源组中预付费机器实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PostPaidInstanceCount' => [ 'description' => '资源组中后付费机器实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '3', ], 'CpuCount' => [ 'description' => 'CPU总核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], 'GpuCount' => [ 'description' => 'GPU总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4', ], 'Memory' => [ 'description' => '总内存，单位为MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '8192', ], 'CpuUsed' => [ 'description' => '已使用CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'GpuUsed' => [ 'description' => '已使用GPU数。', 'type' => 'number', 'format' => 'float', 'example' => '2', ], 'MemoryUsed' => [ 'description' => '已使用内存，单位为MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', ], 'Status' => [ 'description' => '资源组状态。', 'type' => 'string', 'example' => 'ResourceReady', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'Resource is ready', ], 'ExtraData' => [ 'description' => '额外信息。如VPC打通状态，SLS日志状态等。', 'type' => 'string', 'example' => '{"vswitch_id":"vsw-bp17uo6xebcusy****","gpu_share":true,"aux_vswitch_id_list":["vsw-bp13b3pvjap3vxn****","vsw-bp1nls8o5hk8mt8*****"],"security_group_id":"sg-bp1j1z7297hcink*****","vpc_id":"vpc-bp1kjr3rfyhx01*****","destination_cidr":"172.16.0.12/28","role_arn":"acs:ram::1157703270*****:role/AliyunServiceRoleForPaiEas","sls_project":"","sls_logstore":"","sls_status":"ResourceReady","sls_message":"","update_time":""}', ], 'ResourceType' => [ 'description' => '资源组类型，取值如下：'."\n" ."\n" .'- Dedicated：专属资源组'."\n" .'- SelfManaged：自运维资源组', 'type' => 'string', 'enumValueTitles' => [ 'SelfManaged' => 'SelfManaged', 'Dedicated' => 'Dedicated', ], 'example' => 'Dedicated', ], 'InstanceMaxAllocatableMemory' => [ 'description' => '资源组单节点最大可分配Memory大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048', ], 'Features' => [ 'description' => '资源组的功能集合，用于标识该资源组支持的特性。', 'type' => 'array', 'items' => [ 'description' => '资源组所支持的具体特性。目前只支持GpuShare(GPU共享)。', 'type' => 'string', 'example' => 'GpuShare', ], ], 'InstanceMaxAllocatableGPU' => [ 'description' => '资源组单节点最大可分配GPU数。', 'type' => 'number', 'format' => 'float', 'example' => '2', ], 'InstanceMaxAllocatableCPU' => [ 'description' => '资源组单节点最大可分配CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"902976F2-6FAF-5404-8A4D-6CC223***\\",\\n \\"ResourceId\\": \\"eas-r-glkfpsxuw57x1h*****\\",\\n \\"ResourceName\\": \\"my-resouce****\\",\\n \\"ClusterId\\": \\"cn-beijing\\",\\n \\"CreateTime\\": \\"2020-05-19T14:19:42Z\\",\\n \\"UpdateTime\\": \\"2021-02-24T11:52:17Z\\",\\n \\"OwnerUid\\": \\"14401087478****\\",\\n \\"InstanceCount\\": 4,\\n \\"PrePaidInstanceCount\\": 1,\\n \\"PostPaidInstanceCount\\": 3,\\n \\"CpuCount\\": 16,\\n \\"GpuCount\\": 4,\\n \\"Memory\\": 8192,\\n \\"CpuUsed\\": 8,\\n \\"GpuUsed\\": 2,\\n \\"MemoryUsed\\": 2048,\\n \\"Status\\": \\"ResourceReady\\",\\n \\"Message\\": \\"Resource is ready\\",\\n \\"ExtraData\\": \\"{\\\\\\"vswitch_id\\\\\\":\\\\\\"vsw-bp17uo6xebcusy****\\\\\\",\\\\\\"gpu_share\\\\\\":true,\\\\\\"aux_vswitch_id_list\\\\\\":[\\\\\\"vsw-bp13b3pvjap3vxn****\\\\\\",\\\\\\"vsw-bp1nls8o5hk8mt8*****\\\\\\"],\\\\\\"security_group_id\\\\\\":\\\\\\"sg-bp1j1z7297hcink*****\\\\\\",\\\\\\"vpc_id\\\\\\":\\\\\\"vpc-bp1kjr3rfyhx01*****\\\\\\",\\\\\\"destination_cidr\\\\\\":\\\\\\"172.16.0.12/28\\\\\\",\\\\\\"role_arn\\\\\\":\\\\\\"acs:ram::1157703270*****:role/AliyunServiceRoleForPaiEas\\\\\\",\\\\\\"sls_project\\\\\\":\\\\\\"\\\\\\",\\\\\\"sls_logstore\\\\\\":\\\\\\"\\\\\\",\\\\\\"sls_status\\\\\\":\\\\\\"ResourceReady\\\\\\",\\\\\\"sls_message\\\\\\":\\\\\\"\\\\\\",\\\\\\"update_time\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ResourceType\\": \\"Dedicated\\",\\n \\"InstanceMaxAllocatableMemory\\": 2048,\\n \\"Features\\": [\\n \\"GpuShare\\"\\n ],\\n \\"InstanceMaxAllocatableGPU\\": 2,\\n \\"InstanceMaxAllocatableCPU\\": 16\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查看资源组详情', ], 'DescribeResourceDLink' => [ 'summary' => '查看专属资源组VPC直连配置详情。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/dlink', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的ID', 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-adfabas****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'VpcId' => [ 'title' => '已打通直接的Vpc ID', 'description' => '已打通直连的VPC ID。', 'type' => 'string', 'example' => 'vpc-uf66uio7m****1', ], 'VSwitchId' => [ 'title' => '已打通直连的主VSwitch ID', 'description' => '已打通直连的主VSwitch ID。', 'type' => 'string', 'example' => 'vsw-8vbqn2at0kljjxxxx****', ], 'SecurityGroupId' => [ 'title' => '已打通直连的安全组', 'description' => '已打通直连的安全组。', 'type' => 'string', 'example' => 'sg-bp1j1z7297hcink9d****', ], 'AuxVSwitchList' => [ 'title' => '已打通直连的副VSwitch ID', 'description' => '已打通直连的副VSwitch ID。', 'type' => 'array', 'items' => [ 'description' => 'VSwitch ID。', 'type' => 'string', 'example' => '[" vsw-8ersw98sgmlgkxxxxxx", " vsw-4dsgg2at0kljjxxxxxxxx"]', ], ], 'DestinationCIDRs' => [ 'title' => '要打通的客户端的网段信息，会将该网段加入到服务端的回包路由中，与VSwitchIdList可二选一', 'description' => '要打通的客户端的网段信息，会将该网段加入到服务端的回包路由中。', 'type' => 'string', 'example' => '172.16.0.0/16', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"VpcId\\": \\"vpc-uf66uio7m****1\\",\\n \\"VSwitchId\\": \\"vsw-8vbqn2at0kljjxxxx****\\",\\n \\"SecurityGroupId\\": \\"sg-bp1j1z7297hcink9d****\\",\\n \\"AuxVSwitchList\\": [\\n \\"[\\\\\\" vsw-8ersw98sgmlgkxxxxxx\\\\\\", \\\\\\" vsw-4dsgg2at0kljjxxxxxxxx\\\\\\"]\\"\\n ],\\n \\"DestinationCIDRs\\": \\"172.16.0.0/16\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查看资源组VPC直连信息', ], 'DescribeResourceLog' => [ 'summary' => '查看专属资源组SLS日志投递配置详情。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/log', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的ID', 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-asdas****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'ProjectName' => [ 'title' => '资源组对应的sls日志管理项目', 'description' => '资源组对应的SLS日志管理项目。', 'type' => 'string', 'example' => 'eas-r-asdasdasd-sls', ], 'LogStore' => [ 'title' => 'sls日志库', 'description' => 'SLS日志库。', 'type' => 'string', 'example' => 'access_log', ], 'Message' => [ 'title' => 'sls日志信息', 'description' => 'SLS日志信息。', 'type' => 'string', 'example' => 'Network interfaces are updating', ], 'Status' => [ 'title' => '资源组状态', 'description' => '资源组状态。', 'type' => 'string', 'example' => 'ResourceReady', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"ProjectName\\": \\"eas-r-asdasdasd-sls\\",\\n \\"LogStore\\": \\"access_log\\",\\n \\"Message\\": \\"Network interfaces are updating\\",\\n \\"Status\\": \\"ResourceReady\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查看资源组日志投递信息', ], 'ListResourceInstances' => [ 'summary' => '获取指定专属资源组中的机器实例列表。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/instances', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '37095', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的ID', 'description' => '资源组的ID。如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'iot', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'title' => '付费类型'."\n" .'PrePaid预付费'."\n" .'PostPaid后付费', 'description' => '过滤机器付费类型，取值如下：'."\n" .'- PrePaid：预付费。'."\n" .'- PostPaid：后付费。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PostPaid' => '后付费', 'PrePaid' => '预付费', ], 'example' => 'PrePaid', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '请求的页码（默认为1）', 'description' => '专属资源组机器列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为100）', 'description' => '分页查询时设置的每页显示的机器数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => [ 'description' => '按实例名称过滤。', 'type' => 'string', 'required' => false, 'example' => 'e-xxxx***', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => '按实例ID过滤。如何获取实例ID，请参见[ListResourceInstances](~~412129~~)。', 'type' => 'string', 'required' => false, 'example' => 'i-bp1jd6x3uots****a', ], ], [ 'name' => 'InstanceIP', 'in' => 'query', 'schema' => [ 'description' => '机器IP。', 'type' => 'string', 'required' => false, 'example' => '10.224.xx.xx', ], ], [ 'name' => 'Filter', 'in' => 'query', 'schema' => [ 'description' => '关键字搜索。支持按机器ID或IP进行搜索。', 'type' => 'string', 'required' => false, 'example' => '10.224.xx.xx', ], ], [ 'name' => 'InstanceStatus', 'in' => 'query', 'schema' => [ 'description' => '机器状态。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Ready-SchedulingDisabled' => '机器可用-不可调度', 'Ready' => '运行中', 'NotReady' => '未就绪', 'Stopped' => '已停机', 'NotReady-SchedulingDisabled' => '机器不可用-不可调度', 'Attaching' => '启动中', 'Deleting' => '删除中', 'CreateFailed' => '创建失败', ], 'example' => 'Ready', ], ], [ 'name' => 'Label', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '按标签过滤。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'type' => 'string', 'example' => '{"key1":"value1","key2":null}', 'description' => '按{"key":"value"}格式填写。Value可为null或空字符，代表只按Key过滤，Value可为任意值。', ], ], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'description' => '排序字段。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'CreateTime' => '创建时间', 'MemoryUsed' => '内存使用量', 'GpuUsed' => 'GPU使用量', 'ExpireTime' => '过期时间', 'CpuUsed' => 'CPU使用率', ], 'example' => 'CreateTime', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => '排序顺序。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'asc' => '升序', 'desc' => '降序', ], 'example' => 'desc', ], ], [ 'name' => 'Zone', 'in' => 'query', 'schema' => [ 'description' => '机器可用区。', 'type' => 'string', 'required' => false, 'example' => 'J', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Instances' => [ 'description' => '实例列表。', 'type' => 'array', 'items' => [ 'description' => '实例信息。', '$ref' => '#/components/schemas/ResourceInstance', ], ], 'PageNumber' => [ 'description' => '返回查询的资源组机器列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的资源组机器数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => '实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Instances\\": [\\n {\\n \\"InstanceId\\": \\"\\",\\n \\"InstanceName\\": \\"\\",\\n \\"InstanceIp\\": \\"\\",\\n \\"InstanceStatus\\": \\"\\",\\n \\"InstancePhase\\": \\"\\",\\n \\"InstanceCpuCount\\": 0,\\n \\"InstanceGpuCount\\": 0,\\n \\"InstanceMemory\\": \\"\\",\\n \\"InstanceSystemDiskSize\\": 0,\\n \\"InstanceGpuMemory\\": \\"\\",\\n \\"InstanceUsedCpu\\": 0,\\n \\"InstanceUsedGpu\\": 0,\\n \\"InstanceUsedMemory\\": \\"\\",\\n \\"InstanceType\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"ChargeType\\": \\"\\",\\n \\"ExpiredTime\\": \\"\\",\\n \\"AutoRenewal\\": true,\\n \\"Arch\\": \\"\\",\\n \\"Region\\": \\"\\",\\n \\"Zone\\": \\"\\",\\n \\"ResourceId\\": \\"\\",\\n \\"InstanceTenantIp\\": \\"\\",\\n \\"InstanceUsedGpuMemory\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"LabelKey\\": \\"\\",\\n \\"LabelValue\\": \\"\\"\\n }\\n ],\\n \\"LastCordonOperator\\": \\"\\",\\n \\"LastCordonReason\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询资源组机器列表', ], 'ListResourceInstanceWorker' => [ 'summary' => '列举资源实例的服务Worker列表。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/instance/{InstanceName}/workers', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '37099', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '资源组所在的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'description' => '资源组的ID。资源组ID，如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'eas-r-adfabas', ], ], [ 'name' => 'InstanceName', 'in' => 'path', 'schema' => [ 'description' => '资源组的实例名字。如何获取实例名称，请参见[ListResourceInstances](~~412129~~)。该接口返回结果中的HostName即为实例名称。', 'type' => 'string', 'required' => true, 'example' => 'cne10', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '工作实例列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时设置的每页显示的实例数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'WorkerName', 'in' => 'query', 'schema' => [ 'description' => '工作实例名称。', 'type' => 'string', 'required' => false, 'example' => 'test-fd95xxxxx-xxxxxx ', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '工作实例的状态。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Terminating' => 'Terminating', 'Stopped' => 'Stopped', 'Failed' => 'Failed', 'Running' => 'Running', 'Waiting' => 'Waiting', ], 'example' => 'Running', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => '排序方式。'."\n" ."\n" .'- Asc：升序。'."\n" .'- Desc：降序。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Asc' => 'Asc', 'Desc' => 'Desc', ], 'example' => 'Desc', ], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'description' => '排序字段。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Status' => 'Status', 'MemoryLimit' => 'MemoryLimit', 'Ready' => 'Ready', 'CpuLimit' => 'CpuLimit', 'ServiceName' => 'ServiceName', 'Restarts' => 'Restarts', 'StartTime' => 'StartTime', 'MemoryRequest' => 'MemoryRequest', 'GpuLimit' => 'GpuLimit', 'GpuRequest' => 'GpuRequest', 'CpuRequest' => 'CpuRequest', 'Name' => 'Name', ], 'example' => 'CreateTime', ], ], [ 'name' => 'ServiceName', 'in' => 'query', 'schema' => [ 'description' => '服务名称。', 'type' => 'string', 'required' => false, 'example' => 'echo', ], ], [ 'name' => 'Ready', 'in' => 'query', 'schema' => [ 'description' => '健康检查是否通过。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => 'true', 'false' => 'false', ], 'example' => 'true', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Pods' => [ 'title' => 'pod列表', 'description' => 'Worker列表。', 'type' => 'array', 'items' => [ 'description' => 'Worker信息。', '$ref' => '#/components/schemas/ResourceInstanceWorker', ], ], 'PageNumber' => [ 'title' => '当前页码', 'description' => '返回查询的资源组工作实例列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'title' => '每页大小', 'description' => '返回每页显示的资源组工作实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'title' => 'pod总数', 'description' => 'Worker总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], 404 => [], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Pods\\": [\\n {\\n \\"Name\\": \\"\\",\\n \\"ServiceName\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"Ready\\": true,\\n \\"CpuRequest\\": 0,\\n \\"GpuRequest\\": 0,\\n \\"MemoryRquest\\": 0,\\n \\"CpuLimit\\": 0,\\n \\"GpuLimit\\": 0,\\n \\"MemoryLimit\\": 0,\\n \\"RestartCount\\": 0,\\n \\"StartTime\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询资源组工作实例列表', ], 'ListResources' => [ 'summary' => '获取当前用户的专属资源组列表。', 'path' => '/api/v2/resources', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '37092', 'abilityTreeNodes' => [ 'FEATURElearnRPDTZG', ], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '请求的页码（默认为1）', 'description' => '专属资源组列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为100）', 'description' => '分页查询时设置的每页显示的专属资源组数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], [ 'name' => 'ResourceName', 'in' => 'query', 'schema' => [ 'description' => '资源组名称。[CreateResource](~~412111~~)会返回资源组名称。', 'type' => 'string', 'required' => false, 'example' => 'MyResource', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'description' => '资源组ID。[CreateResource](~~412111~~)会返回资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'eas-r-h7lcw24dyqztwxxxxxx', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'description' => '资源组类型，取值如下：'."\n" ."\n" .'- Dedicated：专属资源组'."\n" .'- SelfManaged：自运维资源组', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'SelfManaged' => 'SelfManaged', 'Dedicated' => 'Dedicated', ], 'example' => 'Dedicated', ], ], [ 'name' => 'ResourceStatus', 'in' => 'query', 'schema' => [ 'description' => '资源组状态', 'type' => 'string', 'required' => false, 'example' => 'ResourceReady', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => '排序方式，取值如下：'."\n" .'- Desc：降序。'."\n" .'- Asc：升序。', 'type' => 'string', 'required' => false, 'example' => 'Desc', ], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'description' => '排序字段。按时间戳类型默认倒序排序。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PrePaidInstanceCount' => 'PrePaidInstanceCount', 'CpuCount' => 'CpuCount', 'Memory' => 'Memory', 'CreateTime' => 'CreateTime', 'PostPaidInstanceCount' => 'PostPaidInstanceCount', 'MemoryUsed' => 'MemoryUsed', 'GpuCount' => 'GpuCount', 'GpuUsed' => 'GpuUsed', 'CpuUsed' => 'CpuUsed', 'ServiceCount' => 'ServiceCount', ], 'example' => 'CreateTime', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回Body。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Resources' => [ 'description' => '资源组列表。', 'type' => 'array', 'items' => [ 'description' => '资源组详情信息。', '$ref' => '#/components/schemas/Resource', ], ], 'PageNumber' => [ 'description' => '返回查询的专属资源组列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的专属资源组数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => '资源组总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Resources\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"PrePaidInstanceCount\\": 0,\\n \\"Message\\": \\"\\",\\n \\"ClusterId\\": \\"\\",\\n \\"ResourceName\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"ResourceType\\": \\"\\",\\n \\"PostPaidInstanceCount\\": 0,\\n \\"ExtraData\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Vendor\\": \\"\\",\\n \\"InstanceCount\\": 0,\\n \\"CpuCount\\": 0,\\n \\"InstanceMaxAllocatableCPU\\": 0,\\n \\"ResourceId\\": \\"\\",\\n \\"UpdateTime\\": \\"\\",\\n \\"InstanceMaxAllocatableGPU\\": 0,\\n \\"InstanceMaxAllocatableMemory\\": 0,\\n \\"MemoryUsed\\": 0,\\n \\"Features\\": [\\n \\"\\"\\n ],\\n \\"GpuCount\\": 0,\\n \\"GpuUsed\\": 0,\\n \\"CpuUsed\\": 0\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询资源组列表', ], 'ListResourceServices' => [ 'summary' => '列举专属资源组中已部署的服务列表。', 'path' => '/api/v2/resources/{ClusterId}/{ResourceId}/services', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '37100', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '资源组所在的集群ID', 'description' => '资源组所在的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ResourceId', 'in' => 'path', 'schema' => [ 'title' => '资源组的ID', 'description' => '资源组的ID。资源组ID，如何查询资源组ID，请参见[ListResources](~~412133~~)。', 'type' => 'string', 'required' => true, 'example' => 'iot', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '请求的页码（默认为1）', 'description' => '服务列表的页码。起始值为1，默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页的大小（默认为100）', 'description' => '分页查询时设置的每页显示的服务数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Services' => [ 'description' => '服务列表。', 'type' => 'array', 'items' => [ 'description' => '服务摘要信息。', '$ref' => '#/components/schemas/Service', ], ], 'PageNumber' => [ 'description' => '返回查询的服务列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的服务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'TotalCount' => [ 'description' => '服务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], ], ], ], 404 => [], ], 'staticInfo' => [ 'substitutions' => [ 'eas::2021-07-01::ListServices', ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Services\\": [\\n {\\n \\"ServiceGroup\\": \\"\\",\\n \\"Memory\\": 0,\\n \\"Cpu\\": 0,\\n \\"Image\\": \\"\\",\\n \\"Gpu\\": 0,\\n \\"TotalInstance\\": 0,\\n \\"AccessToken\\": \\"\\",\\n \\"ResourceBurstable\\": true,\\n \\"InternetEndpoint\\": \\"\\",\\n \\"ResourceAlias\\": \\"\\",\\n \\"Status\\": \\"\\",\\n \\"TrafficState\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Resource\\": \\"\\",\\n \\"SecondaryInternetEndpoint\\": \\"\\",\\n \\"Labels\\": [\\n {\\n \\"LabelValue\\": \\"\\",\\n \\"LabelKey\\": \\"\\"\\n }\\n ],\\n \\"Namespace\\": \\"\\",\\n \\"Weight\\": 0,\\n \\"Role\\": \\"\\",\\n \\"SecondaryIntranetEndpoint\\": \\"\\",\\n \\"PendingInstance\\": 0,\\n \\"ServiceName\\": \\"\\",\\n \\"SafetyLock\\": \\"\\",\\n \\"Region\\": \\"\\",\\n \\"AppType\\": \\"\\",\\n \\"InstanceCountInResource\\": {\\n \\"Quota\\": 0,\\n \\"Public\\": 0,\\n \\"Dedicated\\": 0\\n },\\n \\"IntranetEndpoint\\": \\"\\",\\n \\"QuotaId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"CurrentVersion\\": 0,\\n \\"RunningInstance\\": 0,\\n \\"WorkspaceId\\": \\"\\",\\n \\"CallerUid\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"Source\\": \\"\\",\\n \\"ServiceId\\": \\"\\",\\n \\"AppVersion\\": \\"\\",\\n \\"CronscalerEnabled\\": true,\\n \\"ServiceConfig\\": \\"\\",\\n \\"Gateway\\": \\"\\",\\n \\"AppSpecName\\": \\"\\",\\n \\"GPUCorePercentage\\": 0,\\n \\"GPUMemory\\": 0,\\n \\"AppConfig\\": \\"\\",\\n \\"CreateTime\\": \\"\\",\\n \\"AutoscalerEnabled\\": true,\\n \\"ExtraData\\": \\"\\",\\n \\"LatestVersion\\": 0,\\n \\"UpdateTime\\": \\"\\",\\n \\"ServiceUid\\": \\"\\",\\n \\"ParentUid\\": \\"\\",\\n \\"RoleAttrs\\": \\"\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 2\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', 'title' => '查询资源组中的服务列表', ], 'CreateBenchmarkTask' => [ 'summary' => '调用CreateBenchmarkTask，创建压测任务。', 'path' => '/api/v2/benchmark-tasks', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '压测任务的配置参数。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "base": {'."\n" .' "duration": 600'."\n" .' },'."\n" .' "service": {'."\n" .' "serviceName": "test_service",'."\n" .' "requestToken": "test_token"'."\n" .' },'."\n" .' "data": {'."\n" .' "path": "https://larec-benchmark-cd.oss-cn-chengdu.aliyuncs.com/youbei/sv_dbmtl/data/youbei.warmup.tf.bin",'."\n" .' "dataType": "binary"'."\n" .' },'."\n" .' "optional": {'."\n" .' "maxRt": 100'."\n" .' }'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82********', ], 'TaskName' => [ 'description' => '压测任务名字。', 'type' => 'string', 'example' => 'benchmark-larec-test-1076', ], 'Region' => [ 'description' => '压测任务所在的区域。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Benchmark task [foo] is Creating', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82********\\",\\n \\"TaskName\\": \\"benchmark-larec-test-1076\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Message\\": \\"Benchmark task [foo] is Creating\\"\\n}","type":"json"}]', 'title' => '创建压测任务', 'requestParamsDescription' => '## 压测任务配置参数'."\n" .'eas-benchmark 整体配置分五部分，如下所示：'."\n" ."\n" .'| **参数** | **说明** |'."\n" .'| --- | --- |'."\n" .'| base | 压测任务的基本配置。 |'."\n" .'| service | 待压测服务的相关配置。 |'."\n" .'| data | 压测请求数据的相关配置。 |'."\n" .'| http | 服务请求HTTP相关配置。 |'."\n" .'| optional | 压测任务可选高级配置。 |'."\n" ."\n" .'#### 表1. base描述表'."\n" .'| **参数** | **说明** |'."\n" .'| --- | --- |'."\n" .'| name | 【可选】压测任务的名称，如果不指定，会根据服务名自动生成。 |'."\n" .'| duration | 【可选】压测任务执行的总时间，单位为秒，默认为1200。 |'."\n" .'| qps | 【可选】压测任务的目标（预期）QPS， 默认为10000。 |'."\n" .'| concurrency | 【可选】每个压测实例内创建的并发连接数, 初始值默认为40，会动态修改。 |'."\n" .'| agentCount | 【可选】压测任务创建的实例个数，初始值默认为1，会动态修改。 |'."\n" ."\n\n" .'#### 表2. service描述表'."\n" .'当您需要通过访问网关的模式创建压测任务时，需要[提交工单](https://smartservice.console.aliyun.com/service/create-ticket?product=learn)开通白名单权限。 '."\n" .'| **参数** | **说明** |'."\n" .'| --- | --- |'."\n" .'| serviceUrl | 【可选】待压测服务的访问URL，如果待压测服务是EAS服务，无需配置。 |'."\n" .'| serviceName | 【可选】待压测服务的服务名，如果待压测服务是EAS服务，必须配置；如果待压测服务是自定义服务，无需配置。 |'."\n" .'| requestToken | 【可选】访问服务的鉴权token，如果**serviceName**被指定，无需配置。 |'."\n" .'| endpointType | 【可选】服务支持的压测类型，支持**default**（网关）、**direct**（直连模式） 两种模式，默认为**direct**。 |'."\n" .'#### 表3. data描述表'."\n" .'| **参数** | **说明** |'."\n" .'| --- | --- |'."\n" .'| content | 【可选】压测请求数据，字符串格式。 |'."\n" .'| path | 【可选】测试数据源的HTTP路径，可以是单个文件，也支持`.zip`文件，对`.zip`文件下载后会自动解压。 |'."\n" .'| dataType | 【可选】测试数据的类型，支持text和binary两种类型，默认为text类型。 |'."\n" .'| multiLine | 【可选】测试数据是否是按行分割的，BOOL类型，如果设置为true，会将下载的数据逐行解析。|'."\n" .'#### 表4、HTTP描述表'."\n" .'| **参数** | **说明** |'."\n" .'| --- | --- |'."\n" .'| method | 【可选】HTTP请求方法，默认为POST类型。 |'."\n" .'| host | 【可选】请求主机HOST设置，默认为空。 |'."\n" .'| headers | 【可选】HTTP请求HEADER设置，LIST类型，例如：`["Authorization:aaa", "Content-Type:text"] `。|'."\n" .'| timeout | 【可选】HTTP请求延时，单位为毫秒，默认20000。|'."\n" .'#### 表5. optional描述表'."\n" .'| **参数** | **说明** |'."\n" .'| --- | --- |'."\n" .'| mode | 【可选】压测模式，支持以下三种模式：
**auto（自动加压模式）**：默认值。eas-benchmark控制器会自动创建用于压测的Agent Worker，并设置合适的并发，通过自动寻优的算法来寻找服务的承压上限。
**scan（周期加压模式）**：根据您指定的起始QPS（minQPS）、QPS上限（maxQPS）、QPS增长时间间隔（adjustInterval）和QPS增长步长（qpsGrowthDelta）等参数，动态加压，当服务承载到达指定的maxRT、maxQPS或服务压测出现错误数量超出容忍程度（faultTolerate）时为止。
**manual（手动加压模式）**：固定压测Agent数量及每个Agent的并发数，您可以在压测过程中动态调整Agent数量及Agent并发数。|'."\n" .'| adjustInterval | 【可选】自动加压的动态调整间隔，单位为秒，默认为60。例如设置为30， 则每隔30秒调整加压阈值。|'."\n" .'| minQPS | 【可选】在自动加压过程中QPS的最小值，默认为100。|'."\n" .'| maxQPS | 【可选】在自动加压过程中QPS的最大值，默认为10000。|'."\n" .'| maxRT | 【可选】期望的最大RT，超过该阈值会自动调节QPS，直到实时RT符合预期。|'."\n" .'| qpsGrowthDelta | 【可选】在自动加压过程中QPS每次增长的数值，默认为50 。|'."\n" .'| faultTolerate | 【可选】请求错误（非200状态码）率的容忍程度，默认为0.001。 |'."\n" .'| faultAction | 【可选】在请求错误率超过faultTolerate设定的阈值时，压测的行为，可选值：stop （维持当前qps, 不再继续加压）；revise（动态调整QPS，直到请求错误率符合预期）|', ], 'DeleteBenchmarkTask' => [ 'summary' => '删除指定的压测任务。', 'path' => '/api/v2/benchmark-tasks/{ClusterId}/{TaskName}', 'methods' => [ 'delete', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '压测任务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'TaskName', 'in' => 'path', 'schema' => [ 'description' => '压测任务名称。如何获取压测任务名称，请参见[ListBenchmarkTask](~~432976~~)。', 'type' => 'string', 'required' => true, 'example' => 'benchmark-larec-test-2b11', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Benchmark task [benchmark-test-service-234c] is Deleting', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Benchmark task [benchmark-test-service-234c] is Deleting\\"\\n}","type":"json"}]', 'title' => '删除压测任务', ], 'DescribeBenchmarkTask' => [ 'summary' => '查看指定压测任务的详细配置信息。', 'path' => '/api/v2/benchmark-tasks/{ClusterId}/{TaskName}', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '压测任务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'TaskName', 'in' => 'path', 'schema' => [ 'description' => '压测任务名称。如何获取压测任务名称，请参见[ListBenchmarkTask](~~432976~~)。', 'type' => 'string', 'required' => true, 'example' => 'benchmark-larec-test-eac4', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'TaskName' => [ 'description' => '压测任务名称。', 'type' => 'string', 'example' => 'benchmark-larec-test-ae70', ], 'TaskId' => [ 'description' => '压测任务ID。', 'type' => 'string', 'example' => 'eas-b-gv4y86u****', ], 'ServiceName' => [ 'description' => '待压测的服务名称。', 'type' => 'string', 'example' => 'foo', ], 'Token' => [ 'description' => '创建压测任务的鉴权凭证。', 'type' => 'string', 'example' => '6062787a-9301****', ], 'CallerUid' => [ 'description' => '当前调用者ID。', 'type' => 'string', 'example' => '1640133467****', ], 'ParentUid' => [ 'description' => '当前调用的主账号。', 'type' => 'string', 'example' => '1029728669****', ], 'DesiredAgent' => [ 'description' => '预期的压测实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'AvailableAgent' => [ 'description' => '可用的压测实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4', ], 'Status' => [ 'description' => '压测任务的执行状态。', 'type' => 'string', 'enumValueTitles' => [ 'Creating' => '创建中：Creating', 'Starting' => '启动中：Starting', 'DeleteFailed' => '删除失败：DeleteFailed', 'Running' => '运行中：Running', 'Stopping' => '停止中：Stopping', 'Error' => '报错：Error', 'Updating' => '更新中：Updating', 'Deleting' => '删除中：Deleting', 'CreateFailed' => '创建失败：CreateFailed', ], 'example' => 'Running', ], 'Reason' => [ 'description' => '压测任务处于当前状态的事件或原因。', 'type' => 'string', 'example' => 'RUNNING', ], 'Message' => [ 'description' => '压测任务执行状态的摘要信息。', 'type' => 'string', 'example' => 'Benchmar task is Running', ], 'Endpoint' => [ 'description' => '服务网关Endpoint。', 'type' => 'string', 'example' => '192342311234.pai-eas.cn-chengdu.aliyuncs.com', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"TaskName\\": \\"benchmark-larec-test-ae70\\",\\n \\"TaskId\\": \\"eas-b-gv4y86u****\\",\\n \\"ServiceName\\": \\"foo\\",\\n \\"Token\\": \\"6062787a-9301****\\",\\n \\"CallerUid\\": \\"1640133467****\\",\\n \\"ParentUid\\": \\"1029728669****\\",\\n \\"DesiredAgent\\": 4,\\n \\"AvailableAgent\\": 4,\\n \\"Status\\": \\"Running\\",\\n \\"Reason\\": \\"RUNNING\\",\\n \\"Message\\": \\"Benchmar task is Running\\",\\n \\"Endpoint\\": \\"192342311234.pai-eas.cn-chengdu.aliyuncs.com\\"\\n}","type":"json"}]', 'title' => '查看压测任务详情', ], 'DescribeBenchmarkTaskReport' => [ 'summary' => '查看指定压测任务的报告。', 'path' => '/api/v2/benchmark-tasks/{ClusterId}/{TaskName}/report', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '压测任务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'TaskName', 'in' => 'path', 'schema' => [ 'description' => '压测任务名称。如何获取压测任务名称，请参见[ListBenchmarkTask](~~432976~~)。', 'type' => 'string', 'required' => true, 'example' => 'benchmark-larec-test-015d', ], ], [ 'name' => 'ReportType', 'in' => 'query', 'schema' => [ 'description' => '报告类型，支持配置RAW和Report。', 'type' => 'string', 'required' => false, 'example' => 'report', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82********', ], 'ReportUrl' => [ 'description' => '当ReportType为Report时，返回压测报告的下载地址。', 'type' => 'string', 'example' => 'http://eas-benchmark.oss-cn-chengdu.aliyuncs.com/summary/benchmark-larec-test-015d-10007.html', ], 'Data' => [ 'description' => '当ReportType为RAW时，返回压测报告的详细数据。', 'type' => 'any', 'example' => '{'."\n" .' "TimestampList": ["int64"],'."\n" .' "QPSList": ["float32"],'."\n" .' "RTList": ['."\n" .' {'."\n" .' "AVG": "float32",'."\n" .' "TP100": "float32",'."\n" .' "TP99": "float32",'."\n" .' "TP90": "float32",'."\n" .' "TP50": "float32",'."\n" .' "TP10": "float32"'."\n" .' }'."\n" .' ],'."\n" .' "TrafficList": ['."\n" .' {'."\n" .' "Send": "float64",'."\n" .' "Receive": "float64"'."\n" .' }'."\n" .' ],'."\n" .' "StatusCode": {'."\n" .' "200": "uint64",'."\n" .' "450": "uint64",'."\n" .' "500": "uint64"'."\n" .' },'."\n" .' "Count": "uint64",'."\n" .' "Total": "float64",'."\n" .' "MinRT": "float32",'."\n" .' "AvgRT": "float32",'."\n" .' "MaxRT": "float32",'."\n" .' "QPS": "float32",'."\n" .' "TotalSend": "float64",'."\n" .' "TotalReceive": "float64",'."\n" .' "RTDistribution": ['."\n" .' {'."\n" .' "Latency": "float32",'."\n" .' "Percentage": "int"'."\n" .' }'."\n" .' ],'."\n" .' "RTHistogram": ['."\n" .' {'."\n" .' "Count": "int",'."\n" .' "Mark": "float32",'."\n" .' "Frequency": "float32"'."\n" .' }'."\n" .' ]'."\n" .' }', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82********\\",\\n \\"ReportUrl\\": \\"http://eas-benchmark.oss-cn-chengdu.aliyuncs.com/summary/benchmark-larec-test-015d-10007.html\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"TimestampList\\\\\\": [\\\\\\"int64\\\\\\"],\\\\n \\\\\\"QPSList\\\\\\": [\\\\\\"float32\\\\\\"],\\\\n \\\\\\"RTList\\\\\\": [\\\\n {\\\\n \\\\\\"AVG\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"TP100\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"TP99\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"TP90\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"TP50\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"TP10\\\\\\": \\\\\\"float32\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"TrafficList\\\\\\": [\\\\n {\\\\n \\\\\\"Send\\\\\\": \\\\\\"float64\\\\\\",\\\\n \\\\\\"Receive\\\\\\": \\\\\\"float64\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"StatusCode\\\\\\": {\\\\n \\\\\\"200\\\\\\": \\\\\\"uint64\\\\\\",\\\\n \\\\\\"450\\\\\\": \\\\\\"uint64\\\\\\",\\\\n \\\\\\"500\\\\\\": \\\\\\"uint64\\\\\\"\\\\n },\\\\n \\\\\\"Count\\\\\\": \\\\\\"uint64\\\\\\",\\\\n \\\\\\"Total\\\\\\": \\\\\\"float64\\\\\\",\\\\n \\\\\\"MinRT\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"AvgRT\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"MaxRT\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"QPS\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"TotalSend\\\\\\": \\\\\\"float64\\\\\\",\\\\n \\\\\\"TotalReceive\\\\\\": \\\\\\"float64\\\\\\",\\\\n \\\\\\"RTDistribution\\\\\\": [\\\\n {\\\\n \\\\\\"Latency\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"Percentage\\\\\\": \\\\\\"int\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"RTHistogram\\\\\\": [\\\\n {\\\\n \\\\\\"Count\\\\\\": \\\\\\"int\\\\\\",\\\\n \\\\\\"Mark\\\\\\": \\\\\\"float32\\\\\\",\\\\n \\\\\\"Frequency\\\\\\": \\\\\\"float32\\\\\\"\\\\n }\\\\n ]\\\\n }\\"\\n}","type":"json"}]', 'title' => '查看压测任务测试报告', ], 'ListBenchmarkTask' => [ 'summary' => '查看当前用户部署的所有压测任务。', 'path' => '/api/v2/benchmark-tasks', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATURElearnO4KXYN', ], ], 'parameters' => [ [ 'name' => 'Filter', 'in' => 'query', 'schema' => [ 'description' => '过滤参数。如果指定，将分别查找EAS服务名和压测任务名中和指定参数匹配的记录。', 'type' => 'string', 'required' => false, 'example' => 'test_bench', ], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ServiceName', 'in' => 'query', 'schema' => [ 'description' => '压测任务对应的EAS服务名称。如何查询服务名称，请参见[ListServices](~~412109~~)。', 'type' => 'string', 'required' => false, 'example' => 'test_bench_srv', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ModelId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'RequestMethod', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '压测任务列表的页码。起始值为1，默认为1。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时设置的每页显示的压测任务数量，默认为100。', 'type' => 'string', 'required' => false, 'example' => '10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Tasks' => [ 'description' => '任务列表。', 'type' => 'array', 'items' => [ 'description' => '任务详情。', 'type' => 'object', 'properties' => [ 'TaskName' => [ 'description' => '压测任务名称。', 'type' => 'string', 'example' => 'benchmark-larec-test-1076', ], 'TaskId' => [ 'description' => '压测任务ID。', 'type' => 'string', 'example' => 'eas-b-gv4y86uvgt****i', ], 'ServiceName' => [ 'description' => '待压测的服务名称。', 'type' => 'string', 'example' => 'test_quota', ], 'Region' => [ 'description' => '压测任务所在区域。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'AvailableAgent' => [ 'description' => '可用的压测实例个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'Status' => [ 'description' => '压测任务的状态。', 'type' => 'string', 'enumValueTitles' => [ 'Creating' => 'Creating', 'Starting' => 'Starting', 'DeleteFailed' => 'DeleteFailed', 'Running' => 'Running', 'Stopping' => 'Stopping', 'Error' => 'Error', 'Updating' => 'Updating', 'Deleting' => 'Deleting', 'CreateFailed' => 'CreateFailed', ], 'example' => 'Running', ], 'Message' => [ 'description' => '服务的摘要信息。', 'type' => 'string', 'example' => 'Benchmark task [benchmark-larec-test-1076] is Running', ], 'CreateTime' => [ 'description' => '压测任务的创建时间。', 'type' => 'string', 'example' => '2020-02-04T02:43:15Z', ], 'UpdateTime' => [ 'description' => '压测任务的更新时间。', 'type' => 'string', 'example' => '2020-06-24T03:11:30Z', ], ], ], ], 'TotalCount' => [ 'description' => '查询到的任务总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNumber' => [ 'description' => '返回查询的压测任务列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的压测任务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Tasks\\": [\\n {\\n \\"TaskName\\": \\"benchmark-larec-test-1076\\",\\n \\"TaskId\\": \\"eas-b-gv4y86uvgt****i\\",\\n \\"ServiceName\\": \\"test_quota\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"AvailableAgent\\": 2,\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Benchmark task [benchmark-larec-test-1076] is Running\\",\\n \\"CreateTime\\": \\"2020-02-04T02:43:15Z\\",\\n \\"UpdateTime\\": \\"2020-06-24T03:11:30Z\\"\\n }\\n ],\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n}","type":"json"}]', 'title' => '查询压测任务列表', ], 'StartBenchmarkTask' => [ 'summary' => '启动指定的压测任务。', 'path' => '/api/v2/benchmark-tasks/{ClusterId}/{TaskName}/start', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '压测任务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'TaskName', 'in' => 'path', 'schema' => [ 'description' => '压测任务名称。如何获取压测任务名称，请参见[ListBenchmarkTask](~~432976~~)。', 'type' => 'string', 'required' => true, 'example' => 'benchmark-larec-test-3bc6', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Benchmark task [benchmark-larec-test-1076] is Starting', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Benchmark task [benchmark-larec-test-1076] is Starting\\"\\n}","type":"json"}]', 'title' => '启动压测任务', ], 'StopBenchmarkTask' => [ 'summary' => '停止指定的压测任务。', 'path' => '/api/v2/benchmark-tasks/{ClusterId}/{TaskName}/stop', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '压测任务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'TaskName', 'in' => 'path', 'schema' => [ 'description' => '压测任务名称。如何获取压测任务名称，请参见[ListBenchmarkTask](~~432976~~)。', 'type' => 'string', 'required' => true, 'example' => 'benchmark-larec-test-dbe5', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Benchmark task [benchmark-larec-test-dbe5] is Stopping', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Benchmark task [benchmark-larec-test-dbe5] is Stopping\\"\\n}","type":"json"}]', 'title' => '停止压测任务', ], 'UpdateBenchmarkTask' => [ 'summary' => '更新指定的压测任务。', 'path' => '/api/v2/benchmark-tasks/{ClusterId}/{TaskName}', 'methods' => [ 'put', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '压测任务所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'TaskName', 'in' => 'path', 'schema' => [ 'description' => '压测任务名字。', 'type' => 'string', 'required' => true, 'example' => 'benchmark-larec-test-645c', ], ], [ 'name' => 'body', 'in' => 'body', 'schema' => [ 'description' => '压测任务配置参数，详情请参见**表1. base描述表**。', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "base": {'."\n" .' "qps": 200'."\n" .' }'."\n" .'}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'description' => '操作成功信息。', 'type' => 'string', 'example' => 'Benchmark task [benchmark-larec-test-1076] is Updating', ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Benchmark task [benchmark-larec-test-1076] is Updating\\"\\n}","type":"json"}]', 'title' => '更新压测任务', 'requestParamsDescription' => '#### 表1. base描述表'."\n" .'更新操作时只允许修改如下base描述表中的配置，如下所示：'."\n" .'| **参数** | **说明** |'."\n" .'| --- | --- |'."\n" .'| duration | 【可选】压测任务执行的总时间（秒），默认为1200 |'."\n" .'| qps | 【可选】压测任务的目标（预期）qps，默认为10000 |'."\n" .'| concurrency | 【可选】每个压测实例内创建的并发连接数，初始值默认为40，会动态修改 |'."\n" .'| agentCount | 【可选】压测任务创建的实例个数，初始值默认为1，会动态修改 |', ], 'DeleteGatewayLabel' => [ 'summary' => '删除网关标签', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/label', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '167565', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '网关所在区域。', 'description' => '网关所在区域。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'title' => '网关名字。', 'description' => '网关Id。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'LabelKeys', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '要删除的网关标签。', 'description' => '要删除的网关标签。', 'type' => 'array', 'items' => [ 'title' => '服务标签key列表。', 'description' => '网关标签key列表。', 'type' => 'string', 'required' => false, 'example' => 'key1', ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求ID。', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'Succeed to delete gateway labels.', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Succeed to delete gateway labels.\\"\\n}","type":"json"}]', 'title' => '删除网关标签', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'UpdateGatewayLabel' => [ 'summary' => '新增网关标签，或更新已有的网关标签', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/label', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '167564', 'abilityTreeNodes' => [ 'FEATURElearnKDX12S', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '网关所在区域', 'description' => '网关所在区域', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'title' => '网关id', 'description' => '网关id', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '请求Body', 'description' => '请求Body', 'type' => 'object', 'properties' => [ 'Labels' => [ 'title' => '自定义网关标签', 'description' => '自定义网关标签', 'type' => 'object', 'required' => true, 'additionalProperties' => [ 'title' => '标签对象', 'description' => '用户定义标签', 'type' => 'string', 'example' => '{"key":"value"}', ], ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => '请求Id', 'description' => '请求Id', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'title' => '返回信息。', 'description' => '返回信息。', 'type' => 'string', 'example' => 'Succeed to update gateway gw-1uhcqmsc7x22****** labels.', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Succeed to update gateway gw-1uhcqmsc7x22****** labels.\\"\\n}","type":"json"}]', 'title' => '更新网关标签', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'DetachGatewayDomain' => [ 'summary' => '私有网关解绑自定义域名。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/domain/detach', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '243555', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见接口[ListGateway](https://apiworkbench.aliyun-inc.com/document/eas/2021-07-01/ListGateway?spm=openapi-amp.newDocPublishment.0.0.765e281fL2IcjJ&Env=online)返回结果中的GatewayId字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'CustomDomain', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '自定义域名信息。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '域名类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'intranet' => '内网域名', 'internet' => '公网域名', ], 'example' => 'intranet', ], 'Domain' => [ 'description' => '自定义域名。', 'type' => 'string', 'required' => true, 'example' => 'test.com', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见接口[ListGateway](https://apiworkbench.aliyun-inc.com/document/eas/2021-07-01/ListGateway?spm=openapi-amp.newDocPublishment.0.0.765e281fL2IcjJ&Env=online)返回结果中的GatewayId字段。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Successfully delete custom endpoint for gateway gw-1uhcqmsc7x22******'."\n", ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"Message\\": \\"Successfully delete custom endpoint for gateway gw-1uhcqmsc7x22******\\\\n\\"\\n}","type":"json"}]', 'title' => '解绑网关自定义域名', ], 'AttachGatewayDomain' => [ 'summary' => '私有网关绑定自定义域名。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/domain/attach', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '241083', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见接口[ListGateway](https://apiworkbench.aliyun-inc.com/document/eas/2021-07-01/ListGateway?spm=openapi-amp.newDocPublishment.0.0.765e281fL2IcjJ&Env=online)返回结果中的GatewayId字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'CustomDomain', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '自定义域名信息。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '域名类型。', 'type' => 'string', 'required' => true, 'enumValueTitles' => [ 'intranet' => '内网域名', 'internet' => '公网域名', ], 'example' => 'intranet', ], 'CertificateId' => [ 'description' => '域名绑定的SSL证书ID。请在[数字证书管理服务](https://yundunnext.console.aliyun.com/?spm=5176.2020520163.console-base_help.2.4b3baJixaJixOc&p=cas)完成上传或购买证书后获取证书ID。', 'type' => 'string', 'required' => false, 'example' => '1473**25', ], 'Domain' => [ 'description' => '自定义域名。', 'type' => 'string', 'required' => true, 'example' => 'test.com', ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见接口[ListGateway](https://apiworkbench.aliyun-inc.com/document/eas/2021-07-01/ListGateway?spm=openapi-amp.newDocPublishment.0.0.765e281fL2IcjJ&Env=online)返回结果中的GatewayId字段。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'Message' => [ 'description' => '请求返回信息', 'type' => 'string', 'example' => 'Successfully update custom endpoint for gateway gw-1uhcqmsc7x22******'."\n", ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"Message\\": \\"Successfully update custom endpoint for gateway gw-1uhcqmsc7x22******\\\\n\\"\\n}","type":"json"}]', 'title' => '绑定网关自定义域名', ], 'ListGatewayDomains' => [ 'summary' => '查询私有网关自定义域名列表。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/domains', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245872', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见接口[ListGateway](https://apiworkbench.aliyun-inc.com/document/eas/2021-07-01/ListGateway?spm=openapi-amp.newDocPublishment.0.0.765e281fL2IcjJ&Env=online)返回结果中的GatewayId字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Successfully get custom domains', ], 'CustomDomains' => [ 'description' => '自定义域名列表。', 'type' => 'array', 'items' => [ 'description' => '自定义域名详情。', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => '域名类型。', 'type' => 'string', 'enumValueTitles' => [ 'intranet' => '内网域名', 'internet' => '公网域名', ], 'example' => 'intranet', ], 'CertificateId' => [ 'description' => '域名绑定的SSL证书ID。请在[数字证书管理服务](https://yundunnext.console.aliyun.com/?spm=5176.2020520163.console-base_help.2.4b3baJixaJixOc&p=cas)完成上传或购买证书后获取证书ID。', 'type' => 'string', 'example' => '1473**25', ], 'Domain' => [ 'description' => '自定义域名。', 'type' => 'string', 'example' => 'test.com', ], 'CertificateName' => [ 'description' => 'SSL证书名称。', 'type' => 'string', 'example' => 'cert-9955038', ], 'CertificateStartDate' => [ 'description' => '证书签发日期。', 'type' => 'string', 'example' => '2018-07-13', ], 'CertificateEndDate' => [ 'description' => '证书过期时间。', 'type' => 'string', 'example' => '2023-10-25', ], 'CreateTime' => [ 'description' => '域名创建时间。', 'type' => 'string', 'example' => '2020-05-19T14:19:42Z', ], 'UpdateTime' => [ 'description' => '域名更新时间。', 'type' => 'string', 'example' => '2021-05-19T14:19:42Z', ], 'CertificateStatus' => [ 'description' => '域名状态。', 'type' => 'string', 'enumValueTitles' => [ 'Succeeded' => '成功', 'Failed' => '失败', 'Attaching' => '绑定中', 'Deleting' => '删除中', ], 'example' => 'Succeeded', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Successfully get custom domains\\",\\n \\"CustomDomains\\": [\\n {\\n \\"Type\\": \\"intranet\\",\\n \\"CertificateId\\": \\"1473**25\\",\\n \\"Domain\\": \\"test.com\\",\\n \\"CertificateName\\": \\"cert-9955038\\",\\n \\"CertificateStartDate\\": \\"2018-07-13\\",\\n \\"CertificateEndDate\\": \\"2023-10-25\\",\\n \\"CreateTime\\": \\"2020-05-19T14:19:42Z\\",\\n \\"UpdateTime\\": \\"2021-05-19T14:19:42Z\\",\\n \\"CertificateStatus\\": \\"Succeeded\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询网关自定义域名列表', ], 'ListGateway' => [ 'summary' => '查询私有网关列表。', 'path' => '/api/v2/gateways', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192662', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'query', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见ListResources接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => false, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '网关列表的请求页码，默认为1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '分页查询时设置的每页显示的服务数量，默认为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', ], ], [ 'name' => 'GatewayName', 'in' => 'query', 'schema' => [ 'description' => '私有网关别名。', 'type' => 'string', 'required' => false, 'example' => 'mygateway1', ], ], [ 'name' => 'ResourceName', 'in' => 'query', 'schema' => [ 'description' => '资源组ID。如何获取资源组，请参见[ListResources](~~412133~~)接口返回结果中的ResourceId字段。', 'type' => 'string', 'required' => false, 'example' => 'eas-r-4gt8twzwllfo******', ], ], [ 'name' => 'InternetEnabled', 'in' => 'query', 'schema' => [ 'description' => '开启公网。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => '网关状态。', 'type' => 'string', 'required' => false, 'example' => 'Running', ], ], [ 'name' => 'ChargeType', 'in' => 'query', 'schema' => [ 'description' => '付费类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'PostPaid' => '后付费', 'PrePaid' => '预付费', ], 'example' => 'PrePaid', ], ], [ 'name' => 'Sort', 'in' => 'query', 'schema' => [ 'description' => '排序字段', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'Status' => '状态', 'ChargeType' => '付费类型', 'CreateTime' => '创建时间', 'UpdateTime' => '更新时间', 'InternetEnabled' => '开启公网', 'GatewayType' => '网关类型', 'GatewayName' => '网关名称', ], 'example' => 'CreateTime', ], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => [ 'description' => '排序方式。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'asc' => '升序', 'desc' => '倒序', ], 'example' => 'asc', ], ], [ 'name' => 'GatewayType', 'in' => 'query', 'schema' => [ 'description' => '网关类型。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'FullyManaged' => '全托管专属网关', 'Application' => '应用型专属网关', ], 'example' => 'Application', ], ], [ 'name' => 'Label', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '按标签过滤。', 'description' => '按标签过滤。', 'type' => 'object', 'required' => false, 'additionalProperties' => [ 'title' => '按{"key":"value"}格式填写。Value 可为 null 或空字符，代表只按 Key 过滤，Value 可为任意值。', 'description' => '按{"key":"value"}格式填写。Value 可为 null 或空字符，代表只按 Key 过滤，Value 可为任意值。', 'type' => 'string', 'example' => '{"key1":"value1","key2":null}', ], ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Gateways' => [ 'description' => '私有网关列表。', 'type' => 'array', 'items' => [ 'description' => '私有网关详情。', 'type' => 'object', 'properties' => [ 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'GatewayName' => [ 'description' => '私有网关别名。', 'type' => 'string', 'example' => 'mygateway1', ], 'InstanceType' => [ 'description' => '私有网关使用的机型。', 'type' => 'string', 'example' => '2c4g', ], 'IntranetDomain' => [ 'description' => '内网访问域名。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com', ], 'InternetEnabled' => [ 'description' => '公网访问是否开启。', 'type' => 'boolean', 'example' => 'true', ], 'InternetDomain' => [ 'description' => '公网访问域名。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com', ], 'CreateTime' => [ 'description' => '私有网关创建时间。使用UTC时间。', 'type' => 'string', 'example' => '2020-05-19T14:19:42Z', ], 'UpdateTime' => [ 'description' => '私有网关更新时间。使用UTC时间。', 'type' => 'string', 'example' => '2021-02-24T11:52:17Z', ], 'Status' => [ 'description' => '私有网关状态。', 'type' => 'string', 'enumValueTitles' => [ 'Creating' => '创建中', 'Stopped' => '已停止', 'Failed' => '失败', 'Running' => '运行中', 'Deleted' => '已删除', 'Deleting' => '删除中', 'Waiting' => '等待中', ], 'example' => 'Running', ], 'Replicas' => [ 'description' => '私有网关节点数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'IsDefault' => [ 'description' => '是否默认私有网关。', 'type' => 'boolean', 'example' => 'true', ], 'ChargeType' => [ 'description' => '付费类型，取值如下：'."\n" .'- PrePaid：预付费。'."\n" .'- PostPaid：后付费。', 'type' => 'string', 'example' => 'PostPaid', ], 'SSLRedirectionEnabled' => [ 'description' => 'HTTP重定向HTTPS是否开启。', 'type' => 'boolean', 'example' => 'true', ], 'IntranetEnabled' => [ 'description' => '开启内网。', 'type' => 'boolean', ], 'Labels' => [ 'title' => '网关标签列表'."\n", 'description' => '网关标签列表'."\n", 'type' => 'array', 'items' => [ 'title' => '网关标签对象', 'description' => '网关标签对象', 'type' => 'object', 'properties' => [ 'LabelKey' => [ 'title' => '网关标签键', 'description' => '网关标签键', 'type' => 'string', 'example' => 'key1', ], 'LabelValue' => [ 'title' => '网关标签值', 'description' => '网关标签值', 'type' => 'string', 'example' => 'value1', ], ], ], ], ], ], ], 'PageNumber' => [ 'description' => '返回查询的服务列表的当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '返回每页显示的服务数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '100', ], 'TotalCount' => [ 'description' => '网关总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '5', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Gateways\\": [\\n {\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"GatewayName\\": \\"mygateway1\\",\\n \\"InstanceType\\": \\"2c4g\\",\\n \\"IntranetDomain\\": \\"gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com\\",\\n \\"InternetEnabled\\": true,\\n \\"InternetDomain\\": \\"gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com\\",\\n \\"CreateTime\\": \\"2020-05-19T14:19:42Z\\",\\n \\"UpdateTime\\": \\"2021-02-24T11:52:17Z\\",\\n \\"Status\\": \\"Running\\",\\n \\"Replicas\\": 2,\\n \\"IsDefault\\": true,\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"SSLRedirectionEnabled\\": true,\\n \\"IntranetEnabled\\": true,\\n \\"Labels\\": [\\n {\\n \\"LabelKey\\": \\"key1\\",\\n \\"LabelValue\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 5\\n}","type":"json"}]', 'title' => '查询私有网关列表', ], 'ListAclPolicy' => [ 'summary' => '查看网关访问权限的列表。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/acl_policy', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '225605', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见ListResources接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '专有网络的ID。如何获取专有网络ID，请参见DescribeVpcs。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf66uio7md****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'InternetAclPolicyList' => [ 'description' => '公网访问权限列表。', 'type' => 'array', 'items' => [ 'description' => '公网访问权限。', 'type' => 'object', 'properties' => [ 'AclPolicyList' => [ 'description' => '专有网络可访问公网IP段白名单列表。', 'type' => 'array', 'items' => [ 'description' => '专有网络公网可访问IP段信息。', 'type' => 'object', 'properties' => [ 'Entry' => [ 'description' => '专有网络公网可访问IP段。', 'type' => 'string', 'example' => '0.0.0.0/0', ], 'Comment' => [ 'description' => '专有网络公网可访问IP段备注信息。', 'type' => 'string', 'example' => 'default', ], ], ], ], ], ], ], 'IntranetVpcAclPolicyList' => [ 'description' => '内网信息列表。', 'type' => 'array', 'items' => [ 'description' => '内网信息。', 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '专有网络的ID。如何获取专有网络ID，请参见DescribeVpcs。', 'type' => 'string', 'example' => 'vpc-uf66uio7md****', ], 'AclPolicyList' => [ 'description' => '专有网络可访问内网IP段白名单列表。', 'type' => 'array', 'items' => [ 'description' => '专有网络内网可访问IP段信息。', 'type' => 'object', 'properties' => [ 'Entry' => [ 'description' => '专有网络内网可访问IP段。', 'type' => 'string', 'example' => '0.0.0.0/0'."\n", ], 'Comment' => [ 'description' => '专有网络内网可访问IP段备注信息。', 'type' => 'string', 'example' => 'default', ], ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"InternetAclPolicyList\\": [\\n {\\n \\"AclPolicyList\\": [\\n {\\n \\"Entry\\": \\"0.0.0.0/0\\",\\n \\"Comment\\": \\"default\\"\\n }\\n ]\\n }\\n ],\\n \\"IntranetVpcAclPolicyList\\": [\\n {\\n \\"VpcId\\": \\"vpc-uf66uio7md****\\",\\n \\"AclPolicyList\\": [\\n {\\n \\"Entry\\": \\"0.0.0.0/0\\\\n\\",\\n \\"Comment\\": \\"default\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询网关访问权限列表', ], 'DeleteAclPolicy' => [ 'summary' => '删除网关的访问权限，删除的IP段不再具备访问网关的权限。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/acl_policy', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '225607', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '所在区域', 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'title' => '网关ID', 'description' => '私有网关ID。如何获取私有网关ID，请参见ListResources接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '专有网络的ID。如何获取专有网络ID，请参见DescribeVpcs。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf66uio7md****', ], ], [ 'name' => 'AclPolicyList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '专有网络可访问IP段白名单列表。', 'type' => 'array', 'items' => [ 'description' => '专有网络可访问IP段白名单。', 'type' => 'object', 'properties' => [ 'Entry' => [ 'description' => '专有网络可访问IP段。', 'type' => 'string', 'required' => false, 'example' => '10.23.XX.XX/32', ], 'Comment' => [ 'description' => '专有网络可访问IP段备注。', 'type' => 'string', 'required' => false, 'example' => 'default', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Successfully delete acl policy for gateway', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Successfully delete acl policy for gateway\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\"\\n}","type":"json"}]', 'title' => '移除网关访问权限', ], 'CreateAclPolicy' => [ 'summary' => '创建私有网关的访问权限，添加权限的IP段可以访问网关。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/acl_policy', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '225604', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见ListResources接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '专有网络的ID。如何获取专有网络ID，请参见DescribeVpcs。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf66uio7md****', ], ], [ 'name' => 'AclPolicyList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '专有网络可访问IP段白名单列表。', 'type' => 'array', 'items' => [ 'description' => '专有网络可访问IP段白名单。', 'type' => 'object', 'properties' => [ 'Entry' => [ 'description' => '专有网络可访问IP段。', 'type' => 'string', 'required' => true, 'example' => '10.23.XX.XX/32', ], 'Comment' => [ 'description' => '专有网络可访问IP段备注。', 'type' => 'string', 'required' => false, 'example' => 'default', ], ], 'required' => false, ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Successfully add acl policy for gateway', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"Message\\": \\"Successfully add acl policy for gateway\\"\\n}","type":"json"}]', 'title' => '创建网关访问权限', ], 'CreateGateway' => [ 'summary' => '创建网关。', 'path' => '/api/v2/gateways', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '191840', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], ], 'parameters' => [ [ 'name' => 'ResourceName', 'in' => 'query', 'schema' => [ 'description' => '资源组名称。请参见[ListResources](~~412133~~)接口返回的，ResourceType为SelfManaged的ResourceName字段。', 'type' => 'string', 'required' => false, 'example' => 'eas-r-4gt8twzwllfo******', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'InstanceType' => [ 'description' => '私有网关使用的机型。取值如下：'."\n" .'- 2c4g'."\n" .'- 4c8g'."\n" .'- 8c16g'."\n" .'- 16c32g', 'type' => 'string', 'required' => false, 'example' => '2c4g', ], 'EnableIntranet' => [ 'description' => '开启内网访问（默认值为true）。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '开启', 'false' => '关闭', ], 'example' => 'true', ], 'EnableInternet' => [ 'description' => '开启公网访问（默认值为false）。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '开启', 'false' => '关闭', ], 'example' => 'false', ], 'Name' => [ 'description' => '私有网关别名。', 'type' => 'string', 'required' => false, 'example' => 'mygateway1', ], 'Replicas' => [ 'description' => '私有网关节点数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'ChargeType' => [ 'description' => '付费类型，取值如下：'."\n" .'- PrePaid：预付费。'."\n" .'- PostPaid：后付费。', 'type' => 'string', 'required' => false, 'example' => 'PostPaid', ], 'AutoRenewal' => [ 'description' => '是否自动续费，取值如下：'."\n" .'- false（默认值）：表示不自动续费。'."\n" .'- true：表示自动续费。', 'type' => 'boolean', 'required' => false, ], 'GatewayType' => [ 'type' => 'string', 'required' => false, ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'ClusterId' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'example' => 'cn-wulanchabu', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Successfully create gateway for user-managed resource', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"ClusterId\\": \\"cn-wulanchabu\\",\\n \\"Message\\": \\"Successfully create gateway for user-managed resource\\"\\n}","type":"json"}]', 'title' => '创建私有网关', ], 'DescribeGateway' => [ 'summary' => '查看私有网关详情。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191846', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListResources](~~412133~~)接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'title' => '网关ID', 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'GatewayName' => [ 'description' => '私有网关别名。', 'type' => 'string', 'example' => 'mygateway1', ], 'CreateTime' => [ 'title' => '创建时间', 'description' => '私有网关创建时间。使用UTC时间。', 'type' => 'string', 'example' => '2020-05-19T14:19:42Z', ], 'UpdateTime' => [ 'title' => '更新时间', 'description' => '私有网关更新时间。使用UTC时间。', 'type' => 'string', 'example' => '2021-02-24T11:52:17Z', ], 'IntranetDomain' => [ 'title' => '外部域名', 'description' => '内网访问域名。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com', ], 'InternetEnabled' => [ 'description' => '公网访问是否开启。', 'type' => 'boolean', 'example' => 'true', ], 'InternetDomain' => [ 'title' => '内部域名', 'description' => '公网访问域名。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com', ], 'InstanceType' => [ 'title' => '实例种类', 'description' => '私有网关使用的机型。', 'type' => 'string', 'enumValueTitles' => [ '8c16g' => '8c16g', '4c8g' => '4c8g', '2c4g' => '2c4g', '16c32g' => '16c32g', ], 'example' => '2c4g', ], 'Status' => [ 'title' => '网关状态', 'description' => '私有网关状态。', 'type' => 'string', 'enumValueTitles' => [ 'Creating' => '创建中', 'Stopped' => '已停止', 'Failed' => '失败', 'Running' => '运行中', 'Deleted' => '已删除', 'Deleting' => '删除中', 'Waiting' => '等待中', ], 'example' => 'Running', ], 'ExternalClusterId' => [ 'description' => '自运维集群ID。', 'type' => 'string', 'example' => 'c935eadf284c14c2da57a2a13ad6******', ], 'Replicas' => [ 'description' => '私有网关节点数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'IsDefault' => [ 'description' => '是否默认私有网关。', 'type' => 'boolean', 'example' => 'true', ], 'InternetStatus' => [ 'description' => '公网访问开通或关闭状态。', 'type' => 'string', 'enumValueTitles' => [ 'Creating' => '公网访问开通中', 'Failed' => '公网访问开通或删除失败', 'Running' => '公网访问运行中', 'Deleted' => '公网访问已删除', 'Deleting' => '公网访问删除中', ], 'example' => 'Running', ], 'SSLRedirectionEnabled' => [ 'description' => 'HTTP重定向HTTPS是否开启。', 'type' => 'boolean', 'example' => 'true', ], 'ChargeType' => [ 'description' => '付费类型。', 'type' => 'string', 'enumValueTitles' => [ 'PrePaid（预付费）' => 'PrePaid（预付费）', 'PostPaid（后付费）' => 'PostPaid（后付费）', ], 'example' => 'PrePaid', ], 'IntranetEnabled' => [ 'type' => 'boolean', ], 'Labels' => [ 'title' => '网关标签列表'."\n", 'description' => '网关标签列表'."\n", 'type' => 'array', 'items' => [ 'title' => '网关标签对象', 'description' => '网关标签对象', 'type' => 'object', 'properties' => [ 'LabelKey' => [ 'title' => '网关标签键', 'description' => '网关标签键', 'type' => 'string', 'example' => 'key1', ], 'LabelValue' => [ 'title' => '网关标签值', 'description' => '网关标签值', 'type' => 'string', 'example' => 'value1', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"GatewayName\\": \\"mygateway1\\",\\n \\"CreateTime\\": \\"2020-05-19T14:19:42Z\\",\\n \\"UpdateTime\\": \\"2021-02-24T11:52:17Z\\",\\n \\"IntranetDomain\\": \\"gw-1uhcqmsc7x22******-1801786532******-vpc.cn-wulanchabu.pai-eas.aliyuncs.com\\",\\n \\"InternetEnabled\\": true,\\n \\"InternetDomain\\": \\"gw-1uhcqmsc7x22******-1801786532******.cn-wulanchabu.pai-eas.aliyuncs.com\\",\\n \\"InstanceType\\": \\"2c4g\\",\\n \\"Status\\": \\"Running\\",\\n \\"ExternalClusterId\\": \\"c935eadf284c14c2da57a2a13ad6******\\",\\n \\"Replicas\\": 2,\\n \\"IsDefault\\": true,\\n \\"InternetStatus\\": \\"Running\\",\\n \\"SSLRedirectionEnabled\\": true,\\n \\"ChargeType\\": \\"PrePaid\\",\\n \\"IntranetEnabled\\": true,\\n \\"Labels\\": [\\n {\\n \\"LabelKey\\": \\"key1\\",\\n \\"LabelValue\\": \\"value1\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看私有网关详情', ], 'UpdateGateway' => [ 'summary' => '更新私有网关。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '191842', 'abilityTreeNodes' => [ 'FEATURElearn6PC7M4', ], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求Body。', 'type' => 'object', 'properties' => [ 'InstanceType' => [ 'title' => '如果Alias不为空，则更新Alias，否则更新Spec', 'description' => '私有网关使用的机型。取值如下：'."\n" .'- 2c4g'."\n" .'- 4c8g'."\n" .'- 8c16g'."\n" .'- 16c32g', 'type' => 'string', 'required' => false, 'example' => '2c4g', ], 'Name' => [ 'description' => '私有网关别名。', 'type' => 'string', 'required' => false, 'example' => 'mygateway1', ], 'EnableIntranet' => [ 'description' => '开启内网访问（默认值为true）。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '开启内网访问', 'false' => '关闭内网访问', ], 'example' => 'true', ], 'EnableInternet' => [ 'description' => '开启公网访问（默认值为false）。', 'type' => 'boolean', 'required' => false, 'enumValueTitles' => [ 'true' => '开启公网访问', 'false' => '关闭公网访问', ], 'example' => 'false', ], 'IsDefault' => [ 'description' => '是否默认私有网关。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'Replicas' => [ 'description' => '私有网关节点数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', ], 'EnableSSLRedirection' => [ 'description' => '开启HTTP重定向HTTPS (默认值为false)。', 'type' => 'boolean', 'required' => false, 'example' => 'false', ], 'VpcId' => [ 'description' => '网关所属VPC （仅适用于应用型专属网关）。', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1jkde2******3mew', ], 'VSwitchIds' => [ 'description' => '虚拟机交换机列表（仅适用于应用型专属网关）。', 'type' => 'array', 'items' => [ 'description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-wz9mof1ucpr8se7******', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'title' => '实例 ID。', 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListResources](~~412133~~)接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'GatewayId' => [ 'title' => '资源ID，如ECS实例的创建接口CreateInstance应返回InstanceId。', 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'Gateway is updated', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Gateway is updated\\"\\n}","type":"json"}]', 'title' => '更新私有网关', ], 'CreateGatewayIntranetLinkedVpc' => [ 'summary' => '创建私有网关内网访问端点。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/intranet_endpoint_linked_vpc', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', 'abilityTreeCode' => '192211', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关对应地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListResources](~~412133~~)接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '专有网络的ID。如何获取专有网络ID，请参见[DescribeVpcs](~~448581~~)。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf66uio7md****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => '虚拟交换机ID。如何获取虚拟交换机ID，请参见[DescribeVpcs](~~448581~~)。', 'type' => 'string', 'required' => false, 'example' => 'vsw-8vbqn2at0kljjxxxx****', ], ], [ 'name' => 'EnableAuthoritativeDns', 'in' => 'query', 'schema' => [ 'description' => '是否开启权威DNS解析（默认值为false）。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], ], [ 'name' => 'AccountId', 'in' => 'query', 'schema' => [ 'description' => 'Vpc所属阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => '19*****10', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Successfully add intranet linked vpc for gateway', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"Message\\": \\"Successfully add intranet linked vpc for gateway\\"\\n}","type":"json"}]', 'title' => '创建私有网关内网访问端点', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'ListGatewayIntranetLinkedVpc' => [ 'summary' => '查看私有网关内网访问端点列表。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/intranet_endpoint_linked_vpc', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192205', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListResources](~~412133~~)接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => false, 'example' => 'gw-1uhcqmsc7x22******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'IntranetLinkedVpcList' => [ 'description' => '内网访问端点列表。', 'type' => 'array', 'items' => [ 'description' => '内网访问端点。', 'type' => 'object', 'properties' => [ 'Ip' => [ 'description' => 'IP地址。', 'type' => 'string', 'example' => '192.168.10.11', ], 'Status' => [ 'description' => '状态。可能值为：'."\n" .'- Creating：创建中。'."\n" .'- Running：运行中。', 'type' => 'string', 'enumValueTitles' => [ 'Creating' => 'Creating', 'Running' => 'Running', ], 'example' => 'Running', ], 'VpcId' => [ 'description' => '专有网络的ID。', 'type' => 'string', 'example' => 'vpc-2zetuli9ws0qgjd******', ], 'VSwitchId' => [ 'description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-8vb2qjoiio6m9pg******', ], 'SecurityGroupId' => [ 'description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-2ze4pgstgszvgq******', ], 'AuthoritativeDnsEnabled' => [ 'description' => 'DNS权威解析是否开启（默认值为false）。', 'type' => 'boolean', 'example' => 'true', ], 'AccountId' => [ 'description' => 'Vpc所属阿里云账号ID。', 'type' => 'string', 'example' => '161*******66', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"IntranetLinkedVpcList\\": [\\n {\\n \\"Ip\\": \\"192.168.10.11\\",\\n \\"Status\\": \\"Running\\",\\n \\"VpcId\\": \\"vpc-2zetuli9ws0qgjd******\\",\\n \\"VSwitchId\\": \\"vsw-8vb2qjoiio6m9pg******\\",\\n \\"SecurityGroupId\\": \\"sg-2ze4pgstgszvgq******\\",\\n \\"AuthoritativeDnsEnabled\\": true,\\n \\"AccountId\\": \\"161*******66\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看私有网关内网访问端点列表', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'ListGatewayIntranetSupportedZone' => [ 'summary' => '获取网关内网支持的可用区', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/intranet_supported_zone', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '249662', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见接口[ListGateway](https://apiworkbench.aliyun-inc.com/document/eas/2021-07-01/ListGateway?spm=openapi-amp.newDocPublishment.0.0.765e281fL2IcjJ&Env=online)返回结果中的GatewayId字段。', 'type' => 'string', 'required' => false, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在区域。', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Zones' => [ 'description' => '当前地域支持的可用区列表。', 'type' => 'array', 'items' => [ 'description' => '可用区。', 'type' => 'string', 'example' => 'cn-hangzhou-a', ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Zones\\": [\\n \\"cn-hangzhou-a\\"\\n ]\\n}","type":"json"}]', 'title' => '查询私有网关内网支持可用区', ], 'DeleteGatewayIntranetLinkedVpc' => [ 'summary' => '删除私有网关内网访问端点。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/intranet_endpoint_linked_vpc', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'title' => '所在区域', 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'title' => '网关ID', 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListResources](~~412133~~)接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '专有网络的ID。如何获取专有网络ID，请参见[DescribeVpcs](~~448581~~)。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf66uio7md****', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => [ 'description' => '虚拟交换机ID。如何获取虚拟交换机ID，请参见[DescribeVpcs](~~448581~~)。', 'type' => 'string', 'required' => false, 'example' => 'vsw-8vbqn2at0kljjxxxx****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '返回信息。', 'type' => 'string', 'example' => 'Successfully delete intranet linked vpc for gateway', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Successfully delete intranet linked vpc for gateway\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\"\\n}","type":"json"}]', 'title' => '删除私有网关内网访问端点', ], 'DeleteGateway' => [ 'summary' => '删除私有网关。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListResources](~~412133~~)接口返回结果中的private_gateway_id字段。', 'type' => 'string', 'required' => true, 'example' => 'gw-1uhcqmsc7x22******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'Message' => [ 'description' => '请求返回消息。', 'type' => 'string', 'example' => 'Gateway gw-1uhcqmsc7x22****** is deleted', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"Message\\": \\"Gateway gw-1uhcqmsc7x22****** is deleted\\"\\n}","type":"json"}]', 'title' => '删除私有网关', ], 'ListGatewayIntranetLinkedVpcPeer' => [ 'summary' => '获取网关内网访问端点跨VPC连接列表。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/intranet_endpoint_linked_vpc_peer', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '245616', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListGateway](~~2841911~~)。', 'type' => 'string', 'required' => false, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '绑定的专有网络ID，如何查询专有网络ID，请参见[ListGatewayIntranetLinkedVpc](~~2621223~~)。'."\n" .'- 配置专有网络ID，仅查询该VPC ID对应的VPC Peers。'."\n" .'- 不配置专有网络ID，则查询全部VPC Peers。', 'type' => 'string', 'required' => false, 'example' => 'vpc-2zetuli9ws0qgjd******', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'PeerVpcList' => [ 'description' => '对等VPC列表。', 'type' => 'array', 'items' => [ 'description' => '对等VPC列表。', 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '专有网络ID。', 'type' => 'string', 'example' => 'vpc-2zetuli9ws0qgjd******', ], 'PeerVpcs' => [ 'description' => '对等VPC的ID列表。', 'type' => 'array', 'items' => [ 'description' => '对等VPC的ID列表。', 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '对等专有网络ID。', 'type' => 'string', 'example' => 'vpc-uf66uio7md****', ], 'Region' => [ 'description' => '对等专有网络所在地域。', 'type' => 'string', 'example' => 'cn-shanghai', ], 'Status' => [ 'type' => 'string', ], ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"PeerVpcList\\": [\\n {\\n \\"VpcId\\": \\"vpc-2zetuli9ws0qgjd******\\",\\n \\"PeerVpcs\\": [\\n {\\n \\"VpcId\\": \\"vpc-uf66uio7md****\\",\\n \\"Region\\": \\"cn-shanghai\\",\\n \\"Status\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询对等专有网络列表', ], 'CreateGatewayIntranetLinkedVpcPeer' => [ 'summary' => '创建网关内网访问端点跨VPC连接。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/intranet_endpoint_linked_vpc_peer', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '245608', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关对应地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListGateway](~~2841911~~)。', 'type' => 'string', 'required' => false, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '专有网络的ID。如何获取专有网络ID，请参见[ListGatewayIntranetLinkedVpc](~~2621223~~)。', 'type' => 'string', 'required' => false, 'example' => 'vpc-2zetuli9ws0qgjd******', ], ], [ 'name' => 'PeerVpcs', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '对等VPC列表。', 'type' => 'array', 'items' => [ 'description' => '对等VPC列表。', 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '对等专有网络ID。如何获取专有网络ID，请参见[DescribeVpcs](~~35739~~)。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf66uio7md****', ], 'Region' => [ 'description' => '对等专有网络所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Successfully add intranet linked vpc Peer for gateway', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"Message\\": \\"Successfully add intranet linked vpc Peer for gateway\\"\\n}","type":"json"}]', 'title' => '添加对等专有网络', ], 'DeleteGatewayIntranetLinkedVpcPeer' => [ 'summary' => '删除网关内网访问端点跨VPC连接。', 'path' => '/api/v2/gateways/{ClusterId}/{GatewayId}/intranet_endpoint_linked_vpc_peer', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '245615', 'abilityTreeNodes' => [ 'FEATURElearnMC2VJP', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-wulanchabu', ], ], [ 'name' => 'GatewayId', 'in' => 'path', 'schema' => [ 'description' => '私有网关ID。如何获取私有网关ID，请参见[ListGateway](~~2841911~~)。', 'type' => 'string', 'required' => false, 'example' => 'gw-1uhcqmsc7x22******', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'description' => '绑定的专有网络ID。如何查询，请参见[ListGatewayIntranetLinkedVpc](~~2621223~~)。', 'type' => 'string', 'required' => false, 'example' => 'vpc-2zetuli9ws0qgjd******', ], ], [ 'name' => 'PeerVpcs', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '对等专有网络。', 'type' => 'array', 'items' => [ 'description' => '对等专有网络。', 'type' => 'object', 'properties' => [ 'VpcId' => [ 'description' => '对等专有网络ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf66uio7md****', ], 'Region' => [ 'description' => '对等专有网络所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], 'required' => false, ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'requestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'GatewayId' => [ 'description' => '私有网关ID。', 'type' => 'string', 'example' => 'gw-1uhcqmsc7x22******', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Successfully delete intranet linked vpc Peer for gateway', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"40325405-579C-4D82****\\",\\n \\"GatewayId\\": \\"gw-1uhcqmsc7x22******\\",\\n \\"Message\\": \\"Successfully delete intranet linked vpc Peer for gateway\\"\\n}","type":"json"}]', 'title' => '删除对等专有网络', ], 'DescribeRegions' => [ 'summary' => '查询可用的地域信息', 'path' => '/api/v2/regions', 'methods' => [ 'get', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '133892', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求id。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Regions' => [ 'title' => '可用地域列表', 'description' => '可用地域列表', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'RegionId' => [ 'title' => '地域Id', 'description' => '地域Id', 'type' => 'string', 'example' => 'cn-shanghai', ], 'RegionName' => [ 'description' => '地域名称。', 'type' => 'string', 'example' => '华东 2（上海）', ], ], ], ], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Regions\\": [\\n {\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"RegionName\\": \\"华东 2（上海）\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查询可用地域信息', ], 'ReinstallTenantAddon' => [ 'summary' => '重置租户配置。', 'path' => '/api/v2/tenantaddons/{ClusterId}/{TenantAddonName}/reinstall', 'methods' => [ 'put', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '231056', 'abilityTreeNodes' => [ 'FEATURElearnDNLWTG', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '服务所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TenantAddonName', 'in' => 'path', 'schema' => [ 'description' => '插件名称。', 'type' => 'string', 'required' => true, 'example' => 'prometheus_discovery', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Addon prometheus_discovery is successfully reinstalled', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Addon prometheus_discovery is successfully reinstalled\\"\\n}","type":"json"}]', 'title' => '更新租户插件信息', ], 'ListServiceInstanceFaultInjectionInfo' => [ 'summary' => '获取故障注入信息', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/instances/{InstanceName}/faults', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '资源组所在的集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名字。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'InstanceName', 'in' => 'path', 'schema' => [ 'description' => '服务实例的名字。', 'type' => 'string', 'required' => true, 'example' => 'e-xxxx***', ], ], ], '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' => '40325405-579C-4D82****', ], 'FaultInfoList' => [ 'description' => '已注入故障列表', 'type' => 'array', 'items' => [ 'description' => '单个注入故障信息', 'type' => 'object', 'properties' => [ 'FaultType' => [ 'description' => '故障类型。1. CpuFullloadTask: CPU满载故障；2. MemLoadTask: 内存负载故障；3. NetworkTask: 网络故障；4. DiskBurnTask: 磁盘读写故障； 5. DiskFillTask: 磁盘填充故障；', 'type' => 'string', 'example' => 'DiskFillTask', ], 'FaultStatus' => [ 'description' => '故障状态', 'type' => 'object', 'properties' => [ 'FaultStatus' => [ 'description' => '故障状态：'."\n" .'1. FaultNotInjected： 任务已经创建但是无成功注入。'."\n" .'2. FaultInjectedSuccess：故障成功注入。'."\n" .'3. FaultInjectedFailure: 故障注入失败，可能由于参数错误、系统问题等。', 'type' => 'string', 'example' => 'FaultInjectedSuccess', ], 'FaultStatusMessage' => [ 'description' => '故障注入描述信息', 'type' => 'string', 'example' => 'Network interface not found', ], ], ], 'FaultArgs' => [ 'description' => '各故障类型参数详解：'."\n" .'1. CpuFullloadTask (CPU满载故障)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "CpuFullloadTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "fullload",'."\n" .' "CpuPercent": 50'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'2. MemLoadTask (内存负载故障)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "MemLoadTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "load",'."\n" .' "MemPercent": 80'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'3. NetworkTask (网络故障)'."\n" .'3.a. NetworkDelayAction (网络延迟)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "NetworkTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "delay",'."\n" .' "Time": 3000,'."\n" .' "Offset": 100'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'3.b. NetworkCorruptAction (网络包损坏)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "NetworkTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "corrupt",'."\n" .' "Percent": 50'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'3.c. NetworkLossAction (网络包丢失)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "NetworkTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "loss",'."\n" .' "Percent": 30'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'4. DiskBurnTask (磁盘读写故障)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "DiskBurnTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "burn",'."\n" .' "Read": true,'."\n" .' "Write": true,'."\n" .' "Size": 100'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'5. DiskFillTask (磁盘填充故障)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "DiskFillTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "fill",'."\n" .' "Percent": 80'."\n" .' }'."\n" .'}'."\n" .'`', 'type' => 'any', 'example' => '{'."\n" .' "FaultType": "DiskBurnTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "burn",'."\n" .' "Read": true,'."\n" .' "Write": true,'."\n" .' "Size": 100'."\n" .' }'."\n" .'}', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"FaultInfoList\\": [\\n {\\n \\"FaultType\\": \\"DiskFillTask\\",\\n \\"FaultStatus\\": {\\n \\"FaultStatus\\": \\"FaultInjectedSuccess\\",\\n \\"FaultStatusMessage\\": \\"Network interface not found\\"\\n },\\n \\"FaultArgs\\": \\"{\\\\n \\\\\\"FaultType\\\\\\": \\\\\\"DiskBurnTask\\\\\\",\\\\n \\\\\\"FaultArgs\\\\\\": {\\\\n \\\\\\"FaultAction\\\\\\": \\\\\\"burn\\\\\\",\\\\n \\\\\\"Read\\\\\\": true,\\\\n \\\\\\"Write\\\\\\": true,\\\\n \\\\\\"Size\\\\\\": 100\\\\n }\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '列举已注入故障信息', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'CreateFaultInjection' => [ 'summary' => '创建故障注入任务。', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/instances/{InstanceName}/faults', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关对应地域。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo', ], ], [ 'name' => 'InstanceName', 'in' => 'path', 'schema' => [ 'description' => '服务实例的名字。如何查看实例名称，请参见[ListServiceInstances](~~412108~~)。', 'type' => 'string', 'required' => true, 'example' => 'foo-69xxxx4f4-5w9r9', ], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => '请求body。其中关键请求参数配置说明，请参见下方的**表 1. 请求 Body 参数**和**表 2. metadata 参数**。更多参数配置详情，请参见[服务模型所有相关参数说明](~~450525~~)。', 'type' => 'object', 'properties' => [ 'FaultType' => [ 'description' => '故障类型。'."\n" .'设备故障：1. CPU满载故障；2.内存负载故障；3.网络故障；4.磁盘读写挂账； 5.磁盘填充故障；', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'MemLoadTask' => '内存加压', 'CpuFullloadTask' => 'CPU满负荷', 'NetworkTask' => '网络故障', 'DiskFillTask' => '磁盘加压', ], 'example' => 'CpuFullloadTask', ], 'FaultArgs' => [ 'description' => '各故障类型参数详解：'."\n" .'1. CpuFullloadTask (CPU满载故障)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "CpuFullloadTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "fullload",'."\n" .' "CpuPercent": 50'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'2. MemLoadTask (内存负载故障)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "MemLoadTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "load",'."\n" .' "MemPercent": 80'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'3. NetworkTask (网络故障)'."\n" .'3.a. NetworkDelayAction (网络延迟)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "NetworkTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "delay",'."\n" .' "Time": 3000,'."\n" .' "Offset": 100'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'3.b. NetworkCorruptAction (网络包损坏)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "NetworkTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "corrupt",'."\n" .' "Percent": 50'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'3.c. NetworkLossAction (网络包丢失)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "NetworkTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "loss",'."\n" .' "Percent": 30'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'4. DiskBurnTask (磁盘读写故障)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "DiskBurnTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "burn",'."\n" .' "Read": true,'."\n" .' "Write": true,'."\n" .' "Size": 100'."\n" .' }'."\n" .'}'."\n" .'`'."\n" .'5. DiskFillTask (磁盘填充故障)'."\n" .'`'."\n" .'{'."\n" .' "FaultType": "DiskFillTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "fill",'."\n" .' "Percent": 80'."\n" .' }'."\n" .'}'."\n" .'`', 'type' => 'any', 'required' => false, 'example' => '{'."\n" .' "FaultType": "DiskFillTask",'."\n" .' "FaultArgs": {'."\n" .' "FaultAction": "fill",'."\n" .' "Percent": 80'."\n" .' }'."\n" .'}'."\n", ], ], 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '40325405-579C-4D82***', ], 'Message' => [ 'description' => '请求返回信息。', 'type' => 'string', 'example' => 'Addon prometheus_discovery is successfully reinstalled', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82***\\",\\n \\"Message\\": \\"Addon prometheus_discovery is successfully reinstalled\\"\\n}","type":"json"}]', 'title' => '创建故障注入', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'DeleteFaultInjection' => [ 'summary' => '删除故障注入任务', 'path' => '/api/v2/services/{ClusterId}/{ServiceName}/instances/{InstanceName}/faults/{FaultType}', 'methods' => [ 'delete', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [ 'application/json', ], 'produces' => [ 'application/json', ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATURElearnN5R68Z', ], 'autoTest' => false, 'notSupportAutoTestReason' => '编排过于复杂', 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'path', 'schema' => [ 'description' => '私有网关对应地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai', ], ], [ 'name' => 'ServiceName', 'in' => 'path', 'schema' => [ 'description' => '服务名称。如何查看服务名称，请参见[ListServices ](~~412109~~)。', 'type' => 'string', 'required' => false, 'example' => 'foo', ], ], [ 'name' => 'InstanceName', 'in' => 'path', 'schema' => [ 'description' => '服务实例的名字。如何查看实例名称，请参见[ListServiceInstances](~~412108~~)。', 'type' => 'string', 'required' => false, 'example' => 'echo-da290ac8-7fckm', ], ], [ 'name' => 'FaultType', 'in' => 'path', 'schema' => [ 'description' => '设备故障：1. CPU满载故障；2.内存负载故障；3.网络故障；4.磁盘读写挂账； 5.磁盘填充故障；', 'type' => 'string', 'required' => false, 'example' => 'CpuFullloadTask', ], ], ], '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' => '40325405-579C-4D82****', ], 'Message' => [ 'description' => '操作结果信息。', 'type' => 'string', 'example' => 'Successfully delete acl policy for gateway', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Message\\": \\"Successfully delete acl policy for gateway\\"\\n}","type":"json"}]', 'title' => '删除注入的故障', 'description' => '**请确保在使用该接口前，已充分了解EAS产品的收费方式和[价格](~~144261~~)。**', ], 'ListTenantAddons' => [ 'summary' => '查看租户插件列表。', 'path' => '/api/v2/tenantaddons', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'produces' => [ 'application/json', ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '231065', 'abilityTreeNodes' => [ 'FEATURElearnDNLWTG', ], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => '40325405-579C-4D82****', ], 'Addons' => [ 'description' => '插件信息。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => '插件名称。', 'type' => 'string', 'example' => 'prometheus_discovery', ], 'Attributes' => [ 'description' => '插件属性。', 'type' => 'object', 'additionalProperties' => [ 'type' => 'string', 'description' => '属性描述信息。', 'example' => '{'."\n" .' "AccessToken":"ld***.eY***.",'."\n" .' "InternetEndpoint": "****.com/prometheus",'."\n" .' "IntranetEndpoint": "****.vpc.com/prometheus"'."\n" .'}', ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40325405-579C-4D82****\\",\\n \\"Addons\\": [\\n {\\n \\"Name\\": \\"prometheus_discovery\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"AccessToken\\\\\\":\\\\\\"ld***.eY***.\\\\\\",\\\\n \\\\\\"InternetEndpoint\\\\\\": \\\\\\"****.com/prometheus\\\\\\",\\\\n \\\\\\"IntranetEndpoint\\\\\\": \\\\\\"****.vpc.com/prometheus\\\\\\"\\\\n}\\"\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看租户插件列表', ], ], 'endpoints' => [ [ 'regionId' => 'cn-heyuan', 'endpoint' => 'pai-eas.cn-heyuan.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'pai-eas.cn-beijing.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'pai-eas.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'pai-eas.cn-hangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'pai-eas.cn-shanghai.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'pai-eas.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'pai-eas.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'pai-eas.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'pai-eas.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'pai-eas.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'pai-eas.us-east-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'pai-eas.us-west-1.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'pai-eas.eu-central-1.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'pai-eas.cn-shanghai-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'pai-eas.cn-wulanchabu.aliyuncs.com', ], [ 'regionId' => 'cn-guangzhou', 'endpoint' => 'pai-eas.cn-guangzhou.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'pai-eas.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-2', 'endpoint' => 'pai-eas.ap-northeast-2.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'pai-eas.ap-southeast-3.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-7', 'endpoint' => 'pai-eas.ap-southeast-7.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'pai-eas.me-east-1.aliyuncs.com', ], [ 'regionId' => 'us-southeast-1', 'endpoint' => 'pai-eas.us-southeast-1.aliyuncs.com', ], ], ];