'1.0', 'info' => ['style' => 'ROA', 'product' => 'grace', 'version' => '2022-06-06'], 'directories' => ['UploadFileByURL', 'UploadFileByOSS', 'AnalyzeFile', 'GetFile'], 'components' => [ 'schemas' => [ 'FileInfo' => [ 'title' => '文件信息', 'description' => 'File information', 'type' => 'object', 'properties' => [ 'type' => [ 'title' => '文件类型', 'description' => 'File type', 'enumValueTitles' => ['gc_log' => 'GC_LOG', 'thread_dump' => 'THREAD_DMP', 'heap_dump' => 'HEAP_DUMP'], 'type' => 'string', 'example' => 'HEAP_DUMP'."\n", 'visibility' => 'Public', 'backendName' => 'type', ], 'size' => ['title' => '文件大小,单位byte', 'description' => 'File size, in bytes', 'type' => 'integer', 'format' => 'int64', 'example' => '254799093', 'visibility' => 'Public', 'backendName' => 'size'], 'creationTime' => ['title' => '创建时间', 'description' => 'Creation time', 'type' => 'integer', 'format' => 'int64', 'example' => '1683788649000', 'visibility' => 'Public', 'backendName' => 'creationTime'], 'displayName' => ['title' => '文件展示名字', 'description' => 'Display name of the file', 'type' => 'string', 'example' => 'myheap.bin', 'visibility' => 'Public', 'backendName' => 'displayName'], 'analyzeProgress' => [ 'title' => '分析进度', 'description' => 'Analysis progress', 'type' => 'object', 'properties' => [ 'message' => ['title' => '分析详情', 'description' => 'Analysis details', 'type' => 'string', 'example' => 'Trying to analyze....', 'visibility' => 'Public', 'backendName' => 'message'], 'percent' => ['title' => '分析进度', 'description' => 'Analysis progress', 'type' => 'number', 'format' => 'double', 'example' => '1.0', 'visibility' => 'Public', 'backendName' => 'percent'], 'state' => [ 'title' => '分析状态', 'description' => 'Analysis state', 'enumValueTitles' => ['IN_PROGRESS' => 'IN_PROGRESS', 'SUCCESS' => 'SUCCESS', 'NOT_STARTED' => 'NOT_STARTED', 'ERROR' => 'ERROR'], 'type' => 'string', 'example' => 'IN_PROGRESS', 'visibility' => 'Public', 'backendName' => 'state', ], ], 'enumValueTitles' => [], 'example' => '', 'visibility' => 'Public', 'backendName' => 'analyzeProgress', ], 'labels' => ['title' => '文件标签', 'description' => 'File tags', 'type' => 'string', 'example' => 'source:local', 'visibility' => 'Public', 'backendName' => 'labels'], 'shared' => ['title' => '是否允许共享访问', 'description' => 'Indicates whether shared access is allowed', 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'shared'], 'transferState' => [ 'title' => '文件传输状态', 'description' => 'File transfer state', 'enumValueTitles' => ['IN_PROGRESS' => 'IN_PROGRESS', 'SUCCESS' => 'SUCCESS', 'NOT_STARTED' => 'NOT_STARTED', 'ERROR' => 'ERROR'], 'type' => 'string', 'example' => 'ERROR', 'visibility' => 'Public', 'backendName' => 'transferState', ], 'name' => ['title' => '文件名', 'description' => 'File name', 'type' => 'string', 'example' => '1995846817640449-1683529779418-file.log', 'visibility' => 'Public', 'backendName' => 'name'], 'transferProgress' => [ 'title' => '传输进度', 'description' => 'Transfer progress', 'type' => 'object', 'properties' => [ 'totalSize' => ['title' => '总大小,单位byte', 'description' => 'Total size, in bytes', 'type' => 'integer', 'format' => 'int64', 'example' => '3069', 'visibility' => 'Public', 'backendName' => 'totalSize'], 'transferredSize' => ['title' => '已传输大小,单位byte', 'description' => 'Transferred size, in bytes', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'visibility' => 'Public', 'backendName' => 'transferredSize'], ], 'example' => '', 'visibility' => 'Public', 'backendName' => 'transferProgress', ], 'requestId' => ['title' => '请求ID', 'description' => 'Request ID', 'type' => 'string', 'example' => 'B14EABCD-5181-582F-8EB7-6DB142FB529F', 'visibility' => 'Public', 'backendName' => 'requestId'], ], 'example' => '', 'visibility' => 'Public', ], ], ], 'apis' => [ 'AnalyzeFile' => [ 'summary' => 'Analyzes a file.', 'path' => '/AnalyzeFile', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false], 'parameters' => [ [ 'name' => 'name', 'in' => 'query', 'schema' => ['description' => 'File name', 'type' => 'string', 'required' => false, 'example' => '123-456-file.log', 'title' => ''], ], [ 'name' => 'token', 'in' => 'query', 'schema' => ['description' => 'Shared access file token', 'type' => 'string', 'required' => false, 'example' => '6e54e9d5-3147-458e-a85d-bae8722de747', 'title' => ''], ], [ 'name' => 'keepUnreachableObjects', 'in' => 'query', 'schema' => ['description' => 'Retain unreachable objects', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'B14EC7CC-5181-582F-8EB7-6DB142FB529F', 'title' => ''], 'fileName' => ['description' => 'File name', 'type' => 'string', 'example' => '207076258906603549-1667270208299-heap_dump_11.195.186.232_1667269965442.bin', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B14EC7CC-5181-582F-8EB7-6DB142FB529F\\",\\n \\"fileName\\": \\"207076258906603549-1667270208299-heap_dump_11.195.186.232_1667269965442.bin\\"\\n}","type":"json"}]', 'title' => 'Analyze the file', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'grace:AnalyzeFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeFile'], ], ], ], 'GetFile' => [ 'summary' => 'Retrieve information about a file.', 'path' => '/GetFile', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false], 'parameters' => [ [ 'name' => 'name', 'in' => 'query', 'schema' => ['title' => 'Instance ID.', 'description' => 'File name', 'type' => 'string', 'required' => true, 'example' => '1597871211794192-1682563156700-402185-1682563123810-bbbbb'], ], [ 'name' => 'token', 'in' => 'query', 'schema' => ['description' => 'Shared access token', 'type' => 'string', 'required' => false, 'example' => '924cb178-32e6-453a-a553-83289f9f494c', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => ['description' => 'File information', '$ref' => '#/components/schemas/FileInfo', 'title' => '', 'example' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"type\\": \\"HEAP_DUMP\\\\n\\",\\n \\"size\\": 254799093,\\n \\"creationTime\\": 1683788649000,\\n \\"displayName\\": \\"myheap.bin\\",\\n \\"analyzeProgress\\": {\\n \\"message\\": \\"Trying to analyze....\\",\\n \\"percent\\": 1,\\n \\"state\\": \\"IN_PROGRESS\\"\\n },\\n \\"labels\\": \\"source:local\\",\\n \\"shared\\": true,\\n \\"transferState\\": \\"ERROR\\",\\n \\"name\\": \\"1995846817640449-1683529779418-file.log\\",\\n \\"transferProgress\\": {\\n \\"totalSize\\": 3069,\\n \\"transferredSize\\": 22\\n },\\n \\"requestId\\": \\"B14EABCD-5181-582F-8EB7-6DB142FB529F\\"\\n}","type":"json"}]', 'title' => '[parameters_name_schema_description]File Name', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'grace:GetFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFile'], ], ], ], 'UploadFileByOSS' => [ 'summary' => 'Upload files to the ATP platform using OSS.', 'path' => '/UploadFileByOSS', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false], 'parameters' => [ [ 'name' => 'endpoint', 'in' => 'query', 'schema' => ['description' => 'OSS endpoint', 'type' => 'string', 'required' => true, 'example' => 'https://oss-cn-hangzhou.aliyuncs.com', 'title' => ''], ], [ 'name' => 'bucketName', 'in' => 'query', 'schema' => ['description' => 'OSS bucket name', 'type' => 'string', 'required' => true, 'example' => 'mybucket', 'title' => ''], ], [ 'name' => 'objectName', 'in' => 'query', 'schema' => ['description' => 'Object name', 'type' => 'string', 'required' => true, 'example' => 'heap.bin', 'title' => ''], ], [ 'name' => 'type', 'in' => 'query', 'schema' => [ 'description' => 'File type', 'enumValueTitles' => ['gc_log' => 'gc\\_log', 'thread_dump' => 'thread\\_dump', 'heap_dump' => 'heap\\_dump'], 'type' => 'string', 'required' => true, 'example' => 'thread_dump', 'title' => '', ], ], [ 'name' => 'displayName', 'in' => 'query', 'schema' => ['description' => 'Display name', 'type' => 'string', 'required' => false, 'example' => 'heap.bin', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'name' => ['title' => 'Id of the request', 'description' => 'File name', 'type' => 'string', 'example' => '1597871211794192-1665457027646-grace-storage1-heap.bin'], 'requestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'E7D6CC4E-C216-5313-A9A5-B5DA619ED431', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"1597871211794192-1665457027646-grace-storage1-heap.bin\\",\\n \\"requestId\\": \\"E7D6CC4E-C216-5313-A9A5-B5DA619ED431\\"\\n}","type":"json"}]', 'title' => 'Upload a file through OSS', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFileByOSS'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'grace:UploadFileByOSS', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UploadFileByURL' => [ 'summary' => 'Uploads a file from a specified URL.', 'path' => '/UploadFileByURL', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => [], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false], 'parameters' => [ [ 'name' => 'url', 'in' => 'query', 'schema' => ['description' => 'The URL from which to download the file.', 'type' => 'string', 'required' => true, 'example' => 'https://bucket.oss-cn-hangzhou.aliyuncs.com/file.log', 'title' => ''], ], [ 'name' => 'type', 'in' => 'query', 'schema' => ['description' => 'The file type.', 'type' => 'string', 'required' => true, 'example' => 'heap_dump', 'title' => ''], ], [ 'name' => 'displayName', 'in' => 'query', 'schema' => ['description' => 'The display name.', 'type' => 'string', 'required' => false, 'example' => 'atp_stack.log', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D052C0F4-5884-5B01-A8CC-D63B9A549B6C'], 'name' => ['title' => 'If the creation API is implemented asynchronously, a clear JobId must be returned. ', 'description' => 'The file name.', 'type' => 'string', 'example' => '1597871211794192-1682567255445-bbbbb'], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D052C0F4-5884-5B01-A8CC-D63B9A549B6C\\",\\n \\"name\\": \\"1597871211794192-1682567255445-bbbbb\\"\\n}","type":"json"}]', 'title' => 'Upload a file by URL ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFileByURL'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'grace:UploadFileByURL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], ], 'endpoints' => [], 'errorCodes' => [], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFile'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFileByOSS'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFileByURL'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnalyzeFile'], ], ], 'ram' => [ 'productCode' => 'Grace', 'productName' => 'innovative swproduct', 'ramCodes' => ['grace'], 'ramLevel' => 'OPERATION', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'TransferFile', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'grace:TransferFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteFile', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'grace:DeleteFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckOssSLR', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'grace:CheckOssSLR', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CleanFile', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'grace:CleanFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UploadOwnerFileByURL', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'grace:UploadOwnerFileByURL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateFile', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'grace:UpdateFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UploadFileByURL', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'grace:UploadFileByURL', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateOssSLR', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'grace:CreateOssSLR', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UploadOwnerFileByOSS', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'grace:UploadOwnerFileByOSS', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UploadFileByOSS', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'grace:UploadFileByOSS', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateFileShare', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'grace:UpdateFileShare', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UploadFileToOss', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'grace:UploadFileToOss', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFiles', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'grace:ListFiles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FetchFileAnalysis', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'grace:FetchFileAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetFile', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'grace:GetFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AnalyzeFile', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'grace:AnalyzeFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateFileType', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'grace:UpdateFileType', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [], ], ];