summaryrefslogtreecommitdiff
path: root/data/zh_cn/grace/2022-06-06/api-docs.php
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/grace/2022-06-06/api-docs.php')
-rw-r--r--data/zh_cn/grace/2022-06-06/api-docs.php843
1 files changed, 401 insertions, 442 deletions
diff --git a/data/zh_cn/grace/2022-06-06/api-docs.php b/data/zh_cn/grace/2022-06-06/api-docs.php
index be03a49..170bfa6 100644
--- a/data/zh_cn/grace/2022-06-06/api-docs.php
+++ b/data/zh_cn/grace/2022-06-06/api-docs.php
@@ -1,387 +1,187 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'grace',
- 'version' => '2022-06-06',
- ],
- 'directories' => [
- 'UploadFileByURL',
- 'UploadFileByOSS',
- 'AnalyzeFile',
- 'GetFile',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'grace', 'version' => '2022-06-06'],
+ 'directories' => ['UploadFileByURL', 'UploadFileByOSS', 'AnalyzeFile', 'GetFile'],
'components' => [
'schemas' => [
- 'AnalysisConfig' => [
- 'title' => 'analysisConfig',
- 'type' => 'object',
- 'properties' => [
- 'highHeapUsageThreshold' => [
- 'title' => 'highHeapUsageThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'highHumongousUsageThreshold' => [
- 'title' => 'highHumongousUsageThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'longPauseThreshold' => [
- 'title' => 'longPauseThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'highOldUsageThreshold' => [
- 'title' => 'highOldUsageThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'highMetaspaceUsageThreshold' => [
- 'title' => 'highMetaspaceUsageThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'highPromotionThreshold' => [
- 'title' => 'highPromotionThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'tooManyOldGCThreshold' => [
- 'title' => 'tooManyOldGCThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'timeRange' => [
- 'title' => 'timeRange',
- 'type' => 'object',
- 'properties' => [
- 'end' => [
- 'title' => 'end',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'start' => [
- 'title' => 'start',
- 'type' => 'number',
- 'format' => 'double',
- ],
- ],
- ],
- 'fullGCFrequentIntervalThreshold' => [
- 'title' => 'fullGCFrequentIntervalThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'badThroughputThreshold' => [
- 'title' => 'badThroughputThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'smallGenerationThreshold' => [
- 'title' => 'smallGenerationThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'oldGCFrequentIntervalThreshold' => [
- 'title' => 'oldGCFrequentIntervalThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'youngGCFrequentIntervalThreshold' => [
- 'title' => 'youngGCFrequentIntervalThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'longConcurrentThreshold' => [
- 'title' => 'longConcurrentThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'lowUsrThreshold' => [
- 'title' => 'lowUsrThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'highSysThreshold' => [
- 'title' => 'highSysThreshold',
- 'type' => 'number',
- 'format' => 'double',
- ],
- ],
- ],
'FileInfo' => [
'title' => '文件信息',
'description' => '文件信息',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
'type' => [
'title' => '文件类型',
'description' => '文件类型',
+ 'visibility' => 'Public',
'type' => 'string',
- 'enumValueTitles' => [
- 'gc_log' => 'GC_LOG',
- 'thread_dump' => 'THREAD_DMP',
- 'heap_dump' => 'HEAP_DUMP',
- ],
+ 'enumValueTitles' => ['gc_log' => 'GC_LOG', 'thread_dump' => 'THREAD_DMP', 'heap_dump' => 'HEAP_DUMP'],
'example' => 'HEAP_DUMP'."\n",
+ 'backendName' => 'type',
],
- 'size' => [
- 'title' => '文件大小，单位byte',
- 'description' => '文件大小，单位byte',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '254799093',
- ],
- 'creationTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1683788649000',
- ],
- 'displayName' => [
- 'title' => '文件展示名字',
- 'description' => '文件展示名字',
- 'type' => 'string',
- 'example' => 'myheap.bin',
- ],
+ 'size' => ['title' => '文件大小，单位byte', 'description' => '文件大小，单位byte', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '254799093', 'backendName' => 'size'],
+ 'creationTime' => ['title' => '创建时间', 'description' => '创建时间', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1683788649000', 'backendName' => 'creationTime'],
+ 'displayName' => ['title' => '文件展示名字', 'description' => '文件展示名字', 'visibility' => 'Public', 'type' => 'string', 'example' => 'myheap.bin', 'backendName' => 'displayName'],
'analyzeProgress' => [
'title' => '分析进度',
'description' => '分析进度',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'message' => [
- 'title' => '分析详情',
- 'description' => '分析详情',
- 'type' => 'string',
- 'example' => 'Trying to analyze....',
- ],
- 'percent' => [
- 'title' => '分析进度',
- 'description' => '分析进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1.0',
- ],
+ 'message' => ['title' => '分析详情', 'description' => '分析详情', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Trying to analyze....', 'backendName' => 'message'],
+ 'percent' => ['title' => '分析进度', 'description' => '分析进度', 'visibility' => 'Public', 'type' => 'number', 'format' => 'double', 'example' => '1.0', 'backendName' => 'percent'],
'state' => [
'title' => '分析状态',
'description' => '分析状态',
+ 'visibility' => 'Public',
'type' => 'string',
- 'enumValueTitles' => [
- 'IN_PROGRESS' => 'IN_PROGRESS',
- 'SUCCESS' => 'SUCCESS',
- 'NOT_STARTED' => 'NOT_STARTED',
- 'ERROR' => 'ERROR',
- ],
+ 'enumValueTitles' => ['IN_PROGRESS' => 'IN_PROGRESS', 'SUCCESS' => 'SUCCESS', 'NOT_STARTED' => 'NOT_STARTED', 'ERROR' => 'ERROR'],
'example' => 'IN_PROGRESS',
+ 'backendName' => 'state',
],
],
'enumValueTitles' => [],
+ 'backendName' => 'analyzeProgress',
],
- 'labels' => [
- 'title' => '文件标签',
- 'description' => '文件标签',
- 'type' => 'string',
- 'example' => 'source:local',
- ],
- 'shared' => [
- 'title' => '是否允许共享访问',
- 'description' => '是否允许共享访问',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'labels' => ['title' => '文件标签', 'description' => '文件标签', 'visibility' => 'Public', 'type' => 'string', 'example' => 'source:local', 'backendName' => 'labels'],
+ 'shared' => ['title' => '是否允许共享访问', 'description' => '是否允许共享访问', 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'shared'],
'transferState' => [
'title' => '文件传输状态',
'description' => '文件传输状态',
+ 'visibility' => 'Public',
'type' => 'string',
- 'enumValueTitles' => [
- 'IN_PROGRESS' => 'IN_PROGRESS',
- 'SUCCESS' => 'SUCCESS',
- 'NOT_STARTED' => 'NOT_STARTED',
- 'ERROR' => 'ERROR',
- ],
+ 'enumValueTitles' => ['IN_PROGRESS' => 'IN_PROGRESS', 'SUCCESS' => 'SUCCESS', 'NOT_STARTED' => 'NOT_STARTED', 'ERROR' => 'ERROR'],
'example' => 'ERROR',
+ 'backendName' => 'transferState',
],
- 'name' => [
- 'title' => '文件名',
- 'description' => '文件名',
- 'type' => 'string',
- 'example' => '1995846817640449-1683529779418-file.log',
- ],
+ 'name' => ['title' => '文件名', 'description' => '文件名', 'visibility' => 'Public', 'type' => 'string', 'example' => '1995846817640449-1683529779418-file.log', 'backendName' => 'name'],
'transferProgress' => [
'title' => '传输进度',
'description' => '传输进度',
+ 'visibility' => 'Public',
'type' => 'object',
'properties' => [
- 'totalSize' => [
- 'title' => '总大小，单位byte',
- 'description' => '总大小，单位byte',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3069',
- ],
- 'transferredSize' => [
- 'title' => '已传输大小，单位byte',
- 'description' => '已传输大小，单位byte',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '22',
- ],
+ 'totalSize' => ['title' => '总大小，单位byte', 'description' => '总大小，单位byte', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '3069', 'backendName' => 'totalSize'],
+ 'transferredSize' => ['title' => '已传输大小，单位byte', 'description' => '已传输大小，单位byte', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'backendName' => 'transferredSize'],
],
+ 'backendName' => 'transferProgress',
],
- 'requestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'B14EABCD-5181-582F-8EB7-6DB142FB529F',
- ],
- ],
- ],
- 'PhaseStatisticItem' => [
- 'title' => 'A short description of struct',
- 'description' => 'GC阶段的信息',
- 'type' => 'object',
- 'properties' => [
- 'name' => [
- 'title' => 'name',
- 'type' => 'string',
- ],
- 'count' => [
- 'title' => 'count',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'intervalAvg' => [
- 'title' => 'intervalAvg',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'intervalMin' => [
- 'title' => 'intervalMin',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'durationAvg' => [
- 'title' => 'durationAvg',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'durationMax' => [
- 'title' => 'durationMax',
- 'type' => 'number',
- 'format' => 'double',
- ],
- 'durationTotal' => [
- 'title' => 'durationTotal',
- 'type' => 'number',
- 'format' => 'double',
- ],
+ 'requestId' => ['title' => '请求ID', 'description' => '请求ID', 'visibility' => 'Public', 'type' => 'string', 'example' => 'B14EABCD-5181-582F-8EB7-6DB142FB529F', 'backendName' => 'requestId'],
],
],
],
],
'apis' => [
- 'UploadFileByURL' => [
- 'summary' => '通过URL上传文件',
- 'path' => '/UploadFileByURL',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'AnalyzeFile' => [
+ 'summary' => '分析文件。',
+ 'path' => '/AnalyzeFile',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => false,
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false],
'parameters' => [
[
- 'name' => 'url',
+ 'name' => 'name',
'in' => 'query',
- 'schema' => [
- 'description' => '文件下载链接url',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://bucket.oss-cn-hangzhou.aliyuncs.com/file.log',
- ],
+ 'schema' => ['description' => '文件名称', 'type' => 'string', 'required' => false, 'example' => '123-456-file.log'],
],
[
- 'name' => 'type',
+ 'name' => 'token',
'in' => 'query',
- 'schema' => [
- 'description' => '文件类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'heap_dump',
- ],
+ 'schema' => ['description' => '共享访问文件token', 'type' => 'string', 'required' => false, 'example' => '6e54e9d5-3147-458e-a85d-bae8722de747'],
],
[
- 'name' => 'displayName',
+ 'name' => 'keepUnreachableObjects',
'in' => 'query',
- 'schema' => [
- 'description' => '显示名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'atp_stack.log',
- ],
+ 'schema' => ['description' => '是否保留不可达对象', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'D052C0F4-5884-5B01-A8CC-D63B9A549B6C',
- ],
- 'name' => [
- 'title' => '若创建接口为异步实现，则需返回明确的JobId。',
- 'description' => '文件名称',
- 'type' => 'string',
- 'example' => '1597871211794192-1682567255445-bbbbb',
- ],
+ 'requestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'B14EC7CC-5181-582F-8EB7-6DB142FB529F'],
+ 'fileName' => ['description' => '文件名称', 'type' => 'string', 'example' => '207076258906603549-1667270208299-heap_dump_11.195.186.232_1667269965442.bin'],
],
],
],
],
- '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\\": \\"B14EC7CC-5181-582F-8EB7-6DB142FB529F\\",\\n \\"fileName\\": \\"207076258906603549-1667270208299-heap_dump_11.195.186.232_1667269965442.bin\\"\\n}","type":"json"}]',
+ 'title' => '分析文件',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'grace:AnalyzeFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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' => '共享访问token', 'type' => 'string', 'required' => false, 'example' => '924cb178-32e6-453a-a553-83289f9f494c'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['description' => '文件信息', '$ref' => '#/components/schemas/FileInfo'],
+ ],
+ ],
+ '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' => '获取文件信息',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'grace:GetFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D052C0F4-5884-5B01-A8CC-D63B9A549B6C\\",\\n \\"name\\": \\"1597871211794192-1682567255445-bbbbb\\"\\n}","type":"json"}]',
- 'title' => '通过URL上传文件',
],
'UploadFileByOSS' => [
'summary' => '通过OSS上传文件到ATP平台。',
'path' => '/UploadFileByOSS',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -389,42 +189,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => 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',
- ],
+ 'schema' => ['description' => 'oss endpoint', 'type' => 'string', 'required' => true, 'example' => 'https://oss-cn-hangzhou.aliyuncs.com'],
],
[
'name' => 'bucketName',
'in' => 'query',
- 'schema' => [
- 'description' => 'ossbucket名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'mybucket',
- ],
+ 'schema' => ['description' => 'ossbucket名字', 'type' => 'string', 'required' => true, 'example' => 'mybucket'],
],
[
'name' => 'objectName',
'in' => 'query',
- 'schema' => [
- 'description' => '对象名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'heap.bin',
- ],
+ 'schema' => ['description' => '对象名称', 'type' => 'string', 'required' => true, 'example' => 'heap.bin'],
],
[
'name' => 'type',
@@ -433,23 +213,14 @@
'description' => '文件类型',
'type' => 'string',
'required' => true,
- 'enumValueTitles' => [
- 'gc_log' => 'gc_log',
- 'thread_dump' => 'thread_dump',
- 'heap_dump' => 'heap_dump',
- ],
+ 'enumValueTitles' => ['gc_log' => 'gc_log', 'thread_dump' => 'thread_dump', 'heap_dump' => 'heap_dump'],
'example' => 'thread_dump',
],
],
[
'name' => 'displayName',
'in' => 'query',
- 'schema' => [
- 'description' => '显示名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'heap.bin',
- ],
+ 'schema' => ['description' => '显示名称', 'type' => 'string', 'required' => false, 'example' => 'heap.bin'],
],
],
'responses' => [
@@ -459,158 +230,346 @@
'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' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E7D6CC4E-C216-5313-A9A5-B5DA619ED431',
- ],
+ 'name' => ['title' => 'Id of the request', 'description' => '文件名称', 'type' => 'string', 'example' => '1597871211794192-1665457027646-grace-storage1-heap.bin'],
+ 'requestId' => ['description' => '请求ID。', '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"}]',
'title' => '通过OSS上传文件',
- ],
- 'AnalyzeFile' => [
- 'summary' => '分析文件。',
- 'path' => '/AnalyzeFile',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFileByOSS'],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'grace:UploadFileByOSS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UploadFileByURL' => [
+ 'summary' => '通过URL上传文件',
+ 'path' => '/UploadFileByURL',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'consumes' => [],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => false,
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false],
'parameters' => [
[
- 'name' => 'name',
+ 'name' => 'url',
'in' => 'query',
- 'schema' => [
- 'description' => '文件名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123-456-file.log',
- ],
+ 'schema' => ['description' => '文件下载链接url', 'type' => 'string', 'required' => true, 'example' => 'https://bucket.oss-cn-hangzhou.aliyuncs.com/file.log'],
],
[
- 'name' => 'token',
+ 'name' => 'type',
'in' => 'query',
- 'schema' => [
- 'description' => '共享访问文件token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6e54e9d5-3147-458e-a85d-bae8722de747',
- ],
+ 'schema' => ['description' => '文件类型', 'type' => 'string', 'required' => true, 'example' => 'heap_dump'],
],
[
- 'name' => 'keepUnreachableObjects',
+ 'name' => 'displayName',
'in' => 'query',
- 'schema' => [
- 'description' => '是否保留不可达对象',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ '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' => [
- 'description' => '请求id',
- 'type' => 'string',
- 'example' => 'B14EC7CC-5181-582F-8EB7-6DB142FB529F',
- ],
- 'fileName' => [
- 'description' => '文件名称',
- 'type' => 'string',
- 'example' => '207076258906603549-1667270208299-heap_dump_11.195.186.232_1667269965442.bin',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求id', 'type' => 'string', 'example' => 'D052C0F4-5884-5B01-A8CC-D63B9A549B6C'],
+ 'name' => ['title' => '若创建接口为异步实现，则需返回明确的JobId。', 'description' => '文件名称', 'type' => 'string', 'example' => '1597871211794192-1682567255445-bbbbb'],
],
],
],
],
- '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' => '分析文件',
- ],
- 'GetFile' => [
- 'summary' => '获取文件信息。',
- 'path' => '/GetFile',
- 'methods' => [
- 'get',
+ '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' => ''],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"D052C0F4-5884-5B01-A8CC-D63B9A549B6C\\",\\n \\"name\\": \\"1597871211794192-1682567255445-bbbbb\\"\\n}","type":"json"}]',
+ 'title' => '通过URL上传文件',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UploadFileByURL'],
+ ],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'grace:UploadFileByURL',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ ],
+ ],
+ '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' => '创新应用产品',
+ 'ramCodes' => ['grace'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'TransferFile',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'grace:TransferFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFile',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'grace:DeleteFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CheckOssSLR',
+ 'description' => '',
'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => false,
+ 'ramAction' => [
+ 'action' => 'grace:CheckOssSLR',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'parameters' => [
- [
- 'name' => 'name',
- 'in' => 'query',
- 'schema' => [
- 'title' => '实例 ID。',
- 'description' => '文件名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1597871211794192-1682563156700-402185-1682563123810-bbbbb',
+ [
+ 'apiName' => 'CleanFile',
+ 'description' => '',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'grace:CleanFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'token',
- 'in' => 'query',
- 'schema' => [
- 'description' => '共享访问token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '924cb178-32e6-453a-a553-83289f9f494c',
+ ],
+ [
+ 'apiName' => 'UploadOwnerFileByURL',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'grace:UploadOwnerFileByURL',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '文件信息',
- '$ref' => '#/components/schemas/FileInfo',
+ [
+ 'apiName' => 'UpdateFile',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'grace:UpdateFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadFileByURL',
+ 'description' => '通过URL上传文件',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'grace:UploadFileByURL',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateOssSLR',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'grace:CreateOssSLR',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadOwnerFileByOSS',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'grace:UploadOwnerFileByOSS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadFileByOSS',
+ 'description' => '通过OSS上传文件',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'grace:UploadFileByOSS',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateFileShare',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'grace:UpdateFileShare',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadFileToOss',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'grace:UploadFileToOss',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFiles',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'grace:ListFiles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchFileAnalysis',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'grace:FetchFileAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFile',
+ 'description' => '获取文件信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'grace:GetFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AnalyzeFile',
+ 'description' => '分析文件',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'grace:AnalyzeFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateFileType',
+ 'description' => '',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'grace:UpdateFileType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Grace', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- '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"}]',
- 'title' => '获取文件信息',
],
+ 'resourceTypes' => [],
],
- 'endpoints' => [],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 23:25:20 +0000