'1.0',
'info' => [
'style' => 'RPC',
'product' => 'xtrace',
'version' => '2019-08-08',
],
'directories' => [
'GetTagKey',
'GetTagVal',
'GetTrace',
'ListIpOrHosts',
'ListServices',
'ListSpanNames',
'QueryMetric',
'SearchTraces',
[
'id' => 188134,
'title' => 'Service Activation',
'type' => 'directory',
'children' => [
'OpenXtraceService',
'CheckCommercialStatus',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'GetTagKey' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '55548',
'abilityTreeNodes' => [
'FEATURExtraceZX0L4J',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the region.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => 'The name of the application.',
'type' => 'string',
'required' => false,
'example' => 'appTest',
],
],
[
'name' => 'SpanName',
'in' => 'query',
'schema' => [
'description' => 'The name of the span.',
'type' => 'string',
'required' => false,
'example' => 'createOrder',
],
],
[
'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',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
],
'TagKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagKey' => [
'description' => 'The tag keys.',
'type' => 'array',
'items' => [
'description' => 'The tag keys.',
'type' => 'string',
'example' => '{"TagKey":["date","resultCount","aTid"]}',
],
],
],
],
],
'description' => '',
],
],
],
'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":" \\n \\n date \\n resultCount \\n aTid \\n \\n 7D6519C1-A92A-4F07-AC83-706D48204242 \\n\\n","errorExample":""}]',
'title' => 'GetTagKey',
'summary' => 'Queries tag keys.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetTagVal' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '55549',
'abilityTreeNodes' => [
'FEATURExtraceZX0L4J',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the region.',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => 'The name of the application.',
'type' => 'string',
'required' => false,
'example' => 'appTest',
],
],
[
'name' => 'SpanName',
'in' => 'query',
'schema' => [
'description' => 'The name of the span.',
'type' => 'string',
'required' => false,
'example' => 'createOrder',
],
],
[
'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',
],
],
[
'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',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
],
'TagValues' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagValue' => [
'description' => 'The tag values.',
'type' => 'array',
'items' => [
'description' => 'The tag values.',
'type' => 'string',
'example' => '{"TagValue":["server"]}',
],
],
],
],
],
],
],
],
'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":" \\n D36507D4-FD30-430B-BEC4-738661CFB86C \\n \\n server \\n \\n","errorExample":""}]',
'title' => 'GetTagVal',
'summary' => 'Queries the tag values that correspond to a tag key.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetTrace' => [
'summary' => 'Queries the details of a trace.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '55551',
'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',
],
],
[
'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',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the region.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => 'The page number.'."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of entries on each page. Maximum value: 100.'."\n",
'type' => 'string',
'required' => false,
'example' => '5',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
],
'Spans' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Span' => [
'description' => 'The list of spans.'."\n",
'type' => 'array',
'items' => [
'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****',
],
'TagEntryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagEntry' => [
'description' => 'The tags.'."\n",
'type' => 'array',
'items' => [
'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',
],
],
],
],
],
],
'LogEventList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LogEvent' => [
'description' => 'The log events.'."\n",
'type' => 'array',
'items' => [
'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',
],
'TagEntryList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagEntry' => [
'description' => 'The tags.'."\n",
'type' => 'array',
'items' => [
'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',
],
],
],
],
],
],
],
],
],
],
],
'StatusCode' => [
'type' => 'integer',
'format' => 'int64',
],
],
],
],
],
],
],
'description' => '',
],
],
],
'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":" \\n 1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED \\n \\n \\n false \\n fec891bb8f8XXX \\n 192.168.XXX.XXX \\n server1 \\n /api \\n 1.1 \\n 1c6881aab84191a4 \\n 1000 \\n 1583683202047000 \\n 200 \\n fec891bb8f8XXX \\n \\n \\n Warning \\n logLevel \\n \\n \\n \\n \\n 1583683202047000 \\n \\n \\n Warning \\n logLevel \\n \\n \\n \\n \\n \\n \\n","errorExample":""}]',
'title' => 'GetTrace',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListIpOrHosts' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '55553',
'abilityTreeNodes' => [
'FEATURExtraceOGOOWE',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The region ID.'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-beijing',
],
],
[
'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',
],
],
[
'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',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The request ID.'."\n",
'type' => 'string',
'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1FC4****',
],
'IpNames' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'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" ]',
],
],
],
],
],
'description' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1******\\",\\n \\"IpNames\\": {\\n \\"IpName\\": [\\n \\"[ \\\\\\"172.19.XXX.XXX\\\\\\", \\\\\\"10.0.X.X\\\\\\" ]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 23D9757C-CB58-41A5-BBE7-2A9A0652****\\n \\n 172.19.XXX.XXX\\n 10.0.X.X\\n \\n","errorExample":""}]',
'title' => 'ListIpOrHosts',
'summary' => 'Queries IP addresses or hostnames in trace data. You can obtain all IP addresses of an application or in a region.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListServices' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '55554',
'abilityTreeNodes' => [
'FEATURExtraceF2LCA8',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the region.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-beijing',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the region.',
'type' => 'string',
'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED',
],
'Services' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Service' => [
'description' => 'The applications.',
'type' => 'array',
'items' => [
'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',
],
],
],
],
],
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\",\\n \\"Services\\": {\\n \\"Service\\": [\\n {\\n \\"ServiceName\\": \\"a3\\",\\n \\"Pid\\": \\"XXXqn3ly@741623b4e915df8\\",\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":" \\n \\n \\n a3 \\n XXXqn3ly@741623b4e915df8 \\n cn-hangzhou \\n \\n \\n","errorExample":""}]',
'title' => 'ListServices',
'summary' => 'Queries applications.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListSpanNames' => [
'summary' => 'Queries all span names in a specified region or all span names of a microservice.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '55555',
'abilityTreeNodes' => [
'FEATURExtraceZX0L4J',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the region.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => 'The name of the application.',
'type' => 'string',
'required' => false,
'example' => 'service 1',
],
],
[
'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',
],
],
[
'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',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.'."\n",
'type' => 'string',
'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
],
'SpanNames' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'SpanName' => [
'description' => 'The span names.'."\n",
'type' => 'array',
'items' => [
'description' => 'The span names.'."\n",
'type' => 'string',
'example' => '{"SpanName":["rpc0","rpc1.1","rpc1.1.1"]}',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ParameterRegionIdMissing',
'errorMessage' => '区域参数缺失',
],
[
'errorCode' => 'InternalError',
'errorMessage' => '内部错误,建议重试,如果多次重试报错请联系钉钉服务账号',
],
],
403 => [
[
'errorCode' => 'APINotAuthorize',
'errorMessage' => '当前用户无权限访问该接口',
],
],
[
[
'errorCode' => 'ServiceNameNotExist',
'errorMessage' => 'ServiceName不存在',
],
],
],
'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":" \\n \\n rpc0 \\n rpc1.1 \\n rpc1.1.1 \\n \\n 79C84C64-9951-477E-96F3-7FA44128C601 \\n","errorExample":""}]',
'title' => 'ListSpanNames',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'QueryMetric' => [
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '55557',
'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',
],
],
[
'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',
],
],
[
'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',
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => [
'description' => 'The field based on which you want to sort the returned entries.',
'type' => 'string',
'required' => false,
'example' => 'count',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => 'The maximum number of entries that you want to return.',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
[
'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',
],
],
[
'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',
],
],
[
'name' => 'ProxyUserId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the proxy user.',
'type' => 'string',
'required' => false,
'example' => 'testefgag12',
],
],
[
'name' => 'Filters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The filter conditions.'."\n",
'type' => 'array',
'items' => [
'description' => 'The filter conditions.'."\n",
'type' => 'object',
'properties' => [
'Key' => [
'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',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'Dimensions',
'in' => 'query',
'style' => 'repeatList',
'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',
],
'required' => false,
'example' => 'RT',
'maxItems' => 5,
],
],
[
'name' => 'Measures',
'in' => 'query',
'style' => 'repeatList',
'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',
],
'required' => true,
'example' => 'count',
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'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******',
],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{ \\\\\\"Data\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":1583686800000,\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"rt\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"rpc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"childSpan3\\\\\\\\\\\\\\"}]}}\\",\\n \\"RequestId\\": \\"1E2B6A4C-6B83-4062-8B6F-AEEC1F******\\"\\n}","errorExample":""},{"type":"xml","example":" \\n E2373982-D8CD-413D-B991-8EB678C01B4F \\n {\\"data\\":[{\\"date\\":1583686800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583686800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583686800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583686800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583690400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583690400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583690400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583690400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583694000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583694000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583694000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583694000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583697600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583697600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583697600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583697600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583701200000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583701200000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583701200000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583701200000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583704800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583704800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583704800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583704800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583708400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583708400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583708400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583708400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583712000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583712000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583712000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583712000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583715600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583715600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583715600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583715600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583719200000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583719200000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583719200000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583719200000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583722800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583722800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583722800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583722800000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583726400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583726400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583726400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583726400000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583730000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583730000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583730000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583730000000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583733600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583733600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583733600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583733600000,\\"count\\":0,\\"rt\\":0,\\"rpc\\":\\"parentSpan\\"},{\\"date\\":1583737200000,\\"count\\":100,\\"__time__\\":1583683200,\\"rt\\":0.01,\\"rpc\\":\\"childSpan3\\"},{\\"date\\":1583737200000,\\"count\\":100,\\"__time__\\":1583683200,\\"rt\\":305.18,\\"rpc\\":\\"childSpan2\\"},{\\"date\\":1583737200000,\\"count\\":100,\\"__time__\\":1583683200,\\"rt\\":305.25,\\"rpc\\":\\"childSpan\\"},{\\"date\\":1583737200000,\\"count\\":100,\\"__time__\\":1583683200,\\"rt\\":306.25,\\"rpc\\":\\"parentSpan\\"}],\\"actualSizeFromDB\\":0,\\"intervalInSec\\":3600,\\"resultSize\\":0,\\"successful\\":true} \\n\\n","errorExample":""}]',
'title' => 'QueryMetric',
'summary' => 'Queries a metric.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'SearchTraces' => [
'summary' => 'Queries traces by time, application name, IP address, span name, and tag.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '55558',
'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',
],
],
[
'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',
],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => 'The ID of the region.',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-beijing',
],
],
[
'name' => 'ServiceName',
'in' => 'query',
'schema' => [
'description' => 'The name of the application.',
'type' => 'string',
'required' => false,
'example' => 'service 1',
],
],
[
'name' => 'OperationName',
'in' => 'query',
'schema' => [
'description' => 'The name of the span.',
'type' => 'string',
'required' => false,
'example' => '/api',
],
],
[
'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',
],
],
[
'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',
],
],
[
'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',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => 'The number of entries per page.'."\n",
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '100',
],
],
[
'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',
],
],
[
'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',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of the tags.',
'type' => 'array',
'items' => [
'description' => 'Tag.',
'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',
],
],
'required' => false,
],
'required' => false,
'maxItems' => 5,
],
],
[
'name' => 'StatusCode',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => 'The ID of the request.',
'type' => 'string',
'example' => '1E2B6A4C-6B83-4062-8B6F-AEEC1F******',
],
'PageBean' => [
'description' => 'The location of the returned data.'."\n",
'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',
],
'TraceInfos' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TraceInfo' => [
'description' => 'The trace information.'."\n",
'type' => 'array',
'items' => [
'description' => 'The trace information.'."\n",
'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',
],
],
],
],
],
],
],
],
],
'description' => '',
],
],
],
'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":"\\n 1E2B6A4C-6B83-4062-8B6F-AEEC1FC47DED\\n \\n 100\\n 1\\n 1000\\n \\n /api\\n 192.163.XXX.XXX\\n 100\\n 1575561600000000\\n service1\\n 1c6881aab84191a4\\n \\n \\n","errorExample":""}]',
'title' => 'SearchTraces',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'OpenXtraceService' => [
'summary' => 'Activates Managed Service for OpenTelemetry.',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'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',
],
],
],
'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' => '',
],
],
],
'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',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '201972',
'abilityTreeNodes' => [
'FEATURExtraceQU1HZ6',
'FEATURExtraceP9I50Y',
'FEATURExtraceWNT0B5',
],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => [
'description' => '',
'type' => 'string',
'required' => false,
'example' => 'cn-beijing',
],
],
[
'name' => 'Service',
'in' => 'query',
'schema' => [
'description' => 'The service code.'."\n",
'type' => 'string',
'required' => true,
'example' => 'xtrace',
],
],
],
'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',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'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',
],
],
];