tencent cloud

All product documents
APIs
DescribeGeneralOTSpanList
Last updated: 2025-02-25 15:58:02
DescribeGeneralOTSpanList
Last updated: 2025-02-25 15:58:02

1. API Description

Domain name for API request: apm.intl.tencentcloudapi.com.

General Query OpenTelemetry Call Chain List.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeGeneralOTSpanList.
Version Yes String Common Params. The value used for this API: 2021-06-22.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Business system id.
StartTime Yes Integer Span query start timestamp (unit: seconds).
EndTime Yes Integer Span query end timestamp (unit: seconds).
Filters.N No Array of Filter Universal filter parameters.
OrderBy No OrderBy Sort
.
The currently supported keys are:.

-StartTime (start time).
-EndTime (end time).
-Duration (response time).

The currently supported values are:.

- desc: sort in descending order.
-Asc - ascending order.
BusinessName No String The service name of the business itself. console users should fill in taw.
Limit No Integer Number of items per page, defaults to 10,000, valid value range is 0 – 10,000.
Offset No Integer Pagination.

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number.
Spans String The trace structure containing the query results spans. the string after the opentelemetry standard trace structure is hashed. first, the trace is converted into a json string using ptrace.jsonmarshaler, then compressed with gzip, and finally converted into a base64 standard string.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 General Query OpenTelemetry Call Chain List

General Query OpenTelemetry Call Chain List

Input Example

POST / HTTP/1.1
Host: apm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralOTSpanList
<Common request parameters>

{
    "InstanceId": "apm-CVfliqa8U",
    "StartTime": 1739864668,
    "EndTime": 1739865268,
    "Limit": 10
}

Output Example

{
    "Response": {
        "RequestId": "51e8f6fe-f343-45f1-899a-08547ab7b10d",
        "Spans": "H4sIAAAAAAAA/+x9bW+kuJf9V4nq1f8vBWIDNjjSaDXbHc3ManZ+reme0Urbo8jYpkIKMA2udDKj/u4rqMpDURRPNpX0br1pdcB2Yfv6+p7jY/ufRSFKuS6Y+JjTrFxc/vfzk8XlPwuqVBGHayU2r1biYXG5KEVxFzNhZzQVi/PFHU3WdeJSFXG2/HPz54LfW7f0jlqy4KKwtnkW37799e18UTKZv/jF+s+qhLrEywXN0wtVUCbKi7JOdL64E0UZy2xxubiDNlhUZTxlr5P+wqvfdH3gc4JxgFyKQoyDSMAAMiSQH3HHWWyy1WmRADjALnE5izh16eJ8kdNCZOrjYwqPcghJGDgk8jwOwOL88QOZTG0lMiYyZbNErnkqs1jJwubrMJQ2zWP7l/ciie9E8fBxU/OLpVCPj37JIrk4X6zijC8u3fNFqWihPsWp+COL73+jmVxcLqDvkgAjB/ue47lB9eMi4x2JEAjg4ry7x+KsVDSr/sMPd1yEXNcLXW45HvAsL0DIopS5FnWRcDHkxPOCxbdv54+FFzmzy4dSifRwmTSn7EZc183zMu8qKO1C5EnMaClUn0WJVLbYlBV4iIc49Bh6WXT1VhR2Lgt1uEgHBAF4mUuJRKRCFQ82j0tVSPvR8A4XYbuWAxwPAhc2q1bVp8zpkLGiRKleZo8zLu5tmuedfeXsfDvNUzsVtFwXIhVZR7XrEbPTWDnN7NoeD+ZhSVyV+SKTLG0uSlbEuepsoV/jbH1/hmzPhpBY0FJJ9cCzAADEEquy2WosWZdKFJ0VZ0lp3aLw73tUfN0zxq2vOZx5/PB9+RtVMxdyrURx+CeKmN20tph6yDu+rG6ZnT69KQTlPeZzo1RuZbG0iAugJe4Fs3ZMMRVlSZcdBVg7PylXoqM3P3z67c9ff0zE/b/ffGI/vcv+Qz3c7NSxiJdxZjOZ5jLrtMJY2jIX2fOQ23gJq+4Fy7H9lmJlLgrabW4mnHOrRyj5StMdSN7nCcQqEcoq12EmlMUQVeXqTlpfv36VXrrc8VSv0BIyj1nnqGyzjT1fw2SmaJz1DHDMOYAh9bEbBJhj5mHiBCIMI0woBp7vhyGkISI4chwSioi6js9DHwIAfeH6O47xRpbKpgW76ZigUo69zomgu992DHkzSVWTbbGuHPGmm142wV1qF2LZ2Xk0t5Zrmi3/vpHrPS8frss4E2X5G02FXT0/7Orpjn+ky8oYeq14tzqHbPoxrDA91utJ4MlKJgUFzTkhFepGdphbh9lX7b1ptm1cPLDVNgNUFs2a5ZLbcX64FBfYCNgOcG2I3b2efwrhOnud5qn17s8oib/Q4I9WNzTpCyq7HRRDilVpkSyNC7XrtArB49JWcSpKRdOOT3iKbMleC/TGRAgCgIjntJnq49dPqPw2oKScF6IsBxXgkJa5vOvbyd44mOomqrxc5Il8qDyQ/iCqfWh3KZ0tVzV+r9tJaDMMfhwwusjAuo9YxHc+SlG1Lt9J3lEu2J23zHq5DWx931GrPjT77dtf59t6LC7/qYuehoV5ACLGoMAh5JGowWYDCwcs8iAMQAA9iKHPnrHwv6oW/0lklbMT72SmCpkkorCX20f1+y3i7QO6LvFRH9AlCBD/ENCd0kdlXr22voowvWOWa8ORwCjOlCgymmgZ1xxYakrYozPMNYGD8QhZL1IyywSYdMVGYzjtKV1nkjKCbocjw+GuyhCrMiftZiIanKvNNLmv6WHe8bHlfAHKxHBxFjJ1AhupBXX0YMpYvssMraGB6Q2gE5MoVYPC6w6mpuOAY3KuuiDVDGE4KwGlw9x0drFh6kZ3OeANYSwMXQKg47k+hRyLYB9jtaCwlxhry9D+kubJRHBV46ZucOURrAOuqkhjax80y+TG8EoDgOqtYQsdV2YyfDc83gzNhSYno9Fh0KsimvGzjU7cMHyi7h+YmjE7exxddf4Ja1KpZKu8kLeCKbu2z8ch9hQcVY6v6QnfKuX5itHviLl9mFXoTMAzwiMD+NccxzMdsk6EVjOqZjSRiKH4t3Yo0Tpj3fxEJw8xlN/oDq1ME1bHJyneKof1VljvkYSB3gr8dCQ7jugcbNTG8O4MQNUEgBu9KmMI8QHikID4RGARVMhvH/G5rudQBAjghALIomfEty5FYf9RPvXixU9CVX+OlI66GPhBH+jziIMOSkfNdoCBVfgpSkXNBeip4fkgMWKzp+eUnswUNBhCjbNONdoBuUlkMUSR9HLAzx32GvXYY/H69NB5ylQ/RK2+LHI2K3ukTVHoQlMtTnV6MKmxsFD1iQVt3OzLZd2h9Wx9zYbrLTT5RC3Spj9+65z9Xx9JTI59dZYd2gxgPnYhE+qrLFY9ZF6c33ltuXLRu/OEuEADggyHAkNNaai68bkxq5JbJzc9ODEdH+20fm9FiA0xsiGyHZe0NMS43tNj7GZYNNNgcl840+v7+45Z8vcP767BbCsb5ri5KVupTPA8hoiw8UsKc9AqR5HLvvDxf50vxJ3I1HaLZwfChcB5xs3PbrQVzdZFHv6gx9z7frnTdNo2W/X02cer3z5tNsN2Vc4jjoNeuXLO+Mr9fvXu6pc/r97XFTREpkSB5wbQE4T6PmCE6JIpv8plnI3diIth/0ZcF3awKaNHkQHGRAv56gS6hqe1CW7cJH8yKzvxZvbfToHHhugfzbhRm2w7shi52ynNSD6Z0qeN5XnMIQzDNIIZ3DAfFtWgOV5j1/Eow9bAKXMS2pMpyWm8gQlSV4N70GUEp0P2gUR4q/lMAurzUt/6pKIWK/xmNne3eVk95nAK1a+x6meOfBiP3o+590F3HWEqNPi+JDCTCTGji+dHIlQc7LivzTnMRqi40HFemy16I4QKwhQKjqMQQwYpbSFUWnYsbNvtp6tPI2gTj3gY99EmyMGeY3Jbd43U1kViMZllgs0rLHotXctoUlaTzvnO/P0riPSMHtLyBnarHFXYXI1ZuxBf1qJU/bjg6pOpUGb7u2Uus1IMg9kO2APahpfwjqTwNspjrovEjtZJ0k2gXV5cPH8z3x679PjZl8QFqPsYstdFWRqR5GjObArseSICCqkkk0n/qIf221i3nHGzyFs51nM8CdocH7OtbwxEOT9/+vThuuH9ZmVVDGgrdNRuJlYFNJc2ZlnPH8ieIWNLiSMVTv1EcyMAGL700shoeoFFY3miB7S8GYKvD1xprQjuAty/Npje8KnkpZJs9QZPJRcECAx9QBgBhAUtp5KjyBWcQewGwGVMvKBq6jrZH6t/Xyy9fCjEe/pQP92ROzi9uD2ABHt9uD3AEARDzx0f4jUw1F+P1j4rYHwo3zSocevS+103eg6qqT4uIrpOVD0FrZUsLEQ8N5iT1h/AW2ymmqPFC6MC/C+3+T384u6pirUF8q9APWiGplqTCwj2J5ch4YVGhGCcJZkYBxwc+RNxVLMpDasdNFYzJlNBb0PCOukYcL2d0+Og3kFLmkgH7ZRn4QiHHPmBHxkSl5g48WwCIzkgwB8WCRnitvNCMlFWMUOa0oxf02LZ0dv14/Lsn8/Z2dnmzXX96PLs8+JC5uqi6rmLahjf8tVFGGf1g8+Lz9m3z1lXZuu/0hI6QTokKUtoWeZU3QxIfEHz/ILJLLqs/5fE4cX2yJBQSmXVMaQoLMdGNrRvadGerOf1YymJXC6rhy3JE7n0bi0lrTKJvFvLsaHXnoTmcevb23XynB3avu2CRgK6ooWi9vNRKHVZ0HZt1Pj0jK7EA00TC9pO0FotJgthIdu121/fsqTtLS/WMbfaWgbajk3aEre8qCzmvq0azuEeoGslq16Ol+tCDO2uWx6ytrQ/xytaxO8+WJ4NbLe9Aaqsh9snFDQr296nDyFVcdnaRo7t2KA/ebOqBzNV/e53lldlxc0U5ZcnXCyLjScObGA7DSOqvG591FlEWWuL17P3ZhY5UF1Y/f7vV79e/fjxaljeZt17Sqh8msys3ZHcm6cQlbX5zWZ9ccSQVY1OaHu7CXJRRCktVrW9AttxmyXU5WdCqQervKFc8NbfqVPV7He4jlpT1C+tpZTLRDzWsX5W1j3a1g9P5SWxOlS9OKWJVWZxFIni5YFKFrQhaesftQ4P12A7RZaHU2yHdfvLCsKKe9WRoAYQ0yyrJe9wy3pqynpouFXb4K4UaxUnrcmW67qAqsOgRTNeyJjvpohonKwLQVk1Q1twv2+TuFQio2EiorWqPpwQQmxgiTRXD9V0Qe9kzKvGjJKYKetrrG6s+nd3y2E3gq1EURlTTpX1ZU2Tekg3xrwoCllc54XMxPVLA2kZ/beODG9Zw4wavnRZysxy7KDppSJaqttSZk5tzqjd7a9otKKWY+9Zx9MMtjGgw06ayrzjrbjPq8C3mn8OJ9pAvup/h9Oo+46XRQ1Dq5ZptN+mehtDLetqNhL8XSpu3WbVEPJsZDVsK/nb21gf3M9ZZjTPHx5fVwka7b+SFQ6xSsWTuBrhyIYdvhDu+bnd/FsH1VbMbVm4AFlVAU4zBmCryjo4VTSMM74ZkW57ol1TPJyudu1tCXZJgUQuQ8pW1XizoE1sx6JJfkO7sjT4nK1rG5S1FCmT2V2dHPYnr0qu/hezckyWOmlXomd/u5fwsT22M6Oz141PCaq4PGataTZx6+ZTfNttjukdqAcqR2d9/O3HDx9//tenKuUQVPC+wvYVtvyhngcGZ8lj/gMcnLoQufzh8bsH57qRqahzDcoR0lLwuBia4eCZlHWrPkLVl3Dyx7wG45WpbsvXW+7bX/QfqmTZpcsNbcUatyPm+WMay8KjpCaBiyFBCFsUcmx5ASIWYS60qOcwFEBEhYsmbB3oAP0TBErD1xhHUxDDJHKEYgSjyGUEE4w8FIau8BhlgAcuETgIBBKQuVgQj9EIhT5GDEIGeISZS0gwl3pggLIFeggR0r0bYzJJOlY6cogas1Yr5U8908MNHMfAbqBxq+x4/xzS494Rt/sBxz4nwKigd6hGPnAAhN+fRn5HRt6pkw8w8N3vTyf/tAnAkEaeYBoBgl3o4Ugg3HIvmghDjpgfYof7QogXews+Xv169e7TWSrZ6np7rvU1D+2dv9elKOJxZxAEmARu7zH+ACM036L8gCFbs2DH17cbVfXPsQalL8CfZRVI84BMg3IJ3cV3Hg6JzjaDU2+Jsg4IojhJRMdnusCGPrR9bDvupesC3PjWPm3L3jgyFOHPf0ryHHKCIVDkqbkNLeMa2aU+bcBrAEFtEcwrn7ZSDY0via1omHSU0z6ZHguB8rAvQj489M0hH02yoeq0KImzlX0Xi68deHbXDQ0HwqPiIPPqmYnA9FjHXO75dx7aVWt0aL+kbDsVfgqMuuUhMyPwMS2d4mFPGQ1z2puXexWXnaNTB4Ebl6Wd9CUnfclJX3LSl5z0JSd9yUlfctKXnPQlJ33JSV9y0pec9CX/V/UlJvcDzroVj4f28wbh601JPVzI5cVFL2euqOphcUuRCKbOuMjV+RmT60z9v+r///+MlmdKKpqcRYVMz3pJKB4OWCbr4CKM3Naked7J0XUlg/b+Nft1S2PN371nX29EIc5ifvZ5DYDLzv7tbFnIdX4WPtQFHkdVoqWxmJF1Hb379Bib9SvMJtQb3K3vuZ4bVOOFc4AxaNEHUBi4CAJEBEAURbhvt37993uhaJyMvJwg8DeSjW5hAPThwd36Jq/l0t3x/n1uoR7ma0UkkBeKiPkO5WGIXReHDnAw9wEXkCASESI4YCQIQ4Qh8iIXeTQSnotCyIL9CeZol+e9pXN+mkcQ6c2Sc90RdCAK8xy4dzvlBGnHrmO0fD8kzPdDNOuJD3NdOzFxF/JkLW7T1U5ePS+8h/v7+IuZTfZTLiMgtjP9iD8/5IALElk0gK7lOdSzCGLYcj0EuOt70Gdgugpkyvktr7SvXEMjMkqo0SOSn+T7jGiC5j+w76C/shRbZqm2XnDgnoCOkT9xIXsvQp1FFGP4JBBzGpRj3Ja5d6qf8bNfxqsYD3e7juzL4MEhhkQ0RrV848QVTVdnaH+DjsRUdxNQh/sZL+YKxoqdQOAHkOwdXz56CL6KNnvwBg0fgtfevzDbJQYEYgK+v80ZHZcYzEMbNa4PeyukUYQcFkBABQopEn6wTxpxHDBEgMAR5ZwSNPniBej0X7zgER96h4zH7C0Jk7aATAmPPe2LU3oOOB3v/AxNxDNcaDlD84zFBS9HqoV5wLEXhhxbWRJi9SaQjoEzRaeGg0MmdQdjTPauI5zAKB3oibn5n5Exobd/1YfuItvszOZ0VnnWfeqNs7BHYY+ltFKRhu2nYOvc5aHB4pzU0lpq6aOIsk6S7Lene+7Uwr1h2fj/Hr12t6jypOY+qblPau6TmltDzX1YzHtI532zVlImVo32kB3sTXzb99uJb//9Sbb7yrLdHTh3Uu2aUe1WjfqIUF7cc9+t2R0mDUJu5IeuwygSvi8Y8KhHnAj6LuIMc8eHBPgQOE4UQY5EgKkHmPAR8VzH85jbBsA0LjU0t0A4SpEAPRAB5gmLh0FoeR6OrMAPqEU4FUHkAB+Fe5uPxwiHGncTHOu+qAYdbWrNZ9rK5aGP0RA1YTfw20iIt3YP1t4JAUeV0I2TirQQXVqnEvSu8gUg2CH7xl3ouUcIXVblXSyF+s/68R7nZ3QNf5RqK81TvgqX2JACSHdNWef2xelyV+2rQseJwSYIu/bXCf/69j8AAAD//wEAAP//2YWydbXKAAA=",
        "TotalCount": 26674
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error.
AuthFailure.UnauthorizedOperation AuthFailure.UnauthorizedOperation
FailedOperation Operation failed.
FailedOperation.AppIdNotMatchInstanceInfo The appid does not match the business system information.
FailedOperation.InstanceIdIsEmpty Business system id is empty.
FailedOperation.InstanceNotFound The apm business system does not exist.
InternalError Internal error.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon