API standards and multilingual preset SDKs
The OpenAPI of this product (xtrace/2019-08-08) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
API catalog
|
API |
Title |
Description |
| GetTagKey | GetTagKey | Retrieves tag keys |
| GetTagVal | GetTagVal | Retrieves the tag values for a specified tag key from reported traces. |
| GetTrace | Obtain Trace Details | You can invoke the GetTrace API to obtain trace details. |
| ListIpOrHosts | ListIpOrHosts | Queries IP addresses or hostnames in trace data. You can obtain all IP addresses of an application or in a region. |
| ListServices | ListServices | Queries applications. |
| ListSpanNames | Retrieve all span names | Retrieves all span names in a specified region. You can also retrieve all span names of a specific microservice. |
| QueryMetric | QueryMetric | Queries a metric. |
| SearchTraces | SearchTraces | 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. |
Access control
|
API |
Title |
Description |
| OpenXtraceService | OpenXtraceService | Activates Managed Service for OpenTelemetry. |
| CheckCommercialStatus | Check the commercialization status | Check the commercialization status. |