summaryrefslogtreecommitdiff
path: root/data/en_us/xtrace
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/xtrace
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/en_us/xtrace')
-rw-r--r--data/en_us/xtrace/2019-08-08/api-docs.php1719
1 files changed, 774 insertions, 945 deletions
diff --git a/data/en_us/xtrace/2019-08-08/api-docs.php b/data/en_us/xtrace/2019-08-08/api-docs.php
index d1b0754..36d3859 100644
--- a/data/en_us/xtrace/2019-08-08/api-docs.php
+++ b/data/en_us/xtrace/2019-08-08/api-docs.php
@@ -1,42 +1,94 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'xtrace',
- 'version' => '2019-08-08',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'xtrace', 'version' => '2019-08-08'],
'directories' => [
'GetTagKey',
'GetTagVal',
'GetTrace',
- 'ListIpOrHosts',
- 'ListServices',
'ListSpanNames',
- 'QueryMetric',
'SearchTraces',
[
- 'id' => 188134,
+ 'children' => ['OpenXtraceService', 'CheckCommercialStatus'],
+ 'type' => 'directory',
'title' => 'Service Activation',
+ ],
+ [
+ 'children' => ['ListIpOrHosts', 'ListServices', 'QueryMetric'],
+ 'title' => 'Others',
'type' => 'directory',
- 'children' => [
- 'OpenXtraceService',
- 'CheckCommercialStatus',
- ],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'GetTagKey' => [
- 'methods' => [
- 'post',
- 'get',
+ 'CheckCommercialStatus' => [
+ 'summary' => 'Check the commercialization status.',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'none',
+ 'abilityTreeCode' => '201972',
+ 'abilityTreeNodes' => ['FEATURExtraceQU1HZ6', 'FEATURExtraceP9I50Y', 'FEATURExtraceWNT0B5'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
+ ],
+ [
+ 'name' => 'Service',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The service code.'."\n", 'type' => 'string', 'required' => true, 'example' => 'xtrace', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F*******'],
+ 'Data' => ['description' => 'Query result.', 'type' => 'string', 'example' => 'true', 'title' => ''],
+ ],
+ 'example' => '',
+ ],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F*******\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'Check the commercialization status',
+ 'changeSet' => [
+ ['createdAt' => '2024-06-25T06:06:44.000Z', 'description' => 'Request parameters changed'],
],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'xtrace:GetCommercialStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetTagKey' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -46,67 +98,45 @@
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '55548',
- 'abilityTreeNodes' => [
- 'FEATURExtraceZX0L4J',
- ],
+ 'abilityTreeNodes' => ['FEATURExtraceZX0L4J'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the region.',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ServiceName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the application.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'appTest',
- ],
+ 'schema' => ['description' => 'The service name, also known as the application name.', 'type' => 'string', 'required' => false, 'example' => 'appTest', 'title' => ''],
],
[
'name' => 'SpanName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the span.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createOrder',
- ],
+ 'schema' => ['description' => 'The span name, also known as the operation name.', 'type' => 'string', 'required' => false, 'example' => 'createOrder', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n"
- ."\n"
- .'> The value of this parameter is of the LONG type. Precision loss may occur during serialization or deserialization. The value must be less than or equal to 9007199254740991.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1575561600000',
- ],
+ 'schema' => ['description' => 'The start timestamp, in milliseconds (ms).'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'The data type of this parameter is Long. Precision may be lost during serialization and deserialization. Make sure that the value does not exceed 9007199254740991.'."\n"
+ ."\n"
+ .'></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1575561600000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n"
- ."\n"
- .'> The value of this parameter is of the LONG type. Precision loss may occur during serialization or deserialization. The value must be less than or equal to 9007199254740991.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1575622455686',
- ],
+ 'schema' => ['description' => 'The end timestamp, in milliseconds (ms).'."\n"
+ ."\n"
+ .'><notice>'."\n"
+ ."\n"
+ .'The data type of this parameter is Long. Precision may be lost during serialization and deserialization. Make sure that the value does not exceed 9007199254740991.'."\n"
+ ."\n"
+ .'></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1575622455686', 'title' => ''],
],
],
'responses' => [
@@ -114,47 +144,57 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.',
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******', 'title' => ''],
'TagKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagKey' => [
- 'description' => 'The tag keys.',
+ 'description' => 'A list of tag keys.',
'type' => 'array',
- 'items' => [
- 'description' => 'The tag keys.',
- 'type' => 'string',
- 'example' => '{"TagKey":["date","resultCount","aTid"]}',
- ],
+ 'items' => ['description' => 'A list of tag keys.', 'type' => 'string', 'example' => '{"TagKey":["date","resultCount","aTid"]}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"TagKeys\\": {\\n \\"TagKey\\": [\\n \\"{\\\\\\"TagKey\\\\\\":[\\\\\\"date\\\\\\",\\\\\\"resultCount\\\\\\",\\\\\\"aTid\\\\\\"]}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTagKeyResponse> \\n <TagKeys> \\n <TagKey>date</TagKey> \\n <TagKey>resultCount</TagKey> \\n <TagKey>aTid</TagKey> \\n </TagKeys> \\n <RequestId>7D6519C1-A92A-4F07-AC83-706D48204242</RequestId> \\n</GetTagKeyResponse>\\n","errorExample":""}]',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"TagKeys\\": {\\n \\"TagKey\\": [\\n \\"{\\\\\\"TagKey\\\\\\":[\\\\\\"date\\\\\\",\\\\\\"resultCount\\\\\\",\\\\\\"aTid\\\\\\"]}\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => 'GetTagKey',
- 'summary' => 'Queries tag keys.',
+ 'summary' => 'Retrieves tag keys',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetTagVal' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetTagVal' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -164,79 +204,42 @@
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '55549',
- 'abilityTreeNodes' => [
- 'FEATURExtraceZX0L4J',
- ],
+ 'abilityTreeNodes' => ['FEATURExtraceZX0L4J'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the region.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ServiceName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the application.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'appTest',
- ],
+ 'schema' => ['description' => 'The service name. This is also called the application name.', 'type' => 'string', 'required' => false, 'example' => 'appTest', 'title' => ''],
],
[
'name' => 'SpanName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the span.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'createOrder',
- ],
+ 'schema' => ['description' => 'The span name. This is also called the operation name.', 'type' => 'string', 'required' => false, 'example' => 'createOrder', 'title' => ''],
],
[
'name' => 'TagKey',
'in' => 'query',
- 'schema' => [
- 'description' => 'The tag key.'."\n"
- ."\n"
- .'You can call the [GetTagKey](~~2399667~~) operation to obtain a tag key.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'span.kind',
- ],
+ 'schema' => ['description' => 'The tag key.'."\n"
+ ."\n"
+ .'For more information, see [GetTagKey](~~2399667~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'span.kind', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n"
- ."\n"
- .'> This value is of the LONG type, and precision loss may occur during serialization or deserialization. Do not set this parameter to a value greater than 9007199254740991.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1575561600000',
- ],
+ 'schema' => ['description' => 'The start time. The time is accurate to the millisecond (ms).'."\n"
+ .'><notice>This field is a Long data type. Precision may be lost during serialization or deserialization. The value cannot be greater than 9007199254740991.></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1575561600000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n"
- ."\n"
- .'> This value is of the LONG type, and precision loss may occur during serialization or deserialization. Do not set this parameter to a value greater than 9007199254740991.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1575622455686',
- ],
+ 'schema' => ['description' => 'The end time. The time is accurate to the millisecond (ms).'."\n"
+ .'><notice>This field is a Long data type. Precision may be lost during serialization or deserialization. The value cannot be greater than 9007199254740991.></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1575622455686', 'title' => ''],
],
],
'responses' => [
@@ -244,11 +247,7 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.',
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******', 'title' => ''],
'TagValues' => [
'type' => 'object',
'itemNode' => true,
@@ -256,35 +255,50 @@
'TagValue' => [
'description' => 'The tag values.',
'type' => 'array',
- 'items' => [
- 'description' => 'The tag values.',
- 'type' => 'string',
- 'example' => '{"TagValue":["server"]}',
- ],
+ 'items' => ['description' => 'A list of tag values.', 'type' => 'string', 'example' => '{"TagValue":["server"]}', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"TagValues\\": {\\n \\"TagValue\\": [\\n \\"{\\\\\\"TagValue\\\\\\":[\\\\\\"server\\\\\\"]}\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTagValResponse> \\n <RequestId>D36507D4-FD30-430B-BEC4-738661CFB86C</RequestId> \\n <TagValues> \\n <TagValue>server</TagValue> \\n </TagValues> \\n</GetTagValResponse>","errorExample":""}]',
'title' => 'GetTagVal',
- 'summary' => 'Queries the tag values that correspond to a tag key.',
+ 'summary' => 'Retrieves the tag values for a specified tag key from reported traces.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'GetTrace' => [
- 'summary' => 'Queries the details of a trace.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"TagValues\\": {\\n \\"TagValue\\": [\\n \\"{\\\\\\"TagValue\\\\\\":[\\\\\\"server\\\\\\"]}\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetTrace' => [
+ 'summary' => 'You can invoke the GetTrace API to obtain trace details.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -297,68 +311,38 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '55551',
- 'abilityTreeNodes' => [
- 'FEATURExtraceDX6R5A',
- ],
+ 'abilityTreeNodes' => ['FEATURExtraceDX6R5A'],
],
'parameters' => [
[
'name' => 'TraceID',
'in' => 'query',
- 'schema' => [
- 'description' => 'The trace ID, which is the unique identifier of the trace.'."\n"
- ."\n"
- .'You can obtain the trace ID on the **Trace Explorer** page in the Managed Service for OpenTelemetry console or by calling the [SearchTraces](~~2399674~~~) operation.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1c6881aab84191a4',
- ],
+ 'schema' => ['description' => 'The trace ID, which is the unique identifier of the trace.'."\n"
+ ."\n"
+ .'You can obtain the trace ID on the **Trace Explorer** page in the Managed Service for OpenTelemetry console or by calling the [SearchTraces](~~2399674~~~) operation.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1c6881aab84191a4******', 'title' => ''],
],
[
'name' => 'AppType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the application. You can leave this parameter empty or set the value to `XTRACE`. We recommend that you leave it empty.'."\n"
- ."\n"
- .'* Empty value: queries traces reported from Managed Service for Prometheus and Application Real-Time Monitoring Service (ARMS).'."\n"
- .'* `XTRACE`: queries only traces reported from Managed Service for Prometheus.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XTRACE',
- ],
+ 'schema' => ['description' => 'The type of the application. You can leave this parameter empty or set the value to `XTRACE`. We recommend that you leave it empty.'."\n"
+ ."\n"
+ .'* Empty value: queries traces reported from Managed Service for Prometheus and Application Real-Time Monitoring Service (ARMS).'."\n"
+ .'* `XTRACE`: queries only traces reported from Managed Service for Prometheus.'."\n", 'type' => 'string', 'required' => false, 'example' => 'XTRACE', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the region.',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The page number.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries on each page. Maximum value: 100.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '5',
- ],
+ 'schema' => ['description' => 'The number of entries on each page. Maximum value: 100.'."\n", 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''],
],
],
'responses' => [
@@ -366,11 +350,7 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.',
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
- ],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******', 'title' => ''],
'Spans' => [
'type' => 'object',
'itemNode' => true,
@@ -382,66 +362,20 @@
'description' => 'The list of spans.'."\n",
'type' => 'object',
'properties' => [
- 'SpanId' => [
- 'description' => 'The span ID.'."\n",
- 'type' => 'string',
- 'example' => 'fec891bb8f8XXX',
- ],
- 'HaveStack' => [
- 'description' => 'Indicates whether the span has child spans. Valid values:'."\n"
- ."\n"
- .'* `true`'."\n"
- .'* `false`'."\n",
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'ServiceIp' => [
- 'description' => 'The IP address of the server on which the span resides.'."\n",
- 'type' => 'string',
- 'example' => '192.168.XXX.XXX',
- ],
- 'OperationName' => [
- 'description' => 'The name of the span.'."\n",
- 'type' => 'string',
- 'example' => '/api',
- ],
- 'ParentSpanId' => [
- 'description' => 'The ID of the parent span.'."\n",
- 'type' => 'string',
- 'example' => 'fec891bb8f8XXX',
- ],
- 'ResultCode' => [
- 'description' => 'The response code.'."\n",
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Duration' => [
- 'description' => 'The duration of the span. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'RpcId' => [
- 'description' => 'The parent-child and sibling relationship between spans. For example, span 1.1 is the parent of span 1.1.1, and span 1.1.2 and span 1.1.1 are siblings.'."\n",
- 'type' => 'string',
- 'example' => '1.1',
- ],
- 'Timestamp' => [
- 'description' => 'The timestamp when the span was generated. Unit: microseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1689845513298000',
- ],
- 'ServiceName' => [
- 'description' => 'The name of the application.'."\n",
- 'type' => 'string',
- 'example' => 'server1',
- ],
- 'TraceID' => [
- 'description' => 'The trace ID, which is the unique identifier of the trace.'."\n",
- 'type' => 'string',
- 'example' => '1c6881aab84191a4****',
- ],
+ 'SpanId' => ['description' => 'The span ID.'."\n", 'type' => 'string', 'example' => 'fec891bb8f8XXX', 'title' => ''],
+ 'HaveStack' => ['description' => 'Indicates whether the span has child spans. Valid values:'."\n"
+ ."\n"
+ .'* `true`'."\n"
+ .'* `false`'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''],
+ 'ServiceIp' => ['description' => 'The IP address of the server on which the span resides.'."\n", 'type' => 'string', 'example' => '192.168.XXX.XXX', 'title' => ''],
+ 'OperationName' => ['description' => 'The name of the span.'."\n", 'type' => 'string', 'example' => '/api', 'title' => ''],
+ 'ParentSpanId' => ['description' => 'The ID of the parent span.'."\n", 'type' => 'string', 'example' => 'fec891bb8f8XXX', 'title' => ''],
+ 'ResultCode' => ['description' => 'The response code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''],
+ 'Duration' => ['description' => 'The duration of the span. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
+ 'RpcId' => ['description' => 'The parent-child and sibling relationship between spans. For example, span 1.1 is the parent of span 1.1.1, and span 1.1.2 and span 1.1.1 are siblings.'."\n", 'type' => 'string', 'example' => '1.1', 'title' => ''],
+ 'Timestamp' => ['description' => 'The timestamp when the span was generated. Unit: microseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1689845513298000', 'title' => ''],
+ 'ServiceName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'server1', 'title' => ''],
+ 'TraceID' => ['description' => 'The trace ID, which is the unique identifier of the trace.'."\n", 'type' => 'string', 'example' => '1c6881aab84191a4', 'title' => ''],
'TagEntryList' => [
'type' => 'object',
'itemNode' => true,
@@ -453,20 +387,19 @@
'description' => 'The tags in the span.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the span.'."\n",
- 'type' => 'string',
- 'example' => 'logLevel',
- ],
- 'Value' => [
- 'description' => 'The tag value of the span.'."\n",
- 'type' => 'string',
- 'example' => 'Warning',
- ],
+ 'Key' => ['description' => 'The tag key of the span.'."\n", 'type' => 'string', 'example' => 'logLevel', 'title' => ''],
+ 'Value' => ['description' => 'The tag value of the span.'."\n", 'type' => 'string', 'example' => 'Warning', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
'LogEventList' => [
'type' => 'object',
@@ -479,12 +412,7 @@
'description' => 'The log events in the trace.'."\n",
'type' => 'object',
'properties' => [
- 'Timestamp' => [
- 'description' => 'The timestamp when the log event was generated. Unit: microseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1583683202047000',
- ],
+ 'Timestamp' => ['description' => 'The timestamp when the log event was generated. Unit: microseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1689845513298000', 'title' => ''],
'TagEntryList' => [
'type' => 'object',
'itemNode' => true,
@@ -496,55 +424,83 @@
'description' => 'The tags in the log event.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The tag key of the log event.'."\n",
- 'type' => 'string',
- 'example' => 'logLevel',
- ],
- 'Value' => [
- 'description' => 'The tag value of the log event.'."\n",
- 'type' => 'string',
- 'example' => 'Warning',
- ],
+ 'Key' => ['description' => 'The tag key of the log event.'."\n", 'type' => 'string', 'example' => 'logLevel', 'title' => ''],
+ 'Value' => ['description' => 'The tag value of the log event.'."\n", 'type' => 'string', 'example' => 'Warning', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
- 'StatusCode' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'StatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => 'The status code.', 'example' => '200', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"Spans\\": {\\n \\"Span\\": [\\n {\\n \\"SpanId\\": \\"fec891bb8f8XXX\\",\\n \\"HaveStack\\": false,\\n \\"ServiceIp\\": \\"192.168.XXX.XXX\\",\\n \\"OperationName\\": \\"/api\\",\\n \\"ParentSpanId\\": \\"fec891bb8f8XXX\\",\\n \\"ResultCode\\": \\"200\\",\\n \\"Duration\\": 1000,\\n \\"RpcId\\": \\"1.1\\",\\n \\"Timestamp\\": 1689845513298000,\\n \\"ServiceName\\": \\"server1\\",\\n \\"TraceID\\": \\"1c6881aab84191a4\\",\\n \\"TagEntryList\\": {\\n \\"TagEntry\\": [\\n {\\n \\"Key\\": \\"logLevel\\",\\n \\"Value\\": \\"Warning\\"\\n }\\n ]\\n },\\n \\"LogEventList\\": {\\n \\"LogEvent\\": [\\n {\\n \\"Timestamp\\": 1689845513298000,\\n \\"TagEntryList\\": {\\n \\"TagEntry\\": [\\n {\\n \\"Key\\": \\"logLevel\\",\\n \\"Value\\": \\"Warning\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"StatusCode\\": 200\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTraceResponse> \\n <RequestId>1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED</RequestId> \\n <Spans> \\n <Span> \\n <HaveStack>false</HaveStack> \\n <ParentSpanId>fec891bb8f8XXX</ParentSpanId> \\n <ServiceIp>192.168.XXX.XXX</ServiceIp> \\n <ServiceName>server1</ServiceName> \\n <OperationName>/api</OperationName> \\n <RpcId>1.1</RpcId> \\n <TraceID>1c6881aab84191a4</TraceID> \\n <Duration>1000</Duration> \\n <Timestamp>1583683202047000</Timestamp> \\n <ResultCode>200</ResultCode> \\n <SpanId>fec891bb8f8XXX</SpanId> \\n <TagEntryList> \\n <TagEntry> \\n <Value>Warning</Value> \\n <Key>logLevel</Key> \\n </TagEntry> \\n </TagEntryList> \\n <LogEventList> \\n <LogEvent> \\n <Timestamp>1583683202047000</Timestamp> \\n <TagEntryList> \\n <TagEntry> \\n <Value>Warning</Value> \\n <Key>logLevel</Key> \\n </TagEntry> \\n </TagEntryList> \\n </LogEvent> \\n </LogEventList> \\n </Span> \\n </Spans> \\n</GetTraceResponse>","errorExample":""}]',
- 'title' => 'GetTrace',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"Spans\\": {\\n \\"Span\\": [\\n {\\n \\"SpanId\\": \\"fec891bb8f8XXX\\",\\n \\"HaveStack\\": false,\\n \\"ServiceIp\\": \\"192.168.XXX.XXX\\",\\n \\"OperationName\\": \\"/api\\",\\n \\"ParentSpanId\\": \\"fec891bb8f8XXX\\",\\n \\"ResultCode\\": \\"200\\",\\n \\"Duration\\": 1000,\\n \\"RpcId\\": \\"1.1\\",\\n \\"Timestamp\\": 1689845513298000,\\n \\"ServiceName\\": \\"server1\\",\\n \\"TraceID\\": \\"1c6881aab84191a4\\",\\n \\"TagEntryList\\": {\\n \\"TagEntry\\": [\\n {\\n \\"Key\\": \\"logLevel\\",\\n \\"Value\\": \\"Warning\\"\\n }\\n ]\\n },\\n \\"LogEventList\\": {\\n \\"LogEvent\\": [\\n {\\n \\"Timestamp\\": 1689845513298000,\\n \\"TagEntryList\\": {\\n \\"TagEntry\\": [\\n {\\n \\"Key\\": \\"logLevel\\",\\n \\"Value\\": \\"Warning\\"\\n }\\n ]\\n }\\n }\\n ]\\n },\\n \\"StatusCode\\": 200\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => 'Obtain Trace Details',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListIpOrHosts' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-27T08:43:46.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
+ ['createdAt' => '2021-08-20T06:40:07.000Z', 'description' => 'Error codes changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrace'],
+ ],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListIpOrHosts' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -554,53 +510,28 @@
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '55553',
- 'abilityTreeNodes' => [
- 'FEATURExtraceOGOOWE',
- ],
+ 'abilityTreeNodes' => ['FEATURExtraceOGOOWE'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ServiceName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the service. If you do not specify this parameter, the IP addresses of all applications in the specified region are returned.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'service1',
- ],
+ 'schema' => ['description' => 'The name of the service. If you do not specify this parameter, the IP addresses of all applications in the specified region are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'service1', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1583683200000',
- ],
+ 'schema' => ['description' => 'The beginning of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1583683200000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1583723776974',
- ],
+ 'schema' => ['description' => 'The end of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1583723776974', 'title' => ''],
],
],
'responses' => [
@@ -608,11 +539,7 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1FC4****',
- ],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1******', 'title' => ''],
'IpNames' => [
'type' => 'object',
'itemNode' => true,
@@ -620,16 +547,19 @@
'IpName' => [
'description' => 'The IP addresses.'."\n",
'type' => 'array',
- 'items' => [
- 'description' => 'The IP addresses.'."\n",
- 'type' => 'string',
- 'example' => '[ "172.19.XXX.XXX", "10.0.X.X" ]',
- ],
+ 'items' => ['description' => 'The IP addresses.'."\n", 'type' => 'string', 'example' => '[ "172.19.XXX.XXX", "10.0.X.X" ]', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -639,16 +569,27 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListServices' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListServices' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -658,34 +599,21 @@
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '55554',
- 'abilityTreeNodes' => [
- 'FEATURExtraceF2LCA8',
- ],
+ 'abilityTreeNodes' => ['FEATURExtraceF2LCA8'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the region.',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'AppType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the application. You can leave this parameter empty or set this parameter to `XTRACE`. We recommend that you leave this parameter empty.'."\n"
- ."\n"
- .'* If you leave this parameter empty, applications monitored by Managed Service for OpenTelemetry or Application Real-Time Monitoring Service (ARMS) can be queried.'."\n"
- .'* If you set this parameter to `XTRACE`, only applications monitored by Managed Service for OpenTelemetry can be queried.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XTRACE',
- ],
+ 'schema' => ['description' => 'The type of the application. You can leave this parameter empty or set this parameter to `XTRACE`. We recommend that you leave this parameter empty.'."\n"
+ ."\n"
+ .'* If you leave this parameter empty, applications monitored by Managed Service for OpenTelemetry or Application Real-Time Monitoring Service (ARMS) can be queried.'."\n"
+ .'* If you set this parameter to `XTRACE`, only applications monitored by Managed Service for OpenTelemetry can be queried.'."\n", 'type' => 'string', 'required' => false, 'example' => 'XTRACE', 'title' => ''],
],
],
'responses' => [
@@ -693,11 +621,7 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the region.',
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED',
- ],
+ 'RequestId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******', 'title' => ''],
'Services' => [
'type' => 'object',
'itemNode' => true,
@@ -709,27 +633,25 @@
'description' => 'The applications.',
'type' => 'object',
'properties' => [
- 'ServiceName' => [
- 'description' => 'The name of the application.',
- 'type' => 'string',
- 'example' => 'a3',
- ],
- 'Pid' => [
- 'description' => 'The ID of the application.',
- 'type' => 'string',
- 'example' => 'XXXqn3ly@741623b4e915df8',
- ],
- 'RegionId' => [
- 'description' => 'The ID of the region.',
- 'type' => 'string',
- 'example' => 'cn-beijing',
- ],
+ 'ServiceName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'a3', 'title' => ''],
+ 'Pid' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => 'XXXqn3ly@741623b4e915df8', 'title' => ''],
+ 'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -739,17 +661,28 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'ListSpanNames' => [
- 'summary' => 'Queries all span names in a specified region or all span names of a microservice.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListSpanNames' => [
+ 'summary' => 'Retrieves all span names in a specified region. You can also retrieve all span names of a specific microservice.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -761,53 +694,28 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '55555',
- 'abilityTreeNodes' => [
- 'FEATURExtraceZX0L4J',
- ],
+ 'abilityTreeNodes' => ['FEATURExtraceZX0L4J'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the region.',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ServiceName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the application.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'service 1',
- ],
+ 'schema' => ['description' => 'The service name, also known as the application name.', 'type' => 'string', 'required' => false, 'example' => 'service 1', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1575561600000',
- ],
+ 'schema' => ['description' => 'The timestamp of the start time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1714298814000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1575622455686',
- ],
+ 'schema' => ['description' => 'The timestamp of the end time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1714385214000', 'title' => ''],
],
],
'responses' => [
@@ -815,70 +723,140 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.'."\n",
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
- ],
+ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******', 'title' => ''],
'SpanNames' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SpanName' => [
- 'description' => 'The span names.'."\n",
+ 'description' => 'The list of span names.',
'type' => 'array',
- 'items' => [
- 'description' => 'The span names.'."\n",
- 'type' => 'string',
- 'example' => '{"SpanName":["rpc0","rpc1.1","rpc1.1.1"]}',
- ],
+ 'items' => ['description' => 'The list of span names.', 'type' => 'string', 'example' => '{'."\n"
+ .' "SpanName": ['."\n"
+ .' "GET /**",'."\n"
+ .' "path_selection",'."\n"
+ .' "POST"'."\n"
+ .' ]'."\n"
+ .' }', 'title' => ''],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'ParameterRegionIdMissing',
- 'errorMessage' => '区域参数缺失',
- ],
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => '内部错误,建议重试,如果多次重试报错请联系钉钉服务账号',
- ],
+ ['errorCode' => 'ParameterRegionIdMissing', 'errorMessage' => '区域参数缺失', 'description' => ''],
+ ['errorCode' => 'InternalError', 'errorMessage' => '内部错误,建议重试,如果多次重试报错请联系钉钉服务账号', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'APINotAuthorize',
- 'errorMessage' => '当前用户无权限访问该接口',
- ],
+ ['errorCode' => 'APINotAuthorize', 'errorMessage' => '当前用户无权限访问该接口', 'description' => ''],
],
[
- [
- 'errorCode' => 'ServiceNameNotExist',
- 'errorMessage' => 'ServiceName不存在',
- ],
+ ['errorCode' => 'ServiceNameNotExist', 'errorMessage' => 'ServiceName不存在', 'description' => ''],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"SpanNames\\": {\\n \\"SpanName\\": [\\n \\"{\\\\n \\\\\\"SpanName\\\\\\": [\\\\n \\\\\\"GET /**\\\\\\",\\\\n \\\\\\"path_selection\\\\\\",\\\\n \\\\\\"POST\\\\\\"\\\\n ]\\\\n }\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSpanNamesResponse> \\n <SpanNames> \\n <SpanName>rpc0</SpanName> \\n <SpanName>rpc1.1</SpanName> \\n <SpanName>rpc1.1.1</SpanName> \\n </SpanNames> \\n <RequestId>79C84C64-9951-477E-96F3-7FA44128C601</RequestId> \\n</ListSpanNamesResponse>","errorExample":""}]',
- 'title' => 'ListSpanNames',
+ 'title' => 'Retrieve all span names',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-09-04T09:29:42.000Z', 'description' => 'Error codes changed'],
+ ['createdAt' => '2023-08-14T09:45:53.000Z', 'description' => 'Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"SpanNames\\": {\\n \\"SpanName\\": [\\n \\"{\\\\n \\\\\\"SpanName\\\\\\": [\\\\n \\\\\\"GET /**\\\\\\",\\\\n \\\\\\"path_selection\\\\\\",\\\\n \\\\\\"POST\\\\\\"\\\\n ]\\\\n }\\"\\n ]\\n }\\n}","type":"json"}]',
],
- 'QueryMetric' => [
- 'methods' => [
- 'post',
- 'get',
+ 'OpenXtraceService' => [
+ 'summary' => 'Activates Managed Service for OpenTelemetry.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '55556',
+ 'abilityTreeNodes' => ['FEATURExtraceQU1HZ6', 'FEATURExtraceP9I50Y', 'FEATURExtraceWNT0B5'],
],
+ 'parameters' => [
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => ['description' => 'The returned result.'."\n", 'type' => 'string', 'example' => 'True', 'title' => ''],
+ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1FC4****', 'title' => ''],
+ 'OrderId' => ['description' => 'The order ID.'."\n", 'type' => 'string', 'example' => '155709986', 'title' => ''],
+ ],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"True\\",\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1FC4****\\",\\n \\"OrderId\\": \\"155709986\\"\\n}","type":"json"}]',
+ 'title' => 'OpenXtraceService',
+ 'changeSet' => [
+ ['createdAt' => '2023-11-27T08:50:57.000Z', 'description' => 'Response parameters changed'],
+ ['createdAt' => '2023-10-25T03:45:56.000Z', 'description' => 'Request parameters changed, Error codes changed'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'xtrace:GetToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'QueryMetric' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -889,110 +867,60 @@
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '55557',
- 'abilityTreeNodes' => [
- 'FEATURExtraceOGOOWE',
- ],
+ 'abilityTreeNodes' => ['FEATURExtraceOGOOWE'],
],
'parameters' => [
[
'name' => 'IntervalInSec',
'in' => 'query',
- 'schema' => [
- 'description' => 'The time interval at which you want to query metric data. Unit: milliseconds. Minimum value: 60000. '."\n"
- ."\n"
- .'> If you set this parameter to 2147483647, all data in the specified time interval is returned.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '100000',
- ],
+ 'schema' => ['description' => 'The time interval at which you want to query metric data. Unit: milliseconds. Minimum value: 60000. '."\n"
+ ."\n"
+ .'> If you set this parameter to 2147483647, all data in the specified time interval is returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '100000', 'title' => ''],
],
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n"
- ."\n"
- .'> The value of this parameter is of the LONG type. Precision loss may occur during serialization or deserialization. The value must be less than or equal to 9007199254740991.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1575561600000',
- ],
+ 'schema' => ['description' => 'The beginning of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n"
+ ."\n"
+ .'> The value of this parameter is of the LONG type. Precision loss may occur during serialization or deserialization. The value must be less than or equal to 9007199254740991.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1575561600000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n"
- ."\n"
- .'> The value of this parameter is of the LONG type. Precision loss may occur during serialization or deserialization. The value must be less than or equal to 9007199254740991.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1575622455686',
- ],
+ 'schema' => ['description' => 'The end of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n"
+ ."\n"
+ .'> The value of this parameter is of the LONG type. Precision loss may occur during serialization or deserialization. The value must be less than or equal to 9007199254740991.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1575622455686', 'title' => ''],
],
[
'name' => 'OrderBy',
'in' => 'query',
- 'schema' => [
- 'description' => 'The field based on which you want to sort the returned entries.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'count',
- ],
+ 'schema' => ['description' => 'The field based on which you want to sort the returned entries.', 'type' => 'string', 'required' => false, 'example' => 'count', 'title' => ''],
],
[
'name' => 'Limit',
'in' => 'query',
- 'schema' => [
- 'description' => 'The maximum number of entries that you want to return.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => 'The maximum number of entries that you want to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
],
[
'name' => 'Metric',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the metric. Valid values:'."\n"
- ."\n"
- .'- `appstat.incall`: trace statistics '."\n"
- .'- `appstat.sql`: SQL statistics',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'appstat.incall',
- ],
+ 'schema' => ['description' => 'The name of the metric. Valid values:'."\n"
+ ."\n"
+ .'- `appstat.incall`: trace statistics '."\n"
+ .'- `appstat.sql`: SQL statistics', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'appstat.incall', 'title' => ''],
],
[
'name' => 'Order',
'in' => 'query',
- 'schema' => [
- 'description' => 'The order in which you want to sort the returned entries. Valid values:'."\n"
- ."\n"
- .'- ASC: ascending order '."\n"
- .'- DESC: descending order',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ASC',
- ],
+ 'schema' => ['description' => 'The order in which you want to sort the returned entries. Valid values:'."\n"
+ ."\n"
+ .'- ASC: ascending order '."\n"
+ .'- DESC: descending order', 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''],
],
[
'name' => 'ProxyUserId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the proxy user.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'testefgag12',
- ],
+ 'schema' => ['description' => 'The ID of the proxy user.', 'type' => 'string', 'required' => false, 'example' => 'testefgag12', 'title' => ''],
],
[
'name' => 'Filters',
@@ -1009,19 +937,20 @@
'description' => 'The key of the field that you want to use to filter the returned entries.',
'type' => 'string',
'required' => false,
- 'example' => 'http.status_code',
- ],
- 'Value' => [
- 'description' => 'The value of the field that you want to use to filter the returned entries.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '200',
+ 'example' => 'service',
+ 'enumValueTitles' => [],
+ 'title' => '',
],
+ 'Value' => ['description' => 'The value of the field that you want to use to filter the returned entries.', 'type' => 'string', 'required' => false, 'example' => 'service-test', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 5,
+ 'title' => '',
+ 'example' => '',
],
],
[
@@ -1031,15 +960,11 @@
'schema' => [
'description' => 'The dimensions of the metric that you want to query.',
'type' => 'array',
- 'items' => [
- 'description' => 'The dimensions of the metric that you want to query.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pid',
- ],
+ 'items' => ['description' => 'The dimensions of the metric that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pid', 'title' => ''],
'required' => false,
'example' => 'RT',
'maxItems' => 5,
+ 'title' => '',
],
],
[
@@ -1049,29 +974,25 @@
'schema' => [
'description' => 'The measures of the metric that you want to query.'."\n",
'type' => 'array',
- 'items' => [
- 'description' => 'If you set the **Metric** parameter to `appstat.incall`, the **Measures** parameter has the following valid values:'."\n"
- ."\n"
- .'- `rt`: response time '."\n"
- .'- `count`: total number of records that you want to return '."\n"
- .'- `error`: number of errors '."\n"
- .'- `exception`: exception '."\n"
- .'- `errorrate`: error rate '."\n"
- .'- `qps`: number of requests per second '."\n"
- ."\n"
- .'If you set the **Metric** parameter to` appstat.sql`, the **Measures** parameter has the following valid values:'."\n"
- ."\n"
- .'- `rt`: response time '."\n"
- .'- `count`: total number of records that you want to return '."\n"
- .'- `error`: number of errors '."\n"
- .'- `slowcount`: number of slow calls',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'rt',
- ],
+ 'items' => ['description' => 'If you set the **Metric** parameter to `appstat.incall`, the **Measures** parameter has the following valid values:'."\n"
+ ."\n"
+ .'- `rt`: response time '."\n"
+ .'- `count`: total number of records that you want to return '."\n"
+ .'- `error`: number of errors '."\n"
+ .'- `exception`: exception '."\n"
+ .'- `errorrate`: error rate '."\n"
+ .'- `qps`: number of requests per second '."\n"
+ ."\n"
+ .'If you set the **Metric** parameter to` appstat.sql`, the **Measures** parameter has the following valid values:'."\n"
+ ."\n"
+ .'- `rt`: response time '."\n"
+ .'- `count`: total number of records that you want to return '."\n"
+ .'- `error`: number of errors '."\n"
+ .'- `slowcount`: number of slow calls', 'type' => 'string', 'required' => false, 'example' => 'rt', 'title' => ''],
'required' => true,
'example' => 'count',
'maxItems' => 5,
+ 'title' => '',
],
],
],
@@ -1080,17 +1001,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => 'The returned statistics.',
- 'type' => 'string',
- 'example' => '{ "RequestId": "E2373982-D8CD-413D-B991-8EB678******", "Data": "{\\"data\\":[{\\"date\\":1583686800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"}}',
- ],
- 'RequestId' => [
- 'description' => 'The ID of the request.',
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
- ],
+ 'Data' => ['description' => 'The returned statistics.', 'type' => 'string', 'example' => '{ "Data": "{\\"data\\":[{\\"date\\":1583686800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"}]}}', 'title' => ''],
+ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******', 'title' => ''],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
@@ -1100,17 +1016,28 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'SearchTraces' => [
- 'summary' => 'Queries traces by time, application name, IP address, span name, and tag.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'SearchTraces' => [
+ 'summary' => 'Call the SearchTraces operation to query a list of traces. You can filter traces by time, application name, IP address, span name, tag, and other criteria.',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1122,169 +1049,100 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '55558',
- 'abilityTreeNodes' => [
- 'FEATURExtraceZX0L4J',
- ],
+ 'abilityTreeNodes' => ['FEATURExtraceZX0L4J'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The beginning of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1575561600000',
- ],
+ 'schema' => ['description' => 'Start time, in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1714298814000', 'title' => ''],
],
[
'name' => 'EndTime',
'in' => 'query',
- 'schema' => [
- 'description' => 'The end of the time range to query. The value is a timestamp that is accurate to milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1575622455686',
- ],
+ 'schema' => ['description' => 'End time, in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1714385214000', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
- 'schema' => [
- 'description' => 'The ID of the region.',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'cn-beijing',
- ],
+ 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ServiceName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the application.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'service 1',
- ],
+ 'schema' => ['description' => 'Microservice name, also known as application name.', 'type' => 'string', 'required' => false, 'example' => 'service 1', 'title' => ''],
],
[
'name' => 'OperationName',
'in' => 'query',
- 'schema' => [
- 'description' => 'The name of the span.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '/api',
- ],
+ 'schema' => ['description' => 'Span name, which is the name of a trace point or instrumentation point.', 'type' => 'string', 'required' => false, 'example' => '/api', 'title' => ''],
],
[
'name' => 'MinDuration',
'in' => 'query',
- 'schema' => [
- 'description' => 'The minimum value of an execution duration. Unit: seconds. For example, a value of 2 indicates that the traces whose execution duration is more than 2 seconds are queried.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1000',
- ],
+ 'schema' => ['description' => 'Minimum duration threshold in milliseconds (ms). For example, 200 returns traces longer than 200 ms.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'AppType',
'in' => 'query',
- 'schema' => [
- 'description' => 'The type of the application. You can set the value to **XTRACE** or leave this parameter unspecified.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XTRACE',
- ],
+ 'schema' => ['description' => 'Application type. Valid values are empty or `XTRACE`. We recommend leaving this parameter empty.'."\n"
+ ."\n"
+ .'- Empty: Query traces from both XTRACE and ARMS.'."\n"
+ ."\n"
+ .'- `XTRACE`: Query only XTRACE traces.', 'type' => 'string', 'required' => false, 'example' => 'XTRACE', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of the page to return. For example, a value of 5 indicates page 5.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'Page number. For example, 5 indicates page 5.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
+ 'schema' => ['description' => 'Number of trace records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''],
],
[
'name' => 'Reverse',
'in' => 'query',
- 'schema' => [
- 'description' => 'Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: false. Valid values:'."\n"
- ."\n"
- .'- true: reverse chronological order '."\n"
- .'- false: chronological order',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'Sort order by time. Default value: `false`. Valid values:'."\n"
+ ."\n"
+ .'- `true`: Descending order.'."\n"
+ ."\n"
+ .'- `false`: Ascending order.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ServiceIp',
'in' => 'query',
- 'schema' => [
- 'description' => 'The IP address of the server on which the span is running.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '10.0.0.0',
- ],
+ 'schema' => ['description' => 'IP address of the host where the span resides.', 'type' => 'string', 'required' => false, 'example' => '192.163.XXX.XXX', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
- 'description' => 'The list of the tags.',
+ 'description' => 'List of tags.',
'type' => 'array',
'items' => [
- 'description' => 'Tag.',
+ 'description' => 'List of tags.',
'type' => 'object',
'properties' => [
- 'Key' => [
- 'description' => 'The key of the tag.',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http.status_cod',
- ],
- 'Value' => [
- 'description' => 'The value of the tag.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '200',
- ],
+ 'Key' => ['description' => 'Tag key.', 'type' => 'string', 'required' => false, 'example' => 'http.status_cod', 'title' => ''],
+ 'Value' => ['description' => 'Tag value.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''],
],
'required' => false,
+ 'title' => '',
+ 'example' => '',
],
'required' => false,
'maxItems' => 5,
+ 'title' => '',
+ 'example' => '',
],
],
[
'name' => 'StatusCode',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''],
],
],
'responses' => [
@@ -1293,326 +1151,297 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => 'The ID of the request.',
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
- ],
+ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******', 'title' => ''],
'PageBean' => [
- 'description' => 'The location of the returned data.'."\n",
+ 'description' => 'Pagination information for the returned data.',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'description' => 'The number of entries per page.'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageNumber' => [
- 'description' => 'The page number of the returned page.',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalCount' => [
- 'description' => 'The total number of entries returned.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
+ 'PageSize' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
+ 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
+ 'TotalCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''],
'TraceInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TraceInfo' => [
- 'description' => 'The trace information.'."\n",
+ 'description' => 'Returned trace information.',
'type' => 'array',
'items' => [
- 'description' => 'The trace information.'."\n",
+ 'description' => 'Returned trace information.',
'type' => 'object',
'properties' => [
- 'OperationName' => [
- 'description' => 'The span name.'."\n",
- 'type' => 'string',
- 'example' => '/api',
- ],
- 'ServiceIp' => [
- 'description' => 'The IP address or name of the server on which the span is running.'."\n",
- 'type' => 'string',
- 'example' => '192.163.XXX.XXX',
- ],
- 'Duration' => [
- 'description' => 'The duration. Unit: milliseconds.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'Timestamp' => [
- 'description' => 'The timestamp when the span was generated. Unit: millisecond.'."\n",
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1575561600000000',
- ],
- 'ServiceName' => [
- 'description' => 'The service name.'."\n",
- 'type' => 'string',
- 'example' => 'service1',
- ],
- 'TraceID' => [
- 'description' => 'The trace ID.'."\n",
- 'type' => 'string',
- 'example' => '1c6881aab84191a4',
- ],
- 'TagMap' => [
- 'description' => 'The tag information.'."\n",
- 'type' => 'object',
- 'example' => '{"env":"dev"}',
- ],
- 'StatusCode' => [
- 'type' => 'integer',
- 'format' => 'int64',
- ],
+ 'OperationName' => ['description' => 'Span name.', 'type' => 'string', 'example' => '/api', 'title' => ''],
+ 'ServiceIp' => ['description' => 'IP address or hostname of the host where the span resides.', 'type' => 'string', 'example' => '192.163.XXX.XXX', 'title' => ''],
+ 'Duration' => ['description' => 'Duration, in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '500', 'title' => ''],
+ 'Timestamp' => ['description' => 'Time when the span was generated, in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '1714306014000', 'title' => ''],
+ 'ServiceName' => ['description' => 'Microservice name, also known as application name.', 'type' => 'string', 'example' => 'service1', 'title' => ''],
+ 'TraceID' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => '1c6881aab841******', 'title' => ''],
+ 'TagMap' => ['description' => 'Tag information.', 'type' => 'object', 'example' => '{"env":"dev"}', 'title' => ''],
+ 'StatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''],
],
+ 'title' => '',
+ 'example' => '',
],
+ 'title' => '',
+ 'example' => '',
],
],
+ 'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
+ 'title' => '',
+ 'example' => '',
],
],
'description' => '',
+ 'title' => '',
+ 'example' => '',
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"PageBean\\": {\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 500,\\n \\"TraceInfos\\": {\\n \\"TraceInfo\\": [\\n {\\n \\"OperationName\\": \\"/api\\",\\n \\"ServiceIp\\": \\"192.163.XXX.XXX\\",\\n \\"Duration\\": 500,\\n \\"Timestamp\\": 1714306014000,\\n \\"ServiceName\\": \\"service1\\",\\n \\"TraceID\\": \\"1c6881aab841******\\",\\n \\"TagMap\\": {\\n \\"env\\": \\"dev\\"\\n },\\n \\"StatusCode\\": 0\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchTracesResponse>\\n <RequestId>1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED</RequestId>\\n <PageBean>\\n <PageSize>100</PageSize>\\n <PageNumber>1</PageNumber>\\n <TotalCount>1000</TotalCount>\\n <TraceInfos>\\n <OperationName>/api</OperationName>\\n <ServiceIp>192.163.XXX.XXX</ServiceIp>\\n <Duration>100</Duration>\\n <Timestamp>1575561600000000</Timestamp>\\n <ServiceName>service1</ServiceName>\\n <TraceID>1c6881aab84191a4</TraceID>\\n </TraceInfos>\\n </PageBean>\\n</SearchTracesResponse>","errorExample":""}]',
'title' => 'SearchTraces',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'OpenXtraceService' => [
- 'summary' => 'Activates Managed Service for OpenTelemetry.',
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-27T08:43:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'security' => [
- [
- 'AK' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '55556',
- 'abilityTreeNodes' => [
- 'FEATURExtraceQU1HZ6',
- 'FEATURExtraceP9I50Y',
- 'FEATURExtraceWNT0B5',
- ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"PageBean\\": {\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 500,\\n \\"TraceInfos\\": {\\n \\"TraceInfo\\": [\\n {\\n \\"OperationName\\": \\"/api\\",\\n \\"ServiceIp\\": \\"192.163.XXX.XXX\\",\\n \\"Duration\\": 500,\\n \\"Timestamp\\": 1714306014000,\\n \\"ServiceName\\": \\"service1\\",\\n \\"TraceID\\": \\"1c6881aab841******\\",\\n \\"TagMap\\": {\\n \\"env\\": \\"dev\\"\\n },\\n \\"StatusCode\\": 0\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.ap-northeast-1.aliyuncs.com', 'endpoint' => 'xtrace.ap-northeast-1.aliyuncs.com', 'vpc' => 'xtrace-vpc.ap-northeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.ap-southeast-1.aliyuncs.com', 'endpoint' => 'xtrace.ap-southeast-1.aliyuncs.com', 'vpc' => 'xtrace-vpc.ap-southeast-1.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.ap-southeast-3.aliyuncs.com', 'endpoint' => 'xtrace.ap-southeast-3.aliyuncs.com', 'vpc' => 'xtrace-vpc.ap-southeast-3.aliyuncs.com'],
+ ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.ap-southeast-5.aliyuncs.com', 'endpoint' => 'xtrace.ap-southeast-5.aliyuncs.com', 'vpc' => 'xtrace-vpc.ap-southeast-5.aliyuncs.com'],
+ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-beijing.aliyuncs.com', 'endpoint' => 'xtrace.cn-beijing.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-beijing.aliyuncs.com'],
+ ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-guangzhou.aliyuncs.com', 'endpoint' => 'xtrace.cn-guangzhou.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-guangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-hangzhou.aliyuncs.com', 'endpoint' => 'xtrace.cn-hangzhou.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-hangzhou.aliyuncs.com'],
+ ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-heyuan.aliyuncs.com', 'endpoint' => 'xtrace.cn-heyuan.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-heyuan.aliyuncs.com'],
+ ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-hongkong.aliyuncs.com', 'endpoint' => 'xtrace.cn-hongkong.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-hongkong.aliyuncs.com'],
+ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-huhehaote.aliyuncs.com', 'endpoint' => 'xtrace.cn-huhehaote.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-huhehaote.aliyuncs.com'],
+ ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-qingdao.aliyuncs.com', 'endpoint' => 'xtrace.cn-qingdao.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-qingdao.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-shanghai.aliyuncs.com', 'endpoint' => 'xtrace.cn-shanghai.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-shenzhen.aliyuncs.com', 'endpoint' => 'xtrace.cn-shenzhen.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-shenzhen.aliyuncs.com'],
+ ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'xtrace.cn-wulanchabu.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-wulanchabu.aliyuncs.com'],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'xtrace.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'xtrace.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-zhangjiakou.aliyuncs.com'],
+ ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'xtrace.us-west-1.aliyuncs.com', 'endpoint' => 'xtrace.us-west-1.aliyuncs.com', 'vpc' => 'xtrace-vpc.us-west-1.aliyuncs.com'],
+ ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'xtrace.us-east-1.aliyuncs.com', 'endpoint' => 'xtrace.us-east-1.aliyuncs.com', 'vpc' => 'xtrace-vpc.us-east-1.aliyuncs.com'],
+ ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'xtrace.eu-west-1.aliyuncs.com', 'endpoint' => 'xtrace.eu-west-1.aliyuncs.com', 'vpc' => 'xtrace-vpc.eu-west-1.aliyuncs.com'],
+ ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'xtrace.eu-central-1.aliyuncs.com', 'endpoint' => 'xtrace.eu-central-1.aliyuncs.com', 'vpc' => 'xtrace-vpc.eu-central-1.aliyuncs.com'],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'xtrace.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'xtrace.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'xtrace-vpc.cn-shanghai-finance-1.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => '1006', 'message' => 'The parameter is invalid.', 'http_code' => 503, 'description' => ''],
+ ['code' => 'InternalError', 'message' => 'internal error, it is recommended to try again.', 'http_code' => 500, 'description' => 'Internal error, it is recommended to try again, if you try again, please contact the DingTalk service account.'],
+ ['code' => 'InvalidParameter', 'message' => 'The parameter is invalid.', 'http_code' => 503, 'description' => ''],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed', 'api' => 'CheckCommercialStatus'],
],
- 'parameters' => [
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The region ID.'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-hangzhou',
+ 'createdAt' => '2024-06-25T06:06:48.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Response parameters changed', 'api' => 'OpenXtraceService'],
+ ],
+ 'createdAt' => '2023-11-27T08:51:01.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Request parameters changed, Error codes changed', 'api' => 'OpenXtraceService'],
+ ],
+ 'createdAt' => '2023-10-25T03:46:00.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ListSpanNames'],
+ ],
+ 'createdAt' => '2023-09-04T09:29:47.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'ListSpanNames'],
+ ],
+ 'createdAt' => '2023-08-14T09:45:57.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => 'Error codes changed', 'api' => 'GetTrace'],
+ ],
+ 'createdAt' => '2021-08-20T06:40:55.000Z',
+ 'description' => 'GetTrace限流调整',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrace'],
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'Tracing',
+ 'productName' => 'Managed Service for OpenTelemetry',
+ 'ramCodes' => ['xtrace'],
+ 'ramLevel' => 'OPERATION',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'CheckCommercialStatus',
+ 'description' => '',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'xtrace:GetCommercialStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'Result' => [
- 'description' => 'The returned result.'."\n",
- 'type' => 'string',
- 'example' => 'True',
- ],
- 'RequestId' => [
- 'description' => 'The request ID.'."\n",
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1FC4****',
- ],
- 'OrderId' => [
- 'description' => 'The order ID.'."\n",
- 'type' => 'string',
- 'example' => '155709986',
- ],
- ],
- 'description' => '',
+ [
+ 'apiName' => 'ListSpanNames',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"True\\",\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1FC4****\\",\\n \\"OrderId\\": \\"155709986\\"\\n}","type":"json"}]',
- 'title' => 'OpenXtraceService',
- ],
- 'CheckCommercialStatus' => [
- 'summary' => 'Queries the commercialization status.',
- 'methods' => [
- 'get',
- 'post',
+ [
+ 'apiName' => 'ListIpOrHosts',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'ListServices',
+ 'description' => '',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'GetTagVal',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'abilityTreeCode' => '201972',
- 'abilityTreeNodes' => [
- 'FEATURExtraceQU1HZ6',
- 'FEATURExtraceP9I50Y',
- 'FEATURExtraceWNT0B5',
+ [
+ 'apiName' => 'SearchTraces',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
],
],
- 'parameters' => [
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cn-beijing',
+ [
+ 'apiName' => 'GetTrace',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
- [
- 'name' => 'Service',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'The service code.'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xtrace',
+ ],
+ [
+ 'apiName' => 'GetTagKey',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED',
- ],
- 'Data' => [
- 'description' => '',
- 'type' => 'string',
- 'example' => 'true',
- ],
- ],
+ [
+ 'apiName' => 'OpenXtraceService',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'xtrace:GetToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ [
+ 'apiName' => 'QueryMetric',
+ 'description' => '',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'xtrace:SearchTrace',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'Tracing', 'resourceType' => 'All Resource', 'arn' => '*'],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F*******\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => 'CheckCommercialStatus',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'xtrace.cn-qingdao.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'xtrace.cn-beijing.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'xtrace.cn-zhangjiakou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'xtrace.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'xtrace.cn-shanghai.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'xtrace.cn-shenzhen.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'xtrace.cn-hongkong.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'xtrace.ap-southeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'xtrace.us-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'xtrace.cn-shanghai-finance-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'xtrace.cn-huhehaote.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wulanchabu',
- 'endpoint' => 'xtrace.cn-wulanchabu.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-heyuan',
- 'endpoint' => 'xtrace.cn-heyuan.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-guangzhou',
- 'endpoint' => 'xtrace.cn-guangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'xtrace.eu-central-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'xtrace.eu-west-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'xtrace.us-east-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'xtrace.ap-northeast-1.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'xtrace.ap-southeast-3.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'xtrace.ap-southeast-5.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];