summaryrefslogtreecommitdiff
path: root/data/en_us/grace
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
committerZhineng Li <[email protected]>2026-02-13 10:54:11 +0800
commit7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch)
tree0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/grace
downloadacs-metadata-full-1.0.0+20260212.tar.gz
acs-metadata-full-1.0.0+20260212.zip
Diffstat (limited to 'data/en_us/grace')
-rw-r--r--data/en_us/grace/2022-06-06/api-docs.php563
1 files changed, 563 insertions, 0 deletions
diff --git a/data/en_us/grace/2022-06-06/api-docs.php b/data/en_us/grace/2022-06-06/api-docs.php
new file mode 100644
index 0000000..6c0b446
--- /dev/null
+++ b/data/en_us/grace/2022-06-06/api-docs.php
@@ -0,0 +1,563 @@
+<?php return [
+ 'version' => '1.0',
+ 'info' => [
+ 'style' => 'ROA',
+ 'product' => 'grace',
+ 'version' => '2022-06-06',
+ ],
+ 'directories' => [
+ 'UploadFileByURL',
+ 'UploadFileByOSS',
+ 'AnalyzeFile',
+ 'GetFile',
+ ],
+ 'components' => [
+ 'schemas' => [
+ 'FileInfo' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'type' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'type',
+ ],
+ 'size' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'size',
+ ],
+ 'creationTime' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'creationTime',
+ ],
+ 'displayName' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'displayName',
+ ],
+ 'analyzeProgress' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'message' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'message',
+ ],
+ 'percent' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'number',
+ 'format' => 'double',
+ 'backendName' => 'percent',
+ ],
+ 'state' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'state',
+ ],
+ ],
+ 'backendName' => 'analyzeProgress',
+ ],
+ 'labels' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'labels',
+ ],
+ 'shared' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'boolean',
+ 'backendName' => 'shared',
+ ],
+ 'transferState' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'transferState',
+ ],
+ 'name' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'name',
+ ],
+ 'transferProgress' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'object',
+ 'properties' => [
+ 'totalSize' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'totalSize',
+ ],
+ 'transferredSize' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'backendName' => 'transferredSize',
+ ],
+ ],
+ 'backendName' => 'transferProgress',
+ ],
+ 'requestId' => [
+ 'title' => '',
+ 'description' => '',
+ 'visibility' => 'public',
+ 'type' => 'string',
+ 'backendName' => 'requestId',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'apis' => [
+ 'UploadFileByURL' => [
+ 'summary' => '通过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' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'https://bucket.oss-cn-hangzhou.aliyuncs.com/file.log',
+ ],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'heap_dump',
+ ],
+ ],
+ [
+ 'name' => 'displayName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'atp_stack.log',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => [
+ 'title' => 'Id of the request',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'D052C0F4-5884-5B01-A8CC-D63B9A549B6C',
+ ],
+ 'name' => [
+ 'title' => '若创建接口为异步实现,则需返回明确的JobId。',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1597871211794192-1682567255445-bbbbb',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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.',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D052C0F4-5884-5B01-A8CC-D63B9A549B6C\\",\\n \\"name\\": \\"1597871211794192-1682567255445-bbbbb\\"\\n}","type":"json"}]',
+ ],
+ 'UploadFileByOSS' => [
+ 'summary' => 'UploadFileByOSS',
+ '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',
+ ],
+ ],
+ [
+ 'name' => 'bucketName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'grace-storage',
+ ],
+ ],
+ [
+ 'name' => 'objectName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'heap.bin',
+ ],
+ ],
+ [
+ 'name' => 'type',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'thread_dump',
+ ],
+ ],
+ [
+ 'name' => 'displayName',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'heap.bin',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => [
+ 'title' => 'Id of the request',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1597871211794192-1665457027646-grace-storage1-heap.bin',
+ ],
+ 'requestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'E7D6CC4E-C216-5313-A9A5-B5DA619ED431',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"name\\": \\"1597871211794192-1665457027646-grace-storage1-heap.bin\\",\\n \\"requestId\\": \\"E7D6CC4E-C216-5313-A9A5-B5DA619ED431\\"\\n}","type":"json"}]',
+ ],
+ 'AnalyzeFile' => [
+ 'summary' => '分析文件',
+ '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' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '123-456-file.log',
+ ],
+ ],
+ [
+ 'name' => 'token',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '6e54e9d5-3147-458e-a85d-bae8722de747',
+ ],
+ ],
+ [
+ 'name' => 'keepUnreachableObjects',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'required' => false,
+ 'example' => 'true',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'B14EC7CC-5181-582F-8EB7-6DB142FB529F',
+ ],
+ 'fileName' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '207076258906603549-1667270208299-heap_dump_11.195.186.232_1667269965442.bin',
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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"}]',
+ ],
+ 'GetFile' => [
+ 'summary' => '获取文件',
+ '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' => '实例 ID。',
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => '1597871211794192-1682563156700-402185-1682563123810-bbbbb',
+ ],
+ ],
+ [
+ 'name' => 'token',
+ 'in' => 'query',
+ 'schema' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => '924cb178-32e6-453a-a553-83289f9f494c',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => [
+ 'title' => '',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '1995846817640449-1683529779418-file.log',
+ ],
+ 'size' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '254799093',
+ ],
+ 'type' => [
+ 'title' => '',
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'HEAP_DUMP',
+ ],
+ 'transferState' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'IN_PROGRESS',
+ ],
+ 'creationTime' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '1683788649000',
+ ],
+ 'displayName' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'heapdemo.bin',
+ ],
+ 'shared' => [
+ 'description' => '',
+ 'type' => 'boolean',
+ 'example' => 'True',
+ ],
+ 'transferProgress' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'totalSize' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '267',
+ ],
+ 'transferredSize' => [
+ 'description' => '',
+ 'type' => 'integer',
+ 'format' => 'int64',
+ 'example' => '22',
+ ],
+ ],
+ ],
+ 'analyzeProgress' => [
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'state' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'IN_PROGRESS',
+ ],
+ 'percent' => [
+ 'description' => '',
+ 'type' => 'number',
+ 'format' => 'double',
+ 'example' => '100.0%',
+ ],
+ 'message' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'successful',
+ ],
+ ],
+ ],
+ 'requestId' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => '007F9BC4-E4F6-56E9-8A3D-402A39565603',
+ ],
+ 'labels' => [
+ 'description' => '',
+ 'type' => 'string',
+ 'example' => 'source:grace',
+ ],
+ ],
+ '$ref' => '#/components/schemas/FileInfo',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"type\\": \\"\\",\\n \\"size\\": 0,\\n \\"creationTime\\": 0,\\n \\"displayName\\": \\"\\",\\n \\"analyzeProgress\\": {\\n \\"message\\": \\"\\",\\n \\"percent\\": 0,\\n \\"state\\": \\"\\"\\n },\\n \\"labels\\": \\"\\",\\n \\"shared\\": true,\\n \\"transferState\\": \\"\\",\\n \\"name\\": \\"\\",\\n \\"transferProgress\\": {\\n \\"totalSize\\": 0,\\n \\"transferredSize\\": 0\\n },\\n \\"requestId\\": \\"\\"\\n}","type":"json"}]',
+ ],
+ ],
+ 'endpoints' => [],
+];