GetTraceConfig API Overview for Tracing in API Gateway - API Gateway

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries the tracing configurations of a Cloud-native API Gateway instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apig:GetTraceConfig	get	All Resources ``	none	none

Request syntax

GET /v1/gateways/{gatewayId}/trace HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
gatewayId	string	No	The instance ID.	gw-xxx
acceptLanguage	string	No	The language in which you want results to be returned. Valid values: zh: Chinese. en: English.	zh

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
requestId	string	The request ID.	2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
code	integer	The response code.	200
success	boolean	Indicates whether the request was successful. Valid values: true false	true
message	string	The error message.	success
data	object	The data returned.
enable	boolean	Indicates whether tracing analysis is enabled. Valid values: true and false	true
sampleRatio	integer	The sampling rate.	50
traceType	string	The type of tracing analysis. Valid values: XTRACE SKYWALKING OPENTELEMETRY OTSKYWALKING	SKYWALKING
serviceId	string	The service ID. This parameter exists when the traceType value is SKYWALKING.	ss-co370icmjeu****
servicePort	string	The service port. This parameter exists when the traceType value is SKYWALKING.	8090

Examples

Sample success responses

JSONformat

{
  "requestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "code": 200,
  "success": true,
  "message": "success",
  "data": {
    "enable": true,
    "sampleRatio": 50,
    "traceType": "SKYWALKING",
    "serviceId": "ss-co370icmjeu****",
    "servicePort": 8090
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history