diff options
Diffstat (limited to 'data/zh_cn/eais/2019-06-24')
| -rw-r--r-- | data/zh_cn/eais/2019-06-24/api-docs.php | 4859 |
1 files changed, 2008 insertions, 2851 deletions
diff --git a/data/zh_cn/eais/2019-06-24/api-docs.php b/data/zh_cn/eais/2019-06-24/api-docs.php index 8229c9b..bcc78e3 100644 --- a/data/zh_cn/eais/2019-06-24/api-docs.php +++ b/data/zh_cn/eais/2019-06-24/api-docs.php @@ -1,172 +1,27 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'eais', - 'version' => '2019-06-24', - ], + 'info' => ['style' => 'RPC', 'product' => 'eais', 'version' => '2019-06-24'], 'directories' => [ [ - 'id' => 186392, - 'title' => '地域', + 'children' => ['CreateEaisEi', 'AttachEaisEi', 'StartEaisEi', 'StopEaisEi', 'DetachEaisEi', 'DeleteEaisEi', 'DescribeEais', 'CreateEaiJupyter', 'StopEaiJupyter', 'StartEaiJupyter', 'GetInstanceMetrics', 'CreateEai', 'AttachEai', 'DetachEai', 'DeleteEai', 'CreateEaiEci', 'CreateEaiEcs', 'DeleteEaiAll'], 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - ], - ], - [ - 'id' => 186394, 'title' => '实例', - 'type' => 'directory', - 'children' => [ - 'CreateEaisEi', - 'AttachEaisEi', - 'StartEaisEi', - 'StopEaisEi', - 'DetachEaisEi', - 'DeleteEaisEi', - 'DescribeEais', - 'CreateEaiJupyter', - 'StopEaiJupyter', - 'StartEaiJupyter', - 'GetInstanceMetrics', - 'CreateEai', - 'AttachEai', - 'DetachEai', - 'DeleteEai', - 'CreateEaiEci', - 'CreateEaiEcs', - 'DeleteEaiAll', - 'ChangeResourceGroup', - ], + 'id' => 351395, ], [ - 'id' => 194869, - 'title' => '标签', + 'children' => ['ChangeResourceGroup', 'DescribeRegions', 'ListTagResources', 'TagResources', 'UntagResources'], + 'title' => '其他', 'type' => 'directory', - 'children' => [ - 'TagResources', - 'UntagResources', - 'ListTagResources', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'DescribeRegions' => [ - 'summary' => '查询您可以使用的阿里云地域。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****', - ], - 'Regions' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Region' => [ - 'description' => '地域信息集合。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RegionEndpoint' => [ - 'description' => '地域对应的接入地址（Endpoint）。', - 'type' => 'string', - 'example' => 'eais.cn-shenzhen.aliyuncs.com', - ], - 'LocalName' => [ - 'description' => '地域名称。', - 'type' => 'string', - 'example' => '华南1（深圳）', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'CheckTimeout', - 'errorMessage' => 'Check timed out.', - ], - [ - 'errorCode' => 'InconsistentSignature', - 'errorMessage' => 'The signatures are inconsistent.', - ], - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'Operation timed out.', - ], - ], - [ - [ - 'errorCode' => 'CallRamApiFailed', - 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"eais.cn-shenzhen.aliyuncs.com\\",\\n \\"LocalName\\": \\"华南1（深圳）\\",\\n \\"RegionId\\": \\"cn-shenzhen\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>F5FEB9AA-C108-577C-AB3D-D13524AF****</RequestId>\\n <Regions>\\n <RegionEndpoint>eais.cn-shenzhen.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1（深圳）</LocalName>\\n <RegionId>cn-shenzhen</RegionId>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', - 'title' => '查询地域', - ], - 'CreateEaisEi' => [ - 'summary' => '您可以调用API CreateEaisEi创建一个EAIS，并将EAIS实例绑定到客户端实例（ECS实例或ECI实例）上来灵活地为客户端实例提供业务所需的GPU资源并节省成本。以ECS实例为例，您可以通过在ECS实例（非GPU实例）上绑定一个弹性加速计算实例EAIS，即可生成一款新规格的GPU实例，且使用该方式相比直接购买GPU实例，可以实现GPU资源的弹性使用（您可以根据实际需要绑定、解绑或释放EAIS实例），有效为您降低部署成本和使用成本。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AttachEai' => [ + 'summary' => '创建弹性加速计算实例EAIS实例后，您需要调用API AttachEai将该EAIS实例绑定到客户端实例（ECS实例或ECI实例）上，才能为客户端实例提供GPU资源。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -174,233 +29,65 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'InstanceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例的规格。取值范围：'."\n" - ."\n" - .'- eais.ei-a6.4xlarge'."\n" - .'- eais.ei-a6.2xlarge'."\n" - .'- eais.ei-a6.xlarge'."\n" - .'- eais.ei-a6.large', - 'type' => 'string', - 'required' => true, - 'example' => 'eais.ei-a6.2xlarge', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen'], ], [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的虚拟交换机ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp17wmd1wb6fwlimk****', - ], - ], - [ - 'name' => 'SecurityGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的安全组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'sg-bp16jgp51ttnkbdr****', - ], - ], - [ - 'name' => 'InstanceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例的名称。长度为2~128个字符，支持Unicode中letter分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'test_ei', - ], - ], - [ - 'name' => 'ResourceGroupId', + 'name' => 'ElasticAcceleratedInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmvpuy4a5****', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eais-sz8t15a7gt7z7j7i****'], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。`ClientToken`只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], - ], - [ - 'name' => 'Tag', + 'name' => 'ClientInstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '标签列表，最多包含20个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '标签信息。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。限制：'."\n" - ."\n" - .'- 不能为空。'."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。限制：'."\n" - ."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => '待绑定的ECS或ECI实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'i-wz93g6pyat2g7t7o****'], ], ], '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' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****', - ], - 'EiInstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-hzu00xufs1c8j5nn****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC8****'], + 'ElasticAcceleratedInstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-sz8t15a7gt7z7j7i****'], + 'ClientInstanceId' => ['description' => 'ECS或ECI实例ID。', 'type' => 'string', 'example' => 'i-wz93g6pyat2g7t7o****'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidRegionId', - 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', - ], - [ - 'errorCode' => 'CheckTimeout', - 'errorMessage' => 'Check timed out.', - ], - [ - 'errorCode' => 'InconsistentSignature', - 'errorMessage' => 'The signatures are inconsistent.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', - ], - [ - 'errorCode' => 'CustomTag.NumberExceed', - 'errorMessage' => 'The maximum number of system tags for each resource is 20.', - ], - [ - 'errorCode' => 'InvalidInstanceType', - 'errorMessage' => 'The instance type is invalid.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', - ], - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'Operation timed out.', - ], - ], - [ - [ - 'errorCode' => 'CallRamApiFailed', - 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', - ], - ], - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], - [ - 'errorCode' => 'NoResources', - 'errorMessage' => 'The current regional resources are insufficient.', - ], - [ - 'errorCode' => 'CreateOrderFailed', - 'errorMessage' => 'Create order failed: %s.', - ], - [ - 'errorCode' => 'InDebt', - 'errorMessage' => 'The current user has an overdue payment. Please top up first.', - ], - [ - 'errorCode' => 'OperationDenied.KeyValueNotNull', - 'errorMessage' => 'The key value cannot be null.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"i-wz93g6pyat2g7t7o****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachEaiResponse>\\n <RequestId>C3BCB7DA-BEB6-4982-A765-6EA61EC8****</RequestId>\\n <ElasticAcceleratedInstanceId>eais-sz8t15a7gt7z7j7i****</ElasticAcceleratedInstanceId>\\n <ClientInstanceId>i-wz93g6pyat2g7t7o****</ClientInstanceId>\\n</AttachEaiResponse>","errorExample":""}]', + 'title' => '绑定EAIS实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachEai'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:AttachEai', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'product' => 'EAIS', 'resourceType' => 'ContainerGroup', 'arn' => 'acs:eci:{#regionId}:{#accountId}:containergroup/{#ContainerGroupId}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'eais::2019-06-24::DescribeEais', - 'callbackInterval' => 10000, - 'maxCallbackTimes' => 60, - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"EiInstanceId\\": \\"eais-hzu00xufs1c8j5nn****\\"\\n}","type":"json"}]', - 'title' => '（推荐）创建EAIS实例', ], 'AttachEaisEi' => [ 'summary' => '创建弹性加速计算实例EAIS实例后，您需要调用API AttachEaisEi将该EAIS实例绑定到客户端实例（ECS实例或ECI实例）上，才能为客户端实例提供GPU资源。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -408,58 +95,32 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ClientInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '待绑定的ECS或ECI实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'i-bp14ws9hbt1oe0u9****', - ], + 'schema' => ['description' => '待绑定的ECS或ECI实例ID。', 'type' => 'string', 'required' => true, 'example' => 'i-bp14ws9hbt1oe0u9****'], ], [ 'name' => 'EiInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。不设置该参数时，会自动查询用户账号下符合条件的可绑定实例，并选择查询出的第一个实例进行绑定。', - 'type' => 'string', - 'required' => false, - 'example' => 'eais-hzu00xufs1c8j5nn****', - ], + 'schema' => ['description' => 'EAIS实例ID。不设置该参数时，会自动查询用户账号下符合条件的可绑定实例，并选择查询出的第一个实例进行绑定。', 'type' => 'string', 'required' => false, 'example' => 'eais-hzu00xufs1c8j5nn****'], ], [ 'name' => 'EiInstanceType', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例的规格。当未指定`EiInstanceId`参数时，可以设置该参数来限制绑定的EAIS实例规格；指定了`EiInstanceId`参数时，该参数不生效。取值范围：'."\n" - ."\n" - .'- eais.ei-a6.4xlarge'."\n" - .'- eais.ei-a6.2xlarge'."\n" - .'- eais.ei-a6.xlarge'."\n" - .'- eais.ei-a6.large', - 'type' => 'string', - 'required' => false, - 'example' => 'eais.ei-a6.2xlarge', - ], + 'schema' => ['description' => 'EAIS实例的规格。当未指定`EiInstanceId`参数时，可以设置该参数来限制绑定的EAIS实例规格；指定了`EiInstanceId`参数时，该参数不生效。取值范围：'."\n" + ."\n" + .'- eais.ei-a6.4xlarge'."\n" + .'- eais.ei-a6.2xlarge'."\n" + .'- eais.ei-a6.xlarge'."\n" + .'- eais.ei-a6.large', 'type' => 'string', 'required' => false, 'example' => 'eais.ei-a6.2xlarge'], ], ], 'responses' => [ @@ -469,71 +130,52 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC8****', - ], - 'EiInstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-hzu00xufs1c8j5nn****', - ], - 'ClientInstanceId' => [ - 'description' => 'ECS或ECI实例ID。', - 'type' => 'string', - 'example' => 'i-bp14ws9hbt1oe0u9****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC8****'], + 'EiInstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-hzu00xufs1c8j5nn****'], + 'ClientInstanceId' => ['description' => 'ECS或ECI实例ID。', 'type' => 'string', 'example' => 'i-bp14ws9hbt1oe0u9****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidClientInstanceId.NotBound', - 'errorMessage' => 'The client instance is not bound.', - ], - [ - 'errorCode' => 'InvalidClientInstanceId.NotFound', - 'errorMessage' => 'The client instance does not exist or is not bound.', - ], - [ - 'errorCode' => 'InvalidClientInstanceId.TypeError', - 'errorMessage' => 'The client instance ID is invalid. Currently, only ECS or ECI instances can be bound.', - ], - [ - 'errorCode' => 'InvalidClientInstanceId.VpcIdError', - 'errorMessage' => 'The client instance is invalid. Please make sure that the VpcId of the client instance and the VpcId of the EAIS instance are the same.', - ], - [ - 'errorCode' => 'InvalidClientInstanceId.VSwitchIdError', - 'errorMessage' => 'The client instance is invalid. Please make sure that the VSwitchId of the client instance and the VSwitchId of the EAIS instance are the same.', - ], + ['errorCode' => 'InvalidClientInstanceId.NotBound', 'errorMessage' => 'The client instance is not bound.', 'description' => '客户端实例未绑定。'], + ['errorCode' => 'InvalidClientInstanceId.NotFound', 'errorMessage' => 'The client instance does not exist or is not bound.', 'description' => '客户端实例不存在或未绑定。'], + ['errorCode' => 'InvalidClientInstanceId.TypeError', 'errorMessage' => 'The client instance ID is invalid. Currently, only ECS or ECI instances can be bound.', 'description' => '无效的客户端实例ID, 目前只支持绑定ECS或ECI实例。'], + ['errorCode' => 'InvalidClientInstanceId.VpcIdError', 'errorMessage' => 'The client instance is invalid. Please make sure that the VpcId of the client instance and the VpcId of the EAIS instance are the same.', 'description' => '无效的客户端实例，请确保客户端实例与EAIS实例的专有网络VpcId一致。'], + ['errorCode' => 'InvalidClientInstanceId.VSwitchIdError', 'errorMessage' => 'The client instance is invalid. Please make sure that the VSwitchId of the client instance and the VSwitchId of the EAIS instance are the same.', 'description' => '无效的客户端实例，请确保客户端实例与EAIS实例的交换机VSwitchId一致。'], ], 404 => [ - [ - 'errorCode' => 'InvalidClientInstanceId.Forbidden', - 'errorMessage' => 'Please make sure the ClientInstanceId exists and belongs to you.', - ], + ['errorCode' => 'InvalidClientInstanceId.Forbidden', 'errorMessage' => 'Please make sure the ClientInstanceId exists and belongs to you.', 'description' => '无效的客户端实例ID, 请确定该实例存在并归属于您。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\",\\n \\"EiInstanceId\\": \\"eais-hzu00xufs1c8j5nn****\\",\\n \\"ClientInstanceId\\": \\"i-bp14ws9hbt1oe0u9****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachEaisEiResponse>\\n <RequestId>C3BCB7DA-BEB6-4982-A765-6EA61EC8****</RequestId>\\n <EiInstanceId>eais-hzu00xufs1c8j5nn****</EiInstanceId>\\n <ClientInstanceId>i-bp14ws9hbt1oe0u9****</ClientInstanceId>\\n</AttachEaisEiResponse>","errorExample":""}]', 'title' => '绑定EAIS实例', - ], - 'StartEaisEi' => [ - 'summary' => '当您创建好EAIS实例并挂载到目标客户端实例后，您可以调用API StartEaisEi启动一个弹性加速计算实例EAIS来为您的客户端提供GPU资源，以实现GPU资源的灵活扩展。', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachEaisEi'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:AttachEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'ChangeResourceGroup' => [ + 'summary' => '修改弹性加速计算实例所在的资源组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -541,33 +183,22 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ResourceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '资源Id', 'description' => '资源ID。', 'type' => 'string', 'required' => true, 'example' => 'eais-hzs4h26yyt5xkcke****'], ], [ - 'name' => 'EiInstanceId', + 'name' => 'ResourceRegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'eais-hzu00xufs1c8j5nn****', - ], + 'schema' => ['title' => '地域Id', 'description' => '资源所属的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '目标资源组', 'description' => '目标资源组ID。', 'type' => 'string', 'required' => true, 'example' => 'rg-acfmvpuy4a5****'], ], ], 'responses' => [ @@ -577,244 +208,319 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F23AEEC7-4D98-4657-A104-02692701****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC8****'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], + 400 => [ + ['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceRegionId', 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request', 'description' => ''], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartEaisEiResponse>\\n <RequestId>F23AEEC7-4D98-4657-A104-02692701****</RequestId>\\n</StartEaisEiResponse>","errorExample":""}]', - 'title' => '启动EAIS实例', - 'description' => '**请确保在使用该接口前，已充分了解EAIS产品的[计费说明](~~191197~~)。**', - ], - 'StopEaisEi' => [ - 'summary' => '如果您不再需要使用弹性加速计算实例为您的客户端实例提供GPU资源时，可以调用API StopEaisEi停止该EAIS实例，从而避免资源浪费，节约成本。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\"\\n}","errorExample":""},{"type":"xml","example":"<ChangeResourceGroupResponse>\\n <RequestId>C3BCB7DA-BEB6-4982-A765-6EA61EC8****</RequestId>\\n</ChangeResourceGroupResponse>","errorExample":""}]', + 'title' => '改变资源组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'eais:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'CreateEai' => [ + 'summary' => '您可以调用API CreateEai创建一个EAIS，并将EAIS实例绑定到客户端实例（ECS实例或ECI实例）上来灵活地为客户端实例提供业务所需的GPU资源并节省成本。以ECS实例为例，您可以通过在ECS实例（非GPU实例）上绑定一个弹性加速计算实例EAIS，即可生成一款新规格的GPU实例，且使用该方式相比直接购买GPU实例，可以实现GPU资源的弹性使用（您可以根据实际需要绑定、解绑或释放EAIS实例），有效为您降低部署成本和使用成本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen'], ], [ - 'name' => 'EiInstanceId', + 'name' => 'InstanceType', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'eais-hzu00xufs1c8j5nn****', - ], + 'schema' => ['description' => 'EAIS实例的规格。取值范围：'."\n" + ."\n" + .'- eais.ei-a6.4xlarge'."\n" + ."\n" + .'- eais.ei-a6.2xlarge'."\n" + ."\n" + .'- eais.ei-a6.xlarge'."\n" + ."\n" + .'- eais.ei-a6.large', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eais.ei-a6.2xlarge'], ], - ], - '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' => 'F23AEEC7-4D98-4657-A104-02692701****', - ], - ], - ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'EAIS 实例的名称。长度为2~128个字符，支持Unicode中letter分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'eais-test01'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopEaisEiResponse>\\n <RequestId>F23AEEC7-4D98-4657-A104-02692701****</RequestId>\\n</StopEaisEiResponse>","errorExample":""}]', - 'title' => '停止EAIS实例', - ], - 'DetachEaisEi' => [ - 'summary' => '为满足您业务的灵活性，您可以根据业务需要，调用API DetachEaisEi从客户端实例（即ECS实例或ECI实例）上解绑目标弹性加速计算实例EAIS。解绑ECS实例后，您的客户端实例将失去EAIS实例提供的加速效果。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => '实例所属的安全组ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sg-uf66jeqopgqa9hdn****'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所属的虚拟交换机ID。'."\n" + ."\n" + .'> 交换机网段内IP的个数决定了该交换机最大可支持创建的EAIS实例个数，请务必提前规划好网段设置。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'vsw-uf6h3rbwbm90urjwa****'], ], [ - 'name' => 'EiInstanceId', + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvpuy4a5****'], + ], + [ + 'name' => 'Image', + 'in' => 'query', + 'schema' => ['description' => 'EAIS实例镜像。默认使用EAIS内部镜像提供服务，用户也可以通过指定Image参数使用自己的镜像。自定义镜像使用限制如下：'."\n" + ."\n" + .'- 必须是公网可下载的镜像。'."\n" + ."\n" + .'- 只能选择使用1688、42000、50000端口。'."\n" + ."\n" + .'- 建议镜像文件大小小于5 GB。'."\n" + ."\n" + .'> 镜像太大可能会导致下载镜像的过程太长，造成创建超时失败。', 'type' => 'string', 'required' => false, 'example' => 'ubuntu:20.04'], + ], + [ + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'eais-hzu00xufs1c8j5nn****', + 'description' => '标签列表，最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。限制：'."\n" + ."\n" + .'- 不能为空。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => '标签值。限制：'."\n" + ."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, ], ], ], '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' => '04DEB304-2436-4CB9-BB63-468BCEA0****', - ], + 'ElasticAcceleratedInstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-sz8t15a7gt7z7j7i****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CheckTimeout', 'errorMessage' => 'Check timed out.', 'description' => '检查超时。'], + ['errorCode' => 'CustomTag.NumberExceed', 'errorMessage' => 'The maximum number of system tags for each resource is 20.', 'description' => '每个资源最多允许绑定20个用户标签。'], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', 'description' => '传入的TagKey重复。'], + ['errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The instance type is invalid.', 'description' => '无效的实例类型。'], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The specified Tag.n.Key is invalid.', 'description' => 'TagKey为非法值。'], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified Tag.n.Value is invalid.', 'description' => 'TagValue为非法值。'], + ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', 'description' => '无效的地域，您可以调用DescribeRegions API查看服务支持的地域。'], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => '传入的Tag数量达到上限，最多支持20个。'], + ['errorCode' => 'Timeout', 'errorMessage' => 'Operation timed out.', 'description' => '操作超时。'], + ], + [ + ['errorCode' => 'CallRamApiFailed', 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', 'description' => '调用阿里云RAM失败。'], + ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], + ['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Create order failed: %s.', 'description' => '创建订单失败，请尝试重新创建。'], + ['errorCode' => 'InDebt', 'errorMessage' => 'The current user has an overdue payment. Please top up first.', 'description' => '当前用户欠费中，请充值后再操作。'], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ['errorCode' => 'NoResources', 'errorMessage' => 'The current regional resources are insufficient.', 'description' => '当前地域资源不足。'], + ['errorCode' => 'OperationDenied.KeyValueNotNull', 'errorMessage' => 'The key value cannot be null.', 'description' => '标签值不能为空。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04DEB304-2436-4CB9-BB63-468BCEA0****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachEaisEiResponse>\\n <RequestId>04DEB304-2436-4CB9-BB63-468BCEA0****</RequestId>\\n</DetachEaisEiResponse>","errorExample":""}]', - 'title' => '解绑EAIS实例', - ], - 'DeleteEaisEi' => [ - 'summary' => '如果您不再需要使用弹性加速计算实例EAIS，您可以调用API DeleteEaisEi释放该EAIS实例。', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'eais::2019-06-24::DescribeEais', 'callbackInterval' => 20000, 'maxCallbackTimes' => 30], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\"\\n}","type":"json"}]', + 'title' => '创建EAIS实例', + 'description' => '**请确保在使用该接口前，已充分了解EAIS产品的[计费说明](~~191197~~)。**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEai'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEai', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], ], + ], + 'CreateEaiEci' => [ + 'summary' => '创建一个弹性加速计算实例和一个客户端ECI实例，并将弹性加速计算实例绑定到ECI实例上。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen'], ], [ - 'name' => 'EiInstanceId', + 'name' => 'EaisName', + 'in' => 'query', + 'schema' => ['description' => '弹性加速计算实例的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'eais-test01'], + ], + [ + 'name' => 'EaisType', 'in' => 'query', + 'schema' => ['description' => 'EAIS实例的规格。取值范围：'."\n" + ."\n" + .'- eais.ei-a6.4xlarge'."\n" + ."\n" + .'- eais.ei-a6.2xlarge'."\n" + ."\n" + .'- eais.ei-a6.xlarge'."\n" + ."\n" + .'- eais.ei-a6.large', 'type' => 'string', 'required' => true, 'example' => 'eais.ei-a6.2xlarge'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '实例所属的虚拟交换机ID。'."\n" + ."\n" + .'> 交换机网段内IP的个数决定了该交换机最大可支持创建的EAIS实例个数，请务必提前规划好网段设置。', 'type' => 'string', 'required' => true, 'example' => 'vsw-uf6h3rbwbm90urjwa****'], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => '实例所属的安全组ID。', 'type' => 'string', 'required' => true, 'example' => 'sg-uf66jeqopgqa9hdn****'], + ], + [ + 'name' => 'Eci', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'eais-hzu00xufs1c8j5nn****', + 'description' => 'ECI实例参数对象。', + 'type' => 'object', + 'properties' => [ + 'Container' => [ + 'description' => '容器参数对象。', + 'type' => 'object', + 'properties' => [ + 'Arg' => ['description' => '容器启动命令对应的参数。最多10个。', 'type' => 'string', 'required' => false, 'example' => '100'], + 'Command' => ['description' => '容器启动命令。最多20个。每个命令最多包含256个字符。', 'type' => 'string', 'required' => false, 'example' => 'sleep'], + 'Image' => ['description' => '容器使用的镜像。', 'type' => 'string', 'required' => false, 'example' => 'nginx'], + 'Name' => ['description' => '容器名称。', 'type' => 'string', 'required' => false, 'example' => 'test1'], + 'Volumes' => ['description' => '容器挂载的数据卷。', 'type' => 'string', 'required' => false, 'example' => '/mnt/eais=eais,/models=eais/models'], + ], + 'required' => false, + ], + 'EipId' => ['description' => 'ECI实例使用的弹性公网ID。', 'type' => 'string', 'required' => false, 'example' => 'eip-uf66jeqopgqa9hdn****'], + 'Name' => ['description' => 'ECI实例名称。', 'type' => 'string', 'required' => false, 'example' => 'test-nginx'], + 'Type' => ['description' => 'ECI实例规格。', 'type' => 'string', 'required' => false, 'example' => 'ecs.c5.xlarge'], + 'Volume' => ['description' => 'ECI实例挂载的数据卷。', 'type' => 'string', 'required' => false, 'example' => '00c7****-rivj.cn-hangzhou.extreme.nas.aliyuncs.com:/share'], + ], + 'required' => false, ], ], [ - 'name' => 'Force', + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => 'EAIS实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvpuy4a5****'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '实例状态不符合删除条件时，是否强制删除。取值范围：'."\n" - .'- true：强制删除。'."\n" - .'- false：不强制删除。'."\n" - ."\n" - .'默认值：false。'."\n" - ."\n" - .'实例状态与本参数说明如下：'."\n" - ."\n" - .'- 当实例状态为**可绑定**时，无需设置本参数，实例会正常释放。'."\n" - .'- 当实例不是**可绑定**状态时，可以设置本参数值为true来强制释放实例。', - 'type' => 'boolean', + 'description' => '标签列表，最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。限制：'."\n" + ."\n" + .'- 不能为空。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => '标签值。限制：'."\n" + ."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'false', + 'maxItems' => 21, ], ], ], @@ -825,189 +531,180 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F23AEEC7-4D98-4657-A104-02692701****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****'], + 'ElasticAcceleratedInstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-sz8t15a7gt7z7j7i****'], + 'ClientInstanceId' => ['description' => 'ECI实例ID。', 'type' => 'string', 'example' => 'eci-2zeh03ygxlrzmfi6****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The InstanceId is invalid.', - ], - [ - 'errorCode' => 'InvalidRegionId', - 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', - ], + ['errorCode' => 'CheckTimeout', 'errorMessage' => 'Check timed out.', 'description' => '检查超时。'], + ['errorCode' => 'CustomTag.NumberExceed', 'errorMessage' => 'The maximum number of system tags for each resource is 20.', 'description' => '每个资源最多允许绑定20个用户标签。'], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', 'description' => '传入的TagKey重复。'], + ['errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The instance type is invalid.', 'description' => '无效的实例类型。'], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The specified Tag.n.Key is invalid.', 'description' => 'TagKey为非法值。'], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified Tag.n.Value is invalid.', 'description' => 'TagValue为非法值。'], + ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', 'description' => '无效的地域，您可以调用DescribeRegions API查看服务支持的地域。'], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => '传入的Tag数量达到上限，最多支持20个。'], + ['errorCode' => 'Timeout', 'errorMessage' => 'Operation timed out.', 'description' => '操作超时。'], + ], + [ + ['errorCode' => 'CallRamApiFailed', 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', 'description' => '调用阿里云RAM失败。'], ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], + ['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Create order failed: %s.', 'description' => '创建订单失败，请尝试重新创建。'], + ['errorCode' => 'InDebt', 'errorMessage' => 'The current user has an overdue payment. Please top up first.', 'description' => '当前用户欠费中，请充值后再操作。'], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ['errorCode' => 'NoResources', 'errorMessage' => 'The current regional resources are insufficient.', 'description' => '当前地域资源不足。'], + ['errorCode' => 'OperationDenied.KeyValueNotNull', 'errorMessage' => 'The key value cannot be null.', 'description' => '标签值不能为空。'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"eci-2zeh03ygxlrzmfi6****\\"\\n}","type":"json"}]', + 'title' => '创建EAIS实例并绑定至客户端实例', + 'changeSet' => [ + ['createdAt' => '2025-01-15T01:59:38.000Z', 'description' => '请求参数发生变更'], + ['createdAt' => '2023-08-23T05:59:34.000Z', 'description' => '错误码发生变更'], + ['createdAt' => '2023-04-27T01:42:53.000Z', 'description' => '请求参数发生变更'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEaiEci'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidParameter.InstanceId.NotFound', - 'errorMessage' => 'The specified InstanceId does not exist.', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEaiEci', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEaisEiResponse>\\n <RequestId>F23AEEC7-4D98-4657-A104-02692701****</RequestId>\\n</DeleteEaisEiResponse>","errorExample":""}]', - 'title' => '释放EAIS实例', ], - 'DescribeEais' => [ - 'summary' => '调用此API查询一个或多个已创建的弹性加速计算实例EAIS的详细信息，例如EAIS的实例ID、实例状态、实例规格、EAIS实例绑定的客户端实例（ECS实例或ECI实例）等信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateEaiEcs' => [ + 'summary' => '创建一个弹性加速计算实例和一个客户端ECS实例，并将弹性加速计算实例绑定到ECS实例上。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-shenzhen'], ], [ - 'name' => 'ElasticAcceleratedInstanceIds', + 'name' => 'EaisName', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。取值可以由多个实例ID组成一个JSON数组，ID之间用半角逗号（,）隔开。最多支持200个ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '["eais-id1", "eais-id2"]', - ], + 'schema' => ['description' => '弹性加速计算实例的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'eais-test01'], ], [ - 'name' => 'InstanceName', + 'name' => 'Ecs', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'EAIS实例名称，支持使用通配符*进行模糊搜索。', - 'type' => 'string', + 'description' => 'ECS实例参数对象。', + 'type' => 'object', + 'properties' => [ + 'ImageId' => ['description' => 'ECS实例使用的镜像ID。', 'type' => 'string', 'required' => false, 'example' => 'aliyun_2_1903_x64_20G_alibase_20200324.vhd'], + 'InternetMaxBandwidthIn' => ['description' => 'ECS实例公网入带宽最大值，单位为Mbit/s。取值范围：'."\n" + ."\n" + .'- 当所购公网出带宽小于等于10 Mbit/s时：1~10，默认为10。'."\n" + .'- 当所购公网出带宽大于10 Mbit/s时：1~`InternetMaxBandwidthOut`的取值，默认为`InternetMaxBandwidthOut`的取值。', 'type' => 'string', 'required' => false, 'example' => '10'], + 'InternetMaxBandwidthOut' => ['description' => 'ECS实例公网出带宽最大值，单位为Mbit/s。取值范围：0~100。'."\n" + .'默认值：0。', 'type' => 'string', 'required' => false, 'example' => '10'], + 'Name' => ['description' => 'ECS实例名称。长度为2~128个字符，必须以大小字母或中文开头，不能以http://或https://开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test1'], + 'Password' => ['description' => 'ECS实例密码。长度为8~30个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：`()~!@#$%^&*-_+=|{}[]:;\'<>,.?/`。', 'type' => 'string', 'required' => false, 'example' => 'EcsV587!'], + 'SystemDiskCategory' => ['description' => 'ECS实例系统盘的云盘种类。取值范围：'."\n" + ."\n" + .'- cloud_efficiency：高效云盘。'."\n" + .'- cloud_ssd：SSD云盘。'."\n" + .'- cloud_essd：ESSD云盘。'."\n" + .'- cloud：普通云盘。'."\n" + .'- cloud_auto：ESSD AutoPL云盘。'."\n" + ."\n" + .'已停售的实例规格且非I/O优化实例默认值为cloud，否则默认值为cloud_efficiency。', 'type' => 'string', 'required' => false, 'example' => 'cloud_ssd'], + 'SystemDiskSize' => ['description' => 'ECS实例系统盘大小，单位为GiB。取值范围：20~500。'."\n" + ."\n" + .'该参数的取值必须大于或者等于max{20, `ImageSize`}。'."\n" + ."\n" + .'默认值：max{40, `ImageId`对应的镜像大小}。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '40'], + 'Type' => ['description' => 'ECS实例的资源规格。', 'type' => 'string', 'required' => false, 'example' => 'ecs.g7.4xlarge'], + 'ZoneId' => ['description' => 'ECS实例所属的可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen-e'], + ], 'required' => false, - 'example' => 'eais*', ], ], [ - 'name' => 'Status', + 'name' => 'EaisType', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例状态。具体状态与创建EAIS实例的方式有关，说明如下：'."\n" - .'- 调用[CreateEaisEi](~~2618548~~)创建EAIS实例： '."\n" - .' - Pending：准备中'."\n" - .' - Creating：创建中'."\n" - .' - Bindable：可绑定'."\n" - .' - Bound：已绑定'."\n" - .' - InUse：使用中'."\n" - .'- 调用[CreateEai](~~2618555~~)创建EAIS实例：'."\n" - .' - Starting：创建中'."\n" - .' - Available：可绑定'."\n" - .' - Attaching：绑定中'."\n" - .' - InUse：已绑定'."\n" - .' - Detaching：解绑中', - 'type' => 'string', - 'required' => false, - 'example' => 'InUse', - ], + 'schema' => ['description' => 'EAIS实例的规格。取值范围：'."\n" + ."\n" + .'- eais.ei-a6.4xlarge'."\n" + ."\n" + .'- eais.ei-a6.2xlarge'."\n" + ."\n" + .'- eais.ei-a6.xlarge'."\n" + ."\n" + .'- eais.ei-a6.large', 'type' => 'string', 'required' => true, 'example' => 'eais.ei-a6.2xlarge'], ], [ - 'name' => 'InstanceType', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例规格。取值范围：'."\n" - ."\n" - .'- eais.ei-a6.4xlarge'."\n" - ."\n" - .'- eais.ei-a6.2xlarge'."\n" - ."\n" - .'- eais.ei-a6.xlarge'."\n" - ."\n" - .'- eais.ei-a6.large'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eais.ei-a6.2xlarge', - ], + 'schema' => ['description' => '实例所属的虚拟交换机ID。'."\n" + ."\n" + .'> 交换机网段内IP的个数决定了该交换机最大可支持创建的EAIS实例个数，请务必提前规划好网段设置。', 'type' => 'string', 'required' => true, 'example' => 'vsw-uf6h3rbwbm90urjwa****'], ], [ - 'name' => 'ClientInstanceId', + 'name' => 'SecurityGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '绑定的ECS或ECI实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'i-wz96zm231cua8hbv****', - ], + 'schema' => ['description' => '实例所属的安全组ID。', 'type' => 'string', 'required' => true, 'example' => 'sg-uf66jeqopgqa9hdn****'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmvpuy4a5****', - ], + 'schema' => ['description' => 'EAIS实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvpuy4a5****'], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '标签列表', + 'description' => '标签列表，最多包含20个子项。', 'type' => 'array', 'items' => [ - 'description' => '标签', + 'description' => '标签信息。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '实例的标签键。N的取值范围为1~20。'."\n" - ."\n" - .'使用一个标签过滤资源，查询到该标签下的资源数量不能超过1000个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过1000个。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '实例的标签值。N的取值范围：1~20。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => '标签键。限制：'."\n" + ."\n" + .'- 不能为空。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => '标签值。限制：'."\n" + ."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], ], 'required' => false, ], @@ -1015,240 +712,70 @@ 'maxItems' => 21, ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '查询接口返回信息列表的页码。'."\n" - ."\n" - .'起始值：1。'."\n" - ."\n" - .'默认值：1。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '分页展示响应信息时设置的每页行数，单位：行。'."\n" - ."\n" - .'最大值：200。'."\n" - ."\n" - .'默认值：20。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1E23D585-BBD8-436F-9615-54CACD67****', - ], - 'PageNumber' => [ - 'description' => 'EAIS实例列表的页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '输入时设置的每页行数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => '查询到的EAIS实例总数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Instances' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Instance' => [ - 'description' => '由Instances组成的数组格式，返回实例的信息。', - 'type' => 'array', - 'items' => [ - 'description' => '实例列表信息。', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'EAIS实例状态。', - 'type' => 'string', - 'example' => 'InUse', - ], - 'CreationTime' => [ - 'description' => 'EAIS实例创建时间。格式为毫秒级的时间戳。', - 'type' => 'string', - 'example' => '1669945859000', - ], - 'ClientInstanceName' => [ - 'description' => '与EAIS实例绑定的ECS或ECI实例名称。', - 'type' => 'string', - 'example' => 'test1', - ], - 'Description' => [ - 'description' => 'EAIS实例描述。', - 'type' => 'string', - 'example' => 'testDescription', - ], - 'ElasticAcceleratedInstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-sz8t15a7gt7****', - ], - 'InstanceName' => [ - 'description' => 'EAIS实例名称。', - 'type' => 'string', - 'example' => 'testName', - ], - 'ClientInstanceType' => [ - 'description' => '与EAIS实例绑定的ECS或ECI实例规格。', - 'type' => 'string', - 'example' => 'ecs.g5ne.large', - ], - 'ClientInstanceId' => [ - 'description' => '与EAIS实例绑定的ECS或ECI实例ID。', - 'type' => 'string', - 'example' => 'i-wz93g6pyat2g****', - ], - 'ZoneId' => [ - 'description' => 'EAIS实例所属可用区。', - 'type' => 'string', - 'example' => 'cn-shenzhen-e', - ], - 'InstanceType' => [ - 'description' => 'EAIS实例规格。可能值：'."\n" - ."\n" - .'- eais.ei-a6.4xlarge'."\n" - ."\n" - .'- eais.ei-a6.2xlarge'."\n" - ."\n" - .'- eais.ei-a6.xlarge'."\n" - ."\n" - .'- eais.ei-a6.large', - 'type' => 'string', - 'example' => 'eais.ei-a6.2xlarge', - ], - 'RegionId' => [ - 'description' => '实例所属地域ID。', - 'type' => 'string', - 'example' => 'cn-shenzhen', - ], - 'Tags' => [ - 'type' => 'object', - 'itemNode' => true, - 'properties' => [ - 'Tag' => [ - 'description' => 'EAIS实例的标签集合。', - 'type' => 'array', - 'items' => [ - 'description' => '实例的标签集合。', - 'type' => 'object', - 'properties' => [ - 'TagKey' => [ - 'description' => 'EAIS实例的标签键。', - 'type' => 'string', - 'example' => 'TestKey', - ], - 'TagValue' => [ - 'description' => 'EAIS实例的标签值。', - 'type' => 'string', - 'example' => 'TestValue', - ], - ], - ], - ], - ], - ], - 'Category' => [ - 'description' => 'EAIS实例的类别。可能值：'."\n" - ."\n" - .'- eais：普通的弹性加速计算实例'."\n" - ."\n" - .'- jupyter：部署了特定的modelscope镜像并支持Jupyter Notebook功能的弹性加速计算实例', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'jupyter', - ], - 'JupyterUrl' => [ - 'description' => 'Jupyter Notebook的访问地址。仅当返回参数`Category`的值为`jupyter`时有值，当返回参数`Category`的值为`eais`时，值为空字符串。', - 'type' => 'string', - 'example' => 'http://121.41.**.24:8888', - ], - 'VSwitchId' => [ - 'description' => '虚拟交换机ID。', - 'type' => 'string', - 'example' => 'vsw-bp1sd131hfmd76r******', - ], - 'SecurityGroupId' => [ - 'description' => '安全组ID。', - 'type' => 'string', - 'example' => 'sg-bp1gppir818lx4******', - ], - 'StartTime' => [ - 'description' => 'EAIS实例启动完成时间。格式为毫秒级的时间戳。', - 'type' => 'string', - 'example' => '1669945889000', - ], - 'ResourceGroupId' => [ - 'description' => '实例所属的资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfmvpuy4a5****', - ], - 'PaymentType' => [ - 'description' => '支付类型，取值目前仅支持`PayAsYouGo`：后付费（后付费/按量付费）。', - 'type' => 'string', - 'example' => 'PayAsYouGo', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****'], + 'ElasticAcceleratedInstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-sz8t15a7gt7z7j7i****'], + 'ClientInstanceId' => ['description' => 'ECS实例ID。', 'type' => 'string', 'example' => 'i-bp1hjrvleawl4ogb****'], ], ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidParameter.InstanceId.NotFound', - 'errorMessage' => 'The specified InstanceId does not exist.', - ], + 400 => [ + ['errorCode' => 'CheckTimeout', 'errorMessage' => 'Check timed out.', 'description' => '检查超时。'], + ['errorCode' => 'CustomTag.NumberExceed', 'errorMessage' => 'The maximum number of system tags for each resource is 20.', 'description' => '每个资源最多允许绑定20个用户标签。'], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', 'description' => '传入的TagKey重复。'], + ['errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The instance type is invalid.', 'description' => '无效的实例类型。'], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The specified Tag.n.Key is invalid.', 'description' => 'TagKey为非法值。'], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified Tag.n.Value is invalid.', 'description' => 'TagValue为非法值。'], + ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', 'description' => '无效的地域，您可以调用DescribeRegions API查看服务支持的地域。'], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => '传入的Tag数量达到上限，最多支持20个。'], + ['errorCode' => 'Timeout', 'errorMessage' => 'Operation timed out.', 'description' => '操作超时。'], + ], + [ + ['errorCode' => 'CallRamApiFailed', 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', 'description' => '调用阿里云RAM失败。'], + ], + 403 => [ + ['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Create order failed: %s.', 'description' => '创建订单失败，请尝试重新创建。'], + ['errorCode' => 'InDebt', 'errorMessage' => 'The current user has an overdue payment. Please top up first.', 'description' => '当前用户欠费中，请充值后再操作。'], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ['errorCode' => 'NoResources', 'errorMessage' => 'The current regional resources are insufficient.', 'description' => '当前地域资源不足。'], + ['errorCode' => 'OperationDenied.KeyValueNotNull', 'errorMessage' => 'The key value cannot be null.', 'description' => '标签值不能为空。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"i-bp1hjrvleawl4ogb****\\"\\n}","type":"json"}]', + 'title' => '创建EAIS实例并绑定至客户端实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEaiEcs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEaiEcs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E23D585-BBD8-436F-9615-54CACD67****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"Status\\": \\"InUse\\",\\n \\"CreationTime\\": \\"1669945859000\\",\\n \\"ClientInstanceName\\": \\"test1\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7****\\",\\n \\"InstanceName\\": \\"testName\\",\\n \\"ClientInstanceType\\": \\"ecs.g5ne.large\\",\\n \\"ClientInstanceId\\": \\"i-wz93g6pyat2g****\\",\\n \\"ZoneId\\": \\"cn-shenzhen-e\\",\\n \\"InstanceType\\": \\"eais.ei-a6.2xlarge\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ]\\n },\\n \\"Category\\": \\"jupyter\\",\\n \\"JupyterUrl\\": \\"http://121.41.**.24:8888\\",\\n \\"VSwitchId\\": \\"vsw-bp1sd131hfmd76r******\\",\\n \\"SecurityGroupId\\": \\"sg-bp1gppir818lx4******\\",\\n \\"StartTime\\": \\"1669945889000\\",\\n \\"ResourceGroupId\\": \\"rg-acfmvpuy4a5****\\",\\n \\"PaymentType\\": \\"PayAsYouGo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询EAIS实例列表', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], 'CreateEaiJupyter' => [ 'summary' => '创建一个部署了notebook的弹性加速计算实例。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1256,11 +783,7 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'RegionId', @@ -1269,9 +792,7 @@ 'description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'cn-hangzhou' => 'cn-hangzhou', - ], + 'enumValueTitles' => ['cn-hangzhou' => 'cn-hangzhou'], 'example' => 'cn-hangzhou', ], ], @@ -1282,43 +803,26 @@ 'description' => 'EAIS实例的规格，仅支持设置为**eais.ei-a6.2xlarge**。', 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'eais.ei-a6.2xlarge' => 'eais.ei-a6.2xlarge', - ], + 'enumValueTitles' => ['eais.ei-a6.2xlarge' => 'eais.ei-a6.2xlarge'], 'example' => 'eais.ei-a6.2xlarge', ], ], [ 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的虚拟交换机ID。'."\n" - ."\n" - .'> 交换机网段内IP的个数决定了该交换机最大可支持创建的EAIS实例个数，请务必提前规划好网段设置。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-uf6h3rbwbm90urjwa****', - ], + 'schema' => ['description' => '实例所属的虚拟交换机ID。'."\n" + ."\n" + .'> 交换机网段内IP的个数决定了该交换机最大可支持创建的EAIS实例个数，请务必提前规划好网段设置。'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-uf6h3rbwbm90urjwa****'], ], [ 'name' => 'SecurityGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的安全组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'sg-uf66jeqopgqa9hdn****', - ], + 'schema' => ['description' => '实例所属的安全组ID。', 'type' => 'string', 'required' => true, 'example' => 'sg-uf66jeqopgqa9hdn****'], ], [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + 'schema' => ['description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], ], [ 'name' => 'EnvironmentVar', @@ -1330,20 +834,11 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '环境变量名。长度为1~128位。格式要求：[0-9a-zA-Z]，以及下划线（_），不能以数字开头。', - 'type' => 'string', - 'required' => false, - 'example' => 'MY_USER_NAME', - ], - 'Value' => [ - 'description' => '环境变量值。长度为0~256位。', - 'type' => 'string', - 'required' => false, - 'example' => 'test123', - ], + 'Key' => ['description' => '环境变量名。长度为1~128位。格式要求：[0-9a-zA-Z]，以及下划线（_），不能以数字开头。', 'type' => 'string', 'required' => false, 'example' => 'MY_USER_NAME'], + 'Value' => ['description' => '环境变量值。长度为0~256位。', 'type' => 'string', 'required' => false, 'example' => 'test123'], ], 'required' => false, + 'description' => '', ], 'required' => false, ], @@ -1351,22 +846,12 @@ [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmvpuy4a5****', - ], + 'schema' => ['description' => 'EAIS实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvpuy4a5****'], ], [ 'name' => 'EaisName', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'EAIS实例的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'Tag', @@ -1379,27 +864,17 @@ 'description' => '标签信息。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '标签键。限制：'."\n" - ."\n" - .'- 不能为空。'."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。限制：'."\n" - ."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => '标签键。限制：'."\n" + ."\n" + .'- 不能为空。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => '标签值。限制：'."\n" + ."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], ], 'required' => false, ], @@ -1415,442 +890,385 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A655AB0E-31BB-45AD-9255-FCE93F65****', - ], - 'ElasticAcceleratedInstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-hz8t15a7gt7z7j7i****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'A655AB0E-31BB-45AD-9255-FCE93F65****'], + 'ElasticAcceleratedInstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-hz8t15a7gt7z7j7i****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'Operation timed out.', - ], - [ - 'errorCode' => 'CheckTimeout', - 'errorMessage' => 'Check timed out.', - ], - [ - 'errorCode' => 'InconsistentSignature', - 'errorMessage' => 'The signatures are inconsistent.', - ], - [ - 'errorCode' => 'InvalidInstanceType', - 'errorMessage' => 'The instance type is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The specified Tag.n.Key is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The specified Tag.n.Value is invalid.', - ], - [ - 'errorCode' => 'InvalidRegionId', - 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', - ], + ['errorCode' => 'Timeout', 'errorMessage' => 'Operation timed out.', 'description' => '操作超时。'], + ['errorCode' => 'CheckTimeout', 'errorMessage' => 'Check timed out.', 'description' => '检查超时。'], + ['errorCode' => 'InconsistentSignature', 'errorMessage' => 'The signatures are inconsistent.', 'description' => '签名不一致。'], + ['errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The instance type is invalid.', 'description' => '无效的实例类型。'], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The specified Tag.n.Key is invalid.', 'description' => 'TagKey为非法值。'], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified Tag.n.Value is invalid.', 'description' => 'TagValue为非法值。'], + ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', 'description' => '无效的地域，您可以调用DescribeRegions API查看服务支持的地域。'], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => '传入的Tag数量达到上限，最多支持20个。'], ], [ - [ - 'errorCode' => 'CallRamApiFailed', - 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', - ], + ['errorCode' => 'CallRamApiFailed', 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', 'description' => '调用阿里云RAM失败。'], ], 403 => [ - [ - 'errorCode' => 'CreateOrderFailed', - 'errorMessage' => 'Create order failed: %s.', - ], - [ - 'errorCode' => 'InDebt', - 'errorMessage' => 'The current user has an overdue payment. Please top up first.', - ], - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], - [ - 'errorCode' => 'NoResources', - 'errorMessage' => 'The current regional resources are insufficient.', - ], - [ - 'errorCode' => 'OperationDenied.KeyValueNotNull', - 'errorMessage' => 'The key value cannot be null.', - ], + ['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Create order failed: %s.', 'description' => '创建订单失败，请尝试重新创建。'], + ['errorCode' => 'InDebt', 'errorMessage' => 'The current user has an overdue payment. Please top up first.', 'description' => '当前用户欠费中，请充值后再操作。'], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ['errorCode' => 'NoResources', 'errorMessage' => 'The current regional resources are insufficient.', 'description' => '当前地域资源不足。'], + ['errorCode' => 'OperationDenied.KeyValueNotNull', 'errorMessage' => 'The key value cannot be null.', 'description' => '标签值不能为空。'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A655AB0E-31BB-45AD-9255-FCE93F65****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-hz8t15a7gt7z7j7i****\\"\\n}","type":"json"}]', 'title' => '创建Jupyter EAIS实例', - ], - 'StopEaiJupyter' => [ - 'summary' => '停止一个部署了notebook的弹性加速计算实例。', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEaiJupyter'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEaiJupyter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], ], + ], + 'CreateEaisEi' => [ + 'summary' => '您可以调用API CreateEaisEi创建一个EAIS，并将EAIS实例绑定到客户端实例（ECS实例或ECI实例）上来灵活地为客户端实例提供业务所需的GPU资源并节省成本。以ECS实例为例，您可以通过在ECS实例（非GPU实例）上绑定一个弹性加速计算实例EAIS，即可生成一款新规格的GPU实例，且使用该方式相比直接购买GPU实例，可以实现GPU资源的弹性使用（您可以根据实际需要绑定、解绑或释放EAIS实例），有效为您降低部署成本和使用成本。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InstanceId', + 'name' => 'InstanceType', + 'in' => 'query', + 'schema' => ['description' => 'EAIS实例的规格。取值范围：'."\n" + ."\n" + .'- eais.ei-a6.4xlarge'."\n" + .'- eais.ei-a6.2xlarge'."\n" + .'- eais.ei-a6.xlarge'."\n" + .'- eais.ei-a6.large', 'type' => 'string', 'required' => true, 'example' => 'eais.ei-a6.2xlarge'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => '实例所属的虚拟交换机ID。', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp17wmd1wb6fwlimk****'], + ], + [ + 'name' => 'SecurityGroupId', 'in' => 'query', + 'schema' => ['description' => '实例所属的安全组ID。', 'type' => 'string', 'required' => true, 'example' => 'sg-bp16jgp51ttnkbdr****'], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => ['description' => 'EAIS实例的名称。长度为2~128个字符，支持Unicode中letter分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', 'type' => 'string', 'required' => false, 'example' => 'test_ei'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvpuy4a5****'], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。`ClientToken`只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'eais-hze3x2gv9wimdj0k****', + 'description' => '标签列表，最多包含20个子项。', + 'type' => 'array', + 'items' => [ + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。限制：'."\n" + ."\n" + .'- 不能为空。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => '标签值。限制：'."\n" + ."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, ], ], ], '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' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****', - ], - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息.'."\n" - .'> 只有RAM校验失败才会返回此字段。', - 'type' => 'object', - 'properties' => [ - 'AuthAction' => [ - 'description' => '需要鉴权的权限点。', - 'type' => 'string', - 'example' => 'eais:StopEaiJupyter', - ], - 'AuthPrincipalDisplayName' => [ - 'description' => '授权主体显示名称。', - 'type' => 'string', - 'example' => '20560152949032****', - ], - 'AuthPrincipalOwnerId' => [ - 'description' => '授权主体所有者ID。', - 'type' => 'string', - 'example' => '170718266783****', - ], - 'AuthPrincipalType' => [ - 'description' => '授权主体类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'SubUser' => 'SubUser', - 'AssumedRoleUser' => 'AssumedRoleUser', - ], - 'example' => 'SubUser', - ], - 'EncodedDiagnosticMessage' => [ - 'description' => '编码诊断信息。', - 'type' => 'string', - 'example' => 'AQFmj0FOZo9BTjMyQTFDRkIzLUE5MTItNUIwNC1BQzkxLTcyMUFFQTUyQjhGQQ==', - ], - 'NoPermissionType' => [ - 'description' => '无权限类型。', - 'type' => 'string', - 'example' => 'ExplicitDeny', - ], - 'PolicyType' => [ - 'description' => '策略类型。', - 'type' => 'string', - 'example' => 'AccountLevelIdentityBasedPolicy', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****'], + 'EiInstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-hzu00xufs1c8j5nn****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The InstanceId is invalid.', - ], + ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', 'description' => '无效的地域，您可以调用DescribeRegions API查看服务支持的地域。'], + ['errorCode' => 'CheckTimeout', 'errorMessage' => 'Check timed out.', 'description' => '检查超时。'], + ['errorCode' => 'InconsistentSignature', 'errorMessage' => 'The signatures are inconsistent.', 'description' => '签名不一致。'], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', 'description' => '传入的TagKey重复。'], + ['errorCode' => 'CustomTag.NumberExceed', 'errorMessage' => 'The maximum number of system tags for each resource is 20.', 'description' => '每个资源最多允许绑定20个用户标签。'], + ['errorCode' => 'InvalidInstanceType', 'errorMessage' => 'The instance type is invalid.', 'description' => '无效的实例类型。'], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => '传入的Tag数量达到上限，最多支持20个。'], + ['errorCode' => 'Timeout', 'errorMessage' => 'Operation timed out.', 'description' => '操作超时。'], + ], + [ + ['errorCode' => 'CallRamApiFailed', 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', 'description' => '调用阿里云RAM失败。'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ['errorCode' => 'NoResources', 'errorMessage' => 'The current regional resources are insufficient.', 'description' => '当前地域资源不足。'], + ['errorCode' => 'CreateOrderFailed', 'errorMessage' => 'Create order failed: %s.', 'description' => '创建订单失败，请尝试重新创建。'], + ['errorCode' => 'InDebt', 'errorMessage' => 'The current user has an overdue payment. Please top up first.', 'description' => '当前用户欠费中，请充值后再操作。'], + ['errorCode' => 'OperationDenied.KeyValueNotNull', 'errorMessage' => 'The key value cannot be null.', 'description' => '标签值不能为空。'], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'eais::2019-06-24::DescribeEais', - 'callbackInterval' => 3000, - 'maxCallbackTimes' => 5, + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'eais::2019-06-24::DescribeEais', 'callbackInterval' => 10000, 'maxCallbackTimes' => 60], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"EiInstanceId\\": \\"eais-hzu00xufs1c8j5nn****\\"\\n}","type":"json"}]', + 'title' => '（推荐）创建EAIS实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEaisEi'], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"eais:StopEaiJupyter\\",\\n \\"AuthPrincipalDisplayName\\": \\"20560152949032****\\",\\n \\"AuthPrincipalOwnerId\\": \\"170718266783****\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFmj0FOZo9BTjMyQTFDRkIzLUE5MTItNUIwNC1BQzkxLTcyMUFFQTUyQjhGQQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n }\\n}","type":"json"}]', - 'title' => '停止Jupyter EAIS实例', ], - 'StartEaiJupyter' => [ - 'summary' => '启动一个部署了notebook的弹性加速计算实例。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DeleteEai' => [ + 'summary' => '如果您不再需要使用弹性加速计算实例EAIS，您可以调用API DeleteEai释放该EAIS实例。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen'], ], [ - 'name' => 'InstanceId', + 'name' => 'ElasticAcceleratedInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'eais-hze3x2gv9wimdj0k****', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eais-sz8t15a7gt7z7j7i****'], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => ['description' => '实例状态不符合删除条件时，是否强制删除。取值范围：'."\n" + ."\n" + .'- true：强制删除。'."\n" + .'- false：不强制删除。'."\n" + ."\n" + .'默认值：false。'."\n" + ."\n" + .'实例状态与本参数说明如下：'."\n" + ."\n" + .'- 当实例状态为**可绑定**或**已绑定**时，无需设置本参数，实例会正常释放。'."\n" + .'- 当实例状态为**创建中**、**绑定中**或**解绑中**时，可以设置本参数值为`true`来强制释放实例。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04DEB304-2436-4CB9-BB63-468BCEA0****', - ], - 'AccessDeniedDetail' => [ - 'description' => '访问被拒绝详细信息.'."\n" - .'> 只有RAM校验失败才会返回此字段。', - 'type' => 'object', - 'properties' => [ - 'AuthAction' => [ - 'description' => '需要鉴权的权限点。', - 'type' => 'string', - 'example' => 'eais:StartEaiJupyter', - ], - 'AuthPrincipalDisplayName' => [ - 'description' => '授权主体显示名称。', - 'type' => 'string', - 'example' => '20560152949032****', - ], - 'AuthPrincipalOwnerId' => [ - 'description' => '授权主体所有者ID。', - 'type' => 'string', - 'example' => '170718266783****', - ], - 'AuthPrincipalType' => [ - 'description' => '授权主体类型。', - 'type' => 'string', - 'enumValueTitles' => [ - 'SubUser' => 'SubUser', - 'AssumedRoleUser' => 'AssumedRoleUser', - ], - 'example' => 'SubUser', - ], - 'EncodedDiagnosticMessage' => [ - 'description' => '编码诊断信息。', - 'type' => 'string', - 'example' => 'AQFmfh3BZn4dwUQyNzY4MDVELTgzQkUtNTBEOC04QjQyLTNGM0U1QUI5MjhBRA==', - ], - 'NoPermissionType' => [ - 'description' => '无权限类型。', - 'type' => 'string', - 'example' => 'ExplicitDeny', - ], - 'PolicyType' => [ - 'description' => '策略类型。', - 'type' => 'string', - 'example' => 'AccountLevelIdentityBasedPolicy', - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F23AEEC7-4D98-4657-A104-02692701****'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The InstanceId is invalid.', - ], + ['errorCode' => 'InvalidEaiStatus', 'errorMessage' => 'The current state of the EAIS instance does not support the operation.', 'description' => '当前EAIS实例状态下不支持此操作。'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ], + [ + ['errorCode' => 'InvalidParameter.InstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'eais::2019-06-24::DescribeEais', - 'callbackInterval' => 10000, - 'maxCallbackTimes' => 60, + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEaiResponse>\\n <RequestId>F23AEEC7-4D98-4657-A104-02692701****</RequestId>\\n</DeleteEaiResponse>","errorExample":""}]', + 'title' => '释放EAIS实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEai'], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'eais:DeleteEai', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04DEB304-2436-4CB9-BB63-468BCEA0****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"eais:StartEaiJupyter\\",\\n \\"AuthPrincipalDisplayName\\": \\"20560152949032****\\",\\n \\"AuthPrincipalOwnerId\\": \\"170718266783****\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFmfh3BZn4dwUQyNzY4MDVELTgzQkUtNTBEOC04QjQyLTNGM0U1QUI5MjhBRA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n }\\n}","type":"json"}]', - 'title' => '启动Jupyter EAIS实例', ], - 'GetInstanceMetrics' => [ - 'summary' => '查询EAIS Jupyter实例的监控数据，包括GPU使用率、GPU Memory使用率、CPU使用率、Memory使用率。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteEaiAll' => [ + 'summary' => '释放一个弹性加速计算实例和与其绑定的客户端实例（即ECS实例或ECI实例）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen'], ], [ - 'name' => 'InstanceId', + 'name' => 'ElasticAcceleratedInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'eais-hznzre6ffmz9num4****', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eais-hza1ahi0uuw0re33****'], ], [ - 'name' => 'MetricType', + 'name' => 'ClientInstanceId', 'in' => 'query', + 'schema' => ['description' => '与EAIS实例绑定的ECS或ECI实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-bp1fvhi60e1zizsp****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '指标类型。取值范围：'."\n" - ."\n" - .'- GpuCoreUsage：GPU使用率'."\n" - ."\n" - .'- GpuMemoryUsage：GPU Memory使用率'."\n" - ."\n" - .'- CpuCoreUsage：CPU使用率'."\n" - ."\n" - .'- MemoryUsage：Memory使用率', - 'type' => 'string', - 'required' => true, - 'example' => 'MemoryUsage', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'AD4EA714-A35B-4710-BF92-8275BCDD****'], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AD4EA714-A35B-4710-BF92-8275BCDD****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEaiAllResponse>\\n <RequestId>AD4EA714-A35B-4710-BF92-8275BCDD****</RequestId>\\n</DeleteEaiAllResponse>","errorExample":""}]', + 'title' => '释放EAIS实例及绑定的客户端实例', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEaiAll'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'eais:DeleteEaiAll', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'product' => 'EAIS', 'resourceType' => 'ContainerGroup', 'arn' => 'acs:eci:{#regionId}:{#accountId}:containergroup/{#ContainerGroupId}'], + ], ], ], + ], + ], + 'DeleteEaisEi' => [ + 'summary' => '如果您不再需要使用弹性加速计算实例EAIS，您可以调用API DeleteEaisEi释放该EAIS实例。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '开始时间，默认取值为当前时间减1小时。支持时间戳和时间字符串，时间字符串格式为：yyyy-MM-ddTHH:mm:SSZ，采用UTC +0时区。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-11-22T16:00:00Z', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EndTime', + 'name' => 'EiInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '结束时间，默认取值为当前时间。支持时间戳和时间字符串，时间字符串格式为：yyyy-MM-ddTHH:mm:SSZ，采用UTC +0时区。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-11-22T16:30:00Z', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'eais-hzu00xufs1c8j5nn****'], ], [ - 'name' => 'TimeStep', + 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'description' => '时间步长，默认值：5m。支持的时长单位的取值范围：'."\n" - ."\n" - .'- h：小时。'."\n" - ."\n" - .'- m：分钟。'."\n" - ."\n" - .'- s：秒。'."\n" - ."\n" - .'当值不带单位时，默认使用单位：s（秒）。', - 'type' => 'string', - 'required' => false, - 'example' => '5m', - ], + 'schema' => ['description' => '实例状态不符合删除条件时，是否强制删除。取值范围：'."\n" + .'- true：强制删除。'."\n" + .'- false：不强制删除。'."\n" + ."\n" + .'默认值：false。'."\n" + ."\n" + .'实例状态与本参数说明如下：'."\n" + ."\n" + .'- 当实例状态为**可绑定**时，无需设置本参数，实例会正常释放。'."\n" + .'- 当实例不是**可绑定**状态时，可以设置本参数值为true来强制释放实例。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ @@ -1860,84 +1278,58 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****', - ], - 'InstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-bj8b53it29hfhj******', - ], - 'PodMetrics' => [ - 'description' => 'Pod指标列表。', - 'type' => 'array', - 'items' => [ - 'description' => 'Pod指标。', - 'type' => 'object', - 'properties' => [ - 'PodId' => [ - 'description' => 'Pod ID。', - 'type' => 'string', - 'example' => 'eais-hznzre6ffmz9num4****-579b587ddf-9txr6', - ], - 'Metrics' => [ - 'description' => '指标数据列表。', - 'type' => 'array', - 'items' => [ - 'description' => '指标数据。', - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => '时间戳。单位：毫秒。', - 'type' => 'string', - 'example' => '1669107528450', - ], - 'Value' => [ - 'description' => '利用率百分比。取值在0~100之间。', - 'type' => 'string', - 'example' => '4.536552540058814', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F23AEEC7-4D98-4657-A104-02692701****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The InstanceId is invalid.', 'description' => '无效的EAIS实例ID。'], + ['errorCode' => 'InvalidRegionId', 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', 'description' => '无效的地域，您可以调用DescribeRegions API查看服务支持的地域。'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ], + [ + ['errorCode' => 'InvalidParameter.InstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"InstanceId\\": \\"eais-bj8b53it29hfhj******\\",\\n \\"PodMetrics\\": [\\n {\\n \\"PodId\\": \\"eais-hznzre6ffmz9num4****-579b587ddf-9txr6\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": \\"1669107528450\\",\\n \\"Value\\": \\"4.536552540058814\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceMetricsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <InstanceId>eais-bj8b53it29hfhj******</InstanceId>\\n <PodMetrics>\\n <PodId>eais-hznzre6ffmz9num4****-579b587ddf-9txr6</PodId>\\n <Metrics>\\n <Time>1669107528450</Time>\\n <Value>4.536552540058814</Value>\\n </Metrics>\\n </PodMetrics>\\n</GetInstanceMetricsResponse>","errorExample":""}]', - 'title' => '查询EAIS Jupyter实例监控数据', - ], - 'CreateEai' => [ - 'summary' => '您可以调用API CreateEai创建一个EAIS，并将EAIS实例绑定到客户端实例（ECS实例或ECI实例）上来灵活地为客户端实例提供业务所需的GPU资源并节省成本。以ECS实例为例，您可以通过在ECS实例（非GPU实例）上绑定一个弹性加速计算实例EAIS，即可生成一款新规格的GPU实例，且使用该方式相比直接购买GPU实例，可以实现GPU资源的弹性使用（您可以根据实际需要绑定、解绑或释放EAIS实例），有效为您降低部署成本和使用成本。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEaisEiResponse>\\n <RequestId>F23AEEC7-4D98-4657-A104-02692701****</RequestId>\\n</DeleteEaisEiResponse>","errorExample":""}]', + 'title' => '释放EAIS实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEaisEi'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'eais:DeleteEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'DescribeEais' => [ + 'summary' => '调用此API查询一个或多个已创建的弹性加速计算实例EAIS的详细信息，例如EAIS的实例ID、实例状态、实例规格、EAIS实例绑定的客户端实例（ECS实例或ECI实例）等信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', @@ -1947,132 +1339,75 @@ 'type' => 'string', 'required' => true, 'docRequired' => true, + 'enumValueTitles' => [], 'example' => 'cn-shenzhen', ], ], [ - 'name' => 'InstanceType', + 'name' => 'ElasticAcceleratedInstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例的规格。取值范围：'."\n" - ."\n" - .'- eais.ei-a6.4xlarge'."\n" - ."\n" - .'- eais.ei-a6.2xlarge'."\n" - ."\n" - .'- eais.ei-a6.xlarge'."\n" - ."\n" - .'- eais.ei-a6.large', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'eais.ei-a6.2xlarge', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], + 'schema' => ['description' => 'EAIS实例ID。取值可以由多个实例ID组成一个JSON数组，ID之间用半角逗号（,）隔开。最多支持200个ID。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["eais-id1", "eais-id2"]'], ], [ 'name' => 'InstanceName', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS 实例的名称。长度为2~128个字符，支持Unicode中letter分类下的字符（其中包括英文、中文和数字等）。可以包含半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'eais-test01', - ], + 'schema' => ['description' => 'EAIS实例名称，支持使用通配符*进行模糊搜索。', 'type' => 'string', 'required' => false, 'example' => 'eais*'], ], [ - 'name' => 'SecurityGroupId', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的安全组ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'sg-uf66jeqopgqa9hdn****', - ], + 'schema' => ['description' => 'EAIS实例状态。具体状态与创建EAIS实例的方式有关，说明如下：'."\n" + .'- 调用[CreateEaisEi](~~2618548~~)创建EAIS实例： '."\n" + .' - Pending：准备中'."\n" + .' - Creating：创建中'."\n" + .' - Bindable：可绑定'."\n" + .' - Bound：已绑定'."\n" + .' - InUse：使用中'."\n" + .'- 调用[CreateEai](~~2618555~~)创建EAIS实例：'."\n" + .' - Starting：创建中'."\n" + .' - Available：可绑定'."\n" + .' - Attaching：绑定中'."\n" + .' - InUse：已绑定'."\n" + .' - Detaching：解绑中', 'type' => 'string', 'required' => false, 'example' => 'InUse'], ], [ - 'name' => 'VSwitchId', + 'name' => 'InstanceType', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的虚拟交换机ID。'."\n" - ."\n" - .'> 交换机网段内IP的个数决定了该交换机最大可支持创建的EAIS实例个数，请务必提前规划好网段设置。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'vsw-uf6h3rbwbm90urjwa****', - ], + 'schema' => ['description' => 'EAIS实例规格。取值范围：'."\n" + ."\n" + .'- eais.ei-a6.4xlarge'."\n" + ."\n" + .'- eais.ei-a6.2xlarge'."\n" + ."\n" + .'- eais.ei-a6.xlarge'."\n" + ."\n" + .'- eais.ei-a6.large'."\n", 'type' => 'string', 'required' => false, 'example' => 'eais.ei-a6.2xlarge'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ClientInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmvpuy4a5****', - ], + 'schema' => ['description' => '绑定的ECS或ECI实例ID。', 'type' => 'string', 'required' => false, 'example' => 'i-wz96zm231cua8hbv****'], ], [ - 'name' => 'Image', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例镜像。默认使用EAIS内部镜像提供服务，用户也可以通过指定Image参数使用自己的镜像。自定义镜像使用限制如下：'."\n" - ."\n" - .'- 必须是公网可下载的镜像。'."\n" - ."\n" - .'- 只能选择使用1688、42000、50000端口。'."\n" - ."\n" - .'- 建议镜像文件大小小于5 GB。'."\n" - ."\n" - .'> 镜像太大可能会导致下载镜像的过程太长，造成创建超时失败。', - 'type' => 'string', - 'required' => false, - 'example' => 'ubuntu:20.04', - ], + 'schema' => ['description' => '实例所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmvpuy4a5****'], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '标签列表，最多包含20个子项。', + 'description' => '标签列表', 'type' => 'array', 'items' => [ - 'description' => '标签信息。', + 'description' => '标签', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '标签键。限制：'."\n" - ."\n" - .'- 不能为空。'."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。限制：'."\n" - ."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => '实例的标签键。N的取值范围为1~20。'."\n" + ."\n" + .'使用一个标签过滤资源，查询到该标签下的资源数量不能超过1000个；使用多个标签过滤资源，查询到同时绑定了多个标签的资源数量不能超过1000个。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => '实例的标签值。N的取值范围：1~20。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], ], 'required' => false, ], @@ -2080,200 +1415,213 @@ 'maxItems' => 21, ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '查询接口返回信息列表的页码。'."\n" + ."\n" + .'起始值：1。'."\n" + ."\n" + .'默认值：1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页展示响应信息时设置的每页行数，单位：行。'."\n" + ."\n" + .'最大值：200。'."\n" + ."\n" + .'默认值：20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ElasticAcceleratedInstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-sz8t15a7gt7z7j7i****', - ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1E23D585-BBD8-436F-9615-54CACD67****'], + 'PageNumber' => ['description' => 'EAIS实例列表的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '输入时设置的每页行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => '查询到的EAIS实例总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Instances' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Instance' => [ + 'description' => '由Instances组成的数组格式，返回实例的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '实例列表信息。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'EAIS实例状态。', 'type' => 'string', 'example' => 'InUse'], + 'CreationTime' => ['description' => 'EAIS实例创建时间。格式为毫秒级的时间戳。', 'type' => 'string', 'example' => '1669945859000'], + 'ClientInstanceName' => ['description' => '与EAIS实例绑定的ECS或ECI实例名称。', 'type' => 'string', 'example' => 'test1'], + 'Description' => ['description' => 'EAIS实例描述。', 'type' => 'string', 'example' => 'testDescription'], + 'ElasticAcceleratedInstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-sz8t15a7gt7****'], + 'InstanceName' => ['description' => 'EAIS实例名称。', 'type' => 'string', 'example' => 'testName'], + 'ClientInstanceType' => ['description' => '与EAIS实例绑定的ECS或ECI实例规格。', 'type' => 'string', 'example' => 'ecs.g5ne.large'], + 'ClientInstanceId' => ['description' => '与EAIS实例绑定的ECS或ECI实例ID。', 'type' => 'string', 'example' => 'i-wz93g6pyat2g****'], + 'ZoneId' => ['description' => 'EAIS实例所属可用区。', 'type' => 'string', 'example' => 'cn-shenzhen-e'], + 'InstanceType' => ['description' => 'EAIS实例规格。可能值：'."\n" + ."\n" + .'- eais.ei-a6.4xlarge'."\n" + ."\n" + .'- eais.ei-a6.2xlarge'."\n" + ."\n" + .'- eais.ei-a6.xlarge'."\n" + ."\n" + .'- eais.ei-a6.large', 'type' => 'string', 'example' => 'eais.ei-a6.2xlarge'], + 'RegionId' => ['description' => '实例所属地域ID。', 'type' => 'string', 'example' => 'cn-shenzhen'], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tag' => [ + 'description' => 'EAIS实例的标签集合。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的标签集合。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['description' => 'EAIS实例的标签键。', 'type' => 'string', 'example' => 'TestKey'], + 'TagValue' => ['description' => 'EAIS实例的标签值。', 'type' => 'string', 'example' => 'TestValue'], + ], + ], + ], + ], + 'description' => '', + ], + 'Category' => [ + 'description' => 'EAIS实例的类别。可能值：'."\n" + ."\n" + .'- eais：普通的弹性加速计算实例'."\n" + ."\n" + .'- jupyter：部署了特定的modelscope镜像并支持Jupyter Notebook功能的弹性加速计算实例', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'jupyter', + ], + 'JupyterUrl' => ['description' => 'Jupyter Notebook的访问地址。仅当返回参数`Category`的值为`jupyter`时有值，当返回参数`Category`的值为`eais`时，值为空字符串。', 'type' => 'string', 'example' => 'http://121.41.**.24:8888'], + 'VSwitchId' => ['description' => '虚拟交换机ID。', 'type' => 'string', 'example' => 'vsw-bp1sd131hfmd76r******'], + 'SecurityGroupId' => ['description' => '安全组ID。', 'type' => 'string', 'example' => 'sg-bp1gppir818lx4******'], + 'StartTime' => ['description' => 'EAIS实例启动完成时间。格式为毫秒级的时间戳。', 'type' => 'string', 'example' => '1669945889000'], + 'ResourceGroupId' => ['description' => '实例所属的资源组ID。', 'type' => 'string', 'example' => 'rg-acfmvpuy4a5****'], + 'PaymentType' => ['description' => '支付类型，取值目前仅支持`PayAsYouGo`：后付费（后付费/按量付费）。', 'type' => 'string', 'example' => 'PayAsYouGo'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'CheckTimeout', - 'errorMessage' => 'Check timed out.', - ], - [ - 'errorCode' => 'CustomTag.NumberExceed', - 'errorMessage' => 'The maximum number of system tags for each resource is 20.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', - ], - [ - 'errorCode' => 'InvalidInstanceType', - 'errorMessage' => 'The instance type is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The specified Tag.n.Key is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The specified Tag.n.Value is invalid.', - ], - [ - 'errorCode' => 'InvalidRegionId', - 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', - ], - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'Operation timed out.', - ], + 404 => [ + ['errorCode' => 'InvalidParameter.InstanceId.NotFound', 'errorMessage' => 'The specified InstanceId does not exist.', 'description' => ''], ], - [ - [ - 'errorCode' => 'CallRamApiFailed', - 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E23D585-BBD8-436F-9615-54CACD67****\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Instances\\": {\\n \\"Instance\\": [\\n {\\n \\"Status\\": \\"InUse\\",\\n \\"CreationTime\\": \\"1669945859000\\",\\n \\"ClientInstanceName\\": \\"test1\\",\\n \\"Description\\": \\"testDescription\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7****\\",\\n \\"InstanceName\\": \\"testName\\",\\n \\"ClientInstanceType\\": \\"ecs.g5ne.large\\",\\n \\"ClientInstanceId\\": \\"i-wz93g6pyat2g****\\",\\n \\"ZoneId\\": \\"cn-shenzhen-e\\",\\n \\"InstanceType\\": \\"eais.ei-a6.2xlarge\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\"\\n }\\n ]\\n },\\n \\"Category\\": \\"jupyter\\",\\n \\"JupyterUrl\\": \\"http://121.41.**.24:8888\\",\\n \\"VSwitchId\\": \\"vsw-bp1sd131hfmd76r******\\",\\n \\"SecurityGroupId\\": \\"sg-bp1gppir818lx4******\\",\\n \\"StartTime\\": \\"1669945889000\\",\\n \\"ResourceGroupId\\": \\"rg-acfmvpuy4a5****\\",\\n \\"PaymentType\\": \\"PayAsYouGo\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询EAIS实例列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEais'], ], - 403 => [ - [ - 'errorCode' => 'CreateOrderFailed', - 'errorMessage' => 'Create order failed: %s.', - ], - [ - 'errorCode' => 'InDebt', - 'errorMessage' => 'The current user has an overdue payment. Please top up first.', - ], - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], - [ - 'errorCode' => 'NoResources', - 'errorMessage' => 'The current regional resources are insufficient.', - ], - [ - 'errorCode' => 'OperationDenied.KeyValueNotNull', - 'errorMessage' => 'The key value cannot be null.', + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'eais:DescribeEais', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'eais::2019-06-24::DescribeEais', - 'callbackInterval' => 20000, - 'maxCallbackTimes' => 30, - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\"\\n}","type":"json"}]', - 'title' => '创建EAIS实例', - 'description' => '**请确保在使用该接口前，已充分了解EAIS产品的[计费说明](~~191197~~)。**', ], - 'AttachEai' => [ - 'summary' => '创建弹性加速计算实例EAIS实例后，您需要调用API AttachEai将该EAIS实例绑定到客户端实例（ECS实例或ECI实例）上，才能为客户端实例提供GPU资源。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeRegions' => [ + 'summary' => '查询您可以使用的阿里云地域。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], - ], - [ - 'name' => 'ElasticAcceleratedInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'eais-sz8t15a7gt7z7j7i****', - ], - ], - [ - 'name' => 'ClientInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '待绑定的ECS或ECI实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'i-wz93g6pyat2g7t7o****', - ], - ], - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC8****', - ], - 'ElasticAcceleratedInstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-sz8t15a7gt7z7j7i****', - ], - 'ClientInstanceId' => [ - 'description' => 'ECS或ECI实例ID。', - 'type' => 'string', - 'example' => 'i-wz93g6pyat2g7t7o****', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****'], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域信息集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegionEndpoint' => ['description' => '地域对应的接入地址（Endpoint）。', 'type' => 'string', 'example' => 'eais.cn-shenzhen.aliyuncs.com'], + 'LocalName' => ['description' => '地域名称。', 'type' => 'string', 'example' => '华南1（深圳）'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-shenzhen'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"i-wz93g6pyat2g7t7o****\\"\\n}","errorExample":""},{"type":"xml","example":"<AttachEaiResponse>\\n <RequestId>C3BCB7DA-BEB6-4982-A765-6EA61EC8****</RequestId>\\n <ElasticAcceleratedInstanceId>eais-sz8t15a7gt7z7j7i****</ElasticAcceleratedInstanceId>\\n <ClientInstanceId>i-wz93g6pyat2g7t7o****</ClientInstanceId>\\n</AttachEaiResponse>","errorExample":""}]', - 'title' => '绑定EAIS实例', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'CheckTimeout', 'errorMessage' => 'Check timed out.', 'description' => '检查超时。'], + ['errorCode' => 'InconsistentSignature', 'errorMessage' => 'The signatures are inconsistent.', 'description' => '签名不一致。'], + ['errorCode' => 'Timeout', 'errorMessage' => 'Operation timed out.', 'description' => '操作超时。'], + ], + [ + ['errorCode' => 'CallRamApiFailed', 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', 'description' => '调用阿里云RAM失败。'], + ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionEndpoint\\": \\"eais.cn-shenzhen.aliyuncs.com\\",\\n \\"LocalName\\": \\"华南1（深圳）\\",\\n \\"RegionId\\": \\"cn-shenzhen\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>F5FEB9AA-C108-577C-AB3D-D13524AF****</RequestId>\\n <Regions>\\n <RegionEndpoint>eais.cn-shenzhen.aliyuncs.com</RegionEndpoint>\\n <LocalName>华南1（深圳）</LocalName>\\n <RegionId>cn-shenzhen</RegionId>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', + 'title' => '查询地域', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ], + ], + 'ramActions' => [], ], 'DetachEai' => [ 'summary' => '为满足您业务的灵活性，您可以根据业务需要，调用API DetachEai从客户端实例（即ECS实例或ECI实例）上解绑目标弹性加速计算实例EAIS。解绑ECS实例后，您的客户端实例将失去EAIS实例提供的加速效果。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2281,35 +1629,17 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen'], ], [ 'name' => 'ElasticAcceleratedInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'eais-sz8t15a7gt7z7j7i****', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'eais-sz8t15a7gt7z7j7i****'], ], ], 'responses' => [ @@ -2317,302 +1647,256 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '04DEB304-2436-4CB9-BB63-468BCEA0****', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '04DEB304-2436-4CB9-BB63-468BCEA0****'], ], + 'description' => '', ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04DEB304-2436-4CB9-BB63-468BCEA0****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachEaiResponse>\\n <RequestId>04DEB304-2436-4CB9-BB63-468BCEA0****</RequestId>\\n</DetachEaiResponse>","errorExample":""}]', 'title' => '解绑EAIS实例', - ], - 'DeleteEai' => [ - 'summary' => '如果您不再需要使用弹性加速计算实例EAIS，您可以调用API DeleteEai释放该EAIS实例。', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachEai'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:DetachEai', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], + ], + 'DetachEaisEi' => [ + 'summary' => '为满足您业务的灵活性，您可以根据业务需要，调用API DetachEaisEi从客户端实例（即ECS实例或ECI实例）上解绑目标弹性加速计算实例EAIS。解绑ECS实例后，您的客户端实例将失去EAIS实例提供的加速效果。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ElasticAcceleratedInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'eais-sz8t15a7gt7z7j7i****', - ], - ], - [ - 'name' => 'Force', + 'name' => 'EiInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例状态不符合删除条件时，是否强制删除。取值范围：'."\n" - ."\n" - .'- true：强制删除。'."\n" - .'- false：不强制删除。'."\n" - ."\n" - .'默认值：false。'."\n" - ."\n" - .'实例状态与本参数说明如下：'."\n" - ."\n" - .'- 当实例状态为**可绑定**或**已绑定**时，无需设置本参数，实例会正常释放。'."\n" - .'- 当实例状态为**创建中**、**绑定中**或**解绑中**时，可以设置本参数值为`true`来强制释放实例。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'eais-hzu00xufs1c8j5nn****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F23AEEC7-4D98-4657-A104-02692701****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '04DEB304-2436-4CB9-BB63-468BCEA0****'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidEaiStatus', - 'errorMessage' => 'The current state of the EAIS instance does not support the operation.', - ], - ], 403 => [ - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04DEB304-2436-4CB9-BB63-468BCEA0****\\"\\n}","errorExample":""},{"type":"xml","example":"<DetachEaisEiResponse>\\n <RequestId>04DEB304-2436-4CB9-BB63-468BCEA0****</RequestId>\\n</DetachEaisEiResponse>","errorExample":""}]', + 'title' => '解绑EAIS实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachEaisEi'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'InvalidParameter.InstanceId.NotFound', - 'errorMessage' => 'The specified InstanceId does not exist.', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:DetachEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEaiResponse>\\n <RequestId>F23AEEC7-4D98-4657-A104-02692701****</RequestId>\\n</DeleteEaiResponse>","errorExample":""}]', - 'title' => '释放EAIS实例', ], - 'CreateEaiEci' => [ - 'summary' => '创建一个弹性加速计算实例和一个客户端ECI实例，并将弹性加速计算实例绑定到ECI实例上。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetInstanceMetrics' => [ + 'summary' => '查询EAIS Jupyter实例的监控数据，包括GPU使用率、GPU Memory使用率、CPU使用率、Memory使用率。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'EaisName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '弹性加速计算实例的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'eais-test01', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'eais-hznzre6ffmz9num4****'], ], [ - 'name' => 'EaisType', + 'name' => 'MetricType', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例的规格。取值范围：'."\n" - ."\n" - .'- eais.ei-a6.4xlarge'."\n" - ."\n" - .'- eais.ei-a6.2xlarge'."\n" - ."\n" - .'- eais.ei-a6.xlarge'."\n" - ."\n" - .'- eais.ei-a6.large', - 'type' => 'string', - 'required' => true, - 'example' => 'eais.ei-a6.2xlarge', - ], + 'schema' => ['description' => '指标类型。取值范围：'."\n" + ."\n" + .'- GpuCoreUsage：GPU使用率'."\n" + ."\n" + .'- GpuMemoryUsage：GPU Memory使用率'."\n" + ."\n" + .'- CpuCoreUsage：CPU使用率'."\n" + ."\n" + .'- MemoryUsage：Memory使用率', 'type' => 'string', 'required' => true, 'example' => 'MemoryUsage'], ], [ - 'name' => 'VSwitchId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的虚拟交换机ID。'."\n" - ."\n" - .'> 交换机网段内IP的个数决定了该交换机最大可支持创建的EAIS实例个数，请务必提前规划好网段设置。', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-uf6h3rbwbm90urjwa****', - ], + 'schema' => ['description' => '开始时间，默认取值为当前时间减1小时。支持时间戳和时间字符串，时间字符串格式为：yyyy-MM-ddTHH:mm:SSZ，采用UTC +0时区。', 'type' => 'string', 'required' => false, 'example' => '2022-11-22T16:00:00Z'], ], [ - 'name' => 'SecurityGroupId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的安全组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'sg-uf66jeqopgqa9hdn****', - ], + 'schema' => ['description' => '结束时间，默认取值为当前时间。支持时间戳和时间字符串，时间字符串格式为：yyyy-MM-ddTHH:mm:SSZ，采用UTC +0时区。', 'type' => 'string', 'required' => false, 'example' => '2022-11-22T16:30:00Z'], ], [ - 'name' => 'Eci', + 'name' => 'TimeStep', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => '时间步长，默认值：5m。支持的时长单位的取值范围：'."\n" + ."\n" + .'- h：小时。'."\n" + ."\n" + .'- m：分钟。'."\n" + ."\n" + .'- s：秒。'."\n" + ."\n" + .'当值不带单位时，默认使用单位：s（秒）。', 'type' => 'string', 'required' => false, 'example' => '5m'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'ECI实例参数对象。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Container' => [ - 'description' => '容器参数对象。', - 'type' => 'object', - 'properties' => [ - 'Arg' => [ - 'description' => '容器启动命令对应的参数。最多10个。', - 'type' => 'string', - 'required' => false, - 'example' => '100', - ], - 'Command' => [ - 'description' => '容器启动命令。最多20个。每个命令最多包含256个字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'sleep', - ], - 'Image' => [ - 'description' => '容器使用的镜像。', - 'type' => 'string', - 'required' => false, - 'example' => 'nginx', - ], - 'Name' => [ - 'description' => '容器名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - 'Volumes' => [ - 'description' => '容器挂载的数据卷。', - 'type' => 'string', - 'required' => false, - 'example' => '/mnt/eais=eais,/models=eais/models', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****'], + 'InstanceId' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'example' => 'eais-bj8b53it29hfhj******'], + 'PodMetrics' => [ + 'description' => 'Pod指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Pod指标。', + 'type' => 'object', + 'properties' => [ + 'PodId' => ['description' => 'Pod ID。', 'type' => 'string', 'example' => 'eais-hznzre6ffmz9num4****-579b587ddf-9txr6'], + 'Metrics' => [ + 'description' => '指标数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标数据。', + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => '时间戳。单位：毫秒。', 'type' => 'string', 'example' => '1669107528450'], + 'Value' => ['description' => '利用率百分比。取值在0~100之间。', 'type' => 'string', 'example' => '4.536552540058814'], + ], + ], + ], ], ], - 'required' => false, - ], - 'EipId' => [ - 'description' => 'ECI实例使用的弹性公网ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'eip-uf66jeqopgqa9hdn****', - ], - 'Name' => [ - 'description' => 'ECI实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test-nginx', - ], - 'Type' => [ - 'description' => 'ECI实例规格。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.c5.xlarge', - ], - 'Volume' => [ - 'description' => 'ECI实例挂载的数据卷。', - 'type' => 'string', - 'required' => false, - 'example' => '00c7****-rivj.cn-hangzhou.extreme.nas.aliyuncs.com:/share', ], ], - 'required' => false, ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\",\\n \\"InstanceId\\": \\"eais-bj8b53it29hfhj******\\",\\n \\"PodMetrics\\": [\\n {\\n \\"PodId\\": \\"eais-hznzre6ffmz9num4****-579b587ddf-9txr6\\",\\n \\"Metrics\\": [\\n {\\n \\"Time\\": \\"1669107528450\\",\\n \\"Value\\": \\"4.536552540058814\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceMetricsResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>\\n <InstanceId>eais-bj8b53it29hfhj******</InstanceId>\\n <PodMetrics>\\n <PodId>eais-hznzre6ffmz9num4****-579b587ddf-9txr6</PodId>\\n <Metrics>\\n <Time>1669107528450</Time>\\n <Value>4.536552540058814</Value>\\n </Metrics>\\n </PodMetrics>\\n</GetInstanceMetricsResponse>","errorExample":""}]', + 'title' => '查询EAIS Jupyter实例监控数据', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceMetrics'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ResourceGroupId', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'eais:GetInstanceMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + ], + 'ListTagResources' => [ + 'summary' => '查询一个或多个EAIS资源已经绑定的标签列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '资源所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['title' => '下一个查询开始Token', 'description' => '下一个查询开始Token。', 'type' => 'string', 'required' => false, 'example' => 'caeba0bbb2be03f84eb48b699f0a4884'], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => ['title' => '资源类型', 'description' => '资源类型定义。目前取值仅支持`instance`。', 'type' => 'string', 'required' => true, 'example' => 'instance'], + ], + [ + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'EAIS实例所属的资源组ID。', - 'type' => 'string', + 'title' => '资源ID,最多 50个子项', + 'description' => '资源ID，最多 50个子项。', + 'type' => 'array', + 'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'eais-hzs4h26yyt5xkcke****'], 'required' => false, - 'example' => 'rg-acfmvpuy4a5****', + 'maxItems' => 51, ], ], [ @@ -2620,33 +1904,24 @@ 'in' => 'query', 'style' => 'repeatList', 'schema' => [ + 'title' => '标签列表，最多包含20个子项', 'description' => '标签列表，最多包含20个子项。', 'type' => 'array', 'items' => [ - 'description' => '标签信息。', + 'description' => '标签对象。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => '标签键。限制：'."\n" - ."\n" - .'- 不能为空。'."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。限制：'."\n" - ."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['title' => '标签键', 'description' => '标签键。限制：'."\n" + ."\n" + .'- 不能为空。'."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['title' => '标签值', 'description' => '标签值。限制：'."\n" + ."\n" + .'- 最多支持 128 个字符。'."\n" + .'- 不能以aliyun或acs:开头。'."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], ], 'required' => false, ], @@ -2662,21 +1937,21 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****', - ], - 'ElasticAcceleratedInstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-sz8t15a7gt7z7j7i****', - ], - 'ClientInstanceId' => [ - 'description' => 'ECI实例ID。', - 'type' => 'string', - 'example' => 'eci-2zeh03ygxlrzmfi6****', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => 'F23AEEC7-4D98-4657-A104-02692701****'], + 'NextToken' => ['description' => '下一个查询开始 Token。NextToken 为空说明为最后一个。', 'type' => 'string', 'example' => 'caeba0bbb2be03f84eb48b699f0a4885'], + 'TagResources' => [ + 'description' => '由资源及其标签组成的集合，包含了资源ID、资源类型和标签键值等信息。', + 'type' => 'array', + 'items' => [ + 'description' => '资源及标签信息对象。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['description' => '标签键。', 'type' => 'string', 'example' => 'TestKey'], + 'TagValue' => ['description' => '标签值。', 'type' => 'string', 'example' => 'TestValue'], + 'ResourceId' => ['description' => '资源ID。', 'type' => 'string', 'example' => 'eais-hzs4h26yyt5xkcke****'], + 'ResourceType' => ['description' => '资源类型。', 'type' => 'string', 'example' => 'instance'], + ], + ], ], ], ], @@ -2684,301 +1959,155 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'CheckTimeout', - 'errorMessage' => 'Check timed out.', - ], - [ - 'errorCode' => 'CustomTag.NumberExceed', - 'errorMessage' => 'The maximum number of system tags for each resource is 20.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', - ], - [ - 'errorCode' => 'InvalidInstanceType', - 'errorMessage' => 'The instance type is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The specified Tag.n.Key is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The specified Tag.n.Value is invalid.', - ], - [ - 'errorCode' => 'InvalidRegionId', - 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', - ], - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'Operation timed out.', - ], + ['errorCode' => 'MissingParameter.ResourceIdOrTag', 'errorMessage' => 'Either ResourceId or Tag must be specified.', 'description' => 'ResourceId和Tag至少有一个必填。'], + ['errorCode' => 'InvalidNextToken', 'errorMessage' => 'The NextToken is invalid.', 'description' => 'NextToken参数非法。'], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', 'description' => '传入的资源ID数量达到上限，最多支持50个。'], + ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'You must specify ResourceIds.', 'description' => 'ResourceId不能为空。'], + ['errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The request contains duplicated ResourceId.', 'description' => 'ResourceId不能重复。'], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => '传入的Tag数量达到上限，最多支持20个。'], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', 'description' => '传入的TagKey重复。'], + ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The ResourceId does not exist.', 'description' => 'ResourceId不存在。'], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The specified Tag.n.Key is invalid.', 'description' => 'TagKey为非法值。'], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified Tag.n.Value is invalid.', 'description' => 'TagValue为非法值。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4885\\",\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"eais-hzs4h26yyt5xkcke****\\",\\n \\"ResourceType\\": \\"instance\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '查询标签列表', + 'description' => '请求中至少指定以下任一参数，以确定查询对象。'."\n" + ."\n" + .'- ResourceId.N'."\n" + .'- Tag.N（Tag.N.Key与Tag.N.Value）'."\n" + ."\n" + .'同时指定Tag.N和ResourceId.N参数时，返回结果中仅包含同时满足这两个条件的 EAIS 资源。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'CallRamApiFailed', - 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', - ], - ], - 403 => [ - [ - 'errorCode' => 'CreateOrderFailed', - 'errorMessage' => 'Create order failed: %s.', - ], - [ - 'errorCode' => 'InDebt', - 'errorMessage' => 'The current user has an overdue payment. Please top up first.', - ], - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], - [ - 'errorCode' => 'NoResources', - 'errorMessage' => 'The current regional resources are insufficient.', - ], - [ - 'errorCode' => 'OperationDenied.KeyValueNotNull', - 'errorMessage' => 'The key value cannot be null.', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'eais:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"eci-2zeh03ygxlrzmfi6****\\"\\n}","type":"json"}]', - 'title' => '创建EAIS实例并绑定至客户端实例', ], - 'CreateEaiEcs' => [ - 'summary' => '创建一个弹性加速计算实例和一个客户端ECS实例，并将弹性加速计算实例绑定到ECS实例上。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartEaiJupyter' => [ + 'summary' => '启动一个部署了notebook的弹性加速计算实例。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'paid', - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '幂等参数，保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken只支持ASCII字符，且不能超过64个字符。更多信息，请参见[如何保证幂等性](~~25693~~)。', - 'type' => 'string', - 'required' => false, - 'example' => '123e4567-e89b-12d3-a456-426655440000', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EaisName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '弹性加速计算实例的名称。长度为2~128个英文或中文字符。必须以大小字母或中文开头，不能以http://或https://开头。可以包含数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'eais-test01', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'eais-hze3x2gv9wimdj0k****'], ], - [ - 'name' => 'Ecs', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'ECS实例参数对象。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ImageId' => [ - 'description' => 'ECS实例使用的镜像ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun_2_1903_x64_20G_alibase_20200324.vhd', - ], - 'InternetMaxBandwidthIn' => [ - 'description' => 'ECS实例公网入带宽最大值，单位为Mbit/s。取值范围：'."\n" - ."\n" - .'- 当所购公网出带宽小于等于10 Mbit/s时：1~10，默认为10。'."\n" - .'- 当所购公网出带宽大于10 Mbit/s时：1~`InternetMaxBandwidthOut`的取值，默认为`InternetMaxBandwidthOut`的取值。', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'InternetMaxBandwidthOut' => [ - 'description' => 'ECS实例公网出带宽最大值，单位为Mbit/s。取值范围：0~100。'."\n" - .'默认值：0。', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'Name' => [ - 'description' => 'ECS实例名称。长度为2~128个字符，必须以大小字母或中文开头，不能以http://或https://开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。', - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], - 'Password' => [ - 'description' => 'ECS实例密码。长度为8~30个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：`()~!@#$%^&*-_+=|{}[]:;\'<>,.?/`。', - 'type' => 'string', - 'required' => false, - 'example' => 'EcsV587!', - ], - 'SystemDiskCategory' => [ - 'description' => 'ECS实例系统盘的云盘种类。取值范围：'."\n" - ."\n" - .'- cloud_efficiency：高效云盘。'."\n" - .'- cloud_ssd：SSD云盘。'."\n" - .'- cloud_essd：ESSD云盘。'."\n" - .'- cloud：普通云盘。'."\n" - .'- cloud_auto：ESSD AutoPL云盘。'."\n" - ."\n" - .'已停售的实例规格且非I/O优化实例默认值为cloud，否则默认值为cloud_efficiency。', - 'type' => 'string', - 'required' => false, - 'example' => 'cloud_ssd', - ], - 'SystemDiskSize' => [ - 'description' => 'ECS实例系统盘大小，单位为GiB。取值范围：20~500。'."\n" - ."\n" - .'该参数的取值必须大于或者等于max{20, `ImageSize`}。'."\n" - ."\n" - .'默认值：max{40, `ImageId`对应的镜像大小}。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '40', - ], - 'Type' => [ - 'description' => 'ECS实例的资源规格。', - 'type' => 'string', - 'required' => false, - 'example' => 'ecs.g7.4xlarge', - ], - 'ZoneId' => [ - 'description' => 'ECS实例所属的可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen-e', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '04DEB304-2436-4CB9-BB63-468BCEA0****'], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息.'."\n" + .'> 只有RAM校验失败才会返回此字段。', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['description' => '需要鉴权的权限点。', 'type' => 'string', 'example' => 'eais:StartEaiJupyter'], + 'AuthPrincipalDisplayName' => ['description' => '授权主体显示名称。', 'type' => 'string', 'example' => '20560152949032****'], + 'AuthPrincipalOwnerId' => ['description' => '授权主体所有者ID。', 'type' => 'string', 'example' => '170718266783****'], + 'AuthPrincipalType' => [ + 'description' => '授权主体类型。', + 'type' => 'string', + 'enumValueTitles' => ['SubUser' => 'SubUser', 'AssumedRoleUser' => 'AssumedRoleUser'], + 'example' => 'SubUser', + ], + 'EncodedDiagnosticMessage' => ['description' => '编码诊断信息。', 'type' => 'string', 'example' => 'AQFmfh3BZn4dwUQyNzY4MDVELTgzQkUtNTBEOC04QjQyLTNGM0U1QUI5MjhBRA=='], + 'NoPermissionType' => ['description' => '无权限类型。', 'type' => 'string', 'example' => 'ExplicitDeny'], + 'PolicyType' => ['description' => '策略类型。', 'type' => 'string', 'example' => 'AccountLevelIdentityBasedPolicy'], + ], ], ], - 'required' => false, ], ], - [ - 'name' => 'EaisType', - 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例的规格。取值范围：'."\n" - ."\n" - .'- eais.ei-a6.4xlarge'."\n" - ."\n" - .'- eais.ei-a6.2xlarge'."\n" - ."\n" - .'- eais.ei-a6.xlarge'."\n" - ."\n" - .'- eais.ei-a6.large', - 'type' => 'string', - 'required' => true, - 'example' => 'eais.ei-a6.2xlarge', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The InstanceId is invalid.', 'description' => '无效的EAIS实例ID。'], ], + ], + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'eais::2019-06-24::DescribeEais', 'callbackInterval' => 10000, 'maxCallbackTimes' => 60], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"04DEB304-2436-4CB9-BB63-468BCEA0****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"eais:StartEaiJupyter\\",\\n \\"AuthPrincipalDisplayName\\": \\"20560152949032****\\",\\n \\"AuthPrincipalOwnerId\\": \\"170718266783****\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFmfh3BZn4dwUQyNzY4MDVELTgzQkUtNTBEOC04QjQyLTNGM0U1QUI5MjhBRA==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n }\\n}","type":"json"}]', + 'title' => '启动Jupyter EAIS实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEaiJupyter'], + ], + ], + 'ramActions' => [ [ - 'name' => 'VSwitchId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的虚拟交换机ID。'."\n" - ."\n" - .'> 交换机网段内IP的个数决定了该交换机最大可支持创建的EAIS实例个数，请务必提前规划好网段设置。', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-uf6h3rbwbm90urjwa****', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:StartEaiJupyter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], + ], + ], + 'StartEaisEi' => [ + 'summary' => '当您创建好EAIS实例并挂载到目标客户端实例后，您可以调用API StartEaisEi启动一个弹性加速计算实例EAIS来为您的客户端提供GPU资源，以实现GPU资源的灵活扩展。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SecurityGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的安全组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'sg-uf66jeqopgqa9hdn****', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmvpuy4a5****', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Tag', + 'name' => 'EiInstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '标签列表，最多包含20个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '标签信息。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。限制：'."\n" - ."\n" - .'- 不能为空。'."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => '标签值。限制：'."\n" - ."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'eais-hzu00xufs1c8j5nn****'], ], ], 'responses' => [ @@ -2988,107 +2117,44 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****', - ], - 'ElasticAcceleratedInstanceId' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'example' => 'eais-sz8t15a7gt7z7j7i****', - ], - 'ClientInstanceId' => [ - 'description' => 'ECS实例ID。', - 'type' => 'string', - 'example' => 'i-bp1hjrvleawl4ogb****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F23AEEC7-4D98-4657-A104-02692701****'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'CheckTimeout', - 'errorMessage' => 'Check timed out.', - ], - [ - 'errorCode' => 'CustomTag.NumberExceed', - 'errorMessage' => 'The maximum number of system tags for each resource is 20.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', - ], - [ - 'errorCode' => 'InvalidInstanceType', - 'errorMessage' => 'The instance type is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The specified Tag.n.Key is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The specified Tag.n.Value is invalid.', - ], - [ - 'errorCode' => 'InvalidRegionId', - 'errorMessage' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', - ], - [ - 'errorCode' => 'Timeout', - 'errorMessage' => 'Operation timed out.', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], ], - [ - [ - 'errorCode' => 'CallRamApiFailed', - 'errorMessage' => 'Failed to call the Alibaba Cloud RAM service.', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartEaisEiResponse>\\n <RequestId>F23AEEC7-4D98-4657-A104-02692701****</RequestId>\\n</StartEaisEiResponse>","errorExample":""}]', + 'title' => '启动EAIS实例', + 'description' => '**请确保在使用该接口前，已充分了解EAIS产品的[计费说明](~~191197~~)。**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEaisEi'], ], - 403 => [ - [ - 'errorCode' => 'CreateOrderFailed', - 'errorMessage' => 'Create order failed: %s.', - ], - [ - 'errorCode' => 'InDebt', - 'errorMessage' => 'The current user has an overdue payment. Please top up first.', - ], - [ - 'errorCode' => 'NoPermission', - 'errorMessage' => 'You are not authorized to perform this operation. %s', - ], - [ - 'errorCode' => 'NoResources', - 'errorMessage' => 'The current regional resources are insufficient.', - ], - [ - 'errorCode' => 'OperationDenied.KeyValueNotNull', - 'errorMessage' => 'The key value cannot be null.', + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:StartEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"i-bp1hjrvleawl4ogb****\\"\\n}","type":"json"}]', - 'title' => '创建EAIS实例并绑定至客户端实例', ], - 'DeleteEaiAll' => [ - 'summary' => '释放一个弹性加速计算实例和与其绑定的客户端实例（即ECS实例或ECI实例）。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopEaiJupyter' => [ + 'summary' => '停止一个部署了notebook的弹性加速计算实例。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3096,80 +2162,85 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'high', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '实例所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], - ], - [ - 'name' => 'ElasticAcceleratedInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'EAIS实例ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'eais-hza1ahi0uuw0re33****', - ], + 'schema' => ['description' => '实例所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ClientInstanceId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '与EAIS实例绑定的ECS或ECI实例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'i-bp1fvhi60e1zizsp****', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'eais-hze3x2gv9wimdj0k****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'AD4EA714-A35B-4710-BF92-8275BCDD****', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****'], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息.'."\n" + .'> 只有RAM校验失败才会返回此字段。', + 'type' => 'object', + 'properties' => [ + 'AuthAction' => ['description' => '需要鉴权的权限点。', 'type' => 'string', 'example' => 'eais:StopEaiJupyter'], + 'AuthPrincipalDisplayName' => ['description' => '授权主体显示名称。', 'type' => 'string', 'example' => '20560152949032****'], + 'AuthPrincipalOwnerId' => ['description' => '授权主体所有者ID。', 'type' => 'string', 'example' => '170718266783****'], + 'AuthPrincipalType' => [ + 'description' => '授权主体类型。', + 'type' => 'string', + 'enumValueTitles' => ['SubUser' => 'SubUser', 'AssumedRoleUser' => 'AssumedRoleUser'], + 'example' => 'SubUser', + ], + 'EncodedDiagnosticMessage' => ['description' => '编码诊断信息。', 'type' => 'string', 'example' => 'AQFmj0FOZo9BTjMyQTFDRkIzLUE5MTItNUIwNC1BQzkxLTcyMUFFQTUyQjhGQQ=='], + 'NoPermissionType' => ['description' => '无权限类型。', 'type' => 'string', 'example' => 'ExplicitDeny'], + 'PolicyType' => ['description' => '策略类型。', 'type' => 'string', 'example' => 'AccountLevelIdentityBasedPolicy'], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The InstanceId is invalid.', 'description' => '无效的EAIS实例ID。'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AD4EA714-A35B-4710-BF92-8275BCDD****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEaiAllResponse>\\n <RequestId>AD4EA714-A35B-4710-BF92-8275BCDD****</RequestId>\\n</DeleteEaiAllResponse>","errorExample":""}]', - 'title' => '释放EAIS实例及绑定的客户端实例', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ChangeResourceGroup' => [ - 'summary' => '修改弹性加速计算实例所在的资源组。', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'eais::2019-06-24::DescribeEais', 'callbackInterval' => 3000, 'maxCallbackTimes' => 5], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"AccessDeniedDetail\\": {\\n \\"AuthAction\\": \\"eais:StopEaiJupyter\\",\\n \\"AuthPrincipalDisplayName\\": \\"20560152949032****\\",\\n \\"AuthPrincipalOwnerId\\": \\"170718266783****\\",\\n \\"AuthPrincipalType\\": \\"SubUser\\",\\n \\"EncodedDiagnosticMessage\\": \\"AQFmj0FOZo9BTjMyQTFDRkIzLUE5MTItNUIwNC1BQzkxLTcyMUFFQTUyQjhGQQ==\\",\\n \\"NoPermissionType\\": \\"ExplicitDeny\\",\\n \\"PolicyType\\": \\"AccountLevelIdentityBasedPolicy\\"\\n }\\n}","type":"json"}]', + 'title' => '停止Jupyter EAIS实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopEaiJupyter'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:StopEaiJupyter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], + ], + 'StopEaisEi' => [ + 'summary' => '如果您不再需要使用弹性加速计算实例为您的客户端实例提供GPU资源时，可以调用API StopEaisEi停止该EAIS实例，从而避免资源浪费，节约成本。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3177,46 +2248,17 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ResourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '资源Id', - 'description' => '资源ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'eais-hzs4h26yyt5xkcke****', - ], - ], - [ - 'name' => 'ResourceRegionId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域Id', - 'description' => '资源所属的地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'EiInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '目标资源组', - 'description' => '目标资源组ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-acfmvpuy4a5****', - ], + 'schema' => ['description' => 'EAIS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'eais-hzu00xufs1c8j5nn****'], ], ], 'responses' => [ @@ -3226,63 +2268,43 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC8****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F23AEEC7-4D98-4657-A104-02692701****'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NoPermission.ChangeResourceGroup', - 'errorMessage' => 'You are not authorized to change resourcegroup', - ], - [ - 'errorCode' => 'MissingParameter.ResourceRegionId', - 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', - ], - [ - 'errorCode' => 'MissingParameter.ResourceId', - 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', - ], - [ - 'errorCode' => 'MissingParameter.ResourceGroupId', - 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', - ], - [ - 'errorCode' => 'InvalidResourceGroup', - 'errorMessage' => 'The specified ResourceGroupId is invalid', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred while processing your request', - ], - [ - 'errorCode' => 'ResourceNotFound', - 'errorMessage' => ' The specified resource is not found', - ], + 403 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this operation. %s', 'description' => '您没有权限执行此操作。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopEaisEiResponse>\\n <RequestId>F23AEEC7-4D98-4657-A104-02692701****</RequestId>\\n</StopEaisEiResponse>","errorExample":""}]', + 'title' => '停止EAIS实例', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopEaisEi'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:StopEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\"\\n}","errorExample":""},{"type":"xml","example":"<ChangeResourceGroupResponse>\\n <RequestId>C3BCB7DA-BEB6-4982-A765-6EA61EC8****</RequestId>\\n</ChangeResourceGroupResponse>","errorExample":""}]', - 'title' => '改变资源组', ], 'TagResources' => [ 'summary' => '为指定的EAIS资源列表统一创建并绑定标签。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3290,34 +2312,17 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '资源所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '资源所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型定义。目前取值仅支持`instance`。', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['title' => '资源类型', 'description' => '资源类型定义。目前取值仅支持`instance`。', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ 'name' => 'ResourceId', @@ -3327,12 +2332,7 @@ 'title' => '资源ID,最多 50个子项', 'description' => '资源ID，最多 50个子项。', 'type' => 'array', - 'items' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'eais-hzgv8uxixkho5b3w****', - ], + 'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'eais-hzgv8uxixkho5b3w****'], 'required' => true, 'maxItems' => 51, ], @@ -3349,34 +2349,22 @@ 'description' => '标签对象。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键。限制：'."\n" - ."\n" - .'- 不能为空。'."\n" - ."\n" - .'- 最多支持128个字符。'."\n" - ."\n" - .'- 不能以aliyun或acs:开头。'."\n" - ."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值。限制：'."\n" - ."\n" - .'- 最多支持128个字符。'."\n" - ."\n" - .'- 不能以aliyun或acs:开头。'."\n" - ."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['title' => '标签键', 'description' => '标签键。限制：'."\n" + ."\n" + .'- 不能为空。'."\n" + ."\n" + .'- 最多支持128个字符。'."\n" + ."\n" + .'- 不能以aliyun或acs:开头。'."\n" + ."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['title' => '标签值', 'description' => '标签值。限制：'."\n" + ."\n" + .'- 最多支持128个字符。'."\n" + ."\n" + .'- 不能以aliyun或acs:开头。'."\n" + ."\n" + .'- 不能包含http://和https://。', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], ], 'required' => false, ], @@ -3392,77 +2380,54 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。'."\n", - 'type' => 'string', - 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n", 'type' => 'string', 'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', - ], - [ - 'errorCode' => 'MissingParameter.ResourceIds', - 'errorMessage' => 'You must specify ResourceIds.', - ], - [ - 'errorCode' => 'Duplicate.ResourceId', - 'errorMessage' => 'The request contains duplicated ResourceId.', - ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', - ], - [ - 'errorCode' => 'InvalidResourceId.NotFound', - 'errorMessage' => 'The ResourceId does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The specified Tag.n.Key is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The specified Tag.n.Value is invalid.', - ], - [ - 'errorCode' => 'CustomTag.NumberExceed', - 'errorMessage' => 'The maximum number of system tags for each resource is 20.', - ], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', 'description' => '传入的资源ID数量达到上限，最多支持50个。'], + ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'You must specify ResourceIds.', 'description' => 'ResourceId不能为空。'], + ['errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The request contains duplicated ResourceId.', 'description' => 'ResourceId不能重复。'], + ['errorCode' => 'NumberExceed.Tags', 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'description' => '传入的Tag数量达到上限，最多支持20个。'], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', 'description' => '传入的TagKey重复。'], + ['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The ResourceId does not exist.', 'description' => 'ResourceId不存在。'], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The specified Tag.n.Key is invalid.', 'description' => 'TagKey为非法值。'], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified Tag.n.Value is invalid.', 'description' => 'TagValue为非法值。'], + ['errorCode' => 'CustomTag.NumberExceed', 'errorMessage' => 'The maximum number of system tags for each resource is 20.', 'description' => '每个资源最多允许绑定20个用户标签。'], ], 403 => [ - [ - 'errorCode' => 'OperationDenied.KeyValueNotNull', - 'errorMessage' => 'The key value cannot be null.', - ], + ['errorCode' => 'OperationDenied.KeyValueNotNull', 'errorMessage' => 'The key value cannot be null.', 'description' => '标签值不能为空。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"<TagResourcesResponse>\\n <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>\\n</TagResourcesResponse>","errorExample":""}]', 'title' => '创建并绑定标签', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'eais:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], ], 'UntagResources' => [ 'summary' => '为指定的EAIS资源列表统一解绑标签。解绑后，如果该标签没有绑定其他任何资源，会被自动删除。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3470,52 +2435,29 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '资源所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '资源所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型定义。目前取值仅支持`instance`。', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', - ], + 'schema' => ['title' => '资源类型', 'description' => '资源类型定义。目前取值仅支持`instance`。', 'type' => 'string', 'required' => true, 'example' => 'instance'], ], [ 'name' => 'All', 'in' => 'query', - 'schema' => [ - 'title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', - 'description' => '是否解绑资源上的所有标签。'."\n" - ."\n" - .'当请求中未设置 TagKey.N 时，该参数才有效。'."\n" - ."\n" - .'取值范围：'."\n" - ."\n" - .'- true：解绑目标资源的所有标签。没有标签的资源则不处理，直接返回成功。'."\n" - .'- false（默认值）：不执行标签操作，直接返回成功。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '是否全部删除，只针对TagKey.N为空时有效。 取值范围： true false True False 默认是 false', 'description' => '是否解绑资源上的所有标签。'."\n" + ."\n" + .'当请求中未设置 TagKey.N 时，该参数才有效。'."\n" + ."\n" + .'取值范围：'."\n" + ."\n" + .'- true：解绑目标资源的所有标签。没有标签的资源则不处理，直接返回成功。'."\n" + .'- false（默认值）：不执行标签操作，直接返回成功。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'ResourceId', @@ -3525,12 +2467,7 @@ 'title' => '资源ID，最多50个子项', 'description' => '资源ID，最多 50个子项。', 'type' => 'array', - 'items' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'eais-hzs4h26yyt5xkcke****', - ], + 'items' => ['description' => '资源ID。', 'type' => 'string', 'required' => false, 'example' => 'eais-hzs4h26yyt5xkcke****'], 'required' => true, 'maxItems' => 51, ], @@ -3543,12 +2480,7 @@ 'title' => '标签键，最多20个子项', 'description' => '标签键列表，最多包含20个子项。', 'type' => 'array', - 'items' => [ - 'description' => '资源的标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], + 'items' => ['description' => '资源的标签键。', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], 'required' => false, 'maxItems' => 21, ], @@ -3561,296 +2493,521 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求 ID。', - 'type' => 'string', - 'example' => '1E23D585-BBD8-436F-9615-54CACD67****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求 ID。', 'type' => 'string', 'example' => '1E23D585-BBD8-436F-9615-54CACD67****'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', - ], - [ - 'errorCode' => 'Duplicate.ResourceId', - 'errorMessage' => 'The request contains duplicated ResourceId.', - ], - [ - 'errorCode' => 'MissingParameter.ResourceIds', - 'errorMessage' => 'You must specify ResourceIds.', - ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', - ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The specified Tag.n.Key is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The specified Tag.n.Value is invalid.', - ], + ['errorCode' => 'NumberExceed.ResourceIds', 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', 'description' => '传入的资源ID数量达到上限，最多支持50个。'], + ['errorCode' => 'Duplicate.ResourceId', 'errorMessage' => 'The request contains duplicated ResourceId.', 'description' => 'ResourceId不能重复。'], + ['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'You must specify ResourceIds.', 'description' => 'ResourceId不能为空。'], + ['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', 'description' => '传入的TagKey重复。'], + ['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The specified Tag.n.Key is invalid.', 'description' => 'TagKey为非法值。'], + ['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified Tag.n.Value is invalid.', 'description' => 'TagValue为非法值。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E23D585-BBD8-436F-9615-54CACD67****\\"\\n}","type":"json"}]', 'title' => '解绑并删除标签', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'eais:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + ], ], - 'ListTagResources' => [ - 'summary' => '查询一个或多个EAIS资源已经绑定的标签列表。', - 'methods' => [ - 'post', - 'get', + ], + 'endpoints' => [ + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eais.cn-beijing.aliyuncs.com', 'endpoint' => 'eais.cn-beijing.aliyuncs.com', 'vpc' => 'eais-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eais.cn-chengdu.aliyuncs.com', 'endpoint' => 'eais.cn-chengdu.aliyuncs.com', 'vpc' => 'eais-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eais.cn-hangzhou.aliyuncs.com', 'endpoint' => 'eais.cn-hangzhou.aliyuncs.com', 'vpc' => 'eais-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eais.cn-shanghai.aliyuncs.com', 'endpoint' => 'eais.cn-shanghai.aliyuncs.com', 'vpc' => 'eais-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'eais.cn-shenzhen.aliyuncs.com', 'endpoint' => 'eais.cn-shenzhen.aliyuncs.com', 'vpc' => 'eais-vpc.cn-shenzhen.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'ApiUnavailable', 'message' => 'The API is temporarily unavailable.', 'http_code' => 403, 'description' => '该API暂不可用。'], + ['code' => 'CallFailed', 'message' => 'API call failed.', 'http_code' => 400, 'description' => '函数调用失败。'], + ['code' => 'CallRamApiFailed', 'message' => 'Failed to call the Alibaba Cloud RAM service.', 'http_code' => 401, 'description' => '调用阿里云RAM失败。'], + ['code' => 'CheckTimeout', 'message' => 'Check timed out.', 'http_code' => 400, 'description' => '检查超时。'], + ['code' => 'CreateOrderFailed', 'message' => 'Create order failed: %s.', 'http_code' => 403, 'description' => '创建订单失败，请尝试重新创建。'], + ['code' => 'CustomTag.NumberExceed', 'message' => 'The maximum number of system tags for each resource is 20.', 'http_code' => 400, 'description' => '每个资源最多允许绑定20个用户标签。'], + ['code' => 'Duplicate.ResourceId', 'message' => 'The request contains duplicated ResourceId.', 'http_code' => 400, 'description' => 'ResourceId不能重复。'], + ['code' => 'Duplicate.TagKey', 'message' => 'The Tag.N.Key contains a duplicated key.', 'http_code' => 400, 'description' => '传入的TagKey重复。'], + ['code' => 'InconsistentSignature', 'message' => 'The signatures are inconsistent.', 'http_code' => 400, 'description' => '签名不一致。'], + ['code' => 'InDebt', 'message' => 'The current user has an overdue payment. Please top up first.', 'http_code' => 403, 'description' => '当前用户欠费中，请充值后再操作。'], + ['code' => 'InvalidClientInstanceChargeType', 'message' => 'The client instance billing type is invalid. Currently, only pay-as-you-go client instances can be bound.', 'http_code' => 400, 'description' => '无效的客户端实例付费类型, 目前仅支持绑定按量付费的客户端实例。'], + ['code' => 'InvalidClientInstanceId.Forbidden', 'message' => 'Please make sure the ClientInstanceId exists and belongs to you.', 'http_code' => 404, 'description' => '无效的客户端实例ID, 请确定该实例存在并归属于您。'], + ['code' => 'InvalidClientInstanceId.NotBound', 'message' => 'The client instance is not bound.', 'http_code' => 400, 'description' => '客户端实例未绑定。'], + ['code' => 'InvalidClientInstanceId.NotFound', 'message' => 'The client instance does not exist or is not bound.', 'http_code' => 400, 'description' => '客户端实例不存在或未绑定。'], + ['code' => 'InvalidClientInstanceId.TypeError', 'message' => 'The client instance ID is invalid. The current instance only supports binding ECS instances.', 'http_code' => 400, 'description' => '无效的客户端实例ID, 当前实例只支持绑定ECS实例。'], + ['code' => 'InvalidClientInstanceId.TypeError', 'message' => 'The client instance ID is invalid. Currently, only ECS or ECI instances can be bound.', 'http_code' => 400, 'description' => '无效的客户端实例ID, 目前只支持绑定ECS或ECI实例。'], + ['code' => 'InvalidClientInstanceId.VpcIdError', 'message' => 'The client instance is invalid. Please make sure that the VpcId of the client instance and the VpcId of the EAIS instance are the same.', 'http_code' => 400, 'description' => '无效的客户端实例，请确保客户端实例与EAIS实例的专有网络VpcId一致。'], + ['code' => 'InvalidClientInstanceId.VSwitchIdError', 'message' => 'The client instance is invalid. Please make sure that the VSwitchId of the client instance and the VSwitchId of the EAIS instance are the same.', 'http_code' => 400, 'description' => '无效的客户端实例，请确保客户端实例与EAIS实例的交换机VSwitchId一致。'], + ['code' => 'InvalidEaiInstance', 'message' => 'EAIS instance is not bound to the client instance.', 'http_code' => 400, 'description' => 'EAIS实例未绑定客户端实例。'], + ['code' => 'InvalidEaiStatus', 'message' => 'The current state of the EAIS instance does not support the operation.', 'http_code' => 400, 'description' => '当前EAIS实例状态下不支持此操作。'], + ['code' => 'InvalidElasticAcceleratedInstanceId.Forbidden', 'message' => 'The EAIS instance does not belong to the current user.', 'http_code' => 400, 'description' => '该EAIS实例不属于当前用户。'], + ['code' => 'InvalidInstanceId', 'message' => 'The InstanceId is invalid.', 'http_code' => 400, 'description' => '无效的EAIS实例ID。'], + ['code' => 'InvalidInstanceType', 'message' => 'The instance type is invalid.', 'http_code' => 400, 'description' => '无效的实例类型。'], + ['code' => 'InvalidNextToken', 'message' => 'The NextToken is invalid.', 'http_code' => 400, 'description' => 'NextToken参数非法。'], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => '指定的参数无效。'], + ['code' => 'InvalidParameter.InstanceId.NotFound', 'message' => 'The specified parameter InstanceId cannot be found.', 'http_code' => 404, 'description' => '指定的参数InstanceId找不到。'], + ['code' => 'InvalidParameter.TagKey', 'message' => 'The specified Tag.n.Key is invalid.', 'http_code' => 400, 'description' => 'TagKey为非法值。'], + ['code' => 'InvalidParameter.TagValue', 'message' => 'The specified Tag.n.Value is invalid.', 'http_code' => 400, 'description' => 'TagValue为非法值。'], + ['code' => 'InvalidRegionId', 'message' => 'The service does not support the region. You can call the DescribeRegions API to view the supported regions.', 'http_code' => 400, 'description' => '无效的地域，您可以调用DescribeRegions API查看服务支持的地域。'], + ['code' => 'InvalidResourceId.NotFound', 'message' => 'The ResourceId does not exist.', 'http_code' => 400, 'description' => 'ResourceId不存在。'], + ['code' => 'InvalidZonId', 'message' => 'The availability zone of the client instance is invalid.', 'http_code' => 400, 'description' => '客户端实例所在的可用区无效。'], + ['code' => 'MissingParameter.ResourceIdOrTag', 'message' => 'Either ResourceId or Tag must be specified.', 'http_code' => 400, 'description' => 'ResourceId和Tag至少有一个必填。'], + ['code' => 'MissingParameter.ResourceIds', 'message' => 'You must specify ResourceIds.', 'http_code' => 400, 'description' => 'ResourceId不能为空。'], + ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this operation. %s', 'http_code' => 403, 'description' => '您没有权限执行此操作。'], + ['code' => 'NoPermission', 'message' => 'You do not have permission to create the service linked role AliyunServiceRoleForEais.', 'http_code' => 403, 'description' => '您没有权限创建服务关联角色AliyunServiceRoleForEais。 '], + ['code' => 'NoResources', 'message' => 'The current regional resources are insufficient.', 'http_code' => 403, 'description' => '当前地域资源不足。'], + ['code' => 'NumberExceed.ResourceIds', 'message' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', 'http_code' => 400, 'description' => '传入的资源ID数量达到上限，最多支持50个。'], + ['code' => 'NumberExceed.Tags', 'message' => 'The maximum number of Tags is exceeded. The maximum is 20.', 'http_code' => 400, 'description' => '传入的Tag数量达到上限，最多支持20个。'], + ['code' => 'OperationDenied.KeyValueNotNull', 'message' => 'The key value cannot be null.', 'http_code' => 403, 'description' => '标签值不能为空。'], + ['code' => 'RepeatBinding', 'message' => 'The EAIS instance has been bound to the client instance and cannot be bound repeatedly.', 'http_code' => 400, 'description' => '该EAIS实例已绑定客户端实例，不能重复绑定。'], + ['code' => 'RepeatedlyBound', 'message' => 'The client instance has been bound by the EAIS instance and cannot be bound repeatedly.', 'http_code' => 400, 'description' => '该客户端实例已经被EAIS实例绑定，不能重复绑定。'], + ['code' => 'SYSTEM.SALE_VALIDATE_FAILED', 'message' => 'The sales expression validation system is incorrect.', 'http_code' => 500, 'description' => '销售表达式校验系统错误。'], + ['code' => 'Timeout', 'message' => 'Operation timed out.', 'http_code' => 400, 'description' => '操作超时。'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeEais'], ], - 'schemes' => [ - 'https', + 'createdAt' => '2023-09-15T07:10:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'DescribeEais'], ], - 'security' => [ - [ - 'AK' => [], + 'createdAt' => '2023-09-01T09:20:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'GetInstanceMetrics'], + ], + 'createdAt' => '2023-08-28T07:31:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'CreateEai'], + ['description' => '错误码发生变更', 'api' => 'CreateEaiEci'], + ['description' => '错误码发生变更', 'api' => 'CreateEaiEcs'], + ['description' => '错误码发生变更', 'api' => 'CreateEaiJupyter'], + ['description' => '错误码发生变更', 'api' => 'CreateEaisEi'], + ['description' => '错误码发生变更', 'api' => 'DeleteEai'], + ['description' => '错误码发生变更', 'api' => 'DescribeRegions'], + ], + 'createdAt' => '2023-08-23T06:00:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateEaiJupyter'], + ], + 'createdAt' => '2023-05-23T02:28:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateEaiEci'], + ['description' => '请求参数发生变更', 'api' => 'CreateEaiEcs'], + ['description' => '错误码发生变更', 'api' => 'DescribeEais'], + ['description' => '请求参数发生变更', 'api' => 'GetInstanceMetrics'], + ], + 'createdAt' => '2023-04-27T01:42:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateEai'], + ], + 'createdAt' => '2023-04-10T09:04:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => '错误码发生变更', 'api' => 'AttachEai'], + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'CreateEai'], + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'CreateEaiAll'], + ['description' => '错误码发生变更', 'api' => 'DeleteEai'], + ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'DescribeEais'], + ['description' => '错误码发生变更', 'api' => 'DetachEai'], + ], + 'createdAt' => '2023-01-03T06:44:47.000Z', + 'description' => 'eais接入资源组相关api配置更新', + ], + [ + 'apis' => [ + ['description' => '响应参数发生变更', 'api' => 'DescribeEais'], + ], + 'createdAt' => '2022-11-22T07:58:26.000Z', + 'description' => '新增GetInstanceMetrics api', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更', 'api' => 'CreateEaiJupyter'], + ], + 'createdAt' => '2022-10-25T01:43:04.000Z', + 'description' => 'CreateEaiJupyter OpenAPI中新增可选入参EnvironmentVar', + ], + [ + 'apis' => [ + ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'DeleteEaiAll'], + ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'DescribeEais'], + ], + 'createdAt' => '2022-10-10T06:00:58.000Z', + 'description' => 'eais notebook创建OpenAPI发布', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEaisEi'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEaiEcs'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopEaiJupyter'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachEai'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEai'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEais'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEaiJupyter'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEai'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEaiJupyter'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEaiAll'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEaisEi'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceMetrics'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeRegions'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopEaisEi'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachEai'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachEaisEi'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEaiEci'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEaisEi'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DetachEaisEi'], + ], + ], + 'ram' => [ + 'productCode' => 'EAIS', + 'productName' => '弹性加速计算实例', + 'ramCodes' => ['eais'], + 'ramLevel' => '资源级', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'CreateEaiJupyter', + 'description' => '创建Jupyter EAIS实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEaiJupyter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + [ + 'apiName' => 'GetInstanceMetrics', + 'description' => '查询EAIS Jupyter实例监控数据', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'eais:GetInstanceMetrics', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '资源所属的地域ID。您可以调用[DescribeRegions](~~364379~~)查看最新的阿里云地域列表。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'StartEaisEi', + 'description' => '启动EAIS实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:StartEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'title' => '下一个查询开始Token', - 'description' => '下一个查询开始Token。', - 'type' => 'string', - 'required' => false, - 'example' => 'caeba0bbb2be03f84eb48b699f0a4884', + ], + [ + 'apiName' => 'DeleteEaisEi', + 'description' => '释放EAIS实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'eais:DeleteEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型定义。目前取值仅支持`instance`。', - 'type' => 'string', - 'required' => true, - 'example' => 'instance', + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '改变资源组', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'eais:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '资源ID,最多 50个子项', - 'description' => '资源ID，最多 50个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'eais-hzs4h26yyt5xkcke****', - ], - 'required' => false, - 'maxItems' => 51, + ], + [ + 'apiName' => 'DeleteEaiAll', + 'description' => '释放EAIS实例及绑定的客户端实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'eais:DeleteEaiAll', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'product' => 'EAIS', 'resourceType' => 'ContainerGroup', 'arn' => 'acs:eci:{#regionId}:{#accountId}:containergroup/{#ContainerGroupId}'], ], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签列表，最多包含20个子项', - 'description' => '标签列表，最多包含20个子项。', - 'type' => 'array', - 'items' => [ - 'description' => '标签对象。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => '标签键。限制：'."\n" - ."\n" - .'- 不能为空。'."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '标签值。限制：'."\n" - ."\n" - .'- 最多支持 128 个字符。'."\n" - .'- 不能以aliyun或acs:开头。'."\n" - .'- 不能包含http://和https://。', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, + ], + [ + 'apiName' => 'CreateEaiEci', + 'description' => '创建EAIS实例并绑定至客户端实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEaiEci', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], ], ], ], - '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' => 'F23AEEC7-4D98-4657-A104-02692701****', - ], - 'NextToken' => [ - 'description' => '下一个查询开始 Token。NextToken 为空说明为最后一个。', - 'type' => 'string', - 'example' => 'caeba0bbb2be03f84eb48b699f0a4885', - ], - 'TagResources' => [ - 'description' => '由资源及其标签组成的集合，包含了资源ID、资源类型和标签键值等信息。', - 'type' => 'array', - 'items' => [ - 'description' => '资源及标签信息对象。', - 'type' => 'object', - 'properties' => [ - 'TagKey' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'TestKey', - ], - 'TagValue' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'TestValue', - ], - 'ResourceId' => [ - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'eais-hzs4h26yyt5xkcke****', - ], - 'ResourceType' => [ - 'description' => '资源类型。', - 'type' => 'string', - 'example' => 'instance', - ], - ], - ], - ], - ], + [ + 'apiName' => 'UntagResources', + 'description' => '解绑并删除标签', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'eais:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'MissingParameter.ResourceIdOrTag', - 'errorMessage' => 'Either ResourceId or Tag must be specified.', + [ + 'apiName' => 'StartEaiJupyter', + 'description' => '启动Jupyter EAIS实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:StartEaiJupyter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], - [ - 'errorCode' => 'InvalidNextToken', - 'errorMessage' => 'The NextToken is invalid.', + ], + ], + [ + 'apiName' => 'CreateEaiEcs', + 'description' => '创建EAIS实例并绑定至客户端实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEaiEcs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], ], - [ - 'errorCode' => 'NumberExceed.ResourceIds', - 'errorMessage' => 'The maximum number of ResourceIds is exceeded. The maximum is 50.', + ], + ], + [ + 'apiName' => 'AttachEaisEi', + 'description' => '绑定EAIS实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:AttachEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], - [ - 'errorCode' => 'MissingParameter.ResourceIds', - 'errorMessage' => 'You must specify ResourceIds.', + ], + ], + [ + 'apiName' => 'CreateEaisEi', + 'description' => '（推荐）创建EAIS实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], ], - [ - 'errorCode' => 'Duplicate.ResourceId', - 'errorMessage' => 'The request contains duplicated ResourceId.', + ], + ], + [ + 'apiName' => 'DetachEaisEi', + 'description' => '解绑EAIS实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:DetachEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], - [ - 'errorCode' => 'NumberExceed.Tags', - 'errorMessage' => 'The maximum number of Tags is exceeded. The maximum is 20.', + ], + ], + [ + 'apiName' => 'DetachEai', + 'description' => '解绑EAIS实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:DetachEai', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], - [ - 'errorCode' => 'Duplicate.TagKey', - 'errorMessage' => 'The Tag.N.Key contains a duplicated key.', + ], + ], + [ + 'apiName' => 'CreateEai', + 'description' => '创建EAIS实例', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'eais:CreateEai', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ], + ], + ], + [ + 'apiName' => 'DeleteEai', + 'description' => '释放EAIS实例', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'eais:DeleteEai', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'StopEaiJupyter', + 'description' => '停止Jupyter EAIS实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:StopEaiJupyter', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeEais', + 'description' => '查询EAIS实例列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'eais:DescribeEais', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], ], - [ - 'errorCode' => 'InvalidResourceId.NotFound', - 'errorMessage' => 'The ResourceId does not exist.', + ], + ], + [ + 'apiName' => 'StopEaisEi', + 'description' => '停止EAIS实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:StopEaisEi', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], - [ - 'errorCode' => 'InvalidParameter.TagKey', - 'errorMessage' => 'The specified Tag.n.Key is invalid.', + ], + ], + [ + 'apiName' => 'TagResources', + 'description' => '创建并绑定标签', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'eais:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], - [ - 'errorCode' => 'InvalidParameter.TagValue', - 'errorMessage' => 'The specified Tag.n.Value is invalid.', + ], + ], + [ + 'apiName' => 'ListTagResources', + 'description' => '查询标签列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'eais:ListTagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'AttachEai', + 'description' => '绑定EAIS实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'eais:AttachEai', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'product' => 'EAIS', 'resourceType' => 'Instance', 'arn' => 'acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'product' => 'EAIS', 'resourceType' => 'ContainerGroup', 'arn' => 'acs:eci:{#regionId}:{#accountId}:containergroup/{#ContainerGroupId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\",\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a4885\\",\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"TestKey\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"eais-hzs4h26yyt5xkcke****\\",\\n \\"ResourceType\\": \\"instance\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查询标签列表', - 'description' => '请求中至少指定以下任一参数，以确定查询对象。'."\n" - ."\n" - .'- ResourceId.N'."\n" - .'- Tag.N（Tag.N.Key与Tag.N.Value）'."\n" - ."\n" - .'同时指定Tag.N和ResourceId.N参数时，返回结果中仅包含同时满足这两个条件的 EAIS 资源。', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'eais.cn-beijing.aliyuncs.com', ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'eais.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'eais.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'eais.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'eais.cn-chengdu.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/*'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:eais:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'resourceType' => 'Instance', 'arn' => 'acs:ecs:{#regionId}:{#accountId}:instance/{#InstanceId}'], + ['validationType' => 'conditional', 'resourceType' => 'ContainerGroup', 'arn' => 'acs:eci:{#regionId}:{#accountId}:containergroup/{#ContainerGroupId}'], ], ], ]; |