GetTraceConfig - API Gateway - Alibaba Cloud Documentation Center

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	Gateway Instance ID	gw-xxx
acceptLanguage	string	No	Language Type: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	Return Parameters
requestId	string	Request ID	2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
code	integer	Response Code	200
success	boolean	Boolean Request Result, with the following values: true: Request succeeded. false: Request failed.	true
message	string	Error Message	success
data	object	Response Data
enable	boolean	Whether to Enable Tracing: true: Enabled false: Disabled	true
sampleRatio	integer	Sampling Rate	50
traceType	string	Tracing Type: XTRACE SKYWALKING OPENTELEMETRY OTSKYWALKING	SKYWALKING
serviceId	string	Service ID, present when the tracing type is SKYWALKING	ss-co370icmjeu****
servicePort	string	服务端口，链路追踪类型为 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.