'1.0',
'info' => [
'style' => 'RPC',
'product' => 'eais',
'version' => '2019-06-24',
],
'directories' => [
[
'id' => 186392,
'title' => 'Geography',
'type' => 'directory',
'children' => [
'DescribeRegions',
],
],
[
'id' => 186394,
'title' => 'Examples',
'type' => 'directory',
'children' => [
'CreateEaisEi',
'AttachEaisEi',
'StartEaisEi',
'StopEaisEi',
'DetachEaisEi',
'DeleteEaisEi',
'DescribeEais',
'CreateEaiJupyter',
'StopEaiJupyter',
'StartEaiJupyter',
'GetInstanceMetrics',
'CreateEai',
'AttachEai',
'DetachEai',
'DeleteEai',
'CreateEaiEci',
'CreateEaiEcs',
'DeleteEaiAll',
'ChangeResourceGroup',
],
],
[
'id' => 194869,
'title' => 'Label',
'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' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF1840',
'type' => 'string',
],
'Regions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Region' => [
'description' => '',
'type' => 'array',
'items' => [
'properties' => [
'RegionEndpoint' => [
'description' => '',
'example' => 'eais.cn-shenzhen.aliyuncs.com',
'type' => 'string',
],
'LocalName' => [
'description' => '',
'example' => '',
'type' => 'string',
],
'RegionId' => [
'description' => '',
'example' => 'cn-shenzhen',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
],
],
'type' => 'object',
],
],
],
'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":"\\n F5FEB9AA-C108-577C-AB3D-D13524AF****\\n \\n eais.cn-shenzhen.aliyuncs.com\\n 华南1(深圳)\\n cn-shenzhen\\n \\n","errorExample":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'DescribeRegions',
],
'CreateEaisEi' => [
'summary' => '创建一个弹性加速计算实例',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'eais.ei-a6.2xlarge',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'vsw-bp17wmd1wb6fwlimk****',
],
],
[
'name' => 'SecurityGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'sg-bp16jgp51ttnkbdr****',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'test_ei',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'rg-acfmvpuy4a5****',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => '123e4567-e89b-12d3-a456-426655440000',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'type' => 'string',
],
'Value' => [
'type' => 'string',
],
],
],
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****',
],
'EiInstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'eais-hzu00xufs1c8j5nn****',
],
],
],
],
],
'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.',
],
],
],
'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' => 'CreateEaisEi',
],
'AttachEaisEi' => [
'summary' => '将EI绑定到ECS或ECI实例上',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ClientInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'i-bp14ws9hbt1oe0u9****',
],
],
[
'name' => 'EiInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'eais-hzu00xufs1c8j5nn****',
],
],
[
'name' => 'EiInstanceType',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'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' => '',
'type' => 'string',
'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC8****',
],
'EiInstanceId' => [
'description' => '',
'type' => 'string',
'example' => 'eais-hzu00xufs1c8j5nn****',
],
'ClientInstanceId' => [
'description' => '',
'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.',
],
],
404 => [
[
'errorCode' => 'InvalidClientInstanceId.Forbidden',
'errorMessage' => 'Please make sure the ClientInstanceId exists and belongs to you.',
],
],
],
'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":"\\n C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\n eais-hzu00xufs1c8j5nn****\\n i-bp14ws9hbt1oe0u9****\\n","errorExample":""}]',
'title' => 'AttachEaisEi',
],
'StartEaisEi' => [
'summary' => '启动一个弹性加速计算实例',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'paid',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'EiInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'eais-hzu00xufs1c8j5nn****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'F23AEEC7-4D98-4657-A104-02692701****',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation. %s',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F23AEEC7-4D98-4657-A104-02692701****\\n","errorExample":""}]',
'title' => 'StartEaisEi',
],
'StopEaisEi' => [
'summary' => '停止一个弹性加速计算实例',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'EiInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'eais-hzu00xufs1c8j5nn****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'F23AEEC7-4D98-4657-A104-02692701****',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation. %s',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F23AEEC7-4D98-4657-A104-02692701****\\n","errorExample":""}]',
'title' => 'StopEaisEi',
],
'DetachEaisEi' => [
'summary' => '将EI实例与ECS或ECI实例解绑',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'EiInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'eais-hzu00xufs1c8j5nn****',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '04DEB304-2436-4CB9-BB63-468BCEA0****',
],
],
],
],
],
'errorCodes' => [
403 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation. %s',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04DEB304-2436-4CB9-BB63-468BCEA0****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04DEB304-2436-4CB9-BB63-468BCEA0****\\n","errorExample":""}]',
'title' => 'DetachEaisEi',
],
'DeleteEaisEi' => [
'summary' => '释放弹性加速计算实例',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'EiInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'eais-hzu00xufs1c8j5nn****',
],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'F23AEEC7-4D98-4657-A104-02692701****',
],
],
],
],
],
'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.',
],
],
403 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation. %s',
],
],
[
[
'errorCode' => 'InvalidParameter.InstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F23AEEC7-4D98-4657-A104-02692701****\\n","errorExample":""}]',
'title' => 'DeleteEaisEi',
],
'DescribeEais' => [
'summary' => '查询一个或多个弹性加速计算实例的详细信息',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'enumValueTitles' => [],
'example' => 'cn-shenzhen',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ElasticAcceleratedInstanceIds',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => false,
'example' => '["eais-id1", "eais-id2"]',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais*',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'InUse',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais.ei-a6.2xlarge',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'ClientInstanceId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'type' => 'string',
],
'Value' => [
'type' => 'string',
],
],
],
'maxItems' => 21,
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'required' => false,
'type' => 'integer',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '200',
'format' => 'int32',
'required' => false,
'type' => 'integer',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '1E23D585-BBD8-436F-9615-54CACD6*****',
'type' => 'string',
],
'PageNumber' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'PageSize' => [
'description' => '',
'example' => '10',
'format' => 'int32',
'type' => 'integer',
],
'TotalCount' => [
'description' => '',
'example' => '1',
'format' => 'int32',
'type' => 'integer',
],
'Instances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Instance' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'properties' => [
'Status' => [
'description' => '',
'example' => 'InUse',
'type' => 'string',
],
'CreationTime' => [
'description' => '',
'example' => '2020-11-11T03:11Z',
'type' => 'string',
],
'ClientInstanceName' => [
'description' => '',
'example' => 'test1',
'type' => 'string',
],
'Description' => [
'description' => '',
'example' => 'testDescription',
'type' => 'string',
],
'ElasticAcceleratedInstanceId' => [
'description' => '',
'example' => 'eais-sz8t15a7gt7****',
'type' => 'string',
],
'InstanceName' => [
'description' => '',
'example' => 'testName',
'type' => 'string',
],
'ClientInstanceType' => [
'description' => '',
'example' => 'ecs.g5ne.large',
'type' => 'string',
],
'ClientInstanceId' => [
'description' => '',
'example' => 'i-wz93g6pyat2g****',
'type' => 'string',
],
'ZoneId' => [
'description' => '',
'example' => 'cn-shenzhen-e',
'type' => 'string',
],
'InstanceType' => [
'description' => '',
'example' => 'eais.ei-a6.2xlarge',
'type' => 'string',
],
'RegionId' => [
'description' => '',
'example' => 'cn-shenzhen',
'type' => 'string',
],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'properties' => [
'TagKey' => [
'description' => '',
'example' => 'TestKey',
'type' => 'string',
],
'TagValue' => [
'description' => '',
'example' => 'TestValue',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
],
'Category' => [
'description' => '',
'enumValueTitles' => [],
'example' => 'jupyter',
'type' => 'string',
],
'JupyterUrl' => [
'description' => '',
'example' => 'http://121.41.**.24:8888',
'type' => 'string',
],
'VSwitchId' => [
'description' => '',
'example' => 'vsw-bp1sd131hfmd76r******',
'type' => 'string',
],
'SecurityGroupId' => [
'description' => '',
'example' => 'sg-bp1gppir818lx4******',
'type' => 'string',
],
'StartTime' => [
'type' => 'string',
],
'ResourceGroupId' => [
'type' => 'string',
],
'PaymentType' => [
'type' => 'string',
],
],
'type' => 'object',
],
],
],
],
],
'type' => 'object',
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'InvalidParameter.InstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
],
'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"}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'DescribeEais',
],
'CreateEaiJupyter' => [
'summary' => '创建一个EAIS Jupyter环境',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'enumValueTitles' => [
'cn-hangzhou' => 'cn-hangzhou',
],
'example' => 'cn-hangzhou',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'EaisType',
'in' => 'query',
'schema' => [
'description' => '',
'enumValueTitles' => [
'eais.ei-a6.2xlarge' => 'eais.ei-a6.2xlarge',
],
'example' => 'eais.ei-a6.2xlarge',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'vsw-uf6h3rbwbm90urjwa****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'SecurityGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'sg-uf66jeqopgqa9hdn****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '123e4567-e89b-12d3-a456-426655440000',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'EnvironmentVar',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'items' => [
'properties' => [
'Key' => [
'description' => '',
'example' => 'MY_USER_NAME',
'required' => false,
'type' => 'string',
],
'Value' => [
'description' => '',
'example' => 'test123',
'required' => false,
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'required' => false,
'type' => 'array',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'EaisName',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'type' => 'string',
],
'Value' => [
'type' => 'string',
],
],
],
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'A655AB0E-31BB-45AD-9255-FCE93F6*****',
'title' => 'Id of the request',
'type' => 'string',
],
'ElasticAcceleratedInstanceId' => [
'description' => '',
'example' => 'eais-hz8t15a7gt7z7j7i****',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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' => '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.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A655AB0E-31BB-45AD-9255-FCE93F65****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-hz8t15a7gt7z7j7i****\\"\\n}","type":"json"}]',
'title' => 'CreateEaiJupyter',
],
'StopEaiJupyter' => [
'summary' => '停止一个部署了notebook的弹性加速计算实例',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'eais-hze3x2gv9wimdj0k****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****',
],
'AccessDeniedDetail' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '',
'type' => 'string',
'example' => 'eais:StopEaiJupyter',
],
'AuthPrincipalDisplayName' => [
'description' => '',
'type' => 'string',
'example' => '20560152949032****',
],
'AuthPrincipalOwnerId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidInstanceId',
'errorMessage' => 'The InstanceId is invalid.',
],
],
],
'staticInfo' => [
'returnType' => 'asynchronous',
'callback' => 'eais::2019-06-24::DescribeEais',
'callbackInterval' => 3000,
'maxCallbackTimes' => 5,
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'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"}]',
],
'StartEaiJupyter' => [
'summary' => '启动一个部署了notebook的弹性加速计算实例',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'paid',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'eais-hze3x2gv9wimdj0k****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'type' => 'string',
'example' => '04DEB304-2436-4CB9-BB63-468BCEA0****',
],
'AccessDeniedDetail' => [
'description' => '',
'type' => 'object',
'properties' => [
'AuthAction' => [
'description' => '',
'type' => 'string',
'example' => 'eais:StartEaiJupyter',
],
'AuthPrincipalDisplayName' => [
'description' => '',
'type' => 'string',
'example' => '20560152949032****',
],
'AuthPrincipalOwnerId' => [
'description' => '',
'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',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidInstanceId',
'errorMessage' => 'The InstanceId is invalid.',
],
],
],
'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"}]',
],
'GetInstanceMetrics' => [
'summary' => '获取EAIS实例级别的监控数据',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais-hznzre6ffmz9num4****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'MetricType',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'MemoryUsage',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '2022-11-22T16:00:00Z',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '2022-11-22T16:30:00Z',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'TimeStep',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '5m',
'required' => false,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'RequestId' => [
'description' => '',
'example' => '473469C7-AA6F-4DC5-B3DB-A3DC0DE3****',
'title' => 'Id of the request',
'type' => 'string',
],
'InstanceId' => [
'description' => '',
'example' => 'eais-bj8b53it29hfhj******',
'type' => 'string',
],
'PodMetrics' => [
'description' => '',
'items' => [
'properties' => [
'PodId' => [
'description' => 'Pod ID。',
'example' => 'eais-hznzre6ffmz9num4****-579b587ddf-9txr6',
'type' => 'string',
],
'Metrics' => [
'description' => '',
'items' => [
'properties' => [
'Time' => [
'description' => '',
'example' => '1669107528450',
'type' => 'string',
],
'Value' => [
'description' => '',
'example' => '4.536552540058814',
'type' => 'string',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'type' => 'object',
],
'type' => 'array',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****\\n eais-bj8b53it29hfhj******\\n \\n eais-hznzre6ffmz9num4****-579b587ddf-9txr6\\n \\n \\n 4.536552540058814\\n \\n \\n","errorExample":""}]',
'title' => 'GetInstanceMetrics',
],
'CreateEai' => [
'summary' => '创建一个弹性加速计算实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'paid',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'cn-shenzhen',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'InstanceType',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'eais.ei-a6.2xlarge',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => [
'description' => '',
'example' => '123e4567-e89b-12d3-a456-426655440000',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais-test01',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'SecurityGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'sg-uf66jeqopgqa9hdn****',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'vsw-uf6h3rbwbm90urjwa****',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Image',
'in' => 'query',
'schema' => [
'type' => 'string',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'type' => 'string',
],
'Value' => [
'type' => 'string',
],
],
],
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'ElasticAcceleratedInstanceId' => [
'description' => '',
'example' => 'eais-sz8t15a7gt7z7j7i****',
'type' => 'string',
],
'RequestId' => [
'description' => '',
'example' => 'A655AB0E-31BB-45AD-9255-FCE93F6*****',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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' => '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.',
],
],
],
'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"}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'CreateEai',
],
'AttachEai' => [
'summary' => '将弹性加速计算实例挂载到ECS实例上',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'cn-shenzhen',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ElasticAcceleratedInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'eais-sz8t15a7gt7z7j7i****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ClientInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'i-wz93g6pyat2g7t7o****',
'required' => true,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC84474',
'type' => 'string',
],
'ElasticAcceleratedInstanceId' => [
'description' => '',
'example' => 'eais-sz8t15a7gt7z7j7i****',
'type' => 'string',
],
'ClientInstanceId' => [
'description' => '',
'example' => 'i-wz93g6pyat2g7t7o****',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"i-wz93g6pyat2g7t7o****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\n eais-sz8t15a7gt7z7j7i****\\n i-wz93g6pyat2g7t7o****\\n","errorExample":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'AttachEai',
],
'DetachEai' => [
'summary' => '从ECS实例上卸载弹性加速计算实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'cn-shenzhen',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ElasticAcceleratedInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'eais-sz8t15a7gt7z7j7i****',
'required' => true,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => '04DEB304-2436-4CB9-BB63-468BCEA03D9D',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"04DEB304-2436-4CB9-BB63-468BCEA0****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 04DEB304-2436-4CB9-BB63-468BCEA0****\\n","errorExample":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'DetachEai',
],
'DeleteEai' => [
'summary' => '释放一个弹性加速计算实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'cn-shenzhen',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ElasticAcceleratedInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'eais-sz8t15a7gt7z7j7i****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'Force',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'false',
'required' => false,
'type' => 'boolean',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'F23AEEC7-4D98-4657-A104-0269270*****',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'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' => 'InvalidParameter.InstanceId.NotFound',
'errorMessage' => 'The specified InstanceId does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F23AEEC7-4D98-4657-A104-02692701****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n F23AEEC7-4D98-4657-A104-02692701****\\n","errorExample":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'DeleteEai',
],
'CreateEaiEci' => [
'summary' => '创建一个EAIS实例和ECI实例并绑定',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'paid',
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'example' => '123e4567-e89b-12d3-a456-426655440000',
'required' => false,
'title' => '幂等参数',
'type' => 'string',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'cn-shenzhen',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'EaisName',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais-test01',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'EaisType',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais.ei-a6.2xlarge',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'vsw-uf6h3rbwbm90urjwa****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'SecurityGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'sg-uf66jeqopgqa9hdn****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'Eci',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'properties' => [
'Container' => [
'description' => '',
'properties' => [
'Arg' => [
'description' => '',
'example' => '100',
'required' => false,
'type' => 'string',
],
'Command' => [
'description' => '',
'example' => 'sleep',
'required' => false,
'type' => 'string',
],
'Image' => [
'description' => '',
'example' => 'nginx',
'required' => false,
'type' => 'string',
],
'Name' => [
'description' => '',
'example' => 'test1',
'required' => false,
'type' => 'string',
],
'Volumes' => [
'description' => '',
'example' => '/mnt/eais=eais,/models=eais/models',
'required' => false,
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
'EipId' => [
'description' => '',
'example' => 'eip-uf66jeqopgqa9hdn****',
'required' => false,
'type' => 'string',
],
'Name' => [
'description' => '',
'example' => 'test-nginx',
'required' => false,
'type' => 'string',
],
'Type' => [
'description' => '',
'example' => 'ecs.c5.xlarge',
'required' => false,
'type' => 'string',
],
'Volume' => [
'description' => '',
'example' => '00c7****-rivj.cn-hangzhou.extreme.nas.aliyuncs.com:/share',
'required' => false,
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'rg-acfmvpuy4a5****',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'type' => 'string',
],
'Value' => [
'type' => 'string',
],
],
],
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****',
'title' => 'Id of the request',
'type' => 'string',
],
'ElasticAcceleratedInstanceId' => [
'description' => '',
'example' => 'eais-sz8t15a7gt7z7j7i****',
'type' => 'string',
],
'ClientInstanceId' => [
'description' => '',
'example' => 'eci-2zeh03ygxlrzmfi6****',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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' => '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.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"eci-2zeh03ygxlrzmfi6****\\"\\n}","type":"json"}]',
'title' => 'CreateEaiEci',
],
'CreateEaiEcs' => [
'summary' => '创建一个EAIS实例和ECS实例并绑定',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'high',
'chargeType' => 'paid',
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '',
'example' => '123e4567-e89b-12d3-a456-426655440000',
'required' => false,
'title' => '幂等参数',
'type' => 'string',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'cn-shenzhen',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'EaisName',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais-test01',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Ecs',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '',
'properties' => [
'ImageId' => [
'description' => '',
'example' => 'aliyun_2_1903_x64_20G_alibase_20200324.vhd',
'required' => false,
'type' => 'string',
],
'InternetMaxBandwidthIn' => [
'description' => '',
'example' => '10',
'required' => false,
'type' => 'string',
],
'InternetMaxBandwidthOut' => [
'description' => '',
'example' => '10',
'required' => false,
'type' => 'string',
],
'Name' => [
'description' => '',
'example' => 'test1',
'required' => false,
'type' => 'string',
],
'Password' => [
'description' => '',
'example' => 'EcsV587!',
'required' => false,
'type' => 'string',
],
'SystemDiskCategory' => [
'description' => '',
'example' => 'cloud_ssd',
'required' => false,
'type' => 'string',
],
'SystemDiskSize' => [
'description' => '',
'example' => '40',
'format' => 'int64',
'required' => false,
'type' => 'integer',
],
'Type' => [
'description' => '',
'example' => 'ecs.g7.4xlarge',
'required' => false,
'type' => 'string',
],
'ZoneId' => [
'description' => '',
'example' => 'cn-shenzhen-e',
'required' => false,
'type' => 'string',
],
],
'required' => false,
'type' => 'object',
],
],
[
'name' => 'EaisType',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais.ei-a6.2xlarge',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'vsw-uf6h3rbwbm90urjwa****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'SecurityGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'sg-uf66jeqopgqa9hdn****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'rg-acfmvpuy4a5****',
'required' => false,
'type' => 'string',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => [
'type' => 'string',
],
'Value' => [
'type' => 'string',
],
],
],
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'F5FEB9AA-C108-577C-AB3D-D13524AF****',
'title' => 'Id of the request',
'type' => 'string',
],
'ElasticAcceleratedInstanceId' => [
'description' => '',
'example' => 'eais-sz8t15a7gt7z7j7i****',
'type' => 'string',
],
'ClientInstanceId' => [
'description' => '',
'example' => 'i-bp1hjrvleawl4ogb****',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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' => '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.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5FEB9AA-C108-577C-AB3D-D13524AF****\\",\\n \\"ElasticAcceleratedInstanceId\\": \\"eais-sz8t15a7gt7z7j7i****\\",\\n \\"ClientInstanceId\\": \\"i-bp1hjrvleawl4ogb****\\"\\n}","type":"json"}]',
'title' => 'CreateEaiEcs',
],
'DeleteEaiAll' => [
'summary' => '释放一个弹性加速计算实例以及与其绑定的ECS或ECI实例',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'cn-shenzhen',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ElasticAcceleratedInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'docRequired' => true,
'example' => 'eais-hza1ahi0uuw0re33****',
'required' => true,
'type' => 'string',
],
],
[
'name' => 'ClientInstanceId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'i-bp1fvhi60e1zizsp****',
'required' => false,
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'AD4EA714-A35B-4710-BF92-8275BCDDB69F',
'type' => 'string',
],
],
'type' => 'object',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AD4EA714-A35B-4710-BF92-8275BCDD****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n AD4EA714-A35B-4710-BF92-8275BCDD****\\n","errorExample":""}]',
'extraInfo' => ' ',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'title' => 'DeleteEaiAll',
],
'ChangeResourceGroup' => [
'summary' => '资源转组',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'eais-hzs4h26yyt5xkcke****',
'required' => true,
'title' => '资源Id',
'type' => 'string',
],
],
[
'name' => 'ResourceRegionId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'cn-hangzhou',
'required' => true,
'title' => '地域Id',
'type' => 'string',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => [
'description' => '',
'example' => 'rg-acfmvpuy4a5****',
'required' => true,
'title' => '目标资源组',
'type' => 'string',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'properties' => [
'RequestId' => [
'description' => '',
'example' => 'C3BCB7DA-BEB6-4982-A765-6EA61EC8****',
'title' => 'Id of the request',
'type' => 'string',
],
],
'title' => 'Schema of Response',
'type' => 'object',
],
],
],
'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',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C3BCB7DA-BEB6-4982-A765-6EA61EC8****\\n","errorExample":""}]',
'title' => 'ChangeResourceGroup',
],
'TagResources' => [
'summary' => '为弹性加速计算实例创建并绑定标签',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'instance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'eais-hzgv8uxixkho5b3w****',
],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'Value' => [
'title' => '标签值',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestValue',
],
],
'required' => false,
],
'required' => true,
'maxItems' => 21,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '',
'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.',
],
],
403 => [
[
'errorCode' => 'OperationDenied.KeyValueNotNull',
'errorMessage' => 'The key value cannot be null.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\n","errorExample":""}]',
],
'UntagResources' => [
'summary' => '解绑并删除标签',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'instance',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => [
'title' => '是否全部删除,只针对TagKey.N为空时有效。 取值范围: true false True False 默认是 false',
'description' => '',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多50个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'eais-hzs4h26yyt5xkcke****',
],
'required' => true,
'maxItems' => 51,
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签键,最多20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'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' => '',
'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.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E23D585-BBD8-436F-9615-54CACD67****\\"\\n}","type":"json"}]',
],
'ListTagResources' => [
'summary' => '查询标签列表',
'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' => '',
'type' => 'string',
'required' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'title' => '下一个查询开始Token',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a4884',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'title' => '资源类型',
'description' => '',
'type' => 'string',
'required' => true,
'example' => 'instance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '资源ID,最多 50个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'eais-hzs4h26yyt5xkcke****',
],
'required' => false,
'maxItems' => 51,
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '标签列表,最多包含20个子项',
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => [
'title' => '标签键',
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'TestKey',
],
'Value' => [
'title' => '标签值',
'description' => '',
'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' => '',
'type' => 'string',
'example' => 'F23AEEC7-4D98-4657-A104-02692701****',
],
'NextToken' => [
'description' => '',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a4885',
],
'TagResources' => [
'description' => '',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'TagKey' => [
'description' => '',
'type' => 'string',
'example' => 'TestKey',
],
'TagValue' => [
'description' => '',
'type' => 'string',
'example' => 'TestValue',
],
'ResourceId' => [
'description' => '',
'type' => 'string',
'example' => 'eais-hzs4h26yyt5xkcke****',
],
'ResourceType' => [
'description' => '',
'type' => 'string',
'example' => 'instance',
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'MissingParameter.ResourceIdOrTag',
'errorMessage' => 'Either ResourceId or Tag must be specified.',
],
[
'errorCode' => 'InvalidNextToken',
'errorMessage' => 'The NextToken is invalid.',
],
[
'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.',
],
],
],
'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"}]',
],
],
'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',
],
],
];