Querying API Debugging Messages in DLM Exclusive

Description

This API is used to query the API debugging information in different clusters.

URL

URI format
GET /v1/{project_id}/service/apis/{api_id}/debug-info[?offset,limit]

Parameter description

Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.
api_id	Yes	String	API ID
offset	No	Integer	Query start coordinate, that is, skipping the first X records. The default value is 0. The value range is [0, MAX_INTEGER).
limit	No	Integer	Number of records to be queried, that is, Y records. The default value is 10. The value range is [1, 100].

Request Message

Example request
None

Response

Example response

{
  "total": 1,
  "publish_messages": [
    {
      "id": "343a6d4c0ad108376ebd060c9c33cc33",
      "api_id": "47046fe7830c1be77cb0dc23bd86afa5",
      "instance_id": "c2e27497562ed193583378e052248003",
      "instance_name": "cluster_test_001",
      "api_status": "API_STATUS_CREATED",
      "api_debug": "API_DEBUG_WAITING"
    }
  ]
}

Response parameter description

Parameter	Type	Description
total	Integer	Debugging messages that meet the query conditions
publish_messages	Dictionary	Debugging messages that are returned

publish_messages parameter description

Parameter	Type	Description
id	String	Publishing message ID
api_id	String	API ID
instance_id	String	Cluster ID
instance_name	String	Cluster name
api_status	String	API status. Available values include: API_STATUS_CREATED: The API has been created. API_STATUS_PUBLISH_WAIT_REVIEW: The API has been published and is waiting to be reviewed. API_STATUS_PUBLISH_REJECT: The request to publish the API has been rejected. API_STATUS_PUBLISHED: The API has been published. API_STATUS_WAITING_STOP: The API is to be suspended. API_STATUS_STOPPED: The API has been suspended. API_STATUS_RECOVER_WAIT_REVIEW: The request to recover the API waits to be reviewed. API_STATUS_WAITING_OFFLINE: The API is pending offline. API_STATUS_OFFLINE: The API is offline.
api_debug	String	API debugging status. Available values include: API_DEBUG_WAITING: The API is waiting to be debugged. API_DEBUG_FAILED: API debugging fails. API_DEBUG_SUCCESS: API debugging is successful.