summaryrefslogtreecommitdiff
path: root/data/en_us/easygene/2021-03-15
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/en_us/easygene/2021-03-15
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/easygene/2021-03-15')
-rw-r--r--data/en_us/easygene/2021-03-15/api-docs.php12048
1 files changed, 4539 insertions, 7509 deletions
diff --git a/data/en_us/easygene/2021-03-15/api-docs.php b/data/en_us/easygene/2021-03-15/api-docs.php
index c1183f1..a7001ae 100644
--- a/data/en_us/easygene/2021-03-15/api-docs.php
+++ b/data/en_us/easygene/2021-03-15/api-docs.php
@@ -1,880 +1,294 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'EasyGene',
- 'version' => '2021-03-15',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'EasyGene', 'version' => '2021-03-15'],
'directories' => [
[
- 'id' => 125018,
- 'title' => null,
- 'type' => 'directory',
'children' => [
[
- 'id' => 125019,
- 'title' => null,
+ 'children' => ['TagApp', 'ImportApp', 'DeleteApp', 'GetApp', 'ListApps'],
'type' => 'directory',
- 'children' => [
- 'CreateWorkspace',
- 'DeleteWorkspace',
- 'UpdateWorkspace',
- 'ListWorkspaces',
- 'GetWorkspace',
- ],
+ 'title' => 'Application',
],
[
- 'id' => 125025,
- 'title' => null,
+ 'children' => ['CreateRun', 'DeleteRun', 'ListUserActiveRuns', 'AbortRun'],
'type' => 'directory',
- 'children' => [
- 'CreateApp',
- 'TagApp',
- 'ImportApp',
- 'DeleteApp',
- 'GetApp',
- 'ListApps',
- ],
+ 'title' => 'Run',
],
[
- 'id' => 125032,
- 'title' => null,
+ 'children' => ['DeleteEntityItems', 'UpdateEntityItems', 'ListEntities', 'ListEntityItems', 'CopyPublicEntity', 'DownloadEntity', 'UploadEntity'],
'type' => 'directory',
- 'children' => [
- 'CreateRun',
- 'GetRun',
- 'DeleteRun',
- 'ListRuns',
- 'ListUserActiveRuns',
- 'AbortRun',
- ],
+ 'title' => 'Entity',
],
[
- 'id' => 125039,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'CreateEntity',
- 'GetEntity',
- 'DeleteEntity',
- 'DeleteEntityItems',
- 'UpdateEntity',
- 'UpdateEntityItems',
- 'ListEntities',
- 'ListEntityItems',
- 'CopyPublicEntity',
- 'DownloadEntity',
- 'UploadEntity',
- ],
- ],
- [
- 'id' => 125049,
- 'title' => null,
+ 'children' => ['CreateSubmission', 'GetSubmission', 'DeleteSubmission', 'ListSubmissions', 'AbortSubmission', 'ResumeSubmission'],
'type' => 'directory',
- 'children' => [
- 'CreateTemplate',
- 'GetTemplate',
- 'DeleteTemplate',
- 'UpdateTemplate',
- 'ListTemplates',
- ],
- ],
- [
- 'id' => 125055,
- 'title' => null,
- 'type' => 'directory',
- 'children' => [
- 'CreateSubmission',
- 'GetSubmission',
- 'DeleteSubmission',
- 'ListSubmissions',
- 'AbortSubmission',
- 'ResumeSubmission',
- ],
+ 'title' => 'Submission',
],
],
+ 'type' => 'directory',
+ 'title' => 'Workspace',
],
[
- 'id' => 125062,
- 'title' => null,
+ 'children' => ['ListGlobalApps', 'GetGlobalApp'],
'type' => 'directory',
- 'children' => [
- 'ListGlobalApps',
- 'GetGlobalApp',
- ],
+ 'title' => 'Public application',
],
[
- 'id' => 125065,
- 'title' => null,
+ 'children' => ['ListContainerImages', 'ListAuthorizedSoftware'],
'type' => 'directory',
- 'children' => [
- 'ListContainerImages',
- 'ListAuthorizedSoftware',
- ],
+ 'title' => 'Developer resources',
],
[
- 'id' => 125068,
- 'title' => null,
+ 'children' => ['ListPublicDataset', 'GetPublicDataset', 'ListPublicDatasetEntities', 'GetPublicDatasetEntity', 'ListPublicDatasetEntityItems', 'ListPublicDatasetTags'],
'type' => 'directory',
- 'children' => [
- 'ListPublicDataset',
- 'GetPublicDataset',
- 'ListPublicDatasetEntities',
- 'GetPublicDatasetEntity',
- 'ListPublicDatasetEntityItems',
- 'ListPublicDatasetTags',
- ],
+ 'title' => 'Public dataset',
],
[
- 'id' => 165096,
- 'title' => null,
+ 'children' => ['InstallGlobalApp'],
+ 'type' => 'directory',
+ 'title' => 'Other',
+ ],
+ [
+ 'children' => ['CreateApp', 'CreateEntity', 'CreateTemplate', 'CreateWorkspace', 'DeleteEntity', 'DeleteTemplate', 'DeleteWorkspace', 'GetEntity', 'GetRun', 'GetTemplate', 'GetWorkspace', 'ListRegions', 'ListRuns', 'ListTemplates', 'ListWorkspaces', 'UpdateEntity', 'UpdateTemplate', 'UpdateWorkspace'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'ListRegions',
- 'InstallGlobalApp',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'CreateWorkspace' => [
- 'summary' => '创建工作空间',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AbortRun' => [
+ 'summary' => 'Stop specific tasks that are running but not yet in a final state within a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'TestWorkspace',
- ],
- ],
- [
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'This is a test workspace',
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'title' => '幂等Token',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestToken',
- ],
- ],
- [
- 'name' => 'Storage',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间的OSS工作路径',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://gstor-default-workspace-cn-shanghai-bae3193d/',
- ],
- ],
- [
- 'name' => 'JobLifecycle',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间任务生命周期',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'Role',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间内的ram角色',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestRole',
- ],
- ],
- [
- 'name' => 'Labels',
+ 'name' => 'RunId',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间标签',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"key":"value"}',
- ],
+ 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Return result',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Workspace' => [
- 'title' => '创建成功的工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"TestWorkspace\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateWorkspaceResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Workspace>TestWorkspace</Workspace>\\n</CreateWorkspaceResponse>","errorExample":""}]',
- ],
- 'DeleteWorkspace' => [
- 'summary' => '删除工作空间',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
- [
- 'name' => 'Workspace',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MyTestWorkspace',
- ],
+ 409 => [
+ ['errorCode' => 'StatusConflict', 'errorMessage' => 'The specified action %s is not supported in current status %s.', 'description' => ''],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '返回结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Stop Running Job',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:AbortRun',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/{#RunId}'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortRun'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteWorkspaceResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</DeleteWorkspaceResponse>","errorExample":""}]',
- 'title' => 'DeleteWorkspace',
],
- 'UpdateWorkspace' => [
- 'summary' => '修改工作空间',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AbortSubmission' => [
+ 'summary' => 'Aborts a specific delivery task in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MyTestWorkspace',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'Description',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a test workspace',
- ],
- ],
- [
- 'name' => 'JobLifecycle',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间内任务生命周期',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '30',
- ],
- ],
- [
- 'name' => 'Role',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间内Ram角色',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MyTestRamRole',
- ],
- ],
- [
- 'name' => 'Labels',
+ 'name' => 'SubmissionId',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间标签',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"env":"test"}',
- ],
+ 'schema' => ['description' => 'Delivery ID', 'type' => 'string', 'required' => true, 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ 409 => [
+ ['errorCode' => 'StatusConflict', 'errorMessage' => 'The specified action %s is not supported in current status %s.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"RequestId\\": \\"easygene.cn-beijing.aliyuncs.com\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateWorkspaceResponse>\\n <HostId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</HostId>\\n <RequestId>easygene.cn-beijing.aliyuncs.com</RequestId>\\n</UpdateWorkspaceResponse>","errorExample":""}]',
- ],
- 'ListWorkspaces' => [
- 'summary' => '列出工作空间',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"easygene.cn-beijing.aliyuncs.com\\"\\n}","type":"json"}]',
+ 'title' => 'AbortSubmission',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:40.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:AbortSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/{#SubmissionId}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortSubmission'],
+ ],
],
+ ],
+ 'CopyPublicEntity' => [
+ 'summary' => 'Copies a public dataset table to a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
- [
- 'BearerToken' => [],
- ],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'Search',
- 'in' => 'query',
- 'schema' => [
- 'title' => '搜索字段',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestName',
- ],
- ],
- [
- 'name' => 'OrderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序依据',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createtime',
- ],
- ],
- [
- 'name' => 'IsReversed',
+ 'name' => 'Dataset',
'in' => 'query',
- 'schema' => [
- 'title' => '逆序',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Dataset name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestDataset', 'title' => ''],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'NextToken',
- 'description' => 'NextToken',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestToken',
- ],
- ],
- [
- 'name' => 'MaxResults',
+ 'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '最多返回数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '5',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'Table name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sample', 'title' => ''],
],
[
- 'name' => 'LabelSelector',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => 'Label选择器',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'env=test',
- ],
+ 'schema' => ['description' => 'Target workspace', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Response data',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'MaxResults' => [
- 'title' => '最大结果数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'NextToken' => [
- 'title' => '下次查询的起始Token',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestToken',
- ],
- 'TotalCount' => [
- 'title' => '返回总个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'Workspaces' => [
- 'title' => '工作空间数组',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'title' => '工作空间描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is a test workspace',
- ],
- 'JobLifecycle' => [
- 'title' => '任务生命周期',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'Labels' => [
- 'title' => '工作空间标签',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'test',
- 'description' => '',
- ],
- ],
- 'Storage' => [
- 'title' => 'OSS工作路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://my-bucket/my-path/',
- ],
- 'BucketName' => [
- 'title' => '工作空间Bucket名字',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'my-bucket',
- ],
- 'Role' => [
- 'title' => 'RAM Role',
- 'description' => 'RAM Role',
- 'type' => 'string',
- 'example' => 'TestRole',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'LastModifiedTime' => [
- 'title' => '最后修改时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'Workspace' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'Status' => [
- 'title' => '工作空间状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Active',
- ],
- 'Location' => [
- 'title' => '地域ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
- ],
- ],
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Workspace' => ['description' => 'Workspace', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'EntityType' => ['description' => 'Entity type', 'type' => 'string', 'example' => 'sample', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 5,\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"TestToken\\",\\n \\"TotalCount\\": 5,\\n \\"Workspaces\\": [\\n {\\n \\"Description\\": \\"This is a test workspace\\",\\n \\"JobLifecycle\\": 30,\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"Storage\\": \\"oss://my-bucket/my-path/\\",\\n \\"BucketName\\": \\"my-bucket\\",\\n \\"Role\\": \\"TestRole\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"LastModifiedTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"Status\\": \\"Active\\",\\n \\"Location\\": \\"cn-beijing\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListWorkspacesResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <MaxResults>5</MaxResults>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <NextToken>TestToken</NextToken>\\n <TotalCount>5</TotalCount>\\n <Workspaces>\\n <Description>This is a test workspace</Description>\\n <JobLifecycle>30</JobLifecycle>\\n <Labels>\\n <key>test</key>\\n </Labels>\\n <OssRoot>oss://my-bucket/my-path/</OssRoot>\\n <BucketName>my-bucket</BucketName>\\n <Role>TestRole</Role>\\n <CreateTime>2021-06-16T15:09:14.378297+08:00</CreateTime>\\n <LastModifiedTime>2021-06-16T15:09:14.378297+08:00</LastModifiedTime>\\n <Workspace>TestWorkspace</Workspace>\\n <Status>Active</Status>\\n <RegionId>cn-beijing</RegionId>\\n </Workspaces>\\n</ListWorkspacesResponse>","errorExample":""}]',
- 'title' => 'ListWorkspaces',
- ],
- 'GetWorkspace' => [
- 'summary' => '查询工作空间详情',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
- 'parameters' => [
- [
- 'name' => 'Workspace',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名字',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MyTestWorkspace',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Description' => [
- 'title' => '工作空间简要描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is a test workspace',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'JobLifecycle' => [
- 'title' => '工作空间内作业生命周期',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'Labels' => [
- 'title' => '工作空间标签',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'test',
- 'description' => '',
- ],
- ],
- 'Storage' => [
- 'title' => '工作空间内OSS上的工作路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://my-bucket/my-path/',
- ],
- 'BucketName' => [
- 'title' => '工作空间Bucket',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'my-bucket',
- ],
- 'Role' => [
- 'title' => '工作空间内默认的RAM服务角色',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestRole',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'LastModifiedTime' => [
- 'title' => '最后修改时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'Workspace' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'Status' => [
- 'title' => '工作空间状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Active',
- ],
- 'Location' => [
- 'title' => '地域ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","type":"json"}]',
+ 'title' => 'Copy public dataset table ',
+ 'changeSet' => [
+ ['createdAt' => '2021-05-28T03:05:29.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-05-28T03:05:29.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:CopyPublicEntity',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- ],
- 404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyPublicEntity'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Description\\": \\"This is a test workspace\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"JobLifecycle\\": 30,\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"Storage\\": \\"oss://my-bucket/my-path/\\",\\n \\"BucketName\\": \\"my-bucket\\",\\n \\"Role\\": \\"TestRole\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"LastModifiedTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"Status\\": \\"Active\\",\\n \\"Location\\": \\"cn-beijing\\"\\n}","errorExample":""},{"type":"xml","example":"<GetWorkspaceResponse>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Description>This is a test workspace</Description>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <JobLifecycle>30</JobLifecycle>\\n <Labels>\\n <key>test</key>\\n </Labels>\\n <OssRoot>oss://my-bucket/my-path/</OssRoot>\\n <BucketName>my-bucket</BucketName>\\n <Role>TestRole</Role>\\n <CreateTime>2021-06-16T15:09:14.378297+08:00</CreateTime>\\n <LastModifiedTime>2021-06-16T15:09:14.378297+08:00</LastModifiedTime>\\n <Workspace>TestWorkspace</Workspace>\\n <Status>Active</Status>\\n <RegionId>cn-beijing</RegionId>\\n</GetWorkspaceResponse>","errorExample":""}]',
- 'title' => 'GetWorkspace',
],
'CreateApp' => [
- 'summary' => '创建应用',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'summary' => 'Create applications in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -882,184 +296,94 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestWorkspace',
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestApp',
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'Application name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestApp', 'title' => ''],
],
[
'name' => 'Definition',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用定义',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'import "./task/echo.wdl" as echo workflow wf_echo { call echo.echo }',
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'Application definition', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'import "./task/echo.wdl" as echo workflow wf_echo { call echo.echo }', 'title' => ''],
],
[
'name' => 'Path',
'in' => 'query',
- 'schema' => [
- 'title' => '主WDL路径',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'main.wdl',
- 'docRequired' => true,
- ],
+ 'schema' => ['description' => 'Main WDL path', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'main.wdl', 'title' => ''],
],
[
'name' => 'RevisionTag',
'in' => 'query',
- 'schema' => [
- 'title' => '应用版本标签，在所有版本间具有唯一性',
- 'type' => 'string',
- 'example' => 'ProduceVersion',
- ],
+ 'schema' => ['title' => 'Application version tag, which is unique across all versions', 'description' => 'Application version tag, unique across all versions', 'type' => 'string', 'example' => 'ProduceVersion', 'required' => false],
],
[
'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => '应用描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a test app',
- ],
+ 'schema' => ['description' => 'Application description', 'type' => 'string', 'example' => 'This is a test app', 'title' => '', 'required' => false],
],
[
'name' => 'Language',
'in' => 'query',
- 'schema' => [
- 'title' => '应用描述语言',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'WDL',
- ],
+ 'schema' => ['description' => 'Application description language', 'type' => 'string', 'example' => 'WDL', 'title' => '', 'required' => false],
],
[
'name' => 'LanguageVersion',
'in' => 'query',
- 'schema' => [
- 'title' => '应用描述语语言版本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0',
- ],
+ 'schema' => ['description' => 'Application description language version', 'type' => 'string', 'example' => '1.0', 'title' => '', 'required' => false],
],
[
'name' => 'AppType',
'in' => 'query',
- 'schema' => [
- 'title' => '应用类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'App',
- ],
+ 'schema' => ['description' => 'Application type', 'type' => 'string', 'example' => 'App', 'title' => '', 'required' => false],
],
[
'name' => 'Documentation',
'in' => 'formData',
- 'schema' => [
- 'title' => '应用使用文档',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Example documentation content',
- ],
+ 'schema' => ['description' => 'Application usage document', 'type' => 'string', 'example' => 'Example documentation content', 'title' => '', 'required' => false],
],
[
'name' => 'RevisionComment',
'in' => 'query',
- 'schema' => [
- 'title' => '应用当前版本说明',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Example revision comment',
- ],
+ 'schema' => ['description' => 'Description of the current application version', 'type' => 'string', 'example' => 'Example revision comment', 'title' => '', 'required' => false],
],
[
'name' => 'Labels',
'in' => 'query',
- 'schema' => [
- 'title' => '应用标签',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"key":"value"}',
- ],
+ 'schema' => ['description' => 'Application labels', 'type' => 'string', 'example' => '{"key":"value"}', 'title' => '', 'required' => false],
],
[
'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'title' => '幂等Token',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestToken',
- ],
+ 'schema' => ['description' => 'Idempotent token', 'type' => 'string', 'example' => 'TestToken', 'title' => '', 'required' => false],
],
[
'name' => 'Dependencies',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '依赖应用',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Dependent applications',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Path' => [
- 'title' => '依赖路径',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => './task/echo.wdl',
- ],
- 'Content' => [
- 'title' => '依赖内容',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'task echo { String txt_out = "default_txt_out" String dd_out = "default_dd_out" command { echo Hello > ${txt_out} /bin/bash -c "dd if=/dev/zero of=${dd_out} bs=1M count=15" echo "This is a test std out." } runtime { cpu: "2" memory: "4G" autoReleaseJob: false reserveOnFail: true userData: "key1 value1" disks: "local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency" tag: "TestTag" } output { File outTxtFile = "${txt_out}" File outDdFile = "${dd_out}" } }',
- ],
+ 'Path' => ['description' => 'Dependency path', 'type' => 'string', 'example' => './task/echo.wdl', 'title' => '', 'required' => false],
+ 'Content' => ['description' => 'Dependency content', 'type' => 'string', 'example' => 'task echo { String txt_out = "default_txt_out" String dd_out = "default_dd_out" command { echo Hello > ${txt_out} /bin/bash -c "dd if=/dev/zero of=${dd_out} bs=1M count=15" echo "This is a test std out." } runtime { cpu: "2" memory: "4G" autoReleaseJob: false reserveOnFail: true userData: "key1 value1" disks: "local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency" tag: "TestTag" } output { File outTxtFile = "${txt_out}" File outDdFile = "${dd_out}" } }', 'title' => '', 'required' => false],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => '{"key":"value"}',
],
],
[
@@ -1067,1148 +391,666 @@
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '参考输入',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The reference data.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Path' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => './config/example.json',
- ],
- 'Content' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{ "wgs.apply_bqsr.cpu": 4, "wgs.apply_bqsr.disks": "local-disk 250 cloud_ssd", "wgs.apply_bqsr.gatk_Launcher": "/usr/local/bin/gatk-4.1.4.1/gatk", "wgs.apply_bqsr.java_opts": "\'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt\'", "wgs.apply_bqsr.memory": "8G"}',
- ],
+ 'Path' => ['description' => 'Configuration path', 'type' => 'string', 'example' => './config/example.json', 'required' => false, 'title' => ''],
+ 'Content' => ['description' => 'Configuration content', 'type' => 'string', 'example' => '{ "wgs.apply_bqsr.cpu": 4, "wgs.apply_bqsr.disks": "local-disk 250 cloud_ssd", "wgs.apply_bqsr.gatk_Launcher": "/usr/local/bin/gatk-4.1.4.1/gatk", "wgs.apply_bqsr.java_opts": "\'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt\'", "wgs.apply_bqsr.memory": "8G"}', 'required' => false, 'title' => ''],
],
'required' => false,
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
+ 'example' => 'TestToken',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '创建应用返回结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Create application response',
'type' => 'object',
'properties' => [
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestApp',
- ],
- 'HostId' => [
- 'title' => '主机 ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求 ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Revision' => [
- 'title' => '应用版本号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RevisionTag' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'ProduceVersion',
- ],
+ 'Workspace' => ['description' => 'Workspace', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'AppName' => ['description' => 'Application name', 'type' => 'string', 'example' => 'TestApp', 'title' => ''],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Revision' => ['description' => 'Application version number', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'RevisionTag' => ['title' => 'Unique Tag of Application Version', 'description' => 'Unique application version tag', 'type' => 'string', 'example' => 'ProduceVersion'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"AppName\\": \\"TestApp\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Revision\\": \\"1\\",\\n \\"RevisionTag\\": \\"ProduceVersion\\"\\n}","type":"json"}]',
- ],
- 'TagApp' => [
- 'summary' => '应用版本打标',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'title' => 'Create Application',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-10T09:29:50.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-12-10T09:13:58.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-01-12T05:28:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateEntity' => [
+ 'summary' => 'Creates an entity table in a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestWorkspace',
- ],
+ 'schema' => ['description' => 'The workspace. For more information about how to obtain the workspace, see [Create a workspace](https://help.aliyun.com/document_detail/601899.html?spm=a2c4g.601898.0.0.2df07010mNFomF).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'AppName',
+ 'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestApp',
- ],
+ 'schema' => ['description' => 'The entity type. The value must be 1 to 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sample', 'title' => ''],
],
[
- 'name' => 'AppRevision',
- 'in' => 'query',
+ 'name' => 'EntityItems',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'An array of table elements. The maximum size is 512 KB.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A table element.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EntityName' => ['description' => 'The name of the table element.', 'type' => 'string', 'example' => 's1', 'title' => '', 'required' => false],
+ 'EntityData' => [
+ 'description' => 'The key-value pairs of the table element.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'A key-value pair.', 'type' => 'string', 'example' => 'key:value', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
'required' => true,
- 'example' => '1',
+ 'docRequired' => true,
+ 'title' => '',
+ 'example' => '',
],
],
[
- 'name' => 'RevisionTag',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'title' => '应用版本唯一标签',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ProduceVersion',
- ],
+ 'schema' => ['description' => 'The idempotence token. The value can be up to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'T93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Workspace' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestApp',
- ],
- 'AppRevision' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RevisionTag' => [
- 'title' => '应用版本唯一标签',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ProduceVersion',
- ],
- 'FormerRevision' => [
- 'title' => '此前拥有该标签的应用版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'FormerTag' => [
- 'title' => '该应用版本此前的唯一标签',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestTag',
- ],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'EntityType' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'sample', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource %s is not found.',
- ],
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","type":"json"}]',
+ 'title' => 'Create Entity Table',
+ 'description' => '**Before you use this operation, ensure that you understand the billing methods and pricing of the EasyGene platform.**',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEntity'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"AppName\\": \\"TestApp\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"RevisionTag\\": \\"ProduceVersion\\",\\n \\"FormerRevision\\": \\"0\\",\\n \\"FormerTag\\": \\"TestTag\\"\\n}","type":"json"}]',
],
- 'ImportApp' => [
- 'summary' => '导入应用。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateRun' => [
+ 'summary' => 'Creates a run task in a workspace.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
- 'name' => 'Source',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '来源',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'easygene:opengene/fastp',
- ],
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'Workspace',
+ 'name' => 'RunName',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestWorkspace',
- ],
+ 'schema' => ['description' => 'The task name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'wgs_sentieon_hc_with_qc_NGPTS1900029301', 'title' => ''],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'title' => '安装后应用名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fastp',
- ],
+ 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Sentieon', 'title' => ''],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'AppRevision',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The application version number.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '16', 'title' => ''],
+ ],
+ [
+ 'name' => 'RevisionTag',
+ 'in' => 'query',
+ 'schema' => ['title' => 'Unique tag for the Application Version ', 'description' => 'The unique tag for the application version.', 'type' => 'string', 'example' => 'ProduceVersion', 'required' => false],
+ ],
+ [
+ 'name' => 'Description',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task description.', 'type' => 'string', 'example' => 'test run', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'Labels',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task labels.', 'type' => 'string', 'example' => '{"env": "test"}', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'ExecuteOptions',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '创建应用返回结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The task configuration.',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机 ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求 ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'AppName' => [
- 'title' => '安装后应用名',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InstalledApp',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
+ 'CallCaching' => ['description' => 'Specifies whether to enable Call Caching.', 'type' => 'boolean', 'example' => 'True', 'title' => '', 'required' => false],
+ 'DeleteIntermediateResults' => ['description' => 'Specifies whether to delete intermediate files.', 'type' => 'boolean', 'example' => 'True', 'title' => '', 'required' => false],
+ 'FailureMode' => ['description' => 'The failure mode.', 'type' => 'string', 'example' => 'NoNewCalls', 'title' => '', 'required' => false],
+ 'UseRelativeOutputPaths' => ['description' => 'Specifies whether to use relative output paths.', 'type' => 'boolean', 'example' => 'True', 'title' => '', 'required' => false],
+ 'DataLoader' => [
'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'RegionId' => [
- 'title' => '区域名',
+ 'example' => 'Mount',
+ 'enum' => ['Mount', 'Download'],
'description' => '',
- 'type' => 'string',
- 'example' => 'cn-beijing',
+ 'required' => false,
+ 'title' => '',
],
],
+ 'required' => false,
+ 'example' => '{ "CallCaching": true, "FailureMode": "NoNewCalls" }',
],
],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ [
+ 'name' => 'ExecuteDirectory',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task execution directory.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'oss://my-bucket/exec/', 'title' => ''],
],
- 404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ [
+ 'name' => 'Role',
+ 'in' => 'query',
+ 'schema' => ['description' => 'An optional custom Resource Access Management (RAM) role. During task execution, this role is assumed to access your resources, such as Object Storage Service (OSS) and Container Registry (ACR). If you do not specify this parameter, the default role aliyuneasygenedefaultrole is used.', 'type' => 'string', 'example' => 'TestRole', 'required' => false, 'title' => ''],
],
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"AppName\\": \\"InstalledApp\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n}","type":"json"}]',
- 'title' => 'ImportApp',
- ],
- 'DeleteApp' => [
- 'summary' => '删除应用',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'OutputFolder',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The directory where task outputs are copied.', 'type' => 'string', 'example' => 'oss://my-bucket/output/', 'title' => '', 'required' => false],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
- 'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'DefaultRuntime',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestWorkspace',
- ],
+ 'schema' => ['description' => 'The default runtime.', 'type' => 'string', 'example' => '{}', 'title' => '', 'required' => false],
],
[
- 'name' => 'AppName',
+ 'name' => 'Inputs',
'in' => 'query',
- 'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestApp',
- ],
+ 'schema' => ['description' => 'The task inputs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }', 'title' => ''],
],
[
- 'name' => 'Revision',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The idempotence token for the task.', 'type' => 'string', 'required' => false, 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'Workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'RunId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAppResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</DeleteAppResponse>","errorExample":""}]',
- 'title' => 'DeleteApp',
- ],
- 'GetApp' => [
- 'summary' => '查询应用详情',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RunId\\": \\"run-13BeYuxc0fxO24uA75UppTiMRoQ\\"\\n}","type":"json"}]',
+ 'title' => 'Create Run Job',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-10T09:33:17.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2024-01-12T05:28:02.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2022-11-18T03:29:59.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRun'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateRun',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateSubmission' => [
+ 'summary' => 'Create a submission to generate tasks in batches.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestWorkspace',
- ],
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestApp',
- ],
+ 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestApp', 'title' => ''],
],
[
'name' => 'Revision',
'in' => 'query',
- 'schema' => [
- 'title' => '应用版本号',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => 'The version number of the application.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1', 'title' => ''],
],
[
'name' => 'RevisionTag',
'in' => 'query',
+ 'schema' => ['title' => 'Unique label of the Application Version', 'description' => 'The unique tag for the application version.', 'type' => 'string', 'example' => 'ProduceVersion', 'required' => false],
+ ],
+ [
+ 'name' => 'EntityType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The entity type.', 'type' => 'string', 'required' => true, 'example' => 'TestEntityType', 'title' => ''],
+ ],
+ [
+ 'name' => 'EntityNames',
+ 'in' => 'query',
+ 'allowEmptyValue' => true,
+ 'style' => 'json',
'schema' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'TestTag',
+ 'description' => 'A list of entity names for the submission tasks.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The entity name.', 'type' => 'string', 'required' => false, 'example' => '[“S0001”, “S0002”]', 'title' => ''],
+ 'required' => false,
+ 'example' => 'TestEntityType',
+ 'title' => '',
],
],
+ [
+ 'name' => 'ExecuteOptions',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task configuration.', 'type' => 'string', 'required' => false, 'example' => '{ "CallCaching": false, "DeleteIntermediateResults": true, "FailureMode": "NoNewCalls" }', 'title' => ''],
+ ],
+ [
+ 'name' => 'ExecuteDirectory',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The directory where the task is executed.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'oss://my-bucket/my-exe-dir/', 'title' => ''],
+ ],
+ [
+ 'name' => 'OutputFolder',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The directory to which the task output is copied.', 'type' => 'string', 'example' => 'oss://my-bucket/my-output-dir/', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'DefaultRuntime',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The default runtime environment.', 'type' => 'string', 'example' => '{}', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'Inputs',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task inputs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => '{}'],
+ ],
+ [
+ 'name' => 'Outputs',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The task outputs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{}'],
+ ],
+ [
+ 'name' => 'ClientToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The idempotence token for the request.', 'type' => 'string', 'required' => false, 'example' => 'TestToken', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '应用详情',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'WorkflowName' => [
- 'title' => '工作流名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MyTestWorkflow',
- ],
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MyTestApp',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'Definition' => [
- 'title' => '应用定义',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'WDL content',
- ],
- 'Description' => [
- 'title' => '应用简要描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is a test app',
- ],
- 'Documentation' => [
- 'title' => '应用详细文档',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'example documentation content',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'Inputs' => [
- 'title' => '应用输入',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestTaskName',
- ],
- 'VariableName' => [
- 'title' => '变量名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestVariableName',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestVariableType',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestVariableValue',
- ],
- 'Required' => [
- 'title' => '是否必须',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Help' => [
- 'title' => '帮助',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'help information',
- ],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'Labels' => [
- 'title' => '应用标签',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'test',
- 'description' => '',
- ],
- ],
- 'Language' => [
- 'title' => '应用描述语言',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'WDL',
- ],
- 'LanguageVersion' => [
- 'title' => '应用描述语言版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'LastModifiedTime' => [
- 'title' => '应用最后修改时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'Outputs' => [
- 'title' => '应用的输出参数',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestTaskName',
- ],
- 'VariableName' => [
- 'title' => '参数名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestVariableName',
- ],
- 'VariableType' => [
- 'title' => '参数类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Int',
- ],
- 'VariableValue' => [
- 'title' => '参数值',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ExampleValue',
- ],
- 'Required' => [
- 'title' => '是否必须',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Example help information',
- ],
- 'StepOrder' => [
- 'title' => '步骤编号',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Revision' => [
- 'title' => '应用版本号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RevisionTag' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'TestTag',
- ],
- 'RevisionComment' => [
- 'title' => '应用当前版本修改',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Example revision comment',
- ],
- 'Revisions' => [
- 'title' => '应用的所有版本号',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'Revision' => [
- 'title' => '版本号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RevisionComment' => [
- 'title' => '应用当前版本修改',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Example revision comment',
- ],
- 'RevisionTag' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'ProduceVersion',
- ],
- ],
- ],
- ],
- 'Scope' => [
- 'title' => '应用可见范围',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Public',
- ],
- 'URL' => [
- 'title' => '应用URL',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Example url',
- ],
- 'Workspace' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'Source' => [
- 'title' => '应用来源',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EasyGene',
- ],
- 'AppType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'App',
- ],
- 'Dependencies' => [
- 'title' => '依赖应用',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Path' => [
- 'title' => '依赖路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => './task/echo.wdl',
- ],
- 'Content' => [
- 'title' => 'wdl内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task echo { String txt_out = "default_txt_out" String dd_out = "default_dd_out" command { echo Hello > ${txt_out} /bin/bash -c "dd if=/dev/zero of=${dd_out} bs=1M count=15" echo "This is a test std out." } runtime { cpu: "2" memory: "4G" autoReleaseJob: false reserveOnFail: true userData: "key1 value1" disks: "local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency" tag: "TestTag" } output { File outTxtFile = "${txt_out}" File outDdFile = "${dd_out}" } }',
- ],
- ],
- ],
- ],
- 'Configs' => [
- 'title' => '参考输入',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Path' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => './config/example.json',
- ],
- 'Content' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '{ "wgs.apply_bqsr.cpu": 4, "wgs.apply_bqsr.disks": "local-disk 250 cloud_ssd", "wgs.apply_bqsr.gatk_Launcher": "/usr/local/bin/gatk-4.1.4.1/gatk", "wgs.apply_bqsr.java_opts": "\'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt\'", "wgs.apply_bqsr.memory": "8G"}',
- ],
- ],
- ],
- ],
- 'Path' => [
- 'title' => '主WDL路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'main.wdl',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'Workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'SubmissionId' => ['description' => 'The submission ID.', 'type' => 'string', 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource %s is not found.',
- ],
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"WorkflowName\\": \\"MyTestWorkflow\\",\\n \\"AppName\\": \\"MyTestApp\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Definition\\": \\"WDL content\\",\\n \\"Description\\": \\"This is a test app\\",\\n \\"Documentation\\": \\"example documentation content\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Inputs\\": [\\n {\\n \\"TaskName\\": \\"TestTaskName\\",\\n \\"VariableName\\": \\"TestVariableName\\",\\n \\"VariableType\\": \\"TestVariableType\\",\\n \\"VariableValue\\": \\"TestVariableValue\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"help information\\",\\n \\"StepOrder\\": 1\\n }\\n ],\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"Language\\": \\"WDL\\",\\n \\"LanguageVersion\\": \\"1.0\\",\\n \\"LastModifiedTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Outputs\\": [\\n {\\n \\"TaskName\\": \\"TestTaskName\\",\\n \\"VariableName\\": \\"TestVariableName\\",\\n \\"VariableType\\": \\"Int\\",\\n \\"VariableValue\\": \\"ExampleValue\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"Example help information\\",\\n \\"StepOrder\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Revision\\": \\"1\\",\\n \\"RevisionTag\\": \\"TestTag\\",\\n \\"RevisionComment\\": \\"Example revision comment\\",\\n \\"Revisions\\": [\\n {\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Revision\\": \\"1\\",\\n \\"RevisionComment\\": \\"Example revision comment\\",\\n \\"RevisionTag\\": \\"ProduceVersion\\"\\n }\\n ],\\n \\"Scope\\": \\"Public\\",\\n \\"URL\\": \\"Example url\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"AppType\\": \\"App\\",\\n \\"Dependencies\\": [\\n {\\n \\"Path\\": \\"./task/echo.wdl\\",\\n \\"Content\\": \\"task echo { String txt_out = \\\\\\"default_txt_out\\\\\\" String dd_out = \\\\\\"default_dd_out\\\\\\" command { echo Hello > ${txt_out} /bin/bash -c \\\\\\"dd if=/dev/zero of=${dd_out} bs=1M count=15\\\\\\" echo \\\\\\"This is a test std out.\\\\\\" } runtime { cpu: \\\\\\"2\\\\\\" memory: \\\\\\"4G\\\\\\" autoReleaseJob: false reserveOnFail: true userData: \\\\\\"key1 value1\\\\\\" disks: \\\\\\"local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency\\\\\\" tag: \\\\\\"TestTag\\\\\\" } output { File outTxtFile = \\\\\\"${txt_out}\\\\\\" File outDdFile = \\\\\\"${dd_out}\\\\\\" } }\\"\\n }\\n ],\\n \\"Configs\\": [\\n {\\n \\"Path\\": \\"./config/example.json\\",\\n \\"Content\\": \\"{ \\\\\\"wgs.apply_bqsr.cpu\\\\\\": 4, \\\\\\"wgs.apply_bqsr.disks\\\\\\": \\\\\\"local-disk 250 cloud_ssd\\\\\\", \\\\\\"wgs.apply_bqsr.gatk_Launcher\\\\\\": \\\\\\"/usr/local/bin/gatk-4.1.4.1/gatk\\\\\\", \\\\\\"wgs.apply_bqsr.java_opts\\\\\\": \\\\\\"\'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt\'\\\\\\", \\\\\\"wgs.apply_bqsr.memory\\\\\\": \\\\\\"8G\\\\\\"}\\"\\n }\\n ],\\n \\"Path\\": \\"main.wdl\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAppResponse>\\n <WorkflowName>MyTestWorkflow</WorkflowName>\\n <AppName>MyTestApp</AppName>\\n <CreateTime>2021-06-16T15:09:14.378297+08:00</CreateTime>\\n <Definition>WDL content</Definition>\\n <Description>This is a test app</Description>\\n <Documentation>example documentation content</Documentation>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <Inputs>\\n <TaskName>TestTaskName</TaskName>\\n <VariableName>TestVariableName</VariableName>\\n <VariableType>TestVariableType</VariableType>\\n <VariableValue>TestVariableValue</VariableValue>\\n <Required>true</Required>\\n <Help>help information</Help>\\n <StepOrder>1</StepOrder>\\n </Inputs>\\n <Labels>\\n <key>test</key>\\n </Labels>\\n <Language>WDL</Language>\\n <LanguageVersion>1.0</LanguageVersion>\\n <LastModifiedTime>2021-06-16T15:09:14.378297+08:00</LastModifiedTime>\\n <Outputs>\\n <TaskName>TestTaskName</TaskName>\\n <VariableName>TestVariableName</VariableName>\\n <VariableType>Int</VariableType>\\n <VariableValue>ExampleValue</VariableValue>\\n <Required>true</Required>\\n <Help>Example help information</Help>\\n <StepOrder>1</StepOrder>\\n </Outputs>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Revision>1</Revision>\\n <RevisionComment>Example revision comment</RevisionComment>\\n <Revisions>\\n <CreateTime>2021-06-16T15:09:14.378297+08:00</CreateTime>\\n <Revision>1</Revision>\\n <RevisionComment>Example revision comment</RevisionComment>\\n </Revisions>\\n <Scope>Public</Scope>\\n <URL>Example url</URL>\\n <Workspace>TestWorkspace</Workspace>\\n <Source>EasyGene</Source>\\n <Namespace>TestNamespace</Namespace>\\n <AppOrigName>TestAppOrigName</AppOrigName>\\n <AppType>App</AppType>\\n <Dependencies>\\n <Path>./task/echo.wdl</Path>\\n <Content>task echo { String txt_out = \\"default_txt_out\\" String dd_out = \\"default_dd_out\\" command { echo Hello &gt; ${txt_out} /bin/bash -c \\"dd if=/dev/zero of=${dd_out} bs=1M count=15\\" echo \\"This is a test std out.\\" } runtime { cpu: \\"2\\" memory: \\"4G\\" autoReleaseJob: false reserveOnFail: true userData: \\"key1 value1\\" disks: \\"local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency\\" tag: \\"TestTag\\" } output { File outTxtFile = \\"${txt_out}\\" File outDdFile = \\"${dd_out}\\" } }</Content>\\n </Dependencies>\\n <Configs>\\n <Path>./config/example.json</Path>\\n <Content>{ \\"wgs.apply_bqsr.cpu\\": 4, \\"wgs.apply_bqsr.disks\\": \\"local-disk 250 cloud_ssd\\", \\"wgs.apply_bqsr.gatk_Launcher\\": \\"/usr/local/bin/gatk-4.1.4.1/gatk\\", \\"wgs.apply_bqsr.java_opts\\": \\"\'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt\'\\", \\"wgs.apply_bqsr.memory\\": \\"8G\\"}</Content>\\n </Configs>\\n <Path>main.wdl</Path>\\n</GetAppResponse>","errorExample":""}]',
- ],
- 'ListApps' => [
- 'summary' => '列出应用',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\"\\n}","type":"json"}]',
+ 'title' => 'Create Delivery',
+ 'changeSet' => [
+ ['createdAt' => '2024-01-12T05:28:02.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSubmission'],
+ ],
+ ],
+ ],
+ 'CreateTemplate' => [
+ 'summary' => 'Creates an application template in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestWorkspace',
- ],
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'TemplateName',
'in' => 'query',
- 'schema' => [
- 'title' => 'Next Token',
- 'description' => 'Next Token',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestToken',
- ],
+ 'schema' => ['description' => 'The application template name.', 'type' => 'string', 'required' => true, 'example' => 'test-template', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '5',
- ],
+ 'schema' => ['description' => 'The description of the application template.', 'type' => 'string', 'example' => 'This is a test template', 'title' => '', 'required' => false],
],
[
- 'name' => 'OrderBy',
+ 'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'title' => '排序依据',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createtime',
- ],
+ 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'MyApp', 'title' => ''],
],
[
- 'name' => 'IsReversed',
+ 'name' => 'AppRevision',
'in' => 'query',
- 'schema' => [
- 'title' => '是否逆序',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The application version.', 'type' => 'string', 'required' => false, 'example' => '4.1.4.1-v1.0', 'title' => ''],
],
[
- 'name' => 'LabelSelector',
+ 'name' => 'RevisionTag',
'in' => 'query',
- 'schema' => [
- 'title' => 'Label 选择器',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'env=test',
- ],
+ 'schema' => ['title' => 'Unique tag of the Application Version ', 'description' => 'The unique tag for the application version.', 'type' => 'string', 'example' => 'ProduceVersion', 'required' => false],
],
[
- 'name' => 'Scope',
+ 'name' => 'RootEntity',
'in' => 'query',
+ 'schema' => ['description' => 'The root entity type.', 'type' => 'string', 'example' => 'TestEntity', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'InputsExpression',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '应用范围',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Public',
+ 'title' => '',
+ 'description' => 'The expression of the application.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The input expressions for the application.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'example' => 'Task1', 'title' => ''],
+ 'VariableName' => ['description' => 'The variable name.', 'type' => 'string', 'required' => true, 'example' => 'fastq1', 'title' => ''],
+ 'VariableType' => ['description' => 'The variable type.', 'type' => 'string', 'required' => true, 'example' => 'File', 'title' => ''],
+ 'VariableValue' => ['description' => 'The variable value.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/file1.fastq', 'title' => ''],
+ 'Required' => ['description' => 'Specifies whether the parameter is required.'."\n"
+ ."\n"
+ .'- true: The parameter is required.'."\n"
+ ."\n"
+ .'- false: The parameter is not required.'."\n"
+ ."\n"
+ .'> This parameter is ignored in the response.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''],
+ 'Help' => ['description' => 'The help information.', 'type' => 'string', 'example' => 'test help', 'title' => '', 'required' => false],
+ 'StepOrder' => ['description' => 'The step order.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'example' => 'TestEntity',
],
],
[
- 'name' => 'Language',
- 'in' => 'query',
+ 'name' => 'OutputsExpression',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '应用描述语言',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'WDL',
+ 'title' => '',
+ 'description' => 'Response parameters for the (application)',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The application outputs.',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'required' => true, 'example' => 'Task1', 'title' => ''],
+ 'VariableName' => ['description' => 'The variable name.', 'type' => 'string', 'required' => true, 'example' => 'bam', 'title' => ''],
+ 'VariableType' => ['description' => 'The variable type.', 'type' => 'string', 'required' => true, 'example' => 'File', 'title' => ''],
+ 'VariableValue' => ['description' => 'The variable value.', 'type' => 'string', 'required' => true, 'example' => 'oss://bucket/file.bam', 'title' => ''],
+ 'Required' => ['description' => 'Specifies whether the parameter is required.'."\n"
+ ."\n"
+ .'- true: The parameter is required.'."\n"
+ ."\n"
+ .'- false: The parameter is not required.'."\n"
+ ."\n"
+ .'The default value is true.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''],
+ 'Help' => ['description' => 'The help information.', 'type' => 'string', 'example' => 'Output alignment results', 'title' => '', 'required' => false],
+ 'StepOrder' => ['description' => 'The step order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'example' => '',
],
],
[
- 'name' => 'AppType',
+ 'name' => 'Labels',
'in' => 'query',
- 'schema' => [
- 'title' => '应用类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'App',
- ],
+ 'schema' => ['description' => 'The application labels.', 'type' => 'string', 'example' => '{"key1": "value1"}', 'title' => '', 'required' => false],
],
[
- 'name' => 'Search',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'title' => '按照名字匹配',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestName',
- ],
+ 'schema' => ['description' => 'The idempotence token.', 'type' => 'string', 'example' => 'GFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response returned after you create the application template.',
'type' => 'object',
'properties' => [
- 'Apps' => [
- 'title' => '应用数组',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestApp',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'Description' => [
- 'title' => '应用描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is a test app',
- ],
- 'AppType' => [
- 'title' => '应用类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'App',
- ],
- 'Language' => [
- 'title' => '应用描述语言',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'WDL',
- ],
- 'Scope' => [
- 'title' => '应用可见范围',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Public',
- ],
- 'Workspace' => [
- 'title' => '应用所在工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'Source' => [
- 'title' => '应用来源',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EasyGene',
- ],
- 'AppDefaultVersion' => [
- 'title' => '默认版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'Labels' => [
- 'title' => '标签',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'test',
- 'description' => '',
- ],
- ],
- ],
- ],
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'MaxResults' => [
- 'title' => '最大返回个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'NextToken' => [
- 'title' => 'Next Token',
- 'description' => 'Next Token',
- 'type' => 'string',
- 'example' => 'TestToken',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'TotalCount' => [
- 'title' => '返回个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
+ 'Workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'TemplateName' => ['description' => 'The application template name.', 'type' => 'string', 'example' => 'test-template', 'title' => ''],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Apps\\": [\\n {\\n \\"AppName\\": \\"TestApp\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"Description\\": \\"This is a test app\\",\\n \\"AppType\\": \\"App\\",\\n \\"Language\\": \\"WDL\\",\\n \\"Scope\\": \\"Public\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"AppDefaultVersion\\": \\"v1\\",\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n }\\n }\\n ],\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 5,\\n \\"NextToken\\": \\"TestToken\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"TotalCount\\": 5\\n}","errorExample":""},{"type":"xml","example":"<ListAppsResponse>\\n <Apps>\\n <AppName>TestApp</AppName>\\n <CreateTime>2021-06-10T13:30:20.414557061Z</CreateTime>\\n <Description>This is a test app</Description>\\n <AppType>App</AppType>\\n <Language>WDL</Language>\\n <Scope>Public</Scope>\\n <Workspace>TestWorkspace</Workspace>\\n <Source>EasyGene</Source>\\n <Namespace>TestNamespace</Namespace>\\n <AppOrigName>TestOrigName</AppOrigName>\\n <AppDefaultVersion>v1</AppDefaultVersion>\\n <Labels>\\n <key>test</key>\\n </Labels>\\n </Apps>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <MaxResults>5</MaxResults>\\n <NextToken>TestToken</NextToken>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <TotalCount>5</TotalCount>\\n</ListAppsResponse>","errorExample":""}]',
- 'title' => 'ListApps',
- ],
- 'CreateRun' => [
- 'summary' => '创建任务',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"TemplateName\\": \\"test-template\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Create Application Template',
+ 'changeSet' => [
+ ['createdAt' => '2024-01-12T05:28:02.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:41.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/*'],
+ ],
+ ],
+ ],
+ ],
+ 'translator' => 'machine',
+ ],
+ 'CreateWorkspace' => [
+ 'summary' => 'Creates a workspace for a user.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2216,1366 +1058,610 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'none'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名字',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'RunName',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'wgs_sentieon_hc_with_qc_NGPTS1900029301',
- ],
+ 'schema' => ['description' => 'Workspace description', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'This is a test workspace', 'title' => ''],
],
[
- 'name' => 'AppName',
+ 'name' => 'ClientToken',
'in' => 'query',
- 'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'Sentieon',
- ],
+ 'schema' => ['description' => 'Idempotency token', 'type' => 'string', 'required' => false, 'example' => 'TestToken', 'title' => ''],
],
[
- 'name' => 'AppRevision',
+ 'name' => 'Storage',
'in' => 'query',
- 'schema' => [
- 'title' => '应用版本号',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '16',
- ],
+ 'schema' => ['description' => 'OSS path for the workspace', 'type' => 'string', 'required' => true, 'example' => 'oss://gstor-default-workspace-cn-shanghai-bae3193d/', 'title' => ''],
],
[
- 'name' => 'RevisionTag',
+ 'name' => 'JobLifecycle',
'in' => 'query',
- 'schema' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'ProduceVersion',
- ],
+ 'schema' => ['description' => 'Task lifecycle for the workspace, in days', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => '', 'required' => false],
],
[
- 'name' => 'Description',
+ 'name' => 'Role',
'in' => 'query',
- 'schema' => [
- 'title' => '任务描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test run',
- ],
+ 'schema' => ['description' => 'RAM role for the workspace', 'type' => 'string', 'example' => 'TestRole', 'title' => '', 'required' => false],
],
[
'name' => 'Labels',
'in' => 'query',
- 'schema' => [
- 'title' => '任务标签',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"env": "test"}',
- ],
+ 'schema' => ['description' => 'Workspace labels', 'type' => 'string', 'example' => '{"key":"value"}', 'title' => '', 'required' => false],
],
- [
- 'name' => 'ExecuteOptions',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '任务配置',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'CallCaching' => [
- 'title' => '使用缓存',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'True',
- ],
- 'DeleteIntermediateResults' => [
- 'title' => '删除中间结果',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'True',
- ],
- 'FailureMode' => [
- 'title' => '失败模式',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'NoNewCalls',
- ],
- 'UseRelativeOutputPaths' => [
- 'title' => '使用相对输出路径',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'True',
- ],
- 'DataLoader' => [
- 'type' => 'string',
- 'example' => 'Mount',
- 'enum' => [
- 'Mount',
- 'Download',
- ],
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Workspace' => ['description' => 'Name of the created workspace', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
],
- 'required' => false,
- 'example' => '{ "CallCaching": true, "FailureMode": "NoNewCalls" }',
- ],
- ],
- [
- 'name' => 'ExecuteDirectory',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务执行目录',
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'oss://my-bucket/exec/',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"TestWorkspace\\"\\n}","type":"json"}]',
+ 'title' => 'Create Workspace',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspace'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Role',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestRole',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'DeleteApp' => [
+ 'summary' => 'Delete applications that you no longer need.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'OutputFolder',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务输出拷贝目录',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://my-bucket/output/',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
[
- 'name' => 'DefaultRuntime',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '默认运行时',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'Inputs',
+ 'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'title' => '任务输入',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }',
- ],
+ 'schema' => ['description' => 'Application name', 'type' => 'string', 'required' => true, 'example' => 'TestApp', 'title' => ''],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Revision',
'in' => 'query',
- 'schema' => [
- 'title' => '任务幂等token',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
+ 'schema' => ['description' => 'Application version', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'RunId' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ',
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RunId\\": \\"run-13BeYuxc0fxO24uA75UppTiMRoQ\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRunResponse>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <Workspace>test-workspace</Workspace>\\n <RunId>run-13BeYuxc0fxO24uA75UppTiMRoQ</RunId>\\n</CreateRunResponse>","errorExample":""}]',
- ],
- 'GetRun' => [
- 'summary' => '获取任务详情',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Application ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/{#AppName}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'],
+ ],
],
+ ],
+ 'DeleteEntity' => [
+ 'summary' => 'Deletes a specific entity table from a workspace.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名字',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'default-workspace',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default-workspace', 'title' => ''],
],
[
- 'name' => 'RunId',
+ 'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'run-12kDbbqp5O9dfsH0sEdQeRclGQb',
- ],
+ 'schema' => ['description' => 'The entity type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sample', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'Workspace' => [
- 'title' => '工作空间名字',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'RunId' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ',
- ],
- 'RunName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-run',
- ],
- 'SubmissionId' => [
- 'title' => '提交ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
- 'Source' => [
- 'title' => '应用来源',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EasyGene',
- ],
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Sentieon',
- ],
- 'AppRevision' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
- 'EntityName' => [
- 'title' => '实体对象名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 's1',
- ],
- 'User' => [
- 'title' => '用户ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => '13579222',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'CreateTime' => [
- 'title' => '提交时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:24.414557061Z',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:36:20.405878292Z',
- ],
- 'ExecuteOptions' => [
- 'title' => '任务配置',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CallCaching' => [
- 'title' => '是否开启CallCaching',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DeleteIntermediateResults' => [
- 'title' => '是否删除中间文件',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'FailureMode' => [
- 'title' => '失败模式',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NoNewCalls',
- ],
- 'UseRelativeOutputPaths' => [
- 'title' => '相对输出路径',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DataLoader' => [
- 'type' => 'string',
- ],
- ],
- ],
- 'Inputs' => [
- 'title' => '任务输入',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }',
- ],
- 'Outputs' => [
- 'title' => '任务输出',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{ "workflow1.bam": "oss://my-bucket/test.bam", "workflow1.vcf": "oss://my-bucket/test.vcf" }',
- ],
- 'Labels' => [
- 'title' => '任务标签',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'test',
- 'description' => '',
- ],
- ],
- 'OutputFolder' => [
- 'title' => '输出拷贝目录',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://my-bucket/output/',
- ],
- 'ExecuteDirectory' => [
- 'title' => '任务执行目录',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://my-bucket/exec/',
- ],
- 'DefaultRuntime' => [
- 'title' => '默认runtime值',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Description' => [
- 'title' => '任务描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test run',
- ],
- 'Timing' => [
- 'title' => '时序信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Calls' => [
- 'title' => '作业信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Failures' => [
- 'title' => '错误信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'BillingInstanceIds' => [
- 'title' => '任务task账单ID数组',
- 'type' => 'array',
- 'items' => [
- 'title' => '任务task账单ID',
- 'type' => 'string',
- ],
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource %s is not found.', 'description' => 'The specified resource %s is not found.'],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Entity Table',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RunId\\": \\"run-13BeYuxc0fxO24uA75UppTiMRoQ\\",\\n \\"RunName\\": \\"test-run\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"AppName\\": \\"Sentieon\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"EntityName\\": \\"s1\\",\\n \\"User\\": \\"13579222\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"StartTime\\": \\"2021-06-10T13:30:24.414557061Z\\",\\n \\"EndTime\\": \\"2021-06-10T13:36:20.405878292Z\\",\\n \\"ExecuteOptions\\": {\\n \\"CallCaching\\": false,\\n \\"DeleteIntermediateResults\\": false,\\n \\"FailureMode\\": \\"NoNewCalls\\",\\n \\"UseRelativeOutputPaths\\": false,\\n \\"DataLoader\\": \\"Mount\\"\\n },\\n \\"Inputs\\": \\"{ \\\\\\"workflow1.task1.param1\\\\\\": \\\\\\"helloooo.txt\\\\\\", \\\\\\"workflow1.task1.param2\\\\\\": \\\\\\"abc\\\\\\", \\\\\\"workflow1.task2.param1\\\\\\": \\\\\\"new_helloooo.txt\\\\\\", \\\\\\"workflow1.task2.param2\\\\\\": \\\\\\"def\\\\\\" }\\",\\n \\"Outputs\\": \\"{ \\\\\\"workflow1.bam\\\\\\": \\\\\\"oss://my-bucket/test.bam\\\\\\", \\\\\\"workflow1.vcf\\\\\\": \\\\\\"oss://my-bucket/test.vcf\\\\\\" }\\",\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"OutputFolder\\": \\"oss://my-bucket/output/\\",\\n \\"ExecuteDirectory\\": \\"oss://my-bucket/exec/\\",\\n \\"DefaultRuntime\\": \\"{}\\",\\n \\"Description\\": \\"test run\\",\\n \\"Timing\\": \\"{}\\",\\n \\"Calls\\": \\"{}\\",\\n \\"Failures\\": \\"{}\\",\\n \\"BillingInstanceIds\\": [\\n \\"test_workflow.test_run;-1;1\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetRunResponse>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <Workspace>test-workspace</Workspace>\\n <RunId>run-13BeYuxc0fxO24uA75UppTiMRoQ</RunId>\\n <Name>test-run</Name>\\n <SubmissionId>sub-13BeXWnGvrOl3MC124tazcJVKaV</SubmissionId>\\n <Source>EasyGene</Source>\\n <Namespace>public</Namespace>\\n <AppOrigName>Sentieon</AppOrigName>\\n <AppName>Sentieon</AppName>\\n <Revision>1</Revision>\\n <EntityType>sample</EntityType>\\n <EntityName>s1</EntityName>\\n <User>13579222</User>\\n <Status>Running</Status>\\n <CreateTime>2021-06-10T13:30:20.414557061Z</CreateTime>\\n <StartTime>2021-06-10T13:30:24.414557061Z</StartTime>\\n <EndTime>2021-06-10T13:36:20.405878292Z</EndTime>\\n <ExecuteOptions>\\n <CallCaching>false</CallCaching>\\n <DeleteIntermediateResults>false</DeleteIntermediateResults>\\n <FailureMode>NoNewCalls</FailureMode>\\n </ExecuteOptions>\\n <Inputs>{ \\"workflow1.task1.param1\\": \\"helloooo.txt\\", \\"workflow1.task1.param2\\": \\"abc\\", \\"workflow1.task2.param1\\": \\"new_helloooo.txt\\", \\"workflow1.task2.param2\\": \\"def\\" }</Inputs>\\n <Outputs>{ \\"workflow1.bam\\": \\"oss://my-bucket/test.bam\\", \\"workflow1.vcf\\": \\"oss://my-bucket/test.vcf\\" }</Outputs>\\n <OutputFolder>oss://my-bucket/output/</OutputFolder>\\n <ExecuteDirectory>oss://my-bucket/exec/</ExecuteDirectory>\\n <DefaultRuntime>{}</DefaultRuntime>\\n <Description>test run</Description>\\n <Timing>{}</Timing>\\n <Calls>{}</Calls>\\n <Failures>{}</Failures>\\n</GetRunResponse>","errorExample":""}]',
- 'title' => 'GetRun',
],
- 'DeleteRun' => [
- 'summary' => '删除任务',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteEntityItems' => [
+ 'summary' => 'Deletes data from a specific entity table in a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'RunId',
+ 'name' => 'EntityType',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The entity type.', 'type' => 'string', 'required' => true, 'example' => 'sample', 'title' => ''],
+ ],
+ [
+ 'name' => 'EntityNames',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
+ 'description' => 'An array of the names of the elements to delete.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The element to delete.', 'type' => 'string', 'required' => false, 'example' => 's1', 'title' => ''],
'required' => true,
- 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果',
- 'description' => '',
+ 'description' => 'The response data.',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
- 409 => [
- [
- 'errorCode' => 'StatusConflict',
- 'errorMessage' => 'The specified action %s is not supported in current status %s.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Delete entity table data',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteEntityItems',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRunResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</DeleteRunResponse>","errorExample":""}]',
- 'title' => 'DeleteRun',
- ],
- 'ListRuns' => [
- 'summary' => '列出任务',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEntityItems'],
+ ],
],
+ ],
+ 'DeleteRun' => [
+ 'summary' => 'Delete a specific run record in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'query',
- 'schema' => [
- 'title' => '状态',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Running',
- 'enum' => [
- 'Running',
- 'Submitted',
- 'Pending',
- 'Failed',
- 'Succeeded',
- 'Aborting',
- 'Aborted',
- ],
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'SubmissionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '提交ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
- ],
- [
- 'name' => 'Search',
- 'in' => 'query',
- 'schema' => [
- 'title' => '搜索ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ',
- ],
- ],
- [
- 'name' => 'LabelSelector',
+ 'name' => 'RunId',
'in' => 'query',
- 'schema' => [
- 'title' => '标签选择',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'env=test',
- ],
+ 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ', 'title' => ''],
],
- [
- 'name' => 'AppName',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MyApp',
+ 'title' => '',
+ 'description' => 'Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ ],
+ 'example' => '',
],
],
- [
- 'name' => 'AppRevision',
- 'in' => 'query',
- 'schema' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4.1.4.1-v1.0',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
- [
- 'name' => 'EntityType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sample',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
- [
- 'name' => 'EntityName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实体名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'S001',
- ],
+ 409 => [
+ ['errorCode' => 'StatusConflict', 'errorMessage' => 'The specified action %s is not supported in current status %s.', 'description' => ''],
],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'title' => '查询起始位置',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Run Job',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:40.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteRun',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/{#RunId}'],
+ ],
],
],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'title' => '最大返回个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRun'],
],
+ ],
+ ],
+ 'DeleteSubmission' => [
+ 'summary' => 'Deletes a specific delivery task record in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'OrderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序依据',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createtime',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete'],
+ 'parameters' => [
[
- 'name' => 'IsReversed',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '是否逆序',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'GetTotal',
+ 'name' => 'SubmissionId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否返回所有任务条数',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Submission ID', 'type' => 'string', 'required' => true, 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'title' => '下次查询Token',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
- 'TotalCount' => [
- 'title' => '返回个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Runs' => [
- 'title' => '任务列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MyApp',
- ],
- 'Source' => [
- 'title' => '应用来源',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EasyGene',
- ],
- 'Labels' => [
- 'title' => '任务标签',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '',
- 'example' => 'test',
- ],
- ],
- 'RunName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-run',
- ],
- 'AppRevision' => [
- 'title' => '应用版本号',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RunId' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'CreateTime' => [
- 'title' => '提交时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:31:20.414557061Z',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:38:20.414557061Z',
- ],
- 'SubmissionId' => [
- 'title' => '提交ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
- 'EntityName' => [
- 'title' => '实体名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 's1',
- ],
- 'EntityType' => [
- 'title' => '实体对象ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
- 'ExecuteDirectory' => [
- 'title' => '运行目录',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://my-bucket/my-execdir/',
- ],
- 'ExecuteOptions' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'CallCaching' => [
- 'title' => '是否开启CallCaching',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'DeleteIntermediateResults' => [
- 'title' => '是否删除中间文件',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'FailureMode' => [
- 'title' => '失败模式',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NoNewCalls',
- ],
- 'UseRelativeOutputPaths' => [
- 'title' => '使用相对路径',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- 'Inputs' => [
- 'title' => '输入参数',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }',
- ],
- 'DefaultRuntime' => [
- 'title' => '默认运行时',
- 'description' => '',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'RegionId' => [
- 'title' => '区域',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
- ],
- ],
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ 409 => [
+ ['errorCode' => 'StatusConflict', 'errorMessage' => 'The specified action %s is not supported in current status %s.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"TotalCount\\": 10,\\n \\"Runs\\": [\\n {\\n \\"AppName\\": \\"MyApp\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"RunName\\": \\"test-run\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"RunId\\": \\"run-13BeYuxc0fxO24uA75UppTiMRoQ\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"StartTime\\": \\"2021-06-10T13:31:20.414557061Z\\",\\n \\"EndTime\\": \\"2021-06-10T13:38:20.414557061Z\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"EntityName\\": \\"s1\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"ExecuteDirectory\\": \\"oss://my-bucket/my-execdir/\\",\\n \\"ExecuteOptions\\": {\\n \\"CallCaching\\": false,\\n \\"DeleteIntermediateResults\\": false,\\n \\"FailureMode\\": \\"NoNewCalls\\",\\n \\"UseRelativeOutputPaths\\": false\\n },\\n \\"Inputs\\": \\"{ \\\\\\"workflow1.task1.param1\\\\\\": \\\\\\"helloooo.txt\\\\\\", \\\\\\"workflow1.task1.param2\\\\\\": \\\\\\"abc\\\\\\", \\\\\\"workflow1.task2.param1\\\\\\": \\\\\\"new_helloooo.txt\\\\\\", \\\\\\"workflow1.task2.param2\\\\\\": \\\\\\"def\\\\\\" }\\",\\n \\"DefaultRuntime\\": \\"{}\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRunsResponse>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <MaxResults>10</MaxResults>\\n <NextToken>MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK</NextToken>\\n <TotalCount>10</TotalCount>\\n <Runs>\\n <AppName>MyApp</AppName>\\n <Source>EasyGene</Source>\\n <Namespace>Public</Namespace>\\n <AppOrigName>PublicApp</AppOrigName>\\n <Labels>\\n <key>test</key>\\n </Labels>\\n <Name>test-run</Name>\\n <Revision>1</Revision>\\n <RunId>run-13BeYuxc0fxO24uA75UppTiMRoQ</RunId>\\n <Status>Running</Status>\\n <CreateTime>2021-06-10T13:30:20.414557061Z</CreateTime>\\n <StartTime>2021-06-10T13:31:20.414557061Z</StartTime>\\n <EndTime>2021-06-10T13:38:20.414557061Z</EndTime>\\n <SubmissionId>sub-13BeXWnGvrOl3MC124tazcJVKaV</SubmissionId>\\n <EntityName>s1</EntityName>\\n <EntityType>sample</EntityType>\\n <ExecuteDirectory>oss://my-bucket/my-execdir/</ExecuteDirectory>\\n <ExecuteOptions>\\n <CallCaching>false</CallCaching>\\n <DeleteIntermediateResults>false</DeleteIntermediateResults>\\n <FailureMode>NoNewCalls</FailureMode>\\n </ExecuteOptions>\\n <Inputs>{ \\"workflow1.task1.param1\\": \\"helloooo.txt\\", \\"workflow1.task1.param2\\": \\"abc\\", \\"workflow1.task2.param1\\": \\"new_helloooo.txt\\", \\"workflow1.task2.param2\\": \\"def\\" }</Inputs>\\n <DefaultRuntime>{}</DefaultRuntime>\\n <Workspace>test-workspace</Workspace>\\n <RegionId>cn-beijing</RegionId>\\n </Runs>\\n</ListRunsResponse>","errorExample":""}]',
- ],
- 'ListUserActiveRuns' => [
- 'summary' => '最近任务列表',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Delivery Job',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:36.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSubmission'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:worksapce/{#Workspace}/submission/{#SubmissionId}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'DeleteTemplate' => [
+ 'summary' => 'Deletes a specified application template from a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
- 'name' => 'MaxResults',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '查询数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '3',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'TemplateName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Application template name', 'type' => 'string', 'required' => true, 'example' => 'test-template', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'title' => '下次查询Token',
- 'type' => 'string',
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
- 'TotalCount' => [
- 'title' => '返回个数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Runs' => [
- 'title' => '任务列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'AppName' => [
- 'title' => '应用名称',
- 'type' => 'string',
- 'example' => 'MyApp',
- ],
- 'Source' => [
- 'title' => '应用来源',
- 'type' => 'string',
- 'example' => 'EasyGene',
- ],
- 'Labels' => [
- 'title' => '任务标签',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'RunName' => [
- 'title' => '任务名称',
- 'type' => 'string',
- 'example' => 'test-run',
- ],
- 'AppRevision' => [
- 'title' => '应用版本号',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RunId' => [
- 'title' => '任务ID',
- 'type' => 'string',
- 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'type' => 'string',
- 'example' => 'Running',
- ],
- 'CreateTime' => [
- 'title' => '提交时间',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'SubmissionId' => [
- 'title' => '提交ID',
- 'type' => 'string',
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
- 'EntityName' => [
- 'title' => '实体名称',
- 'type' => 'string',
- 'example' => 's1',
- ],
- 'EntityType' => [
- 'title' => '实体对象ID',
- 'type' => 'string',
- 'example' => 'sample',
- ],
- 'ExecuteDirectory' => [
- 'title' => '运行目录',
- 'type' => 'string',
- ],
- 'ExecuteOptions' => [
- 'type' => 'object',
- 'properties' => [
- 'CallCaching' => [
- 'title' => '是否开启CallCaching',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'UseRelativeOutputPaths' => [
- 'title' => '使用相对路径',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'FailureMode' => [
- 'title' => '失败模式',
- 'type' => 'string',
- 'example' => 'NoNewCalls',
- ],
- 'DeleteIntermediateResults' => [
- 'title' => '是否删除中间文件',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- 'Inputs' => [
- 'title' => '输入参数',
- 'type' => 'string',
- 'example' => '{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }',
- ],
- 'DefaultRuntime' => [
- 'title' => '默认运行时',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'RegionId' => [
- 'title' => '区域',
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
- ],
- ],
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
- 403 => [
- [
- 'errorCode' => 'InvalidUser.AccessDenied',
- 'errorMessage' => 'The request was denied due to insufficient user permission.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Application Template',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/{#TemplateName}'],
+ ],
],
],
],
- 'responseDemo' => null,
],
- 'AbortRun' => [
- 'summary' => '暂停任务',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteWorkspace' => [
+ 'summary' => 'Deletes a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
- ],
- [
- 'name' => 'RunId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'MyTestWorkspace', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
- 409 => [
- [
- 'errorCode' => 'StatusConflict',
- 'errorMessage' => 'The specified action %s is not supported in current status %s.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Delete Workspace',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Workspace', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<AbortRunResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</AbortRunResponse>","errorExample":""}]',
- 'title' => 'AbortRun',
- ],
- 'CreateEntity' => [
- 'summary' => '创建数据表格',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'],
+ ],
],
+ ],
+ 'DownloadEntity' => [
+ 'summary' => 'Download entity table data from a workspace to a local file.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3583,146 +1669,84 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Workspace', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'Entity type', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sample', 'title' => ''],
],
[
- 'name' => 'EntityItems',
- 'in' => 'formData',
+ 'name' => 'EntityNames',
+ 'in' => 'query',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'description' => 'Array of data element names to download',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'EntityName' => [
- 'title' => '表格元素名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's1',
- ],
- 'EntityData' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '',
- 'example' => 'value',
- ],
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
- ],
- [
- 'name' => 'ClientToken',
- 'in' => 'query',
- 'schema' => [
- 'title' => '幂等Token',
- 'description' => '',
- 'type' => 'string',
+ 'items' => ['description' => 'Data element to download', 'type' => 'string', 'required' => false, 'example' => 's1', 'title' => ''],
'required' => false,
- 'example' => 'T93cy1mMDE4OTgxNGU1ZTkK',
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'description' => 'Response data',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'EntityCSVFile' => ['description' => 'URL of the downloaded CSV file', 'type' => 'string', 'example' => 'https://my-bucket.oss.aliyucs.com/entity.csv', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateEntityResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Workspace>test-workspace</Workspace>\\n <EntityType>sample</EntityType>\\n</CreateEntityResponse>","errorExample":""}]',
- 'title' => 'CreateEntity',
- ],
- 'GetEntity' => [
- 'summary' => '查询数据表格信息',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"EntityCSVFile\\": \\"https://my-bucket.oss.aliyucs.com/entity.csv\\"\\n}","type":"json"}]',
+ 'title' => 'Download Entity Table Data ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:DownloadEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadEntity'],
+ ],
],
+ ],
+ 'GetApp' => [
+ 'summary' => 'Retrieves the details of a specific application in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3730,751 +1754,762 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'The workspace name.', 'type' => 'string', 'required' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'EntityType',
+ 'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'TestApp', 'title' => ''],
+ ],
+ [
+ 'name' => 'Revision',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The version number of the application.', 'type' => 'string', 'example' => '0', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'RevisionTag',
+ 'in' => 'query',
+ 'schema' => ['title' => 'Unique tag of the application version ', 'description' => 'The unique tag for the application version.', 'type' => 'string', 'example' => 'TestTag', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回数据',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The details of the application.',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
+ 'WorkflowName' => ['description' => 'The workflow name.', 'type' => 'string', 'example' => 'MyTestWorkflow', 'title' => ''],
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'MyTestApp', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the application was created.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'Definition' => ['description' => 'The application definition.', 'type' => 'string', 'example' => 'WDL content', 'title' => ''],
+ 'Description' => ['description' => 'A brief description of the application.', 'type' => 'string', 'example' => 'This is a test app', 'title' => ''],
+ 'Documentation' => ['description' => 'The detailed documentation of the application.', 'type' => 'string', 'example' => 'example documentation content', 'title' => ''],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'Inputs' => [
+ 'title' => '',
+ 'description' => 'The application inputs.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'TestTaskName', 'title' => ''],
+ 'VariableName' => ['description' => 'The variable name.', 'type' => 'string', 'example' => 'TestVariableName', 'title' => ''],
+ 'VariableType' => ['description' => 'The variable type.', 'type' => 'string', 'example' => 'TestVariableType', 'title' => ''],
+ 'VariableValue' => ['description' => 'The variable value.', 'type' => 'string', 'example' => 'TestVariableValue', 'title' => ''],
+ 'Required' => ['description' => 'Indicates whether the input is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Help' => ['description' => 'The help information.', 'type' => 'string', 'example' => 'help information', 'title' => ''],
+ 'StepOrder' => ['description' => 'The step order.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
+ 'Labels' => [
+ 'title' => '',
+ 'description' => 'The application labels.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Label', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'example' => '',
],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
+ 'Language' => ['description' => 'The language used to describe the application.', 'type' => 'string', 'example' => 'WDL', 'title' => ''],
+ 'LanguageVersion' => ['description' => 'The version of the language used to describe the application.', 'type' => 'string', 'example' => '1.0', 'title' => ''],
+ 'LastModifiedTime' => ['description' => 'The time when the application was last modified.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'Outputs' => [
+ 'title' => '',
+ 'description' => 'The output parameters of the application.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'TestTaskName', 'title' => ''],
+ 'VariableName' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'TestVariableName', 'title' => ''],
+ 'VariableType' => ['description' => 'The parameter type.', 'type' => 'string', 'example' => 'Int', 'title' => ''],
+ 'VariableValue' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'ExampleValue', 'title' => ''],
+ 'Required' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Help' => ['description' => 'The help information.', 'type' => 'string', 'example' => 'Example help information', 'title' => ''],
+ 'StepOrder' => ['description' => 'The step number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Revision' => ['description' => 'The version number of the application.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'RevisionTag' => ['title' => 'Unique tag for the application version ', 'description' => 'The unique tag for the application version.', 'type' => 'string', 'example' => 'TestTag'],
+ 'RevisionComment' => ['description' => 'The modification comment for the current version of the application.', 'type' => 'string', 'example' => 'Example revision comment', 'title' => ''],
+ 'Revisions' => [
+ 'title' => '',
+ 'description' => 'All versions of the application.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => ['description' => 'The time when the version was created.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'Revision' => ['description' => 'The version number.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'RevisionComment' => ['description' => 'The modification comment for the current version of the application.', 'type' => 'string', 'example' => 'Example revision comment', 'title' => ''],
+ 'RevisionTag' => ['title' => 'Unique tag for the application version', 'description' => 'The unique tag for the application version.', 'type' => 'string', 'example' => 'ProduceVersion'],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
- 'Attributes' => [
- 'title' => '属性列数组',
- 'description' => '',
+ 'Scope' => ['description' => 'The scope of the application.', 'type' => 'string', 'example' => 'Public', 'title' => ''],
+ 'URL' => ['description' => 'The URL of the application.', 'type' => 'string', 'title' => '', 'example' => 'Example url'],
+ 'Workspace' => ['description' => 'The workspace name.', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'Source' => ['description' => 'The source of the application.', 'type' => 'string', 'example' => 'EasyGene', 'title' => ''],
+ 'AppType' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'App', 'title' => ''],
+ 'Dependencies' => [
+ 'title' => '',
+ 'description' => 'Dependent applications.',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Path' => ['description' => 'The path of the dependency.', 'type' => 'string', 'example' => './task/echo.wdl', 'title' => ''],
+ 'Content' => ['description' => 'The WDL content.', 'type' => 'string', 'example' => 'task echo { String txt_out = "default_txt_out" String dd_out = "default_dd_out" command { echo Hello > ${txt_out} /bin/bash -c "dd if=/dev/zero of=${dd_out} bs=1M count=15" echo "This is a test std out." } runtime { cpu: "2" memory: "4G" autoReleaseJob: false reserveOnFail: true userData: "key1 value1" disks: "local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency" tag: "TestTag" } output { File outTxtFile = "${txt_out}" File outDdFile = "${dd_out}" } }', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => 'fastq1',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'TotalCount' => [
- 'title' => '实体元素总个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
+ 'Configs' => [
+ 'title' => '',
+ 'description' => 'Reference inputs.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Path' => ['description' => 'The parameter path.', 'type' => 'string', 'example' => './config/example.json', 'title' => ''],
+ 'Content' => ['description' => 'The parameter content.', 'type' => 'string', 'example' => '{ "wgs.apply_bqsr.cpu": 4, "wgs.apply_bqsr.disks": "local-disk 250 cloud_ssd", "wgs.apply_bqsr.gatk_Launcher": "/usr/local/bin/gatk-4.1.4.1/gatk", "wgs.apply_bqsr.java_opts": "\'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt\'", "wgs.apply_bqsr.memory": "8G"}', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'Path' => ['description' => 'The path of the main WDL file.', 'type' => 'string', 'example' => 'main.wdl', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource %s is not found.', 'description' => 'The specified resource %s is not found.'],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"WorkflowName\\": \\"MyTestWorkflow\\",\\n \\"AppName\\": \\"MyTestApp\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Definition\\": \\"WDL content\\",\\n \\"Description\\": \\"This is a test app\\",\\n \\"Documentation\\": \\"example documentation content\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Inputs\\": [\\n {\\n \\"TaskName\\": \\"TestTaskName\\",\\n \\"VariableName\\": \\"TestVariableName\\",\\n \\"VariableType\\": \\"TestVariableType\\",\\n \\"VariableValue\\": \\"TestVariableValue\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"help information\\",\\n \\"StepOrder\\": 1\\n }\\n ],\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"Language\\": \\"WDL\\",\\n \\"LanguageVersion\\": \\"1.0\\",\\n \\"LastModifiedTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Outputs\\": [\\n {\\n \\"TaskName\\": \\"TestTaskName\\",\\n \\"VariableName\\": \\"TestVariableName\\",\\n \\"VariableType\\": \\"Int\\",\\n \\"VariableValue\\": \\"ExampleValue\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"Example help information\\",\\n \\"StepOrder\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Revision\\": \\"1\\",\\n \\"RevisionTag\\": \\"TestTag\\",\\n \\"RevisionComment\\": \\"Example revision comment\\",\\n \\"Revisions\\": [\\n {\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Revision\\": \\"1\\",\\n \\"RevisionComment\\": \\"Example revision comment\\",\\n \\"RevisionTag\\": \\"ProduceVersion\\"\\n }\\n ],\\n \\"Scope\\": \\"Public\\",\\n \\"URL\\": \\"Example url\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"AppType\\": \\"App\\",\\n \\"Dependencies\\": [\\n {\\n \\"Path\\": \\"./task/echo.wdl\\",\\n \\"Content\\": \\"task echo { String txt_out = \\\\\\"default_txt_out\\\\\\" String dd_out = \\\\\\"default_dd_out\\\\\\" command { echo Hello > ${txt_out} /bin/bash -c \\\\\\"dd if=/dev/zero of=${dd_out} bs=1M count=15\\\\\\" echo \\\\\\"This is a test std out.\\\\\\" } runtime { cpu: \\\\\\"2\\\\\\" memory: \\\\\\"4G\\\\\\" autoReleaseJob: false reserveOnFail: true userData: \\\\\\"key1 value1\\\\\\" disks: \\\\\\"local-disk 40 cloud_ssd, /home/mount/ 40 cloud_efficiency\\\\\\" tag: \\\\\\"TestTag\\\\\\" } output { File outTxtFile = \\\\\\"${txt_out}\\\\\\" File outDdFile = \\\\\\"${dd_out}\\\\\\" } }\\"\\n }\\n ],\\n \\"Configs\\": [\\n {\\n \\"Path\\": \\"./config/example.json\\",\\n \\"Content\\": \\"{ \\\\\\"wgs.apply_bqsr.cpu\\\\\\": 4, \\\\\\"wgs.apply_bqsr.disks\\\\\\": \\\\\\"local-disk 250 cloud_ssd\\\\\\", \\\\\\"wgs.apply_bqsr.gatk_Launcher\\\\\\": \\\\\\"/usr/local/bin/gatk-4.1.4.1/gatk\\\\\\", \\\\\\"wgs.apply_bqsr.java_opts\\\\\\": \\\\\\"\'-XX:GCTimeLimit=50 -XX:GCHeapFreeLimit=10 -Xms3000m -Djava.io.tmpdir=/mnt\'\\\\\\", \\\\\\"wgs.apply_bqsr.memory\\\\\\": \\\\\\"8G\\\\\\"}\\"\\n }\\n ],\\n \\"Path\\": \\"main.wdl\\"\\n}","type":"json"}]',
+ 'title' => 'Query application details ',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-10T09:29:50.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-12-10T09:13:58.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-01-12T05:28:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/{#AppName}'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"Attributes\\": [\\n \\"fastq1\\"\\n ],\\n \\"TotalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<GetEntityResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Workspace>test-workspace</Workspace>\\n <EntityType>sample</EntityType>\\n <Attributes>fastq1</Attributes>\\n <TotalCount>100</TotalCount>\\n</GetEntityResponse>","errorExample":""}]',
- 'title' => 'GetEntity',
- ],
- 'DeleteEntity' => [
- 'summary' => '删除实体表格',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApp'],
+ ],
],
+ ],
+ 'GetEntity' => [
+ 'summary' => 'Queries the definition of a specific entity type in a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'default-workspace',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'The entity type.', 'type' => 'string', 'required' => true, 'example' => 'sample', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => '',
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'EntityType' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'sample', 'title' => ''],
+ 'Attributes' => [
+ 'title' => '',
+ 'description' => 'The array of attribute columns.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The name of the attribute column.', 'type' => 'string', 'example' => 'fastq1', 'title' => ''],
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'The total number of entity elements.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'ResourceNotFound',
- 'errorMessage' => 'The specified resource %s is not found.',
- ],
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"Attributes\\": [\\n \\"fastq1\\"\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
+ 'title' => 'Query entity type definition',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\"\\n}","type":"json"}]',
- ],
- 'DeleteEntityItems' => [
- 'summary' => '删除数据表格的条目',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntity'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetGlobalApp' => [
+ 'summary' => 'Queries the details of a global application.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'Attributes',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
+ 'title' => '',
+ 'description' => 'Query source table columns',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => 'appVersions', 'description' => '', 'required' => false, 'title' => ''],
+ 'required' => false,
+ 'example' => 'AppVersion, AppDescriptorFiles, DescriptorType, DAG, Document, Comment, Alias, NamespaceName, AppScope, AppName, AppDescription, RegionIds, Categories, Toolkit, AppVersions, AppDefaultVersion, AppFee, LastModified, Pinned, Contact, Links, AppType',
],
],
[
- 'name' => 'EntityType',
+ 'name' => 'NamespaceName',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'Namespace', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sentieon', 'title' => ''],
],
[
- 'name' => 'EntityNames',
+ 'name' => 'AppName',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's1',
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => 'Application name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'joint-calling', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppVersion',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Application version', 'type' => 'string', 'example' => '1.0', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Region ID', 'type' => 'string', 'example' => 'cn-beijing', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'LastModified' => ['description' => 'Last modified time', 'type' => 'string', 'example' => 'yyyy/MM/dd HH:mm:ss', 'title' => ''],
+ 'NamespaceName' => ['description' => 'Namespace name', 'type' => 'string', 'example' => 'sentieon', 'title' => ''],
+ 'AppScope' => ['description' => 'The permission scope of the application.', 'type' => 'string', 'example' => 'OpenAccess / Protected', 'title' => ''],
+ 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'joint-calling', 'title' => ''],
+ 'Locations' => [
+ 'title' => '',
+ 'description' => 'Regions supported by the application',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => 'cn-shenzhen', 'description' => '', 'title' => ''],
+ 'example' => '',
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
+ 'AppVersion' => ['description' => 'Application version', 'type' => 'string', 'example' => '1.2a-3', 'title' => ''],
+ 'AppType' => ['description' => 'Application type', 'type' => 'string', 'example' => 'workflow', 'title' => ''],
+ 'AppFee' => ['description' => 'Application billing description', 'type' => 'string', 'example' => '实际使用时，计算该应用消耗的资源费用', 'title' => ''],
+ 'AppDescription' => ['description' => 'Application description', 'type' => 'string', 'example' => 'Use Sentieon for large-scale sample population variant detection.', 'title' => ''],
+ 'Categories' => [
+ 'title' => '',
+ 'description' => 'List of application categories',
+ 'type' => 'array',
+ 'items' => ['description' => 'Application category', 'type' => 'string', 'example' => '群体变异', 'title' => ''],
+ 'example' => 'Population variation',
+ ],
+ 'Toolkit' => ['description' => 'Application toolkit', 'type' => 'string', 'example' => 'Sentieon', 'title' => ''],
+ 'Contact' => ['description' => 'Application contact information', 'type' => 'string', 'example' => 'support@sentieon.com', 'title' => ''],
+ 'Links' => [
+ 'title' => '',
+ 'description' => 'Application reference pages',
+ 'type' => 'array',
+ 'items' => ['description' => 'Page link', 'type' => 'string', 'example' => 'http://www.sentieon.com', 'title' => ''],
+ 'example' => '',
+ ],
+ 'AppVersions' => [
+ 'title' => '',
+ 'description' => 'List of application versions',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Application version information',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppVersion' => ['description' => 'Application version', 'type' => 'string', 'example' => '1.0', 'title' => ''],
+ 'Comment' => ['description' => 'Version description', 'type' => 'string', 'example' => '初始版本', 'title' => ''],
+ 'LastModified' => ['description' => 'Last modified time', 'type' => 'string', 'example' => 'yyyy/MM/dd HH:mm:ss', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
+ ],
+ 'AppDefaultVersion' => ['description' => 'Default version', 'type' => 'string', 'example' => '1.0', 'title' => ''],
+ 'AppDescriptorType' => ['description' => 'Application description language standard', 'type' => 'string', 'example' => 'WDL / CWL', 'title' => ''],
+ 'AppDescriptorFiles' => [
+ 'title' => '',
+ 'description' => 'List of application files',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Application file information',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileType' => ['description' => 'Application file type', 'type' => 'string', 'example' => 'PRIMARY_DESCRIPTOR（主WDL） SECONDARY_DESCRIPTOR（依赖WDL） CONFIG（推荐的输入参数） CONTAINERFILE（镜像制作文件） DATA（输入参数中引用的参考文件） OTHER（其他）', 'title' => ''],
+ 'Path' => ['description' => 'Application file path. Except for PRIMARY\\_DESCRIPTOR, all other paths are relative to PRIMARY\\_DESCRIPTOR.', 'type' => 'string', 'title' => '', 'example' => './main.wdl'],
+ 'Content' => ['description' => 'Application file content', 'type' => 'string', 'example' => 'File content', 'title' => ''],
+ 'Url' => ['description' => 'Application file link', 'type' => 'string', 'example' => 'File URL', 'title' => ''],
+ 'Checksum' => ['description' => 'Integrity checksum for application file content, such as MD5 value.', 'type' => 'string', 'example' => 'File MD5', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'Document' => ['description' => 'Application help document', 'type' => 'string', 'example' => '应用的帮助文档', 'title' => ''],
+ 'Comment' => ['description' => 'Application remarks', 'type' => 'string', 'example' => 'Initial version', 'title' => ''],
+ 'DAG' => ['description' => 'Application DAG information', 'type' => 'string', 'example' => 'DAG', 'title' => ''],
+ 'Pinned' => ['description' => 'Application pinned mark', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidApp.Version.NotFound', 'errorMessage' => 'The specified app version is not found.', 'description' => 'The specified app version is not found.'],
+ ['errorCode' => 'InvalidApp.NotFound', 'errorMessage' => 'The specified app is not found.', 'description' => 'The specified app is not found.'],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteEntityItemsResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</DeleteEntityItemsResponse>","errorExample":""}]',
- 'title' => 'DeleteEntityItems',
- ],
- 'UpdateEntity' => [
- 'summary' => '修改数据表格',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"HostId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\",\\n \\"NamespaceName\\": \\"sentieon\\",\\n \\"AppScope\\": \\"OpenAccess / Protected\\",\\n \\"AppName\\": \\"joint-calling\\",\\n \\"Locations\\": [\\n \\"cn-shenzhen\\"\\n ],\\n \\"AppVersion\\": \\"1.2a-3\\",\\n \\"AppType\\": \\"workflow\\",\\n \\"AppFee\\": \\"实际使用时，计算该应用消耗的资源费用\\",\\n \\"AppDescription\\": \\"Use Sentieon for large-scale sample population variant detection.\\",\\n \\"Categories\\": [\\n \\"群体变异\\"\\n ],\\n \\"Toolkit\\": \\"Sentieon\\",\\n \\"Contact\\": \\"support@sentieon.com\\",\\n \\"Links\\": [\\n \\"http://www.sentieon.com\\"\\n ],\\n \\"AppVersions\\": [\\n {\\n \\"AppVersion\\": \\"1.0\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\"\\n }\\n ],\\n \\"AppDefaultVersion\\": \\"1.0\\",\\n \\"AppDescriptorType\\": \\"WDL / CWL\\",\\n \\"AppDescriptorFiles\\": [\\n {\\n \\"FileType\\": \\"PRIMARY_DESCRIPTOR（主WDL） SECONDARY_DESCRIPTOR（依赖WDL） CONFIG（推荐的输入参数） CONTAINERFILE（镜像制作文件） DATA（输入参数中引用的参考文件） OTHER（其他）\\",\\n \\"Path\\": \\"./main.wdl\\",\\n \\"Content\\": \\"File content\\",\\n \\"Url\\": \\"File URL\\",\\n \\"Checksum\\": \\"File MD5\\"\\n }\\n ],\\n \\"Document\\": \\"应用的帮助文档\\",\\n \\"Comment\\": \\"Initial version\\",\\n \\"DAG\\": \\"DAG\\",\\n \\"Pinned\\": true\\n}","type":"json"}]',
+ 'title' => 'Query public application details ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'translator' => 'machine',
+ ],
+ 'GetPublicDataset' => [
+ 'summary' => 'Retrieve details about a public dataset on the platform.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => true,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'DatasetName',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Name of the dataset', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
],
[
- 'name' => 'EntityType',
+ 'name' => 'Attributes',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sample',
- ],
- ],
- [
- 'name' => 'EntityItems',
- 'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'List of attributes to return',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'EntityName' => [
- 'title' => '实体元素名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's1',
- ],
- 'EntityData' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '',
- 'example' => 'value',
- ],
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'docRequired' => true,
+ 'items' => ['description' => 'Attribute name', 'type' => 'string', 'example' => 'DatasetName, DatasetDescription, About, AccessRequirements, Copyright, Tags, UpdateFrequency, RegionIds, LastModified', 'required' => false, 'title' => ''],
+ 'required' => false,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'DatasetDescription' => ['description' => 'Description of the public dataset', 'type' => 'string', 'example' => 'The Simons Genome Diversity Project (SGDP) is currently the largest and highest-quality population diversity genome dataset in the world.', 'title' => ''],
+ 'Copyright' => ['description' => 'Copyright information for the public dataset', 'type' => 'string', 'example' => 'This dataset is publicly available for everyone, but users must comply with the terms specified by the dataset source (Fort Lauderdale principles)', 'title' => ''],
+ 'AccessRequirements' => ['description' => 'Access requirements for the public dataset', 'type' => 'string', 'example' => 'Alibaba Cloud "as is" provides datasets, without any express or implied warranties.', 'title' => ''],
+ 'About' => ['description' => 'About the public dataset', 'type' => 'string', 'example' => 'The complete dataset includes 279 genomes, See the published articles for details. Alibaba Cloud has collected the fully public variant results recorded in the project documentation asVCF files.', 'title' => ''],
+ 'Tags' => [
+ 'title' => '',
+ 'description' => 'List of tags for the public dataset',
+ 'type' => 'array',
+ 'items' => ['description' => 'Tag', 'type' => 'string', 'example' => '遗传多样性', 'title' => ''],
+ 'example' => 'Genetic diversity',
],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
+ 'DatasetName' => ['description' => 'Name of the public dataset', 'type' => 'string', 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
+ 'UpdateFrequency' => ['description' => 'How often the public dataset is updated', 'type' => 'string', 'example' => 'Synchronize promptly after origin server update', 'title' => ''],
+ 'Locations' => [
+ 'title' => '',
+ 'description' => 'Available areas for the public dataset',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => 'cn-beijing', 'description' => '', 'title' => ''],
+ 'example' => '',
],
+ 'LastModified' => ['description' => 'Time of last update', 'type' => 'string', 'example' => 'yyyy/MM/dd HH:mm:ss', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ['errorCode' => 'InvalidAttributes.NotFound', 'errorMessage' => 'The specified Attributes are not found.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'substitutions' => [
- 'EasyGene::2021-03-15::UpdateEntityItems',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"DatasetDescription\\": \\"The Simons Genome Diversity Project (SGDP) is currently the largest and highest-quality population diversity genome dataset in the world.\\",\\n \\"Copyright\\": \\"This dataset is publicly available for everyone, but users must comply with the terms specified by the dataset source (Fort Lauderdale principles)\\",\\n \\"AccessRequirements\\": \\"Alibaba Cloud \\\\\\"as is\\\\\\" provides datasets, without any express or implied warranties.\\",\\n \\"About\\": \\"The complete dataset includes 279 genomes, See the published articles for details. Alibaba Cloud has collected the fully public variant results recorded in the project documentation asVCF files.\\",\\n \\"Tags\\": [\\n \\"遗传多样性\\"\\n ],\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"UpdateFrequency\\": \\"Synchronize promptly after origin server update\\",\\n \\"Locations\\": [\\n \\"cn-beijing\\"\\n ],\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\"\\n}","type":"json"}]',
+ 'title' => 'Query details of a public dataset ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:37.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:37.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateEntityResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Workspace>test-workspace</Workspace>\\n <EntityType>sample</EntityType>\\n</UpdateEntityResponse>","errorExample":""}]',
- 'title' => 'UpdateEntity',
- ],
- 'UpdateEntityItems' => [
- 'summary' => '修改表格数据',
- 'methods' => [
- 'get',
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetPublicDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'GetPublicDatasetEntity' => [
+ 'summary' => 'Queries the definition of a specific entity from a public dataset on the platform.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'DatasetName',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Dataset name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
],
[
'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'Entity type', 'type' => 'string', 'required' => true, 'example' => 'sample', 'title' => ''],
],
[
- 'name' => 'EntityItems',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'EntityName' => [
- 'title' => '实体元素名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's1',
- ],
- 'EntityData' => [
- 'description' => '',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'description' => '',
- 'example' => '{"key1":"value1"}',
- ],
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'docRequired' => true,
- ],
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Region ID', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'DatasetName' => ['description' => 'Public dataset name', 'type' => 'string', 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
+ 'EntityType' => ['description' => 'Entity type', 'type' => 'string', 'example' => 'sample', 'title' => ''],
+ 'Attributes' => [
+ 'title' => '',
+ 'description' => 'List of entity attribute names',
+ 'type' => 'array',
+ 'items' => ['description' => 'Entity attribute', 'type' => 'string', 'example' => 'key', 'title' => ''],
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'Total number of entities of this type', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ['errorCode' => 'InvalidPublicDataset.NotFound', 'errorMessage' => 'The specified PublicDatasetName is not found.', 'description' => ''],
+ ['errorCode' => 'InvalidEntityType.NotFound', 'errorMessage' => 'The specified EntityType is not found.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","type":"json"}]',
- 'title' => 'UpdateEntityItems',
- ],
- 'ListEntities' => [
- 'summary' => '列出数据实体列表',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"Attributes\\": [\\n \\"key\\"\\n ],\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
+ 'title' => 'Query entity definition in a public dataset ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPublicDatasetEntity'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetPublicDatasetEntity',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetRun' => [
+ 'summary' => 'Retrieves task details.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'title' => '起始查询位置',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'default-workspace', 'title' => ''],
],
[
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'title' => '最大返回数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
- ],
- [
- 'name' => 'OrderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序条件',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createtime',
- ],
- ],
- [
- 'name' => 'IsReversed',
+ 'name' => 'RunId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否逆序',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'example' => 'run-12kDbbqp5O9dfsH0sEdQeRclGQb', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'NextToken' => [
- 'title' => '下次查询的起始Token',
- 'description' => '',
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'Workspace' => ['description' => 'Workspace name', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'RunId' => ['description' => 'Task ID', 'type' => 'string', 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ', 'title' => ''],
+ 'RunName' => ['description' => 'Task name', 'type' => 'string', 'example' => 'test-run', 'title' => ''],
+ 'SubmissionId' => ['description' => 'Submission ID', 'type' => 'string', 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
+ 'Source' => ['description' => 'Application source', 'type' => 'string', 'example' => 'EasyGene', 'title' => ''],
+ 'AppName' => ['description' => 'Application name', 'type' => 'string', 'example' => 'Sentieon', 'title' => ''],
+ 'AppRevision' => ['description' => 'Application version', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'EntityType' => ['description' => 'Entity type', 'type' => 'string', 'example' => 'sample', 'title' => ''],
+ 'EntityName' => ['description' => 'Entity object name', 'type' => 'string', 'example' => 's1', 'title' => ''],
+ 'User' => ['description' => 'User ID', 'type' => 'string', 'title' => '', 'example' => '13579222'],
+ 'Status' => [
+ 'description' => 'Task status',
+ 'enumValueTitles' => ['Submitted' => 'Submit task', 'Succeeded' => 'Run successfully', 'Failed' => 'Run failed', 'Aborting' => 'Canceling task', 'Running' => 'Running', 'Pending' => 'Waiting to run', 'Aborted' => 'Canceling task'],
'type' => 'string',
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
- 'MaxResults' => [
- 'title' => '请求的最大结果数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'example' => 'Running',
+ 'title' => '',
],
- 'TotalCount' => [
- 'title' => '返回总个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'CreateTime' => ['description' => 'Submission time', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'title' => ''],
+ 'StartTime' => ['description' => 'Start time', 'type' => 'string', 'example' => '2021-06-10T13:30:24.414557061Z', 'title' => ''],
+ 'EndTime' => ['description' => 'End time', 'type' => 'string', 'example' => '2021-06-10T13:36:20.405878292Z', 'title' => ''],
+ 'ExecuteOptions' => [
+ 'title' => '',
+ 'description' => 'Task configuration',
+ 'type' => 'object',
+ 'properties' => [
+ 'CallCaching' => ['description' => 'Enable CallCaching', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'DeleteIntermediateResults' => ['description' => 'Delete intermediate files', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'FailureMode' => ['description' => 'Failure mode', 'type' => 'string', 'example' => 'NoNewCalls', 'title' => ''],
+ 'UseRelativeOutputPaths' => ['description' => 'Relative output paths', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'DataLoader' => ['description' => 'Data loading mode', 'type' => 'string', 'example' => 'Mount', 'title' => ''],
+ ],
+ 'example' => '',
],
- 'Entities' => [
- 'title' => '实体类型数组',
- 'description' => '',
+ 'Inputs' => ['description' => 'Task inputs', 'type' => 'string', 'example' => '{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }', 'title' => ''],
+ 'Outputs' => ['description' => 'Task outputs', 'type' => 'string', 'example' => '{ "workflow1.bam": "oss://my-bucket/test.bam", "workflow1.vcf": "oss://my-bucket/test.vcf" }', 'title' => ''],
+ 'Labels' => [
+ 'title' => '',
+ 'description' => 'Task labels',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Label', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'example' => '',
+ ],
+ 'OutputFolder' => ['description' => 'Output copy directory', 'type' => 'string', 'example' => 'oss://my-bucket/output/', 'title' => ''],
+ 'ExecuteDirectory' => ['description' => 'Task execution directory', 'type' => 'string', 'example' => 'oss://my-bucket/exec/', 'title' => ''],
+ 'DefaultRuntime' => ['description' => 'Default runtime value', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'Description' => ['description' => 'Task description', 'type' => 'string', 'example' => 'test run', 'title' => ''],
+ 'Timing' => ['description' => 'Timing information', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'Calls' => ['description' => 'Job information', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'Failures' => ['description' => 'Error message', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'BillingInstanceIds' => [
+ 'description' => 'Task bill ID array',
+ 'title' => 'Array of bill IDs for the job ',
'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
- ],
- ],
+ 'items' => ['title' => 'Bill ID for the job ', 'description' => 'Task bill ID', 'type' => 'string', 'example' => 'test_workflow.test_run;-1;1'],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"MaxResults\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Entities\\": [\\n {\\n \\"EntityType\\": \\"sample\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEntitiesResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <NextToken>MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK</NextToken>\\n <MaxResults>1</MaxResults>\\n <TotalCount>1</TotalCount>\\n <Entities>\\n <EntityType>sample</EntityType>\\n </Entities>\\n</ListEntitiesResponse>","errorExample":""}]',
- 'title' => 'ListEntities',
- ],
- 'ListEntityItems' => [
- 'summary' => '列出数据表格的条目',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RunId\\": \\"run-13BeYuxc0fxO24uA75UppTiMRoQ\\",\\n \\"RunName\\": \\"test-run\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"AppName\\": \\"Sentieon\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"EntityName\\": \\"s1\\",\\n \\"User\\": \\"13579222\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"StartTime\\": \\"2021-06-10T13:30:24.414557061Z\\",\\n \\"EndTime\\": \\"2021-06-10T13:36:20.405878292Z\\",\\n \\"ExecuteOptions\\": {\\n \\"CallCaching\\": false,\\n \\"DeleteIntermediateResults\\": false,\\n \\"FailureMode\\": \\"NoNewCalls\\",\\n \\"UseRelativeOutputPaths\\": false,\\n \\"DataLoader\\": \\"Mount\\"\\n },\\n \\"Inputs\\": \\"{ \\\\\\"workflow1.task1.param1\\\\\\": \\\\\\"helloooo.txt\\\\\\", \\\\\\"workflow1.task1.param2\\\\\\": \\\\\\"abc\\\\\\", \\\\\\"workflow1.task2.param1\\\\\\": \\\\\\"new_helloooo.txt\\\\\\", \\\\\\"workflow1.task2.param2\\\\\\": \\\\\\"def\\\\\\" }\\",\\n \\"Outputs\\": \\"{ \\\\\\"workflow1.bam\\\\\\": \\\\\\"oss://my-bucket/test.bam\\\\\\", \\\\\\"workflow1.vcf\\\\\\": \\\\\\"oss://my-bucket/test.vcf\\\\\\" }\\",\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"OutputFolder\\": \\"oss://my-bucket/output/\\",\\n \\"ExecuteDirectory\\": \\"oss://my-bucket/exec/\\",\\n \\"DefaultRuntime\\": \\"{}\\",\\n \\"Description\\": \\"test run\\",\\n \\"Timing\\": \\"{}\\",\\n \\"Calls\\": \\"{}\\",\\n \\"Failures\\": \\"{}\\",\\n \\"BillingInstanceIds\\": [\\n \\"test_workflow.test_run;-1;1\\"\\n ]\\n}","type":"json"}]',
+ 'title' => 'Get Job details',
+ 'changeSet' => [
+ ['createdAt' => '2024-09-10T09:33:16.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2024-04-07T06:13:26.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetRun',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/{#RunId}'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRun'],
+ ],
],
+ ],
+ 'GetSubmission' => [
+ 'summary' => 'Queries the details of a specific submission in a workspace.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -4482,1431 +2517,967 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'EntityType',
+ 'name' => 'SubmissionId',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'The submission ID.', 'type' => 'string', 'required' => true, 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
],
- [
- 'name' => 'Search',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '搜索条件',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'Submission' => [
+ 'title' => '',
+ 'description' => 'The submission details.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Workspace' => ['description' => 'The submission ID.', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'SubmissionId' => ['description' => 'The submission ID.', 'type' => 'string', 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
+ 'Status' => ['description' => 'The submission status.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the submission was created.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the submission started to run.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'EndTime' => ['description' => 'The time when the submission finished running.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'EntityType' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'TestEntityType', 'title' => ''],
+ 'RunStats' => [
+ 'description' => 'The statistics of run statuses.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Submitted' => ['description' => 'The number of submitted tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Pending' => ['description' => 'The number of pending tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Running' => ['description' => 'The number of running tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Succeeded' => ['description' => 'The number of successful tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Failed' => ['description' => 'The number of failed tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Aborting' => ['description' => 'The number of tasks being canceled.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Aborted' => ['description' => 'The number of canceled tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'example' => '',
+ ],
+ ],
'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
+ 'title' => '',
+ 'example' => '',
],
],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Submission\\": {\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"StartTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"EndTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"EntityType\\": \\"TestEntityType\\",\\n \\"RunStats\\": {\\n \\"Submitted\\": 5,\\n \\"Pending\\": 5,\\n \\"Running\\": 5,\\n \\"Succeeded\\": 5,\\n \\"Failed\\": 5,\\n \\"Aborting\\": 5,\\n \\"Aborted\\": 5\\n }\\n }\\n}","type":"json"}]',
+ 'title' => 'Query delivery Job details ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'OrderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序条件',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createtime',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/{#SubmissionId}'],
+ ],
],
],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubmission'],
+ ],
+ ],
+ ],
+ 'GetTemplate' => [
+ 'summary' => 'Queries the details of a specific application template in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'IsReversed',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否逆序',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
- 'name' => 'NextToken',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '起始查询位置',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'TemplateName',
'in' => 'query',
- 'schema' => [
- 'title' => '最大返回数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'Application template name', 'type' => 'string', 'required' => true, 'example' => 'test-template', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'Application template details',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'MaxResults' => [
- 'title' => '请求的最大结果数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'title' => '下次查询的起始Token',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
+ 'TemplateName' => ['description' => 'Application template name', 'type' => 'string', 'example' => 'test-template', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'title' => ''],
+ 'Description' => ['description' => 'Application brief description', 'type' => 'string', 'example' => 'test template', 'title' => ''],
+ 'AppName' => ['description' => 'Application name', 'type' => 'string', 'example' => 'MyApp', 'title' => ''],
+ 'AppRevision' => ['description' => 'Application version', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'InputsExpression' => [
+ 'title' => '',
+ 'description' => 'Application inputs',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'Task name', 'type' => 'string', 'example' => 'Task1', 'title' => ''],
+ 'VariableName' => ['description' => 'Variable name', 'type' => 'string', 'example' => 'v1', 'title' => ''],
+ 'VariableType' => ['description' => 'Variable type', 'type' => 'string', 'example' => 'File', 'title' => ''],
+ 'VariableValue' => ['description' => 'Variable value', 'type' => 'string', 'example' => 'oss://bucket/file1.fastq', 'title' => ''],
+ 'Required' => ['description' => 'Required parameter', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Help' => ['description' => 'Help information', 'type' => 'string', 'example' => 'test help', 'title' => ''],
+ 'StepOrder' => ['description' => 'Step order', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
- 'TotalCount' => [
- 'title' => '返回总个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
+ 'Labels' => [
+ 'title' => '',
+ 'description' => 'Application labels',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Label', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'example' => '',
],
- 'EntityItems' => [
- 'title' => '表格数据元素数组',
- 'description' => '',
+ 'LastModifiedTime' => ['description' => 'Application last modified time', 'type' => 'string', 'example' => '2021-06-10T13:30:20.405878292Z', 'title' => ''],
+ 'OutputsExpression' => [
+ 'title' => '',
+ 'description' => 'Application output parameters',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Application output parameter expression',
'type' => 'object',
'properties' => [
- 'EntityName' => [
- 'title' => '表格数据元素名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 's1',
- ],
- 'EntityData' => [
- 'title' => '数据元素属性',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'value',
- 'description' => '',
- ],
- ],
+ 'TaskName' => ['description' => 'Task name', 'type' => 'string', 'title' => '', 'example' => 'jobname'],
+ 'VariableName' => ['description' => 'Variable name', 'type' => 'string', 'title' => '', 'example' => 'fastq1'],
+ 'VariableType' => ['description' => 'Variable type', 'type' => 'string', 'title' => '', 'example' => 'string'],
+ 'VariableValue' => ['description' => 'Variable value', 'type' => 'string', 'title' => '', 'example' => 'abc_1.fastq.gz'],
+ 'Required' => ['description' => 'Required parameter', 'type' => 'boolean', 'title' => '', 'example' => 'true'],
+ 'Help' => ['description' => 'Help information', 'type' => 'string', 'example' => 'Sequencing reads file', 'title' => ''],
+ 'StepOrder' => ['description' => 'Step order', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '2'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Source' => ['description' => 'Application source', 'type' => 'string', 'example' => 'EasyGene', 'title' => ''],
+ 'Workspace' => ['description' => 'Workspace name', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'RootEntity' => ['description' => 'Entity type', 'type' => 'string', 'example' => 'test-entity', 'title' => ''],
+ 'RevisionTag' => ['title' => 'Unique tag of the application version ', 'description' => 'Application version unique tag', 'type' => 'string', 'example' => 'produceVersion'],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"TotalCount\\": 10,\\n \\"EntityItems\\": [\\n {\\n \\"EntityName\\": \\"s1\\",\\n \\"EntityData\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEntityItemsResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <MaxResults>10</MaxResults>\\n <NextToken>MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK</NextToken>\\n <TotalCount>10</TotalCount>\\n <EntityItems>\\n <EntityName>s1</EntityName>\\n <EntityData>\\n <key>value</key>\\n </EntityData>\\n </EntityItems>\\n</ListEntityItemsResponse>","errorExample":""}]',
- 'title' => 'ListEntityItems',
- ],
- 'CopyPublicEntity' => [
- 'summary' => '拷贝公共数据集的数据表格',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TemplateName\\": \\"test-template\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"Description\\": \\"test template\\",\\n \\"AppName\\": \\"MyApp\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"InputsExpression\\": [\\n {\\n \\"TaskName\\": \\"Task1\\",\\n \\"VariableName\\": \\"v1\\",\\n \\"VariableType\\": \\"File\\",\\n \\"VariableValue\\": \\"oss://bucket/file1.fastq\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"test help\\",\\n \\"StepOrder\\": 0\\n }\\n ],\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"LastModifiedTime\\": \\"2021-06-10T13:30:20.405878292Z\\",\\n \\"OutputsExpression\\": [\\n {\\n \\"TaskName\\": \\"jobname\\",\\n \\"VariableName\\": \\"fastq1\\",\\n \\"VariableType\\": \\"string\\",\\n \\"VariableValue\\": \\"abc_1.fastq.gz\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"Sequencing reads file\\",\\n \\"StepOrder\\": 2\\n }\\n ],\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RootEntity\\": \\"test-entity\\",\\n \\"RevisionTag\\": \\"produceVersion\\"\\n}","type":"json"}]',
+ 'title' => 'Query application template details ',
+ 'changeSet' => [
+ ['createdAt' => '2024-01-12T05:28:02.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'Dataset',
- 'in' => 'query',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'TestDataset',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/{#TemplateName}'],
+ ],
],
],
+ ],
+ 'translator' => 'machine',
+ ],
+ 'GetWorkspace' => [
+ 'summary' => 'Retrieves details about a workspace, including its status, description, and job lifecycle.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'EntityType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '表格名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sample',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '要拷贝到的工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'MyTestWorkspace', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Description' => ['description' => 'Workspace description', 'type' => 'string', 'example' => 'This is a test workspace', 'title' => ''],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'JobLifecycle' => ['description' => 'The job lifecycle in the workspace.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'Labels' => [
+ 'title' => '',
+ 'description' => 'Workspace labels',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Label', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'example' => '',
+ ],
+ 'Storage' => ['description' => 'OSS path for the workspace', 'type' => 'string', 'example' => 'oss://my-bucket/my-path/', 'title' => ''],
+ 'BucketName' => ['description' => 'Workspace bucket name', 'type' => 'string', 'example' => 'my-bucket', 'title' => ''],
+ 'Role' => ['description' => 'Default RAM service role for the workspace', 'type' => 'string', 'example' => 'TestRole', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'LastModifiedTime' => ['description' => 'Last modified time', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'Workspace' => ['description' => 'Workspace name', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'Status' => ['description' => 'Workspace status', 'type' => 'string', 'example' => 'Active', 'title' => ''],
+ 'Location' => ['description' => 'Region ID', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","errorExample":""},{"type":"xml","example":"<CopyPublicEntityResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Workspace>test-workspace</Workspace>\\n <EntityType>sample</EntityType>\\n</CopyPublicEntityResponse>","errorExample":""}]',
- 'title' => 'CopyPublicEntity',
- ],
- 'DownloadEntity' => [
- 'summary' => '下载数据表格',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Description\\": \\"This is a test workspace\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"JobLifecycle\\": 30,\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"Storage\\": \\"oss://my-bucket/my-path/\\",\\n \\"BucketName\\": \\"my-bucket\\",\\n \\"Role\\": \\"TestRole\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"LastModifiedTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"Status\\": \\"Active\\",\\n \\"Location\\": \\"cn-beijing\\"\\n}","type":"json"}]',
+ 'title' => 'Query workspace details ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Workspace', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'],
+ ],
+ ],
+ ],
+ 'ImportApp' => [
+ 'summary' => 'Imports a public platform application into a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'Source',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Source', 'type' => 'string', 'required' => true, 'example' => 'easygene:opengene/fastp', 'title' => ''],
],
[
- 'name' => 'EntityType',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'EntityNames',
+ 'name' => 'AppName',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's1',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The name of the application after installation.', 'type' => 'string', 'required' => true, 'example' => 'fastp', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response returned after the application is created.',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'EntityCSVFile' => [
- 'title' => '下载的表格文件URL',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://my-bucket.oss.aliyucs.com/entity.csv',
- ],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'AppName' => ['description' => 'The name of the installed application.', 'type' => 'string', 'example' => 'InstalledApp', 'title' => ''],
+ 'Workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'RegionId' => ['description' => 'The region name.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"EntityCSVFile\\": \\"https://my-bucket.oss.aliyucs.com/entity.csv\\"\\n}","errorExample":""},{"type":"xml","example":"<DownloadEntityResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <EntityTSVFile>https://my-bucket.oss.aliyucs.com/xxx</EntityTSVFile>\\n</DownloadEntityResponse>","errorExample":""}]',
- 'title' => 'DownloadEntity',
- ],
- 'UploadEntity' => [
- 'summary' => '上传数据表格',
- 'methods' => [
- 'get',
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"AppName\\": \\"InstalledApp\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n}","type":"json"}]',
+ 'title' => 'Import Application ',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-28T03:40:47.000Z', 'description' => 'OpenAPI offline'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportApp'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:ImportApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'InstallGlobalApp' => [
+ 'summary' => 'Install a platform-wide application into your workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => [],
'parameters' => [
[
+ 'name' => 'Source',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Source', 'type' => 'string', 'required' => true, 'example' => 'EasyGene', 'title' => ''],
+ ],
+ [
+ 'name' => 'NamespaceName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Namespace name', 'type' => 'string', 'required' => true, 'example' => 'sentieon', 'title' => ''],
+ ],
+ [
+ 'name' => 'AppName',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Application name', 'type' => 'string', 'required' => true, 'example' => 'joint-calling', 'title' => ''],
+ ],
+ [
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Workspace', 'type' => 'string', 'required' => true, 'example' => 'default-workspace', 'title' => ''],
],
[
- 'name' => 'EntityCSVFile',
+ 'name' => 'InstalledAppName',
'in' => 'query',
- 'schema' => [
- 'title' => '表格文件地址',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'https://my-bucket.oss.aliyucs.com/entity.csv',
- ],
+ 'schema' => ['description' => 'Installed application name', 'type' => 'string', 'required' => true, 'example' => 'joint-calling', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The result of creating the application.',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'EntityType' => [
- 'title' => '表格名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'InstalledAppName' => ['description' => 'Installed application name', 'type' => 'string', 'example' => 'InstalledApp', 'title' => ''],
+ 'Workspace' => ['description' => 'Workspace', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'RegionId' => ['description' => 'Region name.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","errorExample":""},{"type":"xml","example":"<UploadEntityResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Workspace>test-workspace</Workspace>\\n <EntityType>sample</EntityType>\\n</UploadEntityResponse>","errorExample":""}]',
- ],
- 'CreateTemplate' => [
- 'summary' => '创建应用模板',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"InstalledAppName\\": \\"InstalledApp\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n}","type":"json"}]',
+ 'title' => 'Install Public Application',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallGlobalApp'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'easygene:InstallGlobalApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListApps' => [
+ 'summary' => 'Lists the applications in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '应用模板名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-template',
- ],
+ 'schema' => ['title' => 'Next Token', 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'TestToken', 'required' => false],
],
[
- 'name' => 'Description',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '应用模板描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a test template',
- ],
+ 'schema' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '5', 'title' => '', 'required' => false],
],
[
- 'name' => 'AppName',
+ 'name' => 'OrderBy',
'in' => 'query',
- 'schema' => [
- 'title' => '应用的名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MyApp',
- ],
+ 'schema' => ['description' => 'The field to sort by.', 'type' => 'string', 'example' => 'createtime', 'title' => '', 'required' => false],
],
[
- 'name' => 'AppRevision',
+ 'name' => 'IsReversed',
'in' => 'query',
- 'schema' => [
- 'title' => '应用的版本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '4.1.4.1-v1.0',
- ],
+ 'schema' => ['description' => 'Specifies whether to sort the results in reverse order.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false],
],
[
- 'name' => 'RevisionTag',
+ 'name' => 'LabelSelector',
'in' => 'query',
- 'schema' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'ProduceVersion',
- ],
+ 'schema' => ['description' => 'The label selector.', 'type' => 'string', 'example' => 'env=test', 'title' => '', 'required' => false],
],
[
- 'name' => 'RootEntity',
+ 'name' => 'Scope',
'in' => 'query',
- 'schema' => [
- 'title' => '根实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestEntity',
- ],
- ],
- [
- 'name' => 'InputsExpression',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '应用的输入',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Task1',
- ],
- 'VariableName' => [
- 'title' => '变量名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fastq1',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'File',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://bucket/file1.fastq',
- ],
- 'Required' => [
- 'title' => '是否必填',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test help',
- ],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => 'The scope of the application.', 'type' => 'string', 'example' => 'Public', 'title' => '', 'required' => false],
],
[
- 'name' => 'OutputsExpression',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '应用的输出',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Task1',
- ],
- 'VariableName' => [
- 'title' => '变量名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'bam',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'File',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://bucket/file.bam',
- ],
- 'Required' => [
- 'title' => '是否必填',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test help',
- ],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
+ 'name' => 'Language',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The description language of the application.', 'type' => 'string', 'example' => 'WDL', 'title' => '', 'required' => false],
],
[
- 'name' => 'Labels',
+ 'name' => 'AppType',
'in' => 'query',
- 'schema' => [
- 'title' => '应用标签',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"key1": "value1"}',
- ],
+ 'schema' => ['description' => 'The application type.', 'type' => 'string', 'example' => 'App', 'title' => '', 'required' => false],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '幂等Token',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'GFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
+ 'schema' => ['description' => 'The search keyword to match application names.', 'type' => 'string', 'example' => 'TestName', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '创建应用模板返回结果',
- 'description' => '',
+ 'title' => '',
+ 'description' => 'The response.',
'type' => 'object',
'properties' => [
- 'Workspace' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'TemplateName' => [
- 'title' => '应用模板名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-template',
- ],
- 'HostId' => [
- 'title' => '主机 ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求 ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
+ 'Apps' => [
+ 'title' => '',
+ 'description' => 'The array of applications.',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'TestApp', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the application was created.', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'title' => ''],
+ 'Description' => ['description' => 'The description of the application.', 'type' => 'string', 'example' => 'This is a test app', 'title' => ''],
+ 'AppType' => ['description' => 'The application type.', 'type' => 'string', 'example' => 'App', 'title' => ''],
+ 'Language' => ['description' => 'The description language of the application.', 'type' => 'string', 'example' => 'WDL', 'title' => ''],
+ 'Scope' => ['description' => 'The visibility scope of the application.', 'type' => 'string', 'example' => 'Public', 'title' => ''],
+ 'Workspace' => ['description' => 'The workspace where the application resides.', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'Source' => ['description' => 'The source of the application.', 'type' => 'string', 'example' => 'EasyGene', 'title' => ''],
+ 'AppDefaultVersion' => ['description' => 'The default version.', 'type' => 'string', 'example' => 'v1', 'title' => ''],
+ 'Labels' => [
+ 'title' => '',
+ 'description' => 'The labels.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'The label.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'MaxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'NextToken' => ['title' => 'Next Token', 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => 'TestToken'],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"TemplateName\\": \\"test-template\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateTemplateResponse>\\n <Workspace>test-workspace</Workspace>\\n <TemplateName>test-template</TemplateName>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</CreateTemplateResponse>","errorExample":""}]',
- ],
- 'GetTemplate' => [
- 'summary' => '查询应用模板的详情',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Apps\\": [\\n {\\n \\"AppName\\": \\"TestApp\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"Description\\": \\"This is a test app\\",\\n \\"AppType\\": \\"App\\",\\n \\"Language\\": \\"WDL\\",\\n \\"Scope\\": \\"Public\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"AppDefaultVersion\\": \\"v1\\",\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n }\\n }\\n ],\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 5,\\n \\"NextToken\\": \\"TestToken\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"TotalCount\\": 5\\n}","type":"json"}]',
+ 'title' => 'Obtain application list',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApps'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListApps',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListAuthorizedSoftware' => [
+ 'summary' => 'Retrieves a list of authorized third-party software.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'Location',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '应用模板名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-template',
- ],
+ 'schema' => ['description' => 'Keywords to search in the software name and software long name.', 'type' => 'string', 'required' => false, 'example' => 'Sentieon', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The field to sort by.', 'type' => 'string', 'required' => false, 'example' => 'LastModified', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsReversed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Invert', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token to start the next page of results. Leave this parameter empty to start from the beginning.', 'type' => 'string', 'required' => false, 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '应用模板详情',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'TemplateName' => [
- 'title' => '应用模板名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-template',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'Description' => [
- 'title' => '应用简要描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test template',
- ],
- 'AppName' => [
- 'title' => '应用的名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MyApp',
- ],
- 'AppRevision' => [
- 'title' => '应用的版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'InputsExpression' => [
- 'title' => '应用输入',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Task1',
- ],
- 'VariableName' => [
- 'title' => '变量名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'File',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://bucket/file1.fastq',
- ],
- 'Required' => [
- 'title' => '是否必须参数',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test help',
- ],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'Labels' => [
- 'title' => '应用标签',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'test',
- 'description' => '',
- ],
- ],
- 'LastModifiedTime' => [
- 'title' => '应用最后修改时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.405878292Z',
- ],
- 'OutputsExpression' => [
- 'title' => '应用的输出参数',
- 'description' => '',
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445', 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'Softwares' => [
+ 'title' => '',
+ 'description' => 'The details of the software.',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'A list of software details.',
'type' => 'object',
'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'jobname',
- ],
- 'VariableName' => [
- 'title' => '变量名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'fastq1',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'string',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'abc_1.fastq.gz',
- ],
- 'Required' => [
- 'title' => '是否必须参数',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
+ 'SoftwareName' => ['description' => 'The software name.', 'type' => 'string', 'example' => 'sentieon', 'title' => ''],
+ 'SoftwareLongName' => ['description' => 'The software long name.', 'type' => 'string', 'example' => 'Sentieon acceleration software', 'title' => ''],
+ 'SoftwareDescription' => ['description' => 'The software description.', 'type' => 'string', 'example' => 'NGS数据二级分析软件，提供基于CPU的加速方案，可替代BWA，GATK，HaplotypeCaller，Mutect和Mutect2等分析流程。包括DNASeq，DNAScope，TNScope等工具', 'title' => ''],
+ 'SoftwareDefaultVersion' => ['description' => 'The software default version.', 'type' => 'string', 'example' => '201911', 'title' => ''],
+ 'SoftwareVersions' => [
+ 'title' => '',
+ 'description' => 'A list of all supported software versions.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The version number.', 'type' => 'string', 'example' => '201911', 'title' => ''],
'example' => '',
],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
+ 'SoftwareLicenseFee' => ['description' => 'The software license fee.', 'type' => 'number', 'format' => 'float', 'example' => '0.15', 'title' => ''],
+ 'Locations' => [
+ 'title' => '',
+ 'description' => 'The regions where the software is available.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The region where the software is available.', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
+ 'example' => '',
],
+ 'HelpLink' => ['description' => 'The help link.', 'type' => 'string', 'example' => 'https://help.aliyun.com/document_detail/257750.html', 'title' => ''],
+ 'SoftwareIcon' => ['description' => 'The software icon link.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN01mmZovA1UJfeKQAYvF_!!6000000002497-2-tps-256-256.png', 'title' => ''],
+ 'LastModified' => ['description' => 'The time when the software information was last modified.', 'type' => 'string', 'example' => 'yyyy/MM/dd HH:mm:ss', 'title' => ''],
+ 'Promotion' => ['description' => 'The description of the limited-time free offer.', 'type' => 'string', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Source' => [
- 'title' => '应用来源',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'EasyGene',
- ],
- 'Workspace' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'RootEntity' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-entity',
- ],
- 'RevisionTag' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'produceVersion',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ['errorCode' => 'InvalidOrderBy.NotFound', 'errorMessage' => 'The specified OrderBy is not found.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateName\\": \\"test-template\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"Description\\": \\"test template\\",\\n \\"AppName\\": \\"MyApp\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"InputsExpression\\": [\\n {\\n \\"TaskName\\": \\"Task1\\",\\n \\"VariableName\\": \\"v1\\",\\n \\"VariableType\\": \\"File\\",\\n \\"VariableValue\\": \\"oss://bucket/file1.fastq\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"test help\\",\\n \\"StepOrder\\": 0\\n }\\n ],\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"LastModifiedTime\\": \\"2021-06-10T13:30:20.405878292Z\\",\\n \\"OutputsExpression\\": [\\n {\\n \\"TaskName\\": \\"jobname\\",\\n \\"VariableName\\": \\"fastq1\\",\\n \\"VariableType\\": \\"string\\",\\n \\"VariableValue\\": \\"abc_1.fastq.gz\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"测序reads文件\\",\\n \\"StepOrder\\": 2\\n }\\n ],\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RootEntity\\": \\"test-entity\\",\\n \\"RevisionTag\\": \\"produceVersion\\"\\n}","errorExample":""},{"type":"xml","example":"<GetTemplateResponse>\\n <TemplateName>test-template</TemplateName>\\n <CreateTime>2021-06-10T13:30:20.414557061Z</CreateTime>\\n <Description>test template</Description>\\n <AppName>MyApp</AppName>\\n <Revision>1</Revision>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <Inputs>\\n <TaskName>Task1</TaskName>\\n <VariableName>v1</VariableName>\\n <VariableType>File</VariableType>\\n <VariableValue>oss://bucket/file1.fastq</VariableValue>\\n <Required>true</Required>\\n <Help>test help</Help>\\n <StepOrder>0</StepOrder>\\n </Inputs>\\n <Labels>\\n <key>test</key>\\n </Labels>\\n <LastModifiedTime>2021-06-10T13:30:20.405878292Z</LastModifiedTime>\\n <Outputs>\\n <TaskName>TestTaskName</TaskName>\\n <VariableName>TestVariableName</VariableName>\\n <VariableType>Int</VariableType>\\n <VariableValue>ExampleValue</VariableValue>\\n <Required>true</Required>\\n <Help>Example help information</Help>\\n <StepOrder>1</StepOrder>\\n </Outputs>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Source>EasyGene</Source>\\n <Workspace>test-workspace</Workspace>\\n <RootEntity>test-entity</RootEntity>\\n</GetTemplateResponse>","errorExample":""}]',
- ],
- 'DeleteTemplate' => [
- 'summary' => '删除应用模板',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Softwares\\": [\\n {\\n \\"SoftwareName\\": \\"sentieon\\",\\n \\"SoftwareLongName\\": \\"Sentieon acceleration software\\",\\n \\"SoftwareDescription\\": \\"NGS数据二级分析软件，提供基于CPU的加速方案，可替代BWA，GATK，HaplotypeCaller，Mutect和Mutect2等分析流程。包括DNASeq，DNAScope，TNScope等工具\\",\\n \\"SoftwareDefaultVersion\\": \\"201911\\",\\n \\"SoftwareVersions\\": [\\n \\"201911\\"\\n ],\\n \\"SoftwareLicenseFee\\": 0.15,\\n \\"Locations\\": [\\n \\"cn-shenzhen\\"\\n ],\\n \\"HelpLink\\": \\"https://help.aliyun.com/document_detail/257750.html\\",\\n \\"SoftwareIcon\\": \\"https://img.alicdn.com/imgextra/i2/O1CN01mmZovA1UJfeKQAYvF_!!6000000002497-2-tps-256-256.png\\",\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\",\\n \\"Promotion\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve third-party software list ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:36.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListAuthorizedSoftware',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'ListContainerImages' => [
+ 'summary' => 'Lists public container images provided by the platform.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'Location',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Region ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '应用模板名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-template',
- ],
+ 'schema' => ['description' => 'Pagination token that marks the starting position for reading results. Leave this parameter empty to start from the beginning.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Maximum number of results per page', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'NextToken' => ['description' => 'Pagination token that indicates the position up to which results have been read in this response. An empty value means all data has been returned.', 'type' => 'string', 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445', 'title' => ''],
+ 'MaxResults' => ['description' => 'Number of results per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'ContainerImages' => [
+ 'title' => '',
+ 'description' => 'List of container images',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Container image',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContainerImageNamespace' => ['description' => 'Container image namespace', 'type' => 'string', 'example' => 'samtools', 'title' => ''],
+ 'ContainerImageName' => ['description' => 'Container image name', 'type' => 'string', 'example' => 'samtools', 'title' => ''],
+ 'ContainerImageDescription' => ['description' => 'Container image description', 'type' => 'string', 'example' => 'a suite of programs for interacting with high-throughput sequencing data.', 'title' => ''],
+ 'ContainerImageVersions' => [
+ 'title' => '',
+ 'description' => 'Container image versions',
+ 'type' => 'array',
+ 'items' => ['description' => 'Container image', 'type' => 'string', 'example' => '1.12--h9aed4be_1', 'title' => ''],
+ 'example' => '',
+ ],
+ 'Location' => ['description' => 'Region where the container image is stored', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
+ 'ContainerRegistry' => ['description' => 'Container image registry name', 'type' => 'string', 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com', 'title' => ''],
+ 'LastModified' => ['description' => 'Last modified time', 'type' => 'string', 'example' => 'yyyy/MM/dd HH:mm:ss', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ContainerImages\\": [\\n {\\n \\"ContainerImageNamespace\\": \\"samtools\\",\\n \\"ContainerImageName\\": \\"samtools\\",\\n \\"ContainerImageDescription\\": \\"a suite of programs for interacting with high-throughput sequencing data.\\",\\n \\"ContainerImageVersions\\": [\\n \\"1.12--h9aed4be_1\\"\\n ],\\n \\"Location\\": \\"cn-shenzhen\\",\\n \\"ContainerRegistry\\": \\"registry-vpc.cn-shenzhen.aliyuncs.com\\",\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Obtain the list of public tool images',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListContainerImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteTemplateResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</DeleteTemplateResponse>","errorExample":""}]',
- 'title' => 'DeleteTemplate',
],
- 'UpdateTemplate' => [
- 'summary' => '修改应用模板',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListEntities' => [
+ 'summary' => 'Queries for a list of entity types in a workspace.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Workspace', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'TemplateName',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '应用模板名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-template',
- ],
+ 'schema' => ['description' => 'Starting query position', 'type' => 'string', 'required' => false, 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
],
[
- 'name' => 'Description',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '应用模板描述',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'This is a test template',
- ],
+ 'schema' => ['description' => 'Maximum results', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
],
[
- 'name' => 'RootEntity',
+ 'name' => 'OrderBy',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test-entity',
- ],
- ],
- [
- 'name' => 'InputsExpression',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '应用的输入',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Task1',
- ],
- 'VariableName' => [
- 'title' => '变量名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fastq1',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'String',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'read_1.fastq.gz',
- ],
- 'Required' => [
- 'title' => '是否必填',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'True',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '',
- ],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'OutputsExpression',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '应用的输出',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Task1',
- ],
- 'VariableName' => [
- 'title' => '变量名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Bam',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'String',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'out.bam',
- ],
- 'Required' => [
- 'title' => '是否必填',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'True',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- ],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => 'Sort condition', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'createtime'],
],
[
- 'name' => 'Labels',
+ 'name' => 'IsReversed',
'in' => 'query',
- 'schema' => [
- 'title' => '应用模板标签',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"key": "value"}',
- ],
+ 'schema' => ['description' => 'Is reversed', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果',
- 'description' => '',
+ 'description' => 'Response data',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'NextToken' => ['description' => 'Token for the next query', 'type' => 'string', 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
+ 'MaxResults' => ['description' => 'Maximum requested results', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total results', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'Entities' => [
+ 'title' => '',
+ 'description' => 'Entity type array',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Table element',
+ 'type' => 'object',
+ 'properties' => [
+ 'EntityType' => ['description' => 'Entity type', 'type' => 'string', 'example' => 'sample', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
- ],
- 'ListTemplates' => [
- 'summary' => '列出应用模板',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"MaxResults\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Entities\\": [\\n {\\n \\"EntityType\\": \\"sample\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Obtain the list of entity types',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListEntities',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEntities'],
+ ],
+ ],
+ ],
+ 'ListEntityItems' => [
+ 'summary' => 'Retrieves the content of the data table for a specific entity in a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5914,507 +3485,173 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Workspace', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '下次查询起始位置',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
+ 'schema' => ['description' => 'Entity type', 'type' => 'string', 'required' => true, 'example' => 'sample', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'minimum' => '0',
- 'example' => '10',
- ],
+ 'schema' => ['description' => 'Search condition', 'type' => 'string', 'example' => 'test', 'title' => '', 'required' => false],
],
[
'name' => 'OrderBy',
'in' => 'query',
- 'schema' => [
- 'title' => '排序依据',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createtime',
- ],
+ 'schema' => ['description' => 'Sort condition', 'type' => 'string', 'required' => false, 'example' => 'createtime', 'title' => ''],
],
[
'name' => 'IsReversed',
'in' => 'query',
- 'schema' => [
- 'title' => '是否逆序',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Whether to sort in reverse order', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
- 'name' => 'LabelSelector',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => 'Label 选择器',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'key1=value1',
- ],
+ 'schema' => ['description' => 'Starting position for the query', 'type' => 'string', 'required' => false, 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
],
[
- 'name' => 'Search',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '查找条件',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['description' => 'Maximum number of results to return', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应结果',
- 'description' => '',
+ 'description' => 'Response data',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'NextToken' => [
- 'title' => '下次查询Token',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Templates' => [
- 'title' => '应用模板列表',
- 'description' => '',
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'MaxResults' => ['description' => 'Maximum number of results requested', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'NextToken' => ['description' => 'Token for the next query', 'type' => 'string', 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of returned items', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'EntityItems' => [
+ 'title' => '',
+ 'description' => 'Array of entity types',
'type' => 'array',
'items' => [
+ 'description' => 'Data table elements',
'type' => 'object',
'properties' => [
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-workspace',
- ],
- 'TemplateName' => [
- 'title' => '应用模板名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-template',
- ],
- 'Labels' => [
- 'title' => '标签',
- 'description' => '',
+ 'EntityName' => ['description' => 'Entity element name', 'type' => 'string', 'example' => 's1', 'title' => ''],
+ 'EntityData' => [
+ 'title' => '',
+ 'description' => 'Data element properties',
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => 'test',
- 'description' => '',
- ],
- ],
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'my-app',
- ],
- 'AppRevision' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RootEntity' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'test-entity',
- ],
- 'InputsExpression' => [
- 'title' => '应用输入',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task1',
- ],
- 'VariableName' => [
- 'title' => '变量名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'fastq1',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'File',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://bucket/file1.fastq',
- ],
- 'Required' => [
- 'title' => '是否必须参数',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'help test',
- ],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'OutputsExpression' => [
- 'title' => '应用的输出参数',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'task1',
- ],
- 'VariableName' => [
- 'title' => '变量名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'v1',
- ],
- 'VariableType' => [
- 'title' => '变量类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'File',
- ],
- 'VariableValue' => [
- 'title' => '变量值',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'oss://bucket/test.vcf',
- ],
- 'Required' => [
- 'title' => '是否必须参数',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Help' => [
- 'title' => '帮助信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'help test',
- ],
- 'StepOrder' => [
- 'title' => '步骤顺序',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'Description' => [
- 'title' => '模板描述信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is a test template',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'LastModifiedTime' => [
- 'title' => '最后修改时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-10T13:30:20.414557061Z',
- ],
- 'RevisionTag' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'ProduceVersion',
+ 'additionalProperties' => ['description' => 'Data element property value', 'type' => 'string', 'example' => 'value', 'title' => ''],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'TotalCount' => [
- 'title' => '返回个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Templates\\": [\\n {\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"TemplateName\\": \\"test-template\\",\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"AppName\\": \\"my-app\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"RootEntity\\": \\"test-entity\\",\\n \\"InputsExpression\\": [\\n {\\n \\"TaskName\\": \\"task1\\",\\n \\"VariableName\\": \\"fastq1\\",\\n \\"VariableType\\": \\"File\\",\\n \\"VariableValue\\": \\"oss://bucket/file1.fastq\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"help test\\",\\n \\"StepOrder\\": 0\\n }\\n ],\\n \\"OutputsExpression\\": [\\n {\\n \\"TaskName\\": \\"task1\\",\\n \\"VariableName\\": \\"v1\\",\\n \\"VariableType\\": \\"File\\",\\n \\"VariableValue\\": \\"oss://bucket/test.vcf\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"help test\\",\\n \\"StepOrder\\": 1\\n }\\n ],\\n \\"Description\\": \\"This is a test template\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"LastModifiedTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"RevisionTag\\": \\"ProduceVersion\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n}","errorExample":""},{"type":"xml","example":"<ListTemplatesResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <MaxResults>10</MaxResults>\\n <NextToken>MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK</NextToken>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <Templates>\\n <Workspace>test-workspace</Workspace>\\n <TemplateName>test-template</TemplateName>\\n <AppName>my-app</AppName>\\n <Revision>1</Revision>\\n <RootEntity>test-entity</RootEntity>\\n <Inputs>\\n <TaskName>task1</TaskName>\\n <VariableName>fastq1</VariableName>\\n <VariableType>File</VariableType>\\n <VariableValue>oss://bucket/file1.fastq</VariableValue>\\n <Required>true</Required>\\n <Help>help test</Help>\\n <StepOrder>0</StepOrder>\\n </Inputs>\\n <Outputs>\\n <TaskName>task1</TaskName>\\n <VariableName>v1</VariableName>\\n <VariableType>File</VariableType>\\n <VariableValue>oss://bucket/test.vcf</VariableValue>\\n <Required>true</Required>\\n <Help>help test</Help>\\n <StepOrder>1</StepOrder>\\n </Outputs>\\n <Description>This is a test template</Description>\\n <CreateTime>2021-06-10T13:30:20.414557061Z</CreateTime>\\n <LastModifiedTime>2021-06-10T13:30:20.414557061Z</LastModifiedTime>\\n </Templates>\\n <TotalCount>10</TotalCount>\\n</ListTemplatesResponse>","errorExample":""}]',
- 'title' => 'ListTemplates',
- ],
- 'CreateSubmission' => [
- 'summary' => '创建提交',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"TotalCount\\": 10,\\n \\"EntityItems\\": [\\n {\\n \\"EntityName\\": \\"s1\\",\\n \\"EntityData\\": {\\n \\"key\\": \\"value\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve Entity Data Table',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEntityItems'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListEntityItems',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListGlobalApps' => [
+ 'summary' => 'Lists public applications on the platform.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名字',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'TestWorkspace',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'TestApp',
- ],
- ],
- [
- 'name' => 'Revision',
- 'in' => 'query',
- 'schema' => [
- 'title' => '应用版本号',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'maximum' => '9223372036854775807',
- 'minimum' => '0',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'RevisionTag',
- 'in' => 'query',
- 'schema' => [
- 'title' => '应用版本唯一标签',
- 'type' => 'string',
- 'example' => 'ProduceVersion',
- ],
- ],
- [
- 'name' => 'EntityType',
+ 'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestEntityType',
- ],
+ 'schema' => ['description' => 'The keyword for a fuzzy search. The system searches for matches in the NamespaceName, AppName, Categories, and AppDescription fields.', 'type' => 'string', 'example' => 'Population variation', 'required' => false, 'title' => ''],
],
[
- 'name' => 'EntityNames',
+ 'name' => 'OrderBy',
'in' => 'query',
- 'allowEmptyValue' => true,
- 'style' => 'json',
- 'schema' => [
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '[“S0001”, “S0002”]',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'The field by which to sort the results.', 'type' => 'string', 'required' => false, 'example' => 'AppName, LastModified, Used', 'title' => ''],
],
[
- 'name' => 'ExecuteOptions',
+ 'name' => 'IsReversed',
'in' => 'query',
- 'schema' => [
- 'title' => '任务配置',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{ "CallCaching": false, "DeleteIntermediateResults": true, "FailureMode": "NoNewCalls" }',
- ],
+ 'schema' => ['description' => 'Specifies whether to sort the results in descending order. Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'ExecuteDirectory',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '任务执行目录',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'oss://my-bucket/my-exe-dir/',
- ],
+ 'schema' => ['description' => 'The token that is used for paging. It specifies the starting point of the query. If you do not specify this parameter, the query starts from the beginning.', 'type' => 'string', 'required' => false, 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda', 'title' => ''],
],
[
- 'name' => 'OutputFolder',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '任务输出拷贝目录',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://my-bucket/my-output-dir/',
- ],
+ 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
],
[
- 'name' => 'DefaultRuntime',
+ 'name' => 'AppScope',
'in' => 'query',
- 'schema' => [
- 'title' => '默认运行时',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The visibility scope. OpenAccess means all content is visible.', 'type' => 'string', 'example' => 'OpenAccess', 'title' => '', 'required' => false],
],
[
- 'name' => 'Inputs',
+ 'name' => 'Category',
'in' => 'query',
- 'schema' => [
- 'title' => '任务输入',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The application category.', 'type' => 'string', 'example' => '群体变异', 'title' => '', 'required' => false],
],
[
- 'name' => 'Outputs',
+ 'name' => 'Toolkit',
'in' => 'query',
- 'schema' => [
- 'title' => '任务输出',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
+ 'schema' => ['description' => 'The toolkit.', 'type' => 'string', 'example' => 'Sentieon', 'title' => '', 'required' => false],
],
[
- 'name' => 'ClientToken',
+ 'name' => 'Location',
'in' => 'query',
- 'schema' => [
- 'title' => '任务幂等token',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestToken',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => '', 'required' => false],
],
],
'responses' => [
@@ -6422,63 +3659,95 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'SubmissionId' => [
- 'title' => '投递ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'GlobalApps' => [
+ 'title' => '',
+ 'description' => 'A list of public applications.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A public application.',
+ 'type' => 'object',
+ 'properties' => [
+ 'NamespaceName' => ['description' => 'The name of the namespace.', 'type' => 'string', 'example' => 'sentieon', 'title' => ''],
+ 'AppScope' => ['description' => 'The application permission.', 'type' => 'string', 'example' => 'OpenAccess', 'title' => ''],
+ 'AppName' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'joint-calling', 'title' => ''],
+ 'AppDescription' => ['description' => 'The application description.', 'type' => 'string', 'example' => 'Use Sentieon for large-scale sample population variant detection.', 'title' => ''],
+ 'Toolkit' => ['description' => 'The application toolkit.', 'type' => 'string', 'example' => 'Sentieon', 'title' => ''],
+ 'AppFee' => ['description' => 'The billing description for the application.', 'type' => 'string', 'example' => '实际使用时，计算该应用消耗的资源费用。', 'title' => ''],
+ 'AppDefaultVersion' => ['description' => 'The default version of the application.', 'type' => 'string', 'example' => '1.0', 'title' => ''],
+ 'Pinned' => ['description' => 'Indicates whether the application is pinned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'LastModified' => ['description' => 'The time when the application was last updated.', 'type' => 'string', 'example' => 'yyyy/MM/dd HH:mm:ss', 'title' => ''],
+ 'Locations' => [
+ 'title' => '',
+ 'description' => 'The IDs of the regions where the application is supported.',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'example' => 'cn-shenzhen', 'description' => '', 'title' => ''],
+ 'example' => '',
+ ],
+ 'Categories' => [
+ 'title' => '',
+ 'description' => 'A list of categories to which the application belongs.',
+ 'type' => 'array',
+ 'items' => ['description' => 'The application category.', 'type' => 'string', 'example' => '群体变异检测', 'title' => ''],
+ 'example' => '',
+ ],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'NextToken' => ['description' => 'The pagination token. It is used to retrieve the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445', 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
- 404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ 403 => [
+ ['errorCode' => 'InvalidUser.AccessDenied', 'errorMessage' => 'The request was denied due to insufficient user permission.', 'description' => 'The request was denied due to insufficient user permission.'],
+ ],
+ [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateSubmissionResponse>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <Workspace>TestWorkspace</Workspace>\\n <SubmissionId>sub-13BeXWnGvrOl3MC124tazcJVKaV</SubmissionId>\\n</CreateSubmissionResponse>","errorExample":""}]',
- ],
- 'GetSubmission' => [
- 'summary' => '获取投递详情',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"GlobalApps\\": [\\n {\\n \\"NamespaceName\\": \\"sentieon\\",\\n \\"AppScope\\": \\"OpenAccess\\",\\n \\"AppName\\": \\"joint-calling\\",\\n \\"AppDescription\\": \\"Use Sentieon for large-scale sample population variant detection.\\",\\n \\"Toolkit\\": \\"Sentieon\\",\\n \\"AppFee\\": \\"实际使用时，计算该应用消耗的资源费用。\\",\\n \\"AppDefaultVersion\\": \\"1.0\\",\\n \\"Pinned\\": true,\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\",\\n \\"Locations\\": [\\n \\"cn-shenzhen\\"\\n ],\\n \\"Categories\\": [\\n \\"群体变异检测\\"\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
+ 'title' => 'Retrieve the public application list ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListGlobalApps',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'translator' => 'machine',
+ ],
+ 'ListPublicDataset' => [
+ 'summary' => 'Lists the public datasets on the platform.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6486,283 +3755,252 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'TestWorkspace',
- ],
+ 'schema' => ['description' => 'Keywords to search in the name and description.', 'type' => 'string', 'example' => 'Simons Genome Diversity Project', 'required' => false, 'title' => ''],
],
[
- 'name' => 'SubmissionId',
+ 'name' => 'Tag',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The tag of the public dataset.', 'type' => 'string', 'required' => false, 'example' => '遗传多样性', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderBy',
'in' => 'query',
'schema' => [
- 'title' => '投递ID',
- 'description' => '',
+ 'description' => 'The field to sort by.',
+ 'enumValueTitles' => ['LastModified' => 'Last modified time', 'DatasetName' => 'Dataset name'],
'type' => 'string',
- 'required' => true,
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
+ 'required' => false,
+ 'example' => 'LastModified',
+ 'title' => '',
],
],
+ [
+ 'name' => 'IsReversed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Sorts the results in descending order. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The token to retrieve the next page of results. Leave this empty to get the first page.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
+ ],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'Submission' => [
- 'title' => '投递详情',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Workspace' => [
- 'title' => '提交ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'SubmissionId' => [
- 'title' => '提交ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Succeeded',
- ],
- 'CreateTime' => [
- 'title' => '提交时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestEntityType',
- ],
- 'RunStats' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'Submitted' => [
- 'title' => '已提交数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Pending' => [
- 'title' => '等待中数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Running' => [
- 'title' => '运行中数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Succeeded' => [
- 'title' => '已成功数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Failed' => [
- 'title' => '已失败数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Aborting' => [
- 'title' => '取消中数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Aborted' => [
- 'title' => '已取消数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'NextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is not returned, all results have been returned.', 'type' => 'string', 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445', 'title' => ''],
+ 'MaxResults' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'Datasets' => [
+ 'title' => '',
+ 'description' => 'A list of public datasets.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'A public dataset.',
+ 'type' => 'object',
+ 'properties' => [
+ 'LastModified' => ['description' => 'The time the dataset was last updated.', 'type' => 'string', 'example' => 'yyyy/MM/dd HH:mm:ss', 'title' => ''],
+ 'Copyright' => ['description' => 'The copyright information for the public dataset.', 'type' => 'string', 'example' => 'This dataset is publicly available for everyone, but users must comply with the terms specified by the dataset source (Fort Lauderdale principles)', 'title' => ''],
+ 'AccessRequirements' => ['description' => 'The access requirements for the public dataset.', 'type' => 'string', 'example' => 'Alibaba Cloud "as is" provides datasets, without any express or implied warranties.', 'title' => ''],
+ 'About' => ['description' => 'Information about the public dataset.', 'type' => 'string', 'example' => 'The complete dataset includes 279 genomes, See the published articles for details. Alibaba Cloud has collected the fully public variant results recorded in the project documentation asVCF files.', 'title' => ''],
+ 'Tags' => [
+ 'title' => '',
+ 'description' => 'A list of tags for the public dataset.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A tag.', 'type' => 'string', 'example' => '遗传多样性', 'title' => ''],
+ 'example' => 'Genetic diversity',
+ ],
+ 'DatasetName' => ['description' => 'The name of the public dataset.', 'type' => 'string', 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
+ 'DatasetDescription' => ['description' => 'The Simons Genome Diversity Project (SGDP) is currently the world\'s largest and highest-quality human population diversity genome data.', 'type' => 'string', 'example' => 'This are access requirements', 'title' => ''],
+ 'UpdateFrequency' => ['description' => 'The update frequency of the public dataset.', 'type' => 'string', 'example' => 'Synchronize promptly after origin server update', 'title' => ''],
+ 'Locations' => [
+ 'title' => '',
+ 'description' => 'The regions where the public dataset is available.',
+ 'type' => 'array',
+ 'items' => ['description' => 'A region where the public dataset is available.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
+ 'example' => '',
],
+ 'DatasetId' => ['description' => 'The ID of the public dataset.', 'type' => 'string', 'title' => '', 'example' => '20943***'],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ['errorCode' => 'InvalidOrderBy.NotFound', 'errorMessage' => 'The specified OrderBy is not found.', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"Submission\\": {\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"StartTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"EndTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"EntityType\\": \\"TestEntityType\\",\\n \\"RunStats\\": {\\n \\"Submitted\\": 5,\\n \\"Pending\\": 5,\\n \\"Running\\": 5,\\n \\"Succeeded\\": 5,\\n \\"Failed\\": 5,\\n \\"Aborting\\": 5,\\n \\"Aborted\\": 5\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSubmissionResponse>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <Submission>\\n <Workspace>TestWorkspace</Workspace>\\n <SubmissionId>sub-13BeXWnGvrOl3MC124tazcJVKaV</SubmissionId>\\n <Status>Succeeded</Status>\\n <CreateTime>2021-06-16T15:09:14.378297+08:00</CreateTime>\\n <StartTime>2021-06-16T15:09:14.378297+08:00</StartTime>\\n <EndTime>2021-06-16T15:09:14.378297+08:00</EndTime>\\n <EntityType>TestEntityType</EntityType>\\n <RunStats>\\n <Submitted>5</Submitted>\\n <Pending>5</Pending>\\n <Running>5</Running>\\n <Succeeded>5</Succeeded>\\n <Failed>5</Failed>\\n <Aborting>5</Aborting>\\n <Aborted>5</Aborted>\\n </RunStats>\\n </Submission>\\n</GetSubmissionResponse>","errorExample":""}]',
- 'title' => 'GetSubmission',
- ],
- 'DeleteSubmission' => [
- 'summary' => '删除投递',
- 'methods' => [
- 'post',
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Datasets\\": [\\n {\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\",\\n \\"Copyright\\": \\"This dataset is publicly available for everyone, but users must comply with the terms specified by the dataset source (Fort Lauderdale principles)\\",\\n \\"AccessRequirements\\": \\"Alibaba Cloud \\\\\\"as is\\\\\\" provides datasets, without any express or implied warranties.\\",\\n \\"About\\": \\"The complete dataset includes 279 genomes, See the published articles for details. Alibaba Cloud has collected the fully public variant results recorded in the project documentation asVCF files.\\",\\n \\"Tags\\": [\\n \\"遗传多样性\\"\\n ],\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"DatasetDescription\\": \\"This are access requirements\\",\\n \\"UpdateFrequency\\": \\"Synchronize promptly after origin server update\\",\\n \\"Locations\\": [\\n \\"cn-beijing\\"\\n ],\\n \\"DatasetId\\": \\"20943***\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve the list of public datasets',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:40.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:40.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListPublicDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'translator' => 'machine',
+ ],
+ 'ListPublicDatasetEntities' => [
+ 'summary' => 'Lists the entity types in a public dataset.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'DatasetName',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestWorkspace',
- ],
+ 'schema' => ['description' => 'Name of the public dataset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
],
[
- 'name' => 'SubmissionId',
+ 'name' => 'OrderBy',
'in' => 'query',
- 'schema' => [
- 'title' => '投递ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
+ 'schema' => ['description' => 'Field to sort by.', 'type' => 'string', 'required' => false, 'example' => 'LastModified', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsReversed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Whether to reverse the sort order. Default is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Pagination token that marks the starting position for the next page. Leave empty to start from the beginning.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
+ 'HostId' => ['description' => 'Host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'NextToken' => ['description' => 'Pagination token that marks the position of the last result returned. Empty means all data has been retrieved.', 'type' => 'string', 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445', 'title' => ''],
+ 'MaxResults' => ['description' => 'Number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'DatasetName' => ['description' => 'Name of the public dataset.', 'type' => 'string', 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
+ 'Entities' => [
+ 'title' => '',
+ 'description' => 'The entity contains all of its types.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'List of entity types.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EntityType' => ['description' => 'Entity type.', 'type' => 'string', 'example' => 'sample', 'title' => ''],
+ ],
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- ],
- 409 => [
- [
- 'errorCode' => 'StatusConflict',
- 'errorMessage' => 'The specified action %s is not supported in current status %s.',
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ['errorCode' => 'InvalidPublicDataset.NotFound', 'errorMessage' => 'The specified PublicDatasetName is not found.', 'description' => ''],
+ ['errorCode' => 'InvalidOrderBy.NotFound', 'errorMessage' => 'The specified OrderBy is not found.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"Entities\\": [\\n {\\n \\"EntityType\\": \\"sample\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve the list of entity types in a public dataset ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:37.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:37.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListPublicDatasetEntities',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSubmissionResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</DeleteSubmissionResponse>","errorExample":""}]',
- 'title' => 'DeleteSubmission',
],
- 'ListSubmissions' => [
- 'summary' => '列出投递',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListPublicDatasetEntityItems' => [
+ 'summary' => 'Queries the data table of a specific entity in a public dataset.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6770,99 +4008,47 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'DatasetName',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'TestWorkspace',
- ],
+ 'schema' => ['description' => 'Name of the dataset.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
],
[
- 'name' => 'Status',
+ 'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '状态',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Failed',
- 'enum' => [
- 'Running',
- 'Pending',
- 'Aborting',
- 'Finished',
- 'Aborted',
- 'Failed',
- ],
- ],
+ 'schema' => ['description' => 'Type of the entity.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sample', 'title' => ''],
],
[
'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '搜索ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
+ 'schema' => ['description' => 'Keyword to search for in the entity name.', 'type' => 'string', 'required' => false, 'example' => 's1', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'OrderBy',
'in' => 'query',
- 'schema' => [
- 'title' => 'Next Token',
- 'description' => 'Next Token',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TestToken',
- ],
+ 'schema' => ['description' => 'Field to sort by.', 'type' => 'string', 'required' => false, 'example' => 'LastModified', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'IsReversed',
'in' => 'query',
- 'schema' => [
- 'title' => '最大返回数目',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '5',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'Whether to reverse the sort order. Default is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
- 'name' => 'OrderBy',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '排序依据',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createtime',
- ],
+ 'schema' => ['description' => 'Pagination token that marks the starting position for the next page. Leave empty to start from the beginning.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda', 'title' => ''],
],
[
- 'name' => 'IsReversed',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '逆序',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'Location',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => '', 'required' => false],
],
],
'responses' => [
@@ -6870,361 +4056,255 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'NextToken' => [
- 'title' => '下次查询Token',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestToken',
- ],
- 'TotalCount' => [
- 'title' => '返回个数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'Submissions' => [
- 'title' => '投递列表',
- 'description' => '',
+ 'HostId' => ['description' => 'Host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'NextToken' => ['description' => 'Pagination token that indicates the position up to which data has been read. Empty means all data has been read.', 'type' => 'string', 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445', 'title' => ''],
+ 'MaxResults' => ['description' => 'Number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'DatasetName' => ['description' => 'Name of the public dataset.', 'type' => 'string', 'example' => '西蒙斯基因组多样性计划', 'title' => ''],
+ 'EntityItems' => [
+ 'title' => '',
+ 'description' => 'All table data for this entity.',
'type' => 'array',
'items' => [
+ 'description' => 'Entity object.',
'type' => 'object',
'properties' => [
- 'Workspace' => [
- 'title' => '工作空间名字',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'SubmissionId' => [
- 'title' => '提交ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Succeeded',
- ],
- 'CreateTime' => [
- 'title' => '提交时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => '2021-06-16T15:09:14.378297+08:00',
- ],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestEntityType',
- ],
- 'RunStats' => [
- 'description' => '',
+ 'EntityName' => ['description' => 'Name of the entity.', 'type' => 'string', 'example' => 'sample', 'title' => ''],
+ 'EntityData' => [
+ 'title' => '',
+ 'description' => 'Data of the entity.',
'type' => 'object',
- 'properties' => [
- 'Submitted' => [
- 'title' => '已提交数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Pending' => [
- 'title' => '等待中数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Running' => [
- 'title' => '运行中数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Succeeded' => [
- 'title' => '已成功数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Failed' => [
- 'title' => '已失败数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Aborting' => [
- 'title' => '取消中数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'Aborted' => [
- 'title' => '已取消数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- ],
+ 'additionalProperties' => ['description' => 'Value of the entity property.', 'type' => 'string', 'example' => '{ "key1": "value1" }', 'title' => ''],
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ['errorCode' => 'InvalidPublicDataset.NotFound', 'errorMessage' => 'The specified PublicDatasetName is not found.', 'description' => ''],
+ ['errorCode' => 'InvalidOrderBy.NotFound', 'errorMessage' => 'The specified OrderBy is not found.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"EntityItems\\": [\\n {\\n \\"EntityName\\": \\"sample\\",\\n \\"EntityData\\": {\\n \\"key\\": \\"{ \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\" }\\"\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query public dataset entity data table',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListPublicDatasetEntityItems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 5,\\n \\"NextToken\\": \\"TestToken\\",\\n \\"TotalCount\\": 5,\\n \\"Submissions\\": [\\n {\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"StartTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"EndTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"EntityType\\": \\"TestEntityType\\",\\n \\"RunStats\\": {\\n \\"Submitted\\": 5,\\n \\"Pending\\": 5,\\n \\"Running\\": 5,\\n \\"Succeeded\\": 5,\\n \\"Failed\\": 5,\\n \\"Aborting\\": 5,\\n \\"Aborted\\": 5\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListSubmissionsResponse>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <MaxResults>5</MaxResults>\\n <NextToken>TestToken</NextToken>\\n <TotalCount>5</TotalCount>\\n <Submissions>\\n <Workspace>TestWorkspace</Workspace>\\n <SubmissionId>sub-13BeXWnGvrOl3MC124tazcJVKaV</SubmissionId>\\n <Status>Succeeded</Status>\\n <CreateTime>2021-06-16T15:09:14.378297+08:00</CreateTime>\\n <StartTime>2021-06-16T15:09:14.378297+08:00</StartTime>\\n <EndTime>2021-06-16T15:09:14.378297+08:00</EndTime>\\n <EntityType>TestEntityType</EntityType>\\n <RunStats>\\n <Submitted>5</Submitted>\\n <Pending>5</Pending>\\n <Running>5</Running>\\n <Succeeded>5</Succeeded>\\n <Failed>5</Failed>\\n <Aborting>5</Aborting>\\n <Aborted>5</Aborted>\\n </RunStats>\\n </Submissions>\\n</ListSubmissionsResponse>","errorExample":""}]',
- 'title' => 'ListSubmissions',
],
- 'AbortSubmission' => [
- 'summary' => '取消投递',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListPublicDatasetTags' => [
+ 'summary' => 'Retrieves the categorization tags for public datasets.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
- 'name' => 'Workspace',
+ 'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'test-workspace',
- ],
+ 'schema' => ['description' => 'Keyword to search in tag names.', 'type' => 'string', 'example' => 'Genetic diversity', 'required' => false, 'title' => ''],
],
[
- 'name' => 'SubmissionId',
+ 'name' => 'OrderBy',
'in' => 'query',
- 'schema' => [
- 'title' => '投递ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
+ 'schema' => ['description' => 'Sort field: TagName, LastModified.', 'type' => 'string', 'required' => false, 'example' => 'LastModified', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsReversed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Invert sort order.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Paging token. Marks the current read position. Leave empty to start from the beginning.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
+ 'HostId' => ['description' => 'Host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'NextToken' => ['description' => 'Paging token. Indicates the position read by the current call. An empty value means all data has been read.', 'type' => 'string', 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445', 'title' => ''],
+ 'MaxResults' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total record count.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
+ 'Tags' => [
+ 'title' => '',
+ 'description' => 'Public dataset tags.',
+ 'type' => 'array',
+ 'items' => ['description' => 'Tag.', 'type' => 'string', 'example' => '遗传多样性', 'title' => ''],
+ 'example' => 'Genetic diversity',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ['errorCode' => 'InvalidOrderBy.NotFound', 'errorMessage' => 'The specified OrderBy is not found.', 'description' => ''],
],
- 409 => [
- [
- 'errorCode' => 'StatusConflict',
- 'errorMessage' => 'The specified action %s is not supported in current status %s.',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Tags\\": [\\n \\"遗传多样性\\"\\n ]\\n}","type":"json"}]',
+ 'title' => 'Obtain public dataset categories',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:37.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T07:03:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListPublicDatasetTags',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"easygene.cn-beijing.aliyuncs.com\\"\\n}","errorExample":""},{"type":"xml","example":"<AbortSubmissionResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>easygene.cn-beijing.aliyuncs.com</RequestId>\\n</AbortSubmissionResponse>","errorExample":""}]',
- 'title' => 'AbortSubmission',
+ 'translator' => 'machine',
],
- 'ResumeSubmission' => [
- 'summary' => '恢复投递',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListRegions' => [
+ 'summary' => 'Lists the regions supported by the gene analysis platform, such as North China 2 (Beijing).',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- ],
- 'parameters' => [
- [
- 'name' => 'Workspace',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'TestWorkspace',
- ],
- ],
- [
- 'name' => 'SubmissionId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '投递ID',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV',
- ],
- ],
- ],
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回结果',
- 'description' => '',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Regions' => [
+ 'title' => '',
+ 'description' => 'Regions where the gene cloud product is online',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'LocalName' => ['description' => 'Name', 'type' => 'string', 'example' => '华北2-北京', 'title' => ''],
+ 'RegionEndpoint' => ['description' => 'Access Endpoint', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RegionId' => ['description' => 'Region ID', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"华北2-北京\\",\\n \\"RegionEndpoint\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Query the published Regions of the product',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:38.000Z', 'description' => 'Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListRegions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","errorExample":""},{"type":"xml","example":"<ResumeSubmissionResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n</ResumeSubmissionResponse>","errorExample":""}]',
- 'title' => 'ResumeSubmission',
],
- 'ListGlobalApps' => [
- 'summary' => '获取平台公共应用列表',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListRuns' => [
+ 'summary' => 'Lists runs in a workspace.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7232,112 +4312,84 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'Search',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '模糊搜索字段：NamesapceName AppName Categories AppDescription',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '群体变异',
- ],
+ 'schema' => ['description' => 'Workspace', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'OrderBy',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'title' => '排序字段:AppName,LastModified,Used',
- 'description' => '',
+ 'description' => 'Status',
'type' => 'string',
'required' => false,
- 'example' => 'AppName, LastModified, Used',
+ 'example' => 'Running',
+ 'enum' => ['Running', 'Submitted', 'Pending', 'Failed', 'Succeeded', 'Aborting', 'Aborted'],
+ 'title' => '',
],
],
[
- 'name' => 'IsReversed',
+ 'name' => 'SubmissionId',
'in' => 'query',
- 'schema' => [
- 'title' => '是否倒序，默认倒序排列',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Submission ID', 'type' => 'string', 'required' => false, 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '翻页Token用来标记当前开始读取的位置，置空表示从头开始',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda',
- ],
+ 'schema' => ['description' => 'Search ID', 'type' => 'string', 'required' => false, 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ', 'title' => ''],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'LabelSelector',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'Label selector', 'type' => 'string', 'example' => 'env=test', 'title' => '', 'required' => false],
],
[
- 'name' => 'AppScope',
+ 'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'title' => '可见范围',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'OpenAccess',
- ],
+ 'schema' => ['description' => 'Application name', 'type' => 'string', 'example' => 'MyApp', 'title' => '', 'required' => false],
],
[
- 'name' => 'Category',
+ 'name' => 'AppRevision',
'in' => 'query',
- 'schema' => [
- 'title' => '分类',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '群体变异',
- ],
+ 'schema' => ['description' => 'Application version', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '4.1.4.1-v1.0'],
],
[
- 'name' => 'Toolkit',
+ 'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '工具集',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Sentieon',
- ],
+ 'schema' => ['description' => 'Entity type', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'sample'],
],
[
- 'name' => 'Location',
+ 'name' => 'EntityName',
'in' => 'query',
- 'schema' => [
- 'title' => '区域Id',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shenzhen',
- ],
+ 'schema' => ['description' => 'Entity name', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'S001'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Starting position of the query', 'type' => 'string', 'required' => false, 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Maximum number of results to return', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Sort by field', 'type' => 'string', 'required' => false, 'example' => 'createtime', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsReversed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Reverse sort order', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
+ ],
+ [
+ 'name' => 'GetTotal',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Return total count of runs', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false],
],
],
'responses' => [
@@ -7345,166 +4397,105 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'GlobalApps' => [
- 'title' => '公共应用集合',
- 'description' => '',
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'MaxResults' => ['description' => 'Maximum number of results returned', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'NextToken' => ['description' => 'Token for the next query', 'type' => 'string', 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
+ 'TotalCount' => ['description' => 'Number of results returned', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'Runs' => [
+ 'title' => '',
+ 'description' => 'Run list',
'type' => 'array',
'items' => [
- 'description' => '',
+ 'description' => 'Run list',
'type' => 'object',
'properties' => [
- 'NamespaceName' => [
- 'title' => '命名空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sentieon',
- ],
- 'AppScope' => [
- 'title' => '应用权限',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OpenAccess',
- ],
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'joint-calling',
- ],
- 'AppDescription' => [
- 'title' => '应用描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is app description.',
- ],
- 'Toolkit' => [
- 'title' => '应用工具合集',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Sentieon',
- ],
- 'AppFee' => [
- 'title' => '应用计费说明',
- 'description' => '',
- 'type' => 'string',
- 'example' => '实际使用时，计算该应用消耗的资源费用。',
- ],
- 'AppDefaultVersion' => [
- 'title' => '应用默认版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'Pinned' => [
- 'title' => '应用收藏置顶标记',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'LastModified' => [
- 'title' => '更新时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yyyy/MM/dd HH:mm:ss',
- ],
- 'Locations' => [
- 'title' => '应用支持的区域ids',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
+ 'AppName' => ['description' => 'Application name', 'type' => 'string', 'example' => 'MyApp', 'title' => ''],
+ 'Source' => ['description' => 'Application source', 'type' => 'string', 'example' => 'EasyGene', 'title' => ''],
+ 'Labels' => [
+ 'title' => '',
+ 'description' => 'Run labels',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Label', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'example' => '',
],
- 'Categories' => [
- 'title' => '应用所属分类',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '群体变异检测',
+ 'RunName' => ['description' => 'Run name', 'type' => 'string', 'example' => 'test-run', 'title' => ''],
+ 'AppRevision' => ['description' => 'Application version number', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'RunId' => ['description' => 'Run ID', 'type' => 'string', 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ', 'title' => ''],
+ 'Status' => ['description' => 'Run status', 'type' => 'string', 'example' => 'Running', 'title' => ''],
+ 'CreateTime' => ['description' => 'Submission time', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'title' => ''],
+ 'StartTime' => ['description' => 'Start time', 'type' => 'string', 'example' => '2021-06-10T13:31:20.414557061Z', 'title' => ''],
+ 'EndTime' => ['description' => 'End time', 'type' => 'string', 'example' => '2021-06-10T13:38:20.414557061Z', 'title' => ''],
+ 'SubmissionId' => ['description' => 'Submission ID', 'type' => 'string', 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
+ 'EntityName' => ['description' => 'Entity name', 'type' => 'string', 'example' => 's1', 'title' => ''],
+ 'EntityType' => ['description' => 'Entity object ID', 'type' => 'string', 'example' => 'sample', 'title' => ''],
+ 'ExecuteDirectory' => ['description' => 'Execution directory', 'type' => 'string', 'title' => '', 'example' => 'oss://my-bucket/my-execdir/'],
+ 'ExecuteOptions' => [
+ 'description' => 'Execution options',
+ 'type' => 'object',
+ 'properties' => [
+ 'CallCaching' => ['description' => 'Enable call caching', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'DeleteIntermediateResults' => ['description' => 'Delete intermediate files', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'FailureMode' => ['description' => 'Failure mode', 'type' => 'string', 'example' => 'NoNewCalls', 'title' => ''],
+ 'UseRelativeOutputPaths' => ['description' => 'Use relative output paths', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'Inputs' => ['description' => 'Input parameters', 'type' => 'string', 'example' => '{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }', 'title' => ''],
+ 'DefaultRuntime' => ['description' => 'Default runtime', 'type' => 'string', 'example' => '{}', 'title' => ''],
+ 'Workspace' => ['description' => 'Workspace', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'RegionId' => ['description' => 'Region', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'NextToken' => [
- 'title' => '翻页Token用来表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445',
- ],
- 'MaxResults' => [
- 'title' => '分页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '本次请求条件下的数据总量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
- 403 => [
- [
- 'errorCode' => 'InvalidUser.AccessDenied',
- 'errorMessage' => 'The request was denied due to insufficient user permission.',
- ],
+ 404 => [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"TotalCount\\": 10,\\n \\"Runs\\": [\\n {\\n \\"AppName\\": \\"MyApp\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"RunName\\": \\"test-run\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"RunId\\": \\"run-13BeYuxc0fxO24uA75UppTiMRoQ\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"StartTime\\": \\"2021-06-10T13:31:20.414557061Z\\",\\n \\"EndTime\\": \\"2021-06-10T13:38:20.414557061Z\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"EntityName\\": \\"s1\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"ExecuteDirectory\\": \\"oss://my-bucket/my-execdir/\\",\\n \\"ExecuteOptions\\": {\\n \\"CallCaching\\": false,\\n \\"DeleteIntermediateResults\\": false,\\n \\"FailureMode\\": \\"NoNewCalls\\",\\n \\"UseRelativeOutputPaths\\": false\\n },\\n \\"Inputs\\": \\"{ \\\\\\"workflow1.task1.param1\\\\\\": \\\\\\"helloooo.txt\\\\\\", \\\\\\"workflow1.task1.param2\\\\\\": \\\\\\"abc\\\\\\", \\\\\\"workflow1.task2.param1\\\\\\": \\\\\\"new_helloooo.txt\\\\\\", \\\\\\"workflow1.task2.param2\\\\\\": \\\\\\"def\\\\\\" }\\",\\n \\"DefaultRuntime\\": \\"{}\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve the list of running Jobs ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRuns'],
],
+ ],
+ 'ramActions' => [
[
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListRuns',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"GlobalApps\\": [\\n {\\n \\"NamespaceName\\": \\"sentieon\\",\\n \\"AppScope\\": \\"OpenAccess\\",\\n \\"AppName\\": \\"joint-calling\\",\\n \\"AppDescription\\": \\"使用Sentieon进行大规模样本的群体变异检测。\\",\\n \\"Toolkit\\": \\"Sentieon\\",\\n \\"AppFee\\": \\"实际使用时，计算该应用消耗的资源费用。\\",\\n \\"AppDefaultVersion\\": \\"1.0\\",\\n \\"Pinned\\": true,\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\",\\n \\"Locations\\": [\\n \\"cn-shenzhen\\"\\n ],\\n \\"Categories\\": [\\n \\"群体变异检测\\"\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<ListGlobalAppsResponse>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <GlobalApps>\\n <NamespaceName>sentieon</NamespaceName>\\n <AppScope>OpenAccess</AppScope>\\n <AppName>joint-calling</AppName>\\n <AppDescription>使用Sentieon进行大规模样本的群体变异检测。</AppDescription>\\n <Toolkit>Sentieon</Toolkit>\\n <AppFee>实际使用时，计算该应用消耗的资源费用。</AppFee>\\n <AppDefaultVersion>1.0</AppDefaultVersion>\\n <Pinned>true</Pinned>\\n <LastModified>yyyy/MM/dd HH:mm:ss</LastModified>\\n <RegionIds>cn-shenzhen</RegionIds>\\n <Categories>群体变异检测</Categories>\\n </GlobalApps>\\n <NextToken>ba6d88e2-a6f2-4d2c-a2ae-68b76b078445</NextToken>\\n <MaxResults>10</MaxResults>\\n <TotalCount>100</TotalCount>\\n</ListGlobalAppsResponse>","errorExample":""}]',
- 'title' => 'ListGlobalApps',
],
- 'GetGlobalApp' => [
- 'summary' => '查询平台公共应用详情',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ListSubmissions' => [
+ 'summary' => 'Retrieves a list of submissions in a workspace.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7512,72 +4503,49 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'Attributes',
+ 'name' => 'Workspace',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '查询字段信息：appVersions，regionIds，dag',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- 'example' => 'appVersions',
- ],
- 'required' => false,
- 'example' => 'AppVersion, AppDescriptorFiles, DescriptorType, DAG, Document, Comment, Alias, NamespaceName, AppScope, AppName, AppDescription, RegionIds, Categories, Toolkit, AppVersions, AppDefaultVersion, AppFee, LastModified, Pinned, Contact, Links, AppType',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'NamespaceName',
+ 'name' => 'Status',
'in' => 'query',
'schema' => [
- 'title' => '命名空间',
- 'description' => '',
+ 'description' => 'The status.',
'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sentieon',
+ 'required' => false,
+ 'example' => 'Failed',
+ 'enum' => ['Running', 'Pending', 'Aborting', 'Finished', 'Aborted', 'Failed'],
+ 'title' => '',
],
],
[
- 'name' => 'AppName',
+ 'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'joint-calling',
- ],
+ 'schema' => ['description' => 'The search ID.', 'type' => 'string', 'required' => false, 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
],
[
- 'name' => 'AppVersion',
+ 'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1.0',
- ],
+ 'schema' => ['title' => 'Next Token', 'description' => 'The pagination token.', 'type' => 'string', 'required' => false, 'example' => 'TestToken'],
],
[
- 'name' => 'Location',
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '应用可用区域',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shenzhen',
- ],
+ 'schema' => ['description' => 'The maximum number of entries to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '5', 'default' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The property to sort by.', 'type' => 'string', 'required' => false, 'example' => 'createtime', 'title' => ''],
+ ],
+ [
+ 'name' => 'IsReversed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Reverse order.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
@@ -7585,259 +4553,92 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'LastModified' => [
- 'title' => '更新时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yyyy/MM/dd HH:mm:ss',
- ],
- 'NamespaceName' => [
- 'title' => '命名空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sentieon',
- ],
- 'AppScope' => [
- 'title' => '应用权限',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'OpenAccess / Protected',
- ],
- 'AppName' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'joint-calling',
- ],
- 'Locations' => [
- 'title' => '应用支持的区域',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
- ],
- 'AppVersion' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.2a-3',
- ],
- 'AppType' => [
- 'title' => '应用类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'workflow',
- ],
- 'AppFee' => [
- 'title' => '应用计费说明',
- 'description' => '',
- 'type' => 'string',
- 'example' => '实际使用时，计算该应用消耗的资源费用',
- ],
- 'AppDescription' => [
- 'title' => '应用描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is app description.',
- ],
- 'Categories' => [
- 'title' => '应用所属分类',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '群体变异',
- ],
- ],
- 'Toolkit' => [
- 'title' => '应用所属工具合集',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Sentieon',
- ],
- 'Contact' => [
- 'title' => '应用联系人信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'support@sentieon.com',
- ],
- 'Links' => [
- 'title' => '应用主页信息',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'http://www.sentieon.com',
- ],
- ],
- 'AppVersions' => [
- 'title' => '应用的所有版本列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'AppVersion' => [
- 'title' => '应用版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'Comment' => [
- 'title' => '版本描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => '初始版本',
- ],
- 'LastModified' => [
- 'title' => '更新时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yyyy/MM/dd HH:mm:ss',
- ],
- ],
- ],
- ],
- 'AppDefaultVersion' => [
- 'title' => '默认版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '1.0',
- ],
- 'AppDescriptorType' => [
- 'title' => '应用描述语言标准',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'WDL / CWL',
- ],
- 'AppDescriptorFiles' => [
- 'title' => '应用的描述文件内容',
- 'description' => '',
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'HostId' => ['description' => 'The ID of the host.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'MaxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'NextToken' => ['description' => 'The token for the next query.', 'type' => 'string', 'example' => 'TestToken', 'title' => ''],
+ 'TotalCount' => ['description' => 'The number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'Submissions' => [
+ 'title' => '',
+ 'description' => 'The list of submissions.',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'FileType' => [
- 'title' => '应用文件的类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'PRIMARY_DESCRIPTOR（主WDL） SECONDARY_DESCRIPTOR（依赖WDL） CONFIG（推荐的输入参数） CONTAINERFILE（镜像制作文件） DATA（输入参数中引用的参考文件） OTHER（其他）',
- ],
- 'Path' => [
- 'title' => '应用文件的路径，除PRIMARY_DESCRIPTOR外，其他均为相对于PRIMARY_DESCRIPTOR的相对路径',
- 'description' => '',
- 'type' => 'string',
- 'example' => './main.wdl',
- ],
- 'Content' => [
- 'title' => '应用文件内容',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Url' => [
- 'title' => '应用文件链接',
- 'description' => '',
- 'type' => 'string',
- 'example' => '',
- ],
- 'Checksum' => [
- 'title' => '应用文件内容的完整性校验码，如MD5值',
- 'description' => '',
- 'type' => 'string',
+ 'Workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'SubmissionId' => ['description' => 'The ID of the submission.', 'type' => 'string', 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
+ 'Status' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'Succeeded', 'title' => ''],
+ 'CreateTime' => ['description' => 'The time when the submission was created.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'StartTime' => ['description' => 'The time when the task started.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'EndTime' => ['description' => 'The time when the task ended.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'EntityType' => ['description' => 'The type of the entity.', 'type' => 'string', 'example' => 'TestEntityType', 'title' => ''],
+ 'RunStats' => [
+ 'description' => 'The statistics of the run status.',
+ 'type' => 'object',
+ 'properties' => [
+ 'Submitted' => ['description' => 'The number of submitted tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Pending' => ['description' => 'The number of pending tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Running' => ['description' => 'The number of running tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Succeeded' => ['description' => 'The number of successful tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Failed' => ['description' => 'The number of failed tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Aborting' => ['description' => 'The number of tasks that are being aborted.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ 'Aborted' => ['description' => 'The number of aborted tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
+ ],
+ 'title' => '',
'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- ],
- 'Document' => [
- 'title' => '应用的帮助文档',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'The app details.',
- ],
- 'Comment' => [
- 'title' => '应用的备注信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => '初始版本',
- ],
- 'DAG' => [
- 'title' => '应用的DAG信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DAG',
- ],
- 'Pinned' => [
- 'title' => '应用收藏置顶标记',
- 'description' => '',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidApp.Version.NotFound',
- 'errorMessage' => 'The specified app version is not found.',
- ],
- [
- 'errorCode' => 'InvalidApp.NotFound',
- 'errorMessage' => 'The specified app is not found.',
- ],
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"HostId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\",\\n \\"NamespaceName\\": \\"sentieon\\",\\n \\"AppScope\\": \\"OpenAccess / Protected\\",\\n \\"AppName\\": \\"joint-calling\\",\\n \\"Locations\\": [\\n \\"cn-shenzhen\\"\\n ],\\n \\"AppVersion\\": \\"1.2a-3\\",\\n \\"AppType\\": \\"workflow\\",\\n \\"AppFee\\": \\"实际使用时，计算该应用消耗的资源费用\\",\\n \\"AppDescription\\": \\"使用Sentieon进行大规模样本的群体变异检测。\\",\\n \\"Categories\\": [\\n \\"群体变异\\"\\n ],\\n \\"Toolkit\\": \\"Sentieon\\",\\n \\"Contact\\": \\"support@sentieon.com\\",\\n \\"Links\\": [\\n \\"http://www.sentieon.com\\"\\n ],\\n \\"AppVersions\\": [\\n {\\n \\"AppVersion\\": \\"1.0\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\"\\n }\\n ],\\n \\"AppDefaultVersion\\": \\"1.0\\",\\n \\"AppDescriptorType\\": \\"WDL / CWL\\",\\n \\"AppDescriptorFiles\\": [\\n {\\n \\"FileType\\": \\"PRIMARY_DESCRIPTOR（主WDL） SECONDARY_DESCRIPTOR（依赖WDL） CONFIG（推荐的输入参数） CONTAINERFILE（镜像制作文件） DATA（输入参数中引用的参考文件） OTHER（其他）\\",\\n \\"Path\\": \\"./main.wdl\\",\\n \\"Content\\": \\"文件内容\\",\\n \\"Url\\": \\"文件URL\\",\\n \\"Checksum\\": \\"文件MD5\\"\\n }\\n ],\\n \\"Document\\": \\"应用的帮助文档\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"DAG\\": \\"DAG\\",\\n \\"Pinned\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetGlobalAppResponse>\\n <RequestId>easygene.cn-beijing.aliyuncs.com</RequestId>\\n <HostId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</HostId>\\n <LastModified>yyyy/MM/dd HH:mm:ss</LastModified>\\n <NamespaceName>sentieon</NamespaceName>\\n <AppScope>OpenAccess / Protected</AppScope>\\n <AppName>joint-calling</AppName>\\n <RegionIds>cn-shenzhen</RegionIds>\\n <AppVersion>1.2a-3</AppVersion>\\n <AppType>workflow</AppType>\\n <AppFee>实际使用时，计算该应用消耗的资源费用</AppFee>\\n <AppDescription>使用Sentieon进行大规模样本的群体变异检测。</AppDescription>\\n <Categories>群体变异</Categories>\\n <Toolkit>Sentieon</Toolkit>\\n <Contact>support@sentieon.com</Contact>\\n <Links>http://www.sentieon.com</Links>\\n <AppVersions>\\n <AppVersion>1.0</AppVersion>\\n <Comment>初始版本</Comment>\\n <LastModified>yyyy/MM/dd HH:mm:ss</LastModified>\\n </AppVersions>\\n <AppDefaultVersion>1.0</AppDefaultVersion>\\n <AppDescriptorType>WDL / CWL</AppDescriptorType>\\n <AppDescriptorFiles>\\n <FileType>PRIMARY_DESCRIPTOR（主WDL） SECONDARY_DESCRIPTOR（依赖WDL） CONFIG（推荐的输入参数） CONTAINERFILE（镜像制作文件） DATA（输入参数中引用的参考文件） OTHER（其他）</FileType>\\n <Path>./main.wdl</Path>\\n <Content>文件内容</Content>\\n <Url>文件URL</Url>\\n <Checksum>文件MD5</Checksum>\\n </AppDescriptorFiles>\\n <Document>应用的帮助文档</Document>\\n <Comment>初始版本</Comment>\\n <DAG>DAG</DAG>\\n <Pinned>true</Pinned>\\n</GetGlobalAppResponse>","errorExample":""}]',
- 'title' => 'GetGlobalApp',
- ],
- 'ListContainerImages' => [
- 'summary' => '获取平台公共容器镜像列表',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 5,\\n \\"NextToken\\": \\"TestToken\\",\\n \\"TotalCount\\": 5,\\n \\"Submissions\\": [\\n {\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"StartTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"EndTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"EntityType\\": \\"TestEntityType\\",\\n \\"RunStats\\": {\\n \\"Submitted\\": 5,\\n \\"Pending\\": 5,\\n \\"Running\\": 5,\\n \\"Succeeded\\": 5,\\n \\"Failed\\": 5,\\n \\"Aborting\\": 5,\\n \\"Aborted\\": 5\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'Retrieve the deliver Job List',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Request parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSubmissions'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListSubmissions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTemplates' => [
+ 'summary' => 'Lists application templates in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -7845,260 +4646,184 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'Location',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '区域',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => 'Workspace', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '翻页Token用来标记当前开始读取的位置，置空表示从头开始',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda',
- ],
+ 'schema' => ['description' => 'Token for the next query', 'type' => 'string', 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => '', 'required' => false],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'Maximum number of results to return', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'OrderBy',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Sort by field', 'type' => 'string', 'example' => 'createtime', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'IsReversed',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Reverse sort order', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'LabelSelector',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Label selector', 'type' => 'string', 'example' => 'key1=value1', 'title' => '', 'required' => false],
+ ],
+ [
+ 'name' => 'Search',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Search condition', 'type' => 'string', 'example' => 'test', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'NextToken' => [
- 'title' => '翻页Token用来表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445',
- ],
- 'MaxResults' => [
- 'title' => '分页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'ContainerImages' => [
- 'title' => '容器镜像',
- 'description' => '',
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'MaxResults' => ['description' => 'Maximum number of results returned', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
+ 'NextToken' => ['description' => 'Token for the next query', 'type' => 'string', 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Templates' => [
+ 'title' => '',
+ 'description' => 'Application template list',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'ContainerImageNamespace' => [
- 'title' => '容器镜像名称空间名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'samtools',
- ],
- 'ContainerImageName' => [
- 'title' => '容器镜像名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'samtools',
- ],
- 'ContainerImageDescription' => [
- 'title' => '容器镜像描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'a suite of programs for interacting with high-throughput sequencing data.',
+ 'Workspace' => ['description' => 'Workspace', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'TemplateName' => ['description' => 'Application template name', 'type' => 'string', 'example' => 'test-template', 'title' => ''],
+ 'Labels' => [
+ 'title' => '',
+ 'description' => 'Labels',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Label', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'example' => '',
],
- 'ContainerImageVersions' => [
- 'title' => '容器镜像版本',
- 'description' => '',
+ 'AppName' => ['description' => 'Application name', 'type' => 'string', 'example' => 'my-app', 'title' => ''],
+ 'AppRevision' => ['description' => 'Application revision', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'RootEntity' => ['description' => 'Entity type', 'type' => 'string', 'example' => 'test-entity', 'title' => ''],
+ 'InputsExpression' => [
+ 'title' => '',
+ 'description' => 'Application inputs',
'type' => 'array',
'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'Task name', 'type' => 'string', 'example' => 'task1', 'title' => ''],
+ 'VariableName' => ['description' => 'Variable name', 'type' => 'string', 'example' => 'fastq1', 'title' => ''],
+ 'VariableType' => ['description' => 'Variable type', 'type' => 'string', 'example' => 'File', 'title' => ''],
+ 'VariableValue' => ['description' => 'Variable value', 'type' => 'string', 'example' => 'oss://bucket/file1.fastq', 'title' => ''],
+ 'Required' => ['description' => 'Required parameter', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Help' => ['description' => 'Help text', 'type' => 'string', 'example' => 'help test', 'title' => ''],
+ 'StepOrder' => ['description' => 'Step order', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''],
+ ],
'description' => '',
- 'type' => 'string',
- 'example' => '1.12--h9aed4be_1',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
- 'Location' => [
- 'title' => '容器镜像所在区域',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
- ],
- 'ContainerRegistry' => [
- 'title' => '容器镜像仓库名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'registry-vpc.cn-shenzhen.aliyuncs.com',
- ],
- 'LastModified' => [
- 'title' => '最后更新时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yyyy/MM/dd HH:mm:ss',
+ 'OutputsExpression' => [
+ 'title' => '',
+ 'description' => 'Application output parameters',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'Task name', 'type' => 'string', 'example' => 'task1', 'title' => ''],
+ 'VariableName' => ['description' => 'Variable name', 'type' => 'string', 'example' => 'v1', 'title' => ''],
+ 'VariableType' => ['description' => 'Variable type', 'type' => 'string', 'example' => 'File', 'title' => ''],
+ 'VariableValue' => ['description' => 'Variable value', 'type' => 'string', 'example' => 'oss://bucket/test.vcf', 'title' => ''],
+ 'Required' => ['description' => 'Required parameter', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
+ 'Help' => ['description' => 'Help text', 'type' => 'string', 'example' => 'help test', 'title' => ''],
+ 'StepOrder' => ['description' => 'Step order', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'example' => '',
],
+ 'Description' => ['description' => 'Template description', 'type' => 'string', 'example' => 'This is a test template', 'title' => ''],
+ 'CreateTime' => ['description' => 'Creation time', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'title' => ''],
+ 'LastModifiedTime' => ['description' => 'Last modified time', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'title' => ''],
+ 'RevisionTag' => ['title' => 'Unique tag of the application version ', 'description' => 'Unique application revision tag', 'type' => 'string', 'example' => 'ProduceVersion'],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
+ 'TotalCount' => ['description' => 'Total number of items returned', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ContainerImages\\": [\\n {\\n \\"ContainerImageNamespace\\": \\"samtools\\",\\n \\"ContainerImageName\\": \\"samtools\\",\\n \\"ContainerImageDescription\\": \\"a suite of programs for interacting with high-throughput sequencing data.\\",\\n \\"ContainerImageVersions\\": [\\n \\"1.12--h9aed4be_1\\"\\n ],\\n \\"Location\\": \\"cn-shenzhen\\",\\n \\"ContainerRegistry\\": \\"registry-vpc.cn-shenzhen.aliyuncs.com\\",\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'ListAuthorizedSoftware' => [
- 'summary' => '获取平台第三方软件列表',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Templates\\": [\\n {\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"TemplateName\\": \\"test-template\\",\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"AppName\\": \\"my-app\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"RootEntity\\": \\"test-entity\\",\\n \\"InputsExpression\\": [\\n {\\n \\"TaskName\\": \\"task1\\",\\n \\"VariableName\\": \\"fastq1\\",\\n \\"VariableType\\": \\"File\\",\\n \\"VariableValue\\": \\"oss://bucket/file1.fastq\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"help test\\",\\n \\"StepOrder\\": 0\\n }\\n ],\\n \\"OutputsExpression\\": [\\n {\\n \\"TaskName\\": \\"task1\\",\\n \\"VariableName\\": \\"v1\\",\\n \\"VariableType\\": \\"File\\",\\n \\"VariableValue\\": \\"oss://bucket/test.vcf\\",\\n \\"Required\\": true,\\n \\"Help\\": \\"help test\\",\\n \\"StepOrder\\": 1\\n }\\n ],\\n \\"Description\\": \\"This is a test template\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"LastModifiedTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"RevisionTag\\": \\"ProduceVersion\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n}","type":"json"}]',
+ 'title' => 'Retrieve application template list',
+ 'changeSet' => [
+ ['createdAt' => '2024-01-29T02:27:23.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListTemplates',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/*'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'],
+ ],
],
+ ],
+ 'ListUserActiveRuns' => [
+ 'summary' => 'Recent Tasks List',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
- 'name' => 'Location',
- 'in' => 'query',
- 'schema' => [
- 'title' => '区域',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cn-shanghai',
- ],
- ],
- [
- 'name' => 'Search',
- 'in' => 'query',
- 'schema' => [
- 'title' => '软件名称、软件长名称中搜索的关键字',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Sentieon',
- ],
- ],
- [
- 'name' => 'OrderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LastModified',
- ],
- ],
- [
- 'name' => 'IsReversed',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否反转',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'query',
- 'schema' => [
- 'title' => '翻页Token用来标记当前开始读取的位置，置空表示从头开始',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda',
- ],
- ],
- [
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => 'Quantity of queries ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '3', 'default' => '10', 'description' => ''],
],
],
'responses' => [
@@ -8106,245 +4831,152 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'NextToken' => [
- 'title' => '翻页Token用来表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445',
- ],
- 'MaxResults' => [
- 'title' => '分页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Softwares' => [
- 'title' => '软件信息',
- 'description' => '',
+ 'RequestId' => ['title' => 'Request ID ', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'description' => ''],
+ 'HostId' => ['title' => 'Host ID ', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'description' => ''],
+ 'MaxResults' => ['title' => 'Maximum Return Result ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => ''],
+ 'NextToken' => ['title' => 'Next Query Token ', 'type' => 'string', 'example' => 'MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK', 'description' => ''],
+ 'TotalCount' => ['title' => 'Number of Returned Items ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => ''],
+ 'Runs' => [
+ 'title' => 'Job List ',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'SoftwareName' => [
- 'title' => '软件名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sentieon',
- ],
- 'SoftwareLongName' => [
- 'title' => '软件长名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'Sentieon加速软件',
- ],
- 'SoftwareDescription' => [
- 'title' => '软件描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'NGS数据二级分析软件，提供基于CPU的加速方案，可替代BWA，GATK，HaplotypeCaller，Mutect和Mutect2等分析流程。包括DNASeq，DNAScope，TNScope等工具',
- ],
- 'SoftwareDefaultVersion' => [
- 'title' => '软件默认版本',
- 'description' => '',
- 'type' => 'string',
- 'example' => '201911',
- ],
- 'SoftwareVersions' => [
- 'title' => '软件所有版本',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '201911',
- ],
- ],
- 'SoftwareLicenseFee' => [
- 'title' => '软件使用费用',
+ 'AppName' => ['title' => 'Application Name', 'type' => 'string', 'example' => 'MyApp', 'description' => ''],
+ 'Source' => ['title' => 'Application Source', 'type' => 'string', 'example' => 'EasyGene', 'description' => ''],
+ 'Labels' => [
+ 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
+ 'title' => 'Job Labels ',
+ 'type' => 'object',
'description' => '',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.15',
+ 'example' => '',
],
- 'Locations' => [
- 'title' => '软件可用区域',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-shenzhen',
+ 'RunName' => ['title' => 'Job Name', 'type' => 'string', 'example' => 'test-run', 'description' => ''],
+ 'AppRevision' => ['title' => 'Application Version', 'type' => 'string', 'example' => '1', 'description' => ''],
+ 'RunId' => ['title' => 'Job ID ', 'type' => 'string', 'example' => 'run-13BeYuxc0fxO24uA75UppTiMRoQ', 'description' => ''],
+ 'Status' => ['title' => 'Task Status ', 'type' => 'string', 'example' => 'Running', 'description' => ''],
+ 'CreateTime' => ['title' => 'Submitted At ', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'description' => ''],
+ 'StartTime' => ['title' => 'Start Time ', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'description' => ''],
+ 'EndTime' => ['title' => 'End Time ', 'type' => 'string', 'example' => '2021-06-10T13:30:20.414557061Z', 'description' => ''],
+ 'SubmissionId' => ['title' => 'Submission ID', 'type' => 'string', 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'description' => ''],
+ 'EntityName' => ['title' => 'Entity Name ', 'type' => 'string', 'example' => 's1', 'description' => ''],
+ 'EntityType' => ['title' => 'Entity object ID', 'type' => 'string', 'example' => 'sample', 'description' => ''],
+ 'ExecuteDirectory' => ['title' => 'Run folder', 'type' => 'string', 'description' => '', 'example' => ''],
+ 'ExecuteOptions' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CallCaching' => ['title' => 'Whether CallCaching is Enabled', 'type' => 'boolean', 'example' => 'false', 'description' => ''],
+ 'UseRelativeOutputPaths' => ['title' => 'Use relative path', 'type' => 'boolean', 'example' => 'false', 'description' => ''],
+ 'FailureMode' => ['title' => 'Failure mode', 'type' => 'string', 'example' => 'NoNewCalls', 'description' => ''],
+ 'DeleteIntermediateResults' => ['title' => 'Delete intermediate files', 'type' => 'boolean', 'example' => 'false', 'description' => ''],
],
- ],
- 'HelpLink' => [
- 'title' => '帮助链接',
'description' => '',
- 'type' => 'string',
- 'example' => 'https://help.aliyun.com/document_detail/257750.html',
- ],
- 'SoftwareIcon' => [
- 'title' => '软件图标链接',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN01mmZovA1UJfeKQAYvF_!!6000000002497-2-tps-256-256.png',
- ],
- 'LastModified' => [
- 'title' => '最后更新时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yyyy/MM/dd HH:mm:ss',
- ],
- 'Promotion' => [
- 'title' => '限时免费说明',
- 'description' => '',
- 'type' => 'string',
+ 'title' => '',
+ 'example' => '',
],
+ 'Inputs' => ['title' => 'Input Parameter ', 'type' => 'string', 'example' => '{ "workflow1.task1.param1": "helloooo.txt", "workflow1.task1.param2": "abc", "workflow1.task2.param1": "new_helloooo.txt", "workflow1.task2.param2": "def" }', 'description' => ''],
+ 'DefaultRuntime' => ['title' => 'Default runtime', 'type' => 'string', 'example' => '{}', 'description' => ''],
+ 'Workspace' => ['title' => 'workspace ', 'type' => 'string', 'example' => 'test-workspace', 'description' => ''],
+ 'RegionId' => ['title' => 'area ', 'type' => 'string', 'example' => 'cn-beijing', 'description' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'description' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['errorCode' => 'SignatureDoesNotMatch', 'errorMessage' => 'The specified signature is invalid.', 'description' => 'The specified signature is invalid.'],
],
- 404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- [
- 'errorCode' => 'InvalidOrderBy.NotFound',
- 'errorMessage' => 'The specified OrderBy is not found.',
- ],
+ 403 => [
+ ['errorCode' => 'InvalidUser.AccessDenied', 'errorMessage' => 'The request was denied due to insufficient user permission.', 'description' => 'The request was denied due to insufficient user permission.'],
+ ],
+ [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Softwares\\": [\\n {\\n \\"SoftwareName\\": \\"sentieon\\",\\n \\"SoftwareLongName\\": \\"Sentieon加速软件\\",\\n \\"SoftwareDescription\\": \\"NGS数据二级分析软件，提供基于CPU的加速方案，可替代BWA，GATK，HaplotypeCaller，Mutect和Mutect2等分析流程。包括DNASeq，DNAScope，TNScope等工具\\",\\n \\"SoftwareDefaultVersion\\": \\"201911\\",\\n \\"SoftwareVersions\\": [\\n \\"201911\\"\\n ],\\n \\"SoftwareLicenseFee\\": 0.15,\\n \\"Locations\\": [\\n \\"cn-shenzhen\\"\\n ],\\n \\"HelpLink\\": \\"https://help.aliyun.com/document_detail/257750.html\\",\\n \\"SoftwareIcon\\": \\"https://img.alicdn.com/imgextra/i2/O1CN01mmZovA1UJfeKQAYvF_!!6000000002497-2-tps-256-256.png\\",\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\",\\n \\"Promotion\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'ListPublicDataset' => [
- 'summary' => '获取平台公共数据集列表',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T08:27:57.000Z', 'description' => 'OpenAPI offline'],
+ ['createdAt' => '2021-04-22T08:27:57.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2021-04-22T08:27:57.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListUserActiveRuns',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"MTIzNDU2P1dvcmtzcGFjZT93cy1mMDE4OTgxNGU1ZTkK\\",\\n \\"TotalCount\\": 10,\\n \\"Runs\\": [\\n {\\n \\"AppName\\": \\"MyApp\\",\\n \\"Source\\": \\"EasyGene\\",\\n \\"Labels\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"RunName\\": \\"test-run\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"RunId\\": \\"run-13BeYuxc0fxO24uA75UppTiMRoQ\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"StartTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"EndTime\\": \\"2021-06-10T13:30:20.414557061Z\\",\\n \\"SubmissionId\\": \\"sub-13BeXWnGvrOl3MC124tazcJVKaV\\",\\n \\"EntityName\\": \\"s1\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"ExecuteDirectory\\": \\"\\",\\n \\"ExecuteOptions\\": {\\n \\"CallCaching\\": false,\\n \\"UseRelativeOutputPaths\\": false,\\n \\"FailureMode\\": \\"NoNewCalls\\",\\n \\"DeleteIntermediateResults\\": false\\n },\\n \\"Inputs\\": \\"{ \\\\\\"workflow1.task1.param1\\\\\\": \\\\\\"helloooo.txt\\\\\\", \\\\\\"workflow1.task1.param2\\\\\\": \\\\\\"abc\\\\\\", \\\\\\"workflow1.task2.param1\\\\\\": \\\\\\"new_helloooo.txt\\\\\\", \\\\\\"workflow1.task2.param2\\\\\\": \\\\\\"def\\\\\\" }\\",\\n \\"DefaultRuntime\\": \\"{}\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'ListUserActiveRuns',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserActiveRuns'],
+ ],
],
+ ],
+ 'ListWorkspaces' => [
+ 'summary' => 'Lists the workspaces that meet specified conditions.',
+ 'methods' => ['get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
+ [
+ 'BearerToken' => [],
+ ],
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'Search',
'in' => 'query',
- 'schema' => [
- 'title' => '名称、描述中搜索的关键字',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '西蒙斯基因组多样性计划',
- ],
- ],
- [
- 'name' => 'Tag',
- 'in' => 'query',
- 'schema' => [
- 'title' => '公共数据集标签名',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '遗传多样性',
- ],
+ 'schema' => ['description' => 'Search conditions.', 'type' => 'string', 'required' => false, 'example' => 's1', 'title' => ''],
],
[
'name' => 'OrderBy',
'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LastModified, DatasetName',
- ],
+ 'schema' => ['description' => 'Sort by.', 'type' => 'string', 'required' => false, 'example' => 'createtime', 'title' => ''],
],
[
'name' => 'IsReversed',
'in' => 'query',
- 'schema' => [
- 'title' => '排序是否反转',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Reverse order.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
- 'schema' => [
- 'title' => '翻页Token用来标记当前开始读取的位置，置空表示从头开始',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda',
- ],
+ 'schema' => ['title' => 'NextToken', 'description' => 'Start token for the query.', 'type' => 'string', 'required' => false, 'example' => 'TestToken'],
],
[
'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'Maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '5', 'default' => '10', 'title' => ''],
+ ],
+ [
+ 'name' => 'LabelSelector',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Label selector.', 'type' => 'string', 'example' => 'env=test', 'title' => '', 'required' => false],
],
],
'responses' => [
@@ -8352,936 +4984,634 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'NextToken' => [
- 'title' => '翻页Token用来表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445',
- ],
- 'MaxResults' => [
- 'title' => '分页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Datasets' => [
- 'title' => '公共数据集信息',
- 'description' => '',
+ 'HostId' => ['description' => 'Host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'MaxResults' => ['description' => 'Maximum number of results.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'NextToken' => ['description' => 'Next token for the query.', 'type' => 'string', 'example' => 'TestToken', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
+ 'Workspaces' => [
+ 'title' => '',
+ 'description' => 'Array of Workspaces.',
'type' => 'array',
'items' => [
- 'description' => '',
'type' => 'object',
'properties' => [
- 'LastModified' => [
- 'title' => '最后更新时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yyyy/MM/dd HH:mm:ss',
- ],
- 'Copyright' => [
- 'title' => '公共数据集版权信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is copyright.',
- ],
- 'AccessRequirements' => [
- 'title' => '公共数据集访问要求',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This are access requirements.',
- ],
- 'About' => [
- 'title' => '关于公共数据集',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is description about dataset.',
- ],
- 'Tags' => [
- 'title' => '公共数据集标签',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '遗传多样性',
- ],
- ],
- 'DatasetName' => [
- 'title' => '公共数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '西蒙斯基因组多样性计划',
- ],
- 'DatasetDescription' => [
- 'title' => '公共数据集描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This are access requirements',
- ],
- 'UpdateFrequency' => [
- 'title' => '公共数据集更新频率',
- 'description' => '',
- 'type' => 'string',
- 'example' => '源站更新后及时同步',
- ],
- 'Locations' => [
- 'title' => '公共数据集可用区域',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
+ 'Description' => ['description' => 'Workspace description.', 'type' => 'string', 'example' => 'This is a test workspace', 'title' => ''],
+ 'JobLifecycle' => ['description' => 'Job lifecycle.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
+ 'Labels' => [
+ 'title' => '',
+ 'description' => 'Workspace labels.',
+ 'type' => 'object',
+ 'additionalProperties' => ['description' => 'Label.', 'type' => 'string', 'example' => 'test', 'title' => ''],
+ 'example' => '',
],
- 'DatasetId' => [
- 'title' => '公共数据集UUID',
- 'description' => '',
+ 'Storage' => ['description' => 'OSS working path.', 'type' => 'string', 'example' => 'oss://my-bucket/my-path/', 'title' => ''],
+ 'BucketName' => ['description' => 'Workspace bucket name.', 'type' => 'string', 'example' => 'my-bucket', 'title' => ''],
+ 'Role' => ['title' => 'RAM Role', 'description' => 'RAM Role.', 'type' => 'string', 'example' => 'TestRole'],
+ 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'LastModifiedTime' => ['description' => 'Last modified time.', 'type' => 'string', 'example' => '2021-06-16T15:09:14.378297+08:00', 'title' => ''],
+ 'Workspace' => ['description' => 'Workspace name.', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'Status' => [
+ 'description' => 'Workspace status.',
+ 'enumValueTitles' => ['Active' => 'Active and available.'],
'type' => 'string',
+ 'example' => 'Active',
+ 'title' => '',
],
+ 'Location' => ['description' => 'Region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- [
- 'errorCode' => 'InvalidOrderBy.NotFound',
- 'errorMessage' => 'The specified OrderBy is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Datasets\\": [\\n {\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\",\\n \\"Copyright\\": \\"此数据集公开提供给所有人使用，但使用者需遵循数据集来源规定的条款 (Fort Lauderdale principles)\\",\\n \\"AccessRequirements\\": \\"阿里云“按原样”提供数据集，对此不作任何明示或暗示的保证。\\",\\n \\"About\\": \\"全部数据集包括279个基因组，可以查看已发表的文章。 阿里云收录了项目说明文档中记录的完全公开的变异结果的VCF文件。\\",\\n \\"Tags\\": [\\n \\"遗传多样性\\"\\n ],\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"DatasetDescription\\": \\"This are access requirements\\",\\n \\"UpdateFrequency\\": \\"源站更新后及时同步\\",\\n \\"Locations\\": [\\n \\"cn-beijing\\"\\n ],\\n \\"DatasetId\\": \\"20943***\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPublicDatasetResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <NextToken>ba6d88e2-a6f2-4d2c-a2ae-68b76b078445</NextToken>\\n <MaxResults>10</MaxResults>\\n <TotalCount>100</TotalCount>\\n <Datasets>\\n <LastModified>yyyy/MM/dd HH:mm:ss</LastModified>\\n <Copyright>此数据集公开提供给所有人使用，但使用者需遵循数据集来源规定的条款 (Fort Lauderdale principles)</Copyright>\\n <AccessRequirements>阿里云“按原样”提供数据集，对此不作任何明示或暗示的保证。</AccessRequirements>\\n <About>全部数据集包括279个基因组，可以查看已发表的文章。 阿里云收录了项目说明文档中记录的完全公开的变异结果的VCF文件。</About>\\n <Tags>遗传多样性</Tags>\\n <DatasetName>西蒙斯基因组多样性计划</DatasetName>\\n <DatasetDescription>This are access requirements</DatasetDescription>\\n <UpdateFrequency>源站更新后及时同步</UpdateFrequency>\\n <RegionIds>cn-beijing</RegionIds>\\n </Datasets>\\n</ListPublicDatasetResponse>","errorExample":""}]',
- 'title' => 'ListPublicDataset',
- ],
- 'GetPublicDataset' => [
- 'summary' => '查询平台公共数据集详情',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"MaxResults\\": 5,\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"TestToken\\",\\n \\"TotalCount\\": 5,\\n \\"Workspaces\\": [\\n {\\n \\"Description\\": \\"This is a test workspace\\",\\n \\"JobLifecycle\\": 30,\\n \\"Labels\\": {\\n \\"key\\": \\"test\\"\\n },\\n \\"Storage\\": \\"oss://my-bucket/my-path/\\",\\n \\"BucketName\\": \\"my-bucket\\",\\n \\"Role\\": \\"TestRole\\",\\n \\"CreateTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"LastModifiedTime\\": \\"2021-06-16T15:09:14.378297+08:00\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"Status\\": \\"Active\\",\\n \\"Location\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => 'List workspaces ',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListWorkspaces',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'],
+ ],
+ ],
+ ],
+ 'ResumeSubmission' => [
+ 'summary' => 'Resume a specific deliver task in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'DatasetName',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '西蒙斯基因组多样性计划',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'Attributes',
+ 'name' => 'SubmissionId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '查询的字段名:DatasetNo, DatasetDescription, About, AccessRequirements, Copyright, Tags, UpdateFrequency, Locations, LastModified, RegionIds',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DatasetName, DatasetDescription, About, AccessRequirements, Copyright, Tags, UpdateFrequency, RegionIds, LastModified',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'Delivery ID', 'type' => 'string', 'required' => true, 'example' => 'sub-13BeXWnGvrOl3MC124tazcJVKaV', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'DatasetDescription' => [
- 'title' => '公共数据集描述',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is dataset description.',
- ],
- 'Copyright' => [
- 'title' => '公共数据集版权信息',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is dataset copyright.',
- ],
- 'AccessRequirements' => [
- 'title' => '公共数据集访问要求',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This are dataset access requirements.',
- ],
- 'About' => [
- 'title' => '关于公共数据集',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'This is description about dataset.',
- ],
- 'Tags' => [
- 'title' => '公共数据集标签',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '遗传多样性',
- ],
- ],
- 'DatasetName' => [
- 'title' => '公共数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '西蒙斯基因组多样性计划',
- ],
- 'UpdateFrequency' => [
- 'title' => '公共数据集更新频率',
- 'description' => '',
- 'type' => 'string',
- 'example' => '源站更新后及时同步',
- ],
- 'Locations' => [
- 'title' => '公共数据集可用区域',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
- ],
- 'LastModified' => [
- 'title' => '最后更新时间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'yyyy/MM/dd HH:mm:ss',
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- [
- 'errorCode' => 'InvalidAttributes.NotFound',
- 'errorMessage' => 'The specified Attributes are not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"DatasetDescription\\": \\"西蒙斯基因组多样性计划 (Simons Genome Diversity Project, SGDP) 是目前世界上最大、质量最高的人群多样性基因组数据。\\",\\n \\"Copyright\\": \\"此数据集公开提供给所有人使用，但使用者需遵循数据集来源规定的条款 (Fort Lauderdale principles)\\",\\n \\"AccessRequirements\\": \\"阿里云“按原样”提供数据集，对此不作任何明示或暗示的保证。\\",\\n \\"About\\": \\"全部数据集包括279个基因组，可以查看已发表的文章。 阿里云收录了项目说明文档中记录的完全公开的变异结果的VCF文件。\\",\\n \\"Tags\\": [\\n \\"遗传多样性\\"\\n ],\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"UpdateFrequency\\": \\"源站更新后及时同步\\",\\n \\"Locations\\": [\\n \\"cn-beijing\\"\\n ],\\n \\"LastModified\\": \\"yyyy/MM/dd HH:mm:ss\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPublicDatasetResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <DatasetDescription>西蒙斯基因组多样性计划 (Simons Genome Diversity Project, SGDP) 是目前世界上最大、质量最高的人群多样性基因组数据。</DatasetDescription>\\n <Copyright>此数据集公开提供给所有人使用，但使用者需遵循数据集来源规定的条款 (Fort Lauderdale principles)</Copyright>\\n <AccessRequirements>阿里云“按原样”提供数据集，对此不作任何明示或暗示的保证。</AccessRequirements>\\n <About>全部数据集包括279个基因组，可以查看已发表的文章。 阿里云收录了项目说明文档中记录的完全公开的变异结果的VCF文件。</About>\\n <Tags>遗传多样性</Tags>\\n <DatasetName>西蒙斯基因组多样性计划</DatasetName>\\n <UpdateFrequency>源站更新后及时同步</UpdateFrequency>\\n <RegionIds>cn-beijing</RegionIds>\\n <LastModified>yyyy/MM/dd HH:mm:ss</LastModified>\\n</GetPublicDatasetResponse>","errorExample":""}]',
- 'title' => 'GetPublicDataset',
- ],
- 'ListPublicDatasetEntities' => [
- 'summary' => '查询平台公共数据集包含的实体列表',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'ResumeSubmission',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:ResumeSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/{#SubmissionId}'],
+ ],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeSubmission'],
+ ],
],
+ ],
+ 'TagApp' => [
+ 'summary' => 'Tags a version of an application.',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'DatasetName',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '西蒙斯基因组多样性计划',
- ],
+ 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'TestWorkspace', 'title' => ''],
],
[
- 'name' => 'OrderBy',
+ 'name' => 'AppName',
'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LastModified',
- ],
+ 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => true, 'example' => 'TestApp', 'title' => ''],
],
[
- 'name' => 'IsReversed',
+ 'name' => 'AppRevision',
'in' => 'query',
- 'schema' => [
- 'title' => '排序是否反转',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'The version of the application.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
],
[
- 'name' => 'NextToken',
+ 'name' => 'RevisionTag',
'in' => 'query',
+ 'schema' => ['description' => 'The unique tag for the application version.', 'type' => 'string', 'required' => true, 'example' => 'ProduceVersion', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '翻页Token用来标记当前开始读取的位置，置空表示从头开始',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Workspace' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'TestWorkspace', 'title' => ''],
+ 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'TestApp', 'title' => ''],
+ 'AppRevision' => ['description' => 'The version of the application.', 'type' => 'string', 'example' => '1', 'title' => ''],
+ 'RevisionTag' => ['description' => 'The unique tag for the application version.', 'type' => 'string', 'example' => 'ProduceVersion', 'title' => ''],
+ 'FormerRevision' => ['description' => 'The application version that previously had this tag.', 'type' => 'string', 'example' => '0', 'title' => ''],
+ 'FormerTag' => ['description' => 'The previous unique tag of this application version.', 'type' => 'string', 'example' => 'TestTag', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ],
+ 404 => [
+ ['errorCode' => 'ResourceNotFound', 'errorMessage' => 'The specified resource %s is not found.', 'description' => 'The specified resource %s is not found.'],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"AppName\\": \\"TestApp\\",\\n \\"AppRevision\\": \\"1\\",\\n \\"RevisionTag\\": \\"ProduceVersion\\",\\n \\"FormerRevision\\": \\"0\\",\\n \\"FormerTag\\": \\"TestTag\\"\\n}","type":"json"}]',
+ 'title' => 'Tag Application Version',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:TagApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/{#AppName}'],
+ ],
],
],
+ ],
+ ],
+ 'UpdateEntity' => [
+ 'summary' => 'Updates the data for a specific entity in a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'MaxResults',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => true,
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'Location',
+ 'name' => 'EntityType',
'in' => 'query',
+ 'schema' => ['description' => 'The entity type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sample', 'title' => ''],
+ ],
+ [
+ 'name' => 'EntityItems',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '公共数据集所在区域',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
+ 'description' => 'The array of elements to update.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The element to update.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EntityName' => ['description' => 'The name of the entity element.', 'type' => 'string', 'example' => 's1', 'title' => '', 'required' => false],
+ 'EntityData' => [
+ 'description' => 'The content of the element to update.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'The value of the attribute column.', 'type' => 'string', 'example' => 'value', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The returned data.',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'NextToken' => [
- 'title' => '翻页Token用来表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445',
- ],
- 'MaxResults' => [
- 'title' => '分页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'DatasetName' => [
- 'title' => '公共数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '西蒙斯基因组多样性计划',
- ],
- 'Entities' => [
- 'title' => '该实体包含的所有类型',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
- ],
- ],
- ],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'EntityType' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'sample', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- [
- 'errorCode' => 'InvalidPublicDataset.NotFound',
- 'errorMessage' => 'The specified PublicDatasetName is not found.',
- ],
- [
- 'errorCode' => 'InvalidOrderBy.NotFound',
- 'errorMessage' => 'The specified OrderBy is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"Entities\\": [\\n {\\n \\"EntityType\\": \\"sample\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPublicDatasetEntitiesResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <NextToken>ba6d88e2-a6f2-4d2c-a2ae-68b76b078445</NextToken>\\n <MaxResults>10</MaxResults>\\n <TotalCount>100</TotalCount>\\n <DatasetName>西蒙斯基因组多样性计划</DatasetName>\\n <Entities>\\n <EntityType>sample</EntityType>\\n </Entities>\\n</ListPublicDatasetEntitiesResponse>","errorExample":""}]',
- ],
- 'GetPublicDatasetEntity' => [
- 'summary' => '查询平台公共数据集特定的实体定义',
- 'methods' => [
- 'get',
+ 'staticInfo' => [
+ 'substitutions' => ['EasyGene::2021-03-15::UpdateEntityItems'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","type":"json"}]',
+ 'title' => 'Update Entity Data Table Content',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UpdateEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEntity'],
+ ],
],
+ ],
+ 'UpdateEntityItems' => [
+ 'summary' => 'Updates the data in a specific entity table within a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'DatasetName',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '西蒙斯基因组多样性计划',
- ],
+ 'schema' => ['description' => 'The workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
'name' => 'EntityType',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'The entity type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'sample', 'title' => ''],
],
[
- 'name' => 'Location',
- 'in' => 'query',
+ 'name' => 'EntityItems',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '公共数据集所在区域',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
+ 'description' => 'The entity table data.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'The entity table data.',
+ 'type' => 'object',
+ 'properties' => [
+ 'EntityName' => ['description' => 'The name of the entity element.', 'type' => 'string', 'example' => 's1', 'title' => '', 'required' => false],
+ 'EntityData' => [
+ 'description' => 'The key-value data.',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['description' => 'The key-value data.', 'type' => 'string', 'example' => '{"key1":"value1"}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'docRequired' => true,
+ 'title' => '',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'The entity table data.',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'DatasetName' => [
- 'title' => '公共数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '西蒙斯基因组多样性计划',
- ],
- 'EntityType' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
- 'Attributes' => [
- 'title' => '实体属性名称列表',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'key',
- ],
- ],
- 'TotalCount' => [
- 'title' => '该类型实体总数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'HostId' => ['description' => 'The host ID.', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Workspace' => ['description' => 'The workspace.', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'EntityType' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'sample', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- [
- 'errorCode' => 'InvalidPublicDataset.NotFound',
- 'errorMessage' => 'The specified PublicDatasetName is not found.',
- ],
- [
- 'errorCode' => 'InvalidEntityType.NotFound',
- 'errorMessage' => 'The specified EntityType is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"EntityType\\": \\"sample\\",\\n \\"Attributes\\": [\\n \\"key\\"\\n ],\\n \\"TotalCount\\": 100\\n}","errorExample":""},{"type":"xml","example":"<GetPublicDatasetEntityResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <DatasetName>西蒙斯基因组多样性计划</DatasetName>\\n <EntityType>sample</EntityType>\\n <Attributes>key</Attributes>\\n <TotalCount>100</TotalCount>\\n</GetPublicDatasetEntityResponse>","errorExample":""}]',
- ],
- 'ListPublicDatasetEntityItems' => [
- 'summary' => '查询平台公共数据集特定的实体表格数据',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","type":"json"}]',
+ 'title' => 'Update Entity Element ',
+ 'changeSet' => [
+ ['createdAt' => '2021-10-28T03:40:47.000Z', 'description' => 'OpenAPI offline'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEntityItems'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UpdateEntityItems',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateTemplate' => [
+ 'summary' => 'Updates the details of an application template in a workspace.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'DatasetName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '西蒙斯基因组多样性计划',
- ],
- ],
- [
- 'name' => 'EntityType',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '实体类型',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'sample',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'test-workspace', 'title' => ''],
],
[
- 'name' => 'Search',
+ 'name' => 'TemplateName',
'in' => 'query',
- 'schema' => [
- 'title' => '实体名中搜索的关键字',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 's1',
- ],
+ 'schema' => ['description' => 'Application template name', 'type' => 'string', 'required' => true, 'example' => 'test-template', 'title' => ''],
],
[
- 'name' => 'OrderBy',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => '排序字段',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LastModified',
- ],
+ 'schema' => ['description' => 'Application template description', 'type' => 'string', 'example' => 'This is a test template', 'title' => '', 'required' => false],
],
[
- 'name' => 'IsReversed',
+ 'name' => 'RootEntity',
'in' => 'query',
- 'schema' => [
- 'title' => '是否反转',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Entity type', 'type' => 'string', 'example' => 'test-entity', 'title' => '', 'required' => false],
],
[
- 'name' => 'NextToken',
- 'in' => 'query',
+ 'name' => 'InputsExpression',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '翻页Token用来标记当前开始读取的位置，置空表示从头开始',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda',
+ 'title' => '',
+ 'description' => 'Application input expressions',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Application input',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'Task name', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Task1'],
+ 'VariableName' => ['description' => 'Variable name', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'fastq1'],
+ 'VariableType' => ['description' => 'Variable type', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'String'],
+ 'VariableValue' => ['description' => 'Variable value', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'read_1.fastq.gz'],
+ 'Required' => ['description' => 'Required', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'True'],
+ 'Help' => ['description' => 'Help information', 'type' => 'string', 'example' => 'Sequencing reads file', 'title' => '', 'required' => false],
+ 'StepOrder' => ['description' => 'Step order', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '2'],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'example' => '',
],
],
[
- 'name' => 'MaxResults',
- 'in' => 'query',
+ 'name' => 'OutputsExpression',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '分页数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
+ 'title' => '',
+ 'description' => 'Application output expressions',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'Application output',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskName' => ['description' => 'Task name', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Task1'],
+ 'VariableName' => ['description' => 'Variable name', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Bam'],
+ 'VariableType' => ['description' => 'Variable type', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'String'],
+ 'VariableValue' => ['description' => 'Variable value', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'out.bam'],
+ 'Required' => ['description' => 'Required', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'True'],
+ 'Help' => ['description' => 'Help information', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''],
+ 'StepOrder' => ['description' => 'Step order', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => ''],
+ ],
+ 'required' => false,
+ 'title' => '',
+ 'example' => '',
+ ],
+ 'required' => true,
+ 'example' => '',
],
],
[
- 'name' => 'Location',
+ 'name' => 'Labels',
'in' => 'query',
- 'schema' => [
- 'title' => '公共数据集所在区域',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-shanghai',
- ],
+ 'schema' => ['description' => 'Application template labels', 'type' => 'string', 'example' => '{"key": "value"}', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => '',
+ 'description' => 'Response',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'NextToken' => [
- 'title' => '翻页Token用来表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445',
- ],
- 'MaxResults' => [
- 'title' => '分页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'DatasetName' => [
- 'title' => '公共数据集名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '西蒙斯基因组多样性计划',
- ],
- 'EntityItems' => [
- 'title' => '该实体包含的所有对象',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'EntityName' => [
- 'title' => '实体名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'sample',
- ],
- 'EntityData' => [
- 'title' => '实体属性值',
- 'description' => '',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '{ "key1": "value1" }',
- 'description' => '',
- ],
- ],
- ],
- ],
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
],
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- [
- 'errorCode' => 'InvalidPublicDataset.NotFound',
- 'errorMessage' => 'The specified PublicDatasetName is not found.',
- ],
- [
- 'errorCode' => 'InvalidOrderBy.NotFound',
- 'errorMessage' => 'The specified OrderBy is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DatasetName\\": \\"西蒙斯基因组多样性计划\\",\\n \\"EntityItems\\": [\\n {\\n \\"EntityName\\": \\"sample\\",\\n \\"EntityData\\": {\\n \\"key\\": \\"{ \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\" }\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPublicDatasetEntityItemsResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <NextToken>ba6d88e2-a6f2-4d2c-a2ae-68b76b078445</NextToken>\\n <MaxResults>10</MaxResults>\\n <TotalCount>100</TotalCount>\\n <DatasetName>西蒙斯基因组多样性计划</DatasetName>\\n <EntityItems>\\n <EntityName>sample</EntityName>\\n <EntityData>\\n <key>{ \\"key1\\": \\"value1\\" }</key>\\n </EntityData>\\n </EntityItems>\\n</ListPublicDatasetEntityItemsResponse>","errorExample":""}]',
- ],
- 'ListPublicDatasetTags' => [
- 'summary' => '列出所有公共数据集标签',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\"\\n}","type":"json"}]',
+ 'title' => 'Update Application Template',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTemplate'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UpdateTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/{#TemplateName}'],
+ ],
+ ],
+ ],
+ ],
+ 'translator' => 'machine',
+ ],
+ 'UpdateWorkspace' => [
+ 'summary' => 'Updates the information of a workspace.',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
- 'name' => 'Search',
+ 'name' => 'Workspace',
'in' => 'query',
- 'schema' => [
- 'title' => '标签名中搜索的关键字',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => '遗传多样性',
- ],
+ 'schema' => ['description' => 'Workspace name', 'type' => 'string', 'required' => true, 'example' => 'MyTestWorkspace', 'title' => ''],
],
[
- 'name' => 'OrderBy',
+ 'name' => 'Description',
'in' => 'query',
- 'schema' => [
- 'title' => '排序字段:TagName,LastModified',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'LastModified',
- ],
+ 'schema' => ['description' => 'Workspace description', 'type' => 'string', 'required' => false, 'example' => 'This is a test workspace', 'title' => ''],
],
[
- 'name' => 'IsReversed',
+ 'name' => 'JobLifecycle',
'in' => 'query',
- 'schema' => [
- 'title' => '是否反转',
- 'description' => '',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'Job lifecycle within the workspace', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => '', 'required' => false],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Role',
'in' => 'query',
- 'schema' => [
- 'title' => '翻页Token用来标记当前开始读取的位置，置空表示从头开始',
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '0f2cc944-67db-4fb1-bb10-f136cda74bda',
- ],
+ 'schema' => ['description' => 'RAM role within the workspace', 'type' => 'string', 'example' => 'MyTestRamRole', 'title' => '', 'required' => false],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'Labels',
'in' => 'query',
- 'schema' => [
- 'title' => '分页数量',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2147483647',
- 'minimum' => '1',
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['description' => 'Workspace labels', 'type' => 'string', 'example' => '{"env":"test"}', 'title' => '', 'required' => false],
],
],
'responses' => [
@@ -9289,327 +5619,1027 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'NextToken' => [
- 'title' => '翻页Token用来表示当前调用返回读取到的位置，空代表数据已经读取完毕',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'ba6d88e2-a6f2-4d2c-a2ae-68b76b078445',
- ],
- 'MaxResults' => [
- 'title' => '分页数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Tags' => [
- 'title' => '公共数据集标签',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => '遗传多样性',
- ],
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
- ],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
- ],
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
- ],
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
],
404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
- ],
- [
- 'errorCode' => 'InvalidOrderBy.NotFound',
- 'errorMessage' => 'The specified OrderBy is not found.',
- ],
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"NextToken\\": \\"ba6d88e2-a6f2-4d2c-a2ae-68b76b078445\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Tags\\": [\\n \\"遗传多样性\\"\\n ]\\n}","type":"json"}]',
- ],
- 'ListRegions' => [
- 'summary' => '查询基因分析平台产品的可用地域。',
- 'methods' => [
- 'get',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"RequestId\\": \\"easygene.cn-beijing.aliyuncs.com\\"\\n}","type":"json"}]',
+ 'title' => 'Update Workspace',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UpdateWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Workspace', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}'],
+ ],
+ ],
+ ],
],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspace'],
+ ],
+ ],
+ ],
+ 'UploadEntity' => [
+ 'summary' => 'Upload entity data tables to a workspace.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
+ 'systemTags' => ['operationType' => 'update'],
+ 'parameters' => [
+ [
+ 'name' => 'Workspace',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Workspace', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-workspace', 'title' => ''],
+ ],
+ [
+ 'name' => 'EntityCSVFile',
+ 'in' => 'query',
+ 'schema' => ['description' => 'OSS path of the entity table CSV file', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'oss://my-bucket/entity.csv', 'title' => ''],
+ ],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
+ 'description' => 'Returned data',
'type' => 'object',
'properties' => [
- 'HostId' => [
- 'title' => '主机ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'Regions' => [
- 'title' => '基因分析平台产品可用地域列表。',
- 'description' => '',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'LocalName' => [
- 'title' => '名称',
- 'description' => '',
- 'type' => 'string',
- 'example' => '华北2-北京',
- ],
- 'RegionEndpoint' => [
- 'title' => '访问Endpoint',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RegionId' => [
- 'title' => '区域ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
- ],
- ],
- ],
+ 'HostId' => ['description' => 'Host ID', 'type' => 'string', 'example' => 'easygene.cn-beijing.aliyuncs.com', 'title' => ''],
+ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B', 'title' => ''],
+ 'Workspace' => ['description' => 'Workspace', 'type' => 'string', 'example' => 'test-workspace', 'title' => ''],
+ 'EntityType' => ['description' => 'Table name', 'type' => 'string', 'example' => 'sample', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'SignatureDoesNotMatch',
- 'errorMessage' => 'The specified signature is invalid.',
+ ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter %s is invalid.', 'description' => 'The specified parameter is invalid.'],
+ ['errorCode' => 'MissingParameter', 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ],
+ 404 => [
+ ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'The specified user is not found.', 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Workspace\\": \\"test-workspace\\",\\n \\"EntityType\\": \\"sample\\"\\n}","type":"json"}]',
+ 'title' => 'Upload entity data',
+ 'changeSet' => [
+ ['createdAt' => '2021-04-22T07:03:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadEntity'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UploadEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/*'],
+ ],
],
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
+ ],
+ ],
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'easygene.cn-beijing.aliyuncs.com', 'endpoint' => 'easygene.cn-beijing.aliyuncs.com', 'vpc' => 'easygene-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'easygene.cn-hangzhou.aliyuncs.com', 'endpoint' => 'easygene.cn-hangzhou.aliyuncs.com', 'vpc' => 'easygene-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'easygene.cn-shanghai.aliyuncs.com', 'endpoint' => 'easygene.cn-shanghai.aliyuncs.com', 'vpc' => 'easygene-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'easygene.cn-shenzhen.aliyuncs.com', 'endpoint' => 'easygene.cn-shenzhen.aliyuncs.com', 'vpc' => 'easygene-vpc.cn-shenzhen.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AccessDenied', 'message' => 'The caller is not authorized to perform %s on resource %s.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'AccessDenied', 'message' => 'The access key ID is disabled %s.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'AccessDenied', 'message' => 'The resources do not belong to you.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'AccessDenied', 'message' => 'The STS token is invalid.', 'http_code' => 403, 'description' => ''],
+ ['code' => 'IdempotentParameterMismatch', 'message' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical .', 'http_code' => 400, 'description' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.'],
+ ['code' => 'InternalServerError', 'message' => 'An internal error has occurred. Please try again.', 'http_code' => 500, 'description' => 'An internal error occurred. Please try again later.'],
+ ['code' => 'InvalidApp.Can.Not.Tag', 'message' => 'You cannot tag the private app.', 'http_code' => 400, 'description' => 'You cannot tag a private app.'],
+ ['code' => 'InvalidApp.Cant.Not.Delete', 'message' => 'You cannot delete the default version or the last version.', 'http_code' => 400, 'description' => 'You cannot delete the default version or the last version.'],
+ ['code' => 'InvalidApp.Catagory.NotFound', 'message' => 'The specified app catalog is not found.', 'http_code' => 404, 'description' => 'The specified app catalog is not found.'],
+ ['code' => 'InvalidApp.DescriptorType.NotFound', 'message' => 'The specified app descriptor type is not found.', 'http_code' => 404, 'description' => 'The specified app descriptor type is not found.'],
+ ['code' => 'InvalidApp.Duplicated', 'message' => 'The specified app exists in the namespace. Change the app name and request again.', 'http_code' => 400, 'description' => 'The specified app exists in the namespace. Change the app name and request again.'],
+ ['code' => 'InvalidApp.NotFound', 'message' => 'The specified app is not found.', 'http_code' => 404, 'description' => 'The specified app is not found.'],
+ ['code' => 'InvalidApp.Toolkit.NotFound', 'message' => 'The specified app toolkit is not found.', 'http_code' => 404, 'description' => 'The specified app toolkit is not found.'],
+ ['code' => 'InvalidApp.Type.NotFound', 'message' => 'The specified app type is not found.', 'http_code' => 404, 'description' => 'The specified app type is not found.'],
+ ['code' => 'InvalidApp.Version.locked', 'message' => 'You cannot delete or modify the locked version.', 'http_code' => 400, 'description' => 'You cannot delete or modify the locked version.'],
+ ['code' => 'InvalidApp.Version.NotFound', 'message' => 'The specified app version is not found.', 'http_code' => 404, 'description' => 'The specified app version is not found.'],
+ ['code' => 'InvalidApp.Version.Visible', 'message' => 'You cannot delete the public version.', 'http_code' => 400, 'description' => 'You cannot delete the public version.'],
+ ['code' => 'InvalidApp.WDL.InvalidContent', 'message' => 'The specified WDL content is invalid.', 'http_code' => 400, 'description' => 'The specified WDL file syntax is invalid.'],
+ ['code' => 'InvalidApp.WDL.MissingMain', 'message' => 'You must specify the main.wdl file.', 'http_code' => 400, 'description' => 'You must specify the main.wdl file.'],
+ ['code' => 'InvalidApp.WDL.MultipleMain', 'message' => 'The request contains multiple WDL files named main.', 'http_code' => 400, 'description' => 'The request contains multiple WDL files named main.'],
+ ['code' => 'InvalidNamespace.Duplicated', 'message' => 'The specified namespace already exists. Change the namespace name and request again.', 'http_code' => 400, 'description' => 'The specified namespace already exists. Change the namespace name and request again.'],
+ ['code' => 'InvalidNamespace.NotFound', 'message' => 'The NamespaceName is not found.', 'http_code' => 404, 'description' => 'The NamespaceName is not found.'],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'],
+ ['code' => 'InvalidParameter', 'message' => 'The specified parameter %s is invalid: %s.', 'http_code' => 400, 'description' => 'The specified parameter %s is invalid: %s.'],
+ ['code' => 'InvalidParameter', 'message' => 'The parameter %s is required but not provided.', 'http_code' => 400, 'description' => 'The parameter %s is required but not provided.'],
+ ['code' => 'InvalidUser.AccessDenied', 'message' => 'The request was denied due to insufficient user permission.', 'http_code' => 403, 'description' => 'The request was denied due to insufficient user permission.'],
+ ['code' => 'InvalidUser.NotFound', 'message' => 'The specified user is not found.', 'http_code' => 404, 'description' => 'The specified user is not found. Please activate EasyGene first.'],
+ ['code' => 'InvalidWorkspace.Configuration.Duplicated', 'message' => 'The specified workspace configuration already exists. Change the configuration name and request again.', 'http_code' => 400, 'description' => 'The specified workspace configuration already exists. Change the configuration name and request again.'],
+ ['code' => 'InvalidWorkspace.Configuration.InvalidInputParameter', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'],
+ ['code' => 'InvalidWorkspace.Configuration.MissingInputParameter', 'message' => 'You must specify the parameter.', 'http_code' => 400, 'description' => 'You must specify the required parameter.'],
+ ['code' => 'InvalidWorkspace.Configuration.NotFound', 'message' => 'The specified workspace configuration is not found.', 'http_code' => 404, 'description' => 'The specified workspace configuration is not found.'],
+ ['code' => 'InvalidWorkspace.Duplicated', 'message' => 'The specified workspace already exists. Change the workspace name and request again.', 'http_code' => 400, 'description' => 'The specified workspace already exists. Change the workspace name and request again.'],
+ ['code' => 'InvalidWorkspace.Entity.DataTypeDoesNotMatch', 'message' => 'The specified data does not match the data type.', 'http_code' => 400, 'description' => 'The specified data does not match the data type.'],
+ ['code' => 'InvalidWorkspace.Entity.Duplicated', 'message' => 'The specified entity already exists. Change the entity name and request again.', 'http_code' => 400, 'description' => 'The specified entity already exists. Change the entity name and request again.'],
+ ['code' => 'InvalidWorkspace.Entity.FileNotFound', 'message' => 'The specified entity file is not found.', 'http_code' => 400, 'description' => 'The specified entity file is not found.'],
+ ['code' => 'InvalidWorkspace.Entity.NotFound', 'message' => 'The specified entity is not found.', 'http_code' => 404, 'description' => 'The specified entity is not found.'],
+ ['code' => 'InvalidWorkspace.Entity.RowDuplicated', 'message' => 'Multiple records share the same unique ID in the current entity.', 'http_code' => 400, 'description' => 'Multiple records share the same unique ID in the current entity.'],
+ ['code' => 'InvalidWorkspace.Entity.RowNotFound', 'message' => 'The specified entity row is not found.', 'http_code' => 404, 'description' => 'The specified entity row is not found.'],
+ ['code' => 'InvalidWorkspace.Entity.UnsupportedFileType', 'message' => 'This entity file type is not supported.', 'http_code' => 400, 'description' => 'The entity file type is not supported.'],
+ ['code' => 'InvalidWorkspace.NotFound', 'message' => 'The specified workspace is not found.', 'http_code' => 404, 'description' => 'The specified Workspace is not found.'],
+ ['code' => 'InvalidWorkspace.Task.NotFound', 'message' => 'The specified task is not found.', 'http_code' => 404, 'description' => 'The specified task is not found.'],
+ ['code' => 'MissingParameter', 'message' => 'The input parameter %s that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'The input parameter %s that is mandatory for processing this request is not supplied.'],
+ ['code' => 'Oss.AccessDenied', 'message' => 'You have no permission to access OSS service.', 'http_code' => 403, 'description' => 'You have no permission to access the OSS service.'],
+ ['code' => 'Oss.Disabled', 'message' => 'You have not activated the OSS service, or your OSS service has an overdue payment.', 'http_code' => 403, 'description' => 'You have not activated the OSS service, or your OSS service has an overdue payment.'],
+ ['code' => 'ResourceAlreadyExists', 'message' => 'The specified resource %s already exists.', 'http_code' => 400, 'description' => 'The specified resource %s already exists.'],
+ ['code' => 'ResourceNotFound', 'message' => 'The specified resource %s is not found.', 'http_code' => 404, 'description' => 'The specified resource %s is not found.'],
+ ['code' => 'SignatureDoesNotMatch', 'message' => 'The specified signature is invalid.', 'http_code' => 400, 'description' => 'The specified signature is invalid.'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateApp'],
+ ['description' => 'Response parameters changed', 'api' => 'GetApp'],
+ ],
+ 'createdAt' => '2024-12-10T09:30:00.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateApp'],
+ ['description' => 'Response parameters changed', 'api' => 'GetApp'],
+ ],
+ 'createdAt' => '2024-12-10T09:14:09.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateRun'],
+ ['description' => 'Response parameters changed', 'api' => 'GetRun'],
+ ],
+ 'createdAt' => '2024-09-10T09:33:24.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'GetRun'],
+ ],
+ 'createdAt' => '2024-04-07T06:13:31.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'ListTemplates'],
+ ],
+ 'createdAt' => '2024-01-29T02:27:31.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateApp'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateRun'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateSubmission'],
+ ['description' => 'Request parameters changed', 'api' => 'CreateTemplate'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetApp'],
+ ['description' => 'Response parameters changed', 'api' => 'GetTemplate'],
+ ],
+ 'createdAt' => '2024-01-12T05:28:13.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CreateRun'],
+ ],
+ 'createdAt' => '2022-11-18T03:31:40.000Z',
+ 'description' => '创建任务支持自定义Role',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'AbortRun'],
+ ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'AbortSubmission'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CopyPublicEntity'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateApp'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateEntity'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateRun'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateSubmission'],
+ ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'CreateTemplate'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateWorkspace'],
+ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteApp'],
+ ],
+ 'createdAt' => '2021-10-28T03:44:07.000Z',
+ 'description' => 'Open API 优化调整，已和在使用的用户沟通，知会变更内容。',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'CopyPublicEntity'],
+ ],
+ 'createdAt' => '2021-05-28T03:09:55.000Z',
+ 'description' => '新增拷贝公共数据集entity到工作空间的API',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetPublicDataset'],
+ ['description' => 'Error codes changed', 'api' => 'GetPublicDatasetEntity'],
+ ['description' => 'Error codes changed', 'api' => 'ListAuthorizedSoftware'],
+ ['description' => 'Error codes changed', 'api' => 'ListPublicDataset'],
+ ['description' => 'Error codes changed', 'api' => 'ListPublicDatasetEntities'],
+ ['description' => 'Error codes changed', 'api' => 'ListPublicDatasetEntityItems'],
+ ['description' => 'Error codes changed', 'api' => 'ListPublicDatasetTags'],
+ ],
+ 'createdAt' => '2021-05-28T01:28:50.000Z',
+ 'description' => '新增API错误码',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'GetPublicDatasetEntity'],
+ ['description' => 'Request parameters changed', 'api' => 'ListPublicDatasetEntities'],
+ ['description' => 'Request parameters changed', 'api' => 'ListPublicDatasetEntityItems'],
+ ],
+ 'createdAt' => '2021-05-20T03:31:45.000Z',
+ 'description' => '新增入参',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ListPublicDataset'],
+ ],
+ 'createdAt' => '2021-05-11T06:04:13.000Z',
+ 'description' => '容灾测试',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'ListSubmissions'],
+ ],
+ 'createdAt' => '2021-05-07T12:06:55.000Z',
+ 'description' => '1. 后端配置修改2. 添加Failed枚举值',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetGlobalApp'],
+ ['description' => 'Error codes changed', 'api' => 'GetPublicDataset'],
+ ['description' => 'Error codes changed', 'api' => 'ListUserActiveRuns'],
+ ],
+ 'createdAt' => '2021-05-07T11:57:10.000Z',
+ 'description' => '新增错误码映射',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'OpenAPI offline', 'api' => 'ListUserActiveRuns'],
+ ],
+ 'createdAt' => '2021-04-25T07:56:21.000Z',
+ 'description' => '基因分析平台首次发布',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEntity'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEntities'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateWorkspace'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadEntity'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEntityItems'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRun'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEntity'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportApp'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSubmission'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEntity'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRuns'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkspace'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWorkspace'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSubmission'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWorkspace'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSubmission'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteApp'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeSubmission'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortSubmission'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRun'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyPublicEntity'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRun'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DownloadEntity'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListApps'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTemplate'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetApp'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListWorkspaces'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortRun'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEntityItems'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEntityItems'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserActiveRuns'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateApp'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSubmissions'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallGlobalApp'],
+ ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPublicDatasetEntity'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'Genomics',
+ 'productName' => 'genomics',
+ 'ramCodes' => ['easygene'],
+ 'ramLevel' => 'RESOURCE',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'UploadEntity',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UploadEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/*'],
],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
+ ],
+ ],
+ [
+ 'apiName' => 'GetApp',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/{#AppName}'],
],
],
- 404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ ],
+ [
+ 'apiName' => 'DeleteRun',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteRun',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/{#RunId}'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"Regions\\": [\\n {\\n \\"LocalName\\": \\"华北2-北京\\",\\n \\"RegionEndpoint\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n}","type":"json"}]',
- ],
- 'InstallGlobalApp' => [
- 'summary' => '安装平台公共应用到工作空间中。',
- 'methods' => [
- 'post',
- 'get',
+ [
+ 'apiName' => 'AbortSubmission',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:AbortSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/{#SubmissionId}'],
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ [
+ 'apiName' => 'DeleteSubmission',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:worksapce/{#Workspace}/submission/{#SubmissionId}'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetTemplate',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/{#TemplateName}'],
+ ],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [],
- 'parameters' => [
- [
- 'name' => 'Source',
- 'in' => 'query',
- 'schema' => [
- 'title' => '来源',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'EasyGene',
+ [
+ 'apiName' => 'ListPublicDatasetTags',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListPublicDatasetTags',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'NamespaceName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '命名空间名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sentieon',
+ ],
+ [
+ 'apiName' => 'GetPublicDataset',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetPublicDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'AppName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '应用名称',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'joint-calling',
+ ],
+ [
+ 'apiName' => 'ListContainerImages',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListContainerImages',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Workspace',
- 'in' => 'query',
- 'schema' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'default-workspace',
+ ],
+ [
+ 'apiName' => 'UpdateEntityItems',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UpdateEntityItems',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
],
],
- [
- 'name' => 'InstalledAppName',
- 'in' => 'query',
- 'schema' => [
- 'title' => '安装后应用名',
- 'description' => '',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'joint-calling',
+ ],
+ [
+ 'apiName' => 'GetEntity',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => '创建应用返回结果',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'HostId' => [
- 'title' => '主机 ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- 'RequestId' => [
- 'title' => '请求 ID',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'DA980AD0-158F-44F3-847D-5EAB96C0EB6B',
- ],
- 'InstalledAppName' => [
- 'title' => '安装后应用名',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'InstalledApp',
- ],
- 'Workspace' => [
- 'title' => '工作空间',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'TestWorkspace',
- ],
- 'RegionId' => [
- 'title' => '区域名',
- 'description' => '',
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
- ],
+ [
+ 'apiName' => 'DeleteApp',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/{#AppName}'],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'InvalidParameter',
- 'errorMessage' => 'The specified parameter %s is invalid.',
+ [
+ 'apiName' => 'UpdateTemplate',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UpdateTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/{#TemplateName}'],
],
- [
- 'errorCode' => 'MissingParameter',
- 'errorMessage' => 'The input parameter %s that is mandatory for processing this request is not supplied.',
+ ],
+ ],
+ [
+ 'apiName' => 'CreateEntity',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/*'],
],
],
- 404 => [
- [
- 'errorCode' => 'InvalidUser.NotFound',
- 'errorMessage' => 'The specified user is not found.',
+ ],
+ [
+ 'apiName' => 'ListPublicDatasetEntities',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListPublicDatasetEntities',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRuns',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListRuns',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InstallGlobalApp',
+ 'description' => '',
+ 'operationType' => '',
+ 'ramAction' => [
+ 'action' => 'easygene:InstallGlobalApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateWorkspace',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListUserActiveRuns',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListUserActiveRuns',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateEntity',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UpdateEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateRun',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateRun',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateWorkspace',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:UpdateWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Workspace', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ImportApp',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:ImportApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetWorkspace',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Workspace', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAuthorizedSoftware',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListAuthorizedSoftware',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CopyPublicEntity',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:CopyPublicEntity',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListRegions',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListRegions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AbortRun',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:AbortRun',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/{#RunId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteWorkspace',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteWorkspace',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Workspace', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEntityItems',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListEntityItems',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'TagApp',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:TagApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/{#AppName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateSubmission',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateApp',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateApp',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPublicDatasetEntity',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetPublicDatasetEntity',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ResumeSubmission',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'easygene:ResumeSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/{#SubmissionId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetRun',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetRun',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/{#RunId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPublicDatasetEntityItems',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListPublicDatasetEntityItems',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTemplates',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListTemplates',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWorkspaces',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListWorkspaces',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteTemplate',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/{#TemplateName}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSubmissions',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListSubmissions',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPublicDataset',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListPublicDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteEntity',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DownloadEntity',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:DownloadEntity',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEntities',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListEntities',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSubmission',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:GetSubmission',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/{#SubmissionId}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteEntityItems',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'easygene:DeleteEntityItems',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateTemplate',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'easygene:CreateTemplate',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListGlobalApps',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'easygene:ListGlobalApps',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListApps',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'easygene:ListApps',
+ 'authLevel' => 'resource',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Genomics', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"HostId\\": \\"easygene.cn-beijing.aliyuncs.com\\",\\n \\"RequestId\\": \\"DA980AD0-158F-44F3-847D-5EAB96C0EB6B\\",\\n \\"InstalledAppName\\": \\"InstalledApp\\",\\n \\"Workspace\\": \\"TestWorkspace\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n}","errorExample":""},{"type":"xml","example":"<InstallGlobalAppResponse>\\n <HostId>easygene.cn-beijing.aliyuncs.com</HostId>\\n <RequestId>DA980AD0-158F-44F3-847D-5EAB96C0EB6B</RequestId>\\n <InstalledAppName>InstalledApp</InstalledAppName>\\n <Workspace>TestWorkspace</Workspace>\\n <RegionId>cn-beijing</RegionId>\\n</InstallGlobalAppResponse>","errorExample":""}]',
- 'title' => 'InstallGlobalApp',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'easygene.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'easygene.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'easygene.cn-shenzhen.aliyuncs.com',
],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'easygene.cn-hangzhou.aliyuncs.com',
+ 'resourceTypes' => [
+ ['validationType' => 'always', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/*'],
+ ['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/{#AppName}'],
+ ['validationType' => 'always', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/{#RunId}'],
+ ['validationType' => 'always', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/{#SubmissionId}'],
+ ['validationType' => 'always', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:worksapce/{#Workspace}/submission/{#SubmissionId}'],
+ ['validationType' => 'always', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/{#TemplateName}'],
+ ['validationType' => 'always', 'resourceType' => 'Entity', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/entity/{#EntityType}'],
+ ['validationType' => 'always', 'resourceType' => 'Run', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/run/*'],
+ ['validationType' => 'always', 'resourceType' => 'App', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/app/*'],
+ ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/*'],
+ ['validationType' => 'always', 'resourceType' => 'Workspace', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}'],
+ ['validationType' => 'always', 'resourceType' => 'Submission', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/submission/*'],
+ ['validationType' => 'always', 'resourceType' => 'Template', 'arn' => 'acs:easygene:{#regionId}:{#accountId}:workspace/{#Workspace}/template/*'],
],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 20:24:31 +0000