Obtaining the HTTP Detection Result

Function

This API is used to query the detection result based on task_id returned by the HTTP detection.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/notifications/topics/{topic_urn}/detection/{task_id}

Table 1 Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. For details about how to obtain the project ID, see Obtaining the Project ID.
topic_urn	Yes	String	Specifies the resource identifier of the topic, which is unique. To obtain the resource identifier, see Querying Topics.
task_id	Yes	String	Specifies the ID of the HTTP detection task.

Request Parameters

Table 2 Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies a user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 3 Response body parameters
Parameter	Type	Description
detail	detail object	Specifies the endpoint detection details.
status	Integer	Specifies the status of the HTTP detection task. 0 indicates that the task was successful and the endpoint was available. 1 indicates that the task was not executed. 2 indicates that the task failed and the endpoint was unavailable.
request_id	String	Specifies the request ID.

Table 4 detail
Parameter	Type	Description
httpCode	Integer	Specifies the HTTP code returned by the endpoint detected. 0 indicates that the user was blacklisted. -1 indicates that the endpoint did not respond within 5 seconds. -2 indicates that the queue was full and the HTTP detection task was not executed. Other HTTP codes are the actual values returned by the endpoint.
httpResponse	String	Specifies the response body for endpoint detection. If the HTTP code is 0, -1, -2, or 2xx, the response body content is fixed and defined by SMN. If the HTTP code is not one of the values mentioned above, the response body content is the content returned by the endpoint.

Status code: 400

Table 5 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 403

Table 6 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 404

Table 7 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Status code: 500

Table 8 Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID, which is unique.
code	String	Specifies the error code.
message	String	Describes the error message.

Example Requests

Example

GET https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/detect/c414cfd4326a488e9c6a315ce8dc5fe3

Example Responses

Status code: 200

{
  "detail" : {
    "httpCode" : 200,
    "httpResponse" : "Http endpoint is available."
  },
  "status" : 0,
  "request_id" : "e4bde8f67bd64402804011160c9f8772"
}

Status Codes

Status Code	Description
200	OK
400	Bad Request
403	Unauthorized
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Message Publishing

Предыдущая статья

Publishing a Detection Message

Следующая статья