1. 接口描述
接口请求域名: apm.tencentcloudapi.com 。
通用查询 OpenTelemetry 调用链列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeGeneralOTSpanList。 |
Version | 是 | String | 公共参数,本接口取值:2021-06-22。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 业务系统 ID 示例值:apm-CVfliqa8U |
StartTime | 是 | Integer | Span 查询开始时间戳(单位:秒) 示例值:1617123538 |
EndTime | 是 | Integer | Span 查询结束时间戳(单位:秒) 示例值:1617123538 |
Filters.N | 否 | Array of Filter | 通用过滤参数 示例值:{ "Key": "service.name", "Type": "=", "Value": "java-order-service" } |
OrderBy | 否 | OrderBy | 排序 现支持的 Key 有: - startTime(开始时间) - endTime(结束时间) - duration(响应时间) 现支持的 Value 有: - desc(降序排序) - asc(升序排序) 示例值:{ "Key": "startTime", "Value": "desc" } |
BusinessName | 否 | String | 业务自身服务名,控制台用户请填写taw 示例值:taw |
Limit | 否 | Integer | 单页项目个数,默认为10000,合法取值范围为0~10000 示例值:15 |
Offset | 否 | Integer | 分页 示例值:1 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 总数量 示例值:200 |
Spans | String | Spans字段中包含了链路数据的全部内容,由于数据经过了压缩,需要对结果进行如下三步转换,以还原始的文本。 1. 将Spans字段中的文本进行 Base64 解码,得到经过压缩后字节数组。 2. 使用 gzip 对压缩后的字节数组进行解压,得到压缩前的字节数组。 3. 使用 UTF-8 字符集,将压缩前的字节数组转换为文本。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 通用查询 OpenTelemetry 调用链列表
通用查询 OpenTelemetry 调用链列表
输入示例
POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGeneralOTSpanList
<公共请求参数>
{
"InstanceId": "apm-CVfliqa8U",
"StartTime": 1739864668,
"EndTime": 1739865268,
"Limit": 10
}
输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.UnauthorizedOperation | AuthFailure.UnauthorizedOperation |
FailedOperation | 操作失败。 |
FailedOperation.AppIdNotMatchInstanceInfo | AppID 和业务系统信息不匹配。 |
FailedOperation.InstanceIdIsEmpty | 业务系统 ID 为空。 |
FailedOperation.InstanceNotFound | APM 业务系统不存在。 |
InternalError | 内部错误。 |