Updated on 2024-09-06 GMT+08:00

Publishing a Detection Message

Function

Specifies the HTTP or HTTPS detection messages sent based on topics. These messages are used to check whether the current HTTP or HTTPS endpoint is available and whether the SMN egress can access the endpoint.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/notifications/topics/{topic_urn}/detection

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.

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.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

protocol

Yes

String

Specifies the protocol type. Only http and https are supported. This field cannot be left blank.

endpoint

Yes

String

Specifies the endpoint address to be detected. The address must start with http:// or https:// and cannot be left blank.

extension

No

extension object

Specifies the extended information for subscriptions over HTTP or HTTPS. You can specify multiple key/value pairs for the HTTP or HTTPS protocol. These key/value pairs will be carried as the request header when HTTP or HTTPS messages are sent. extension can be left blank. header can be left blank.

Table 4 extension

Parameter

Mandatory

Type

Description

header

No

Map<String,String>

Specifies the header for subscriptions over HTTP or HTTPS. The header must meet the following requirements:

  1. key can contain letters, digits, and hyphens (-). key cannot end with a hyphen (-) nor contain consecutive hyphens (-).

  2. You can specify up to 10 key/value pairs.

  3. key must start with **x-**but not x-smn. Examples: x-abc-cba or x-abc

  4. The total length of all key/value pairs cannot exceed 1,024 characters.

  5. key is case insensitive.

  6. key must be unique.

  7. value must be an ASCII code. Unicode characters are not supported. Spaces are allowed.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Specifies the request ID.

task_id

String

Specifies the detection task ID.

Status code: 400

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: 403

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: 404

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.

Status code: 429

Table 9 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 10 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

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

{
  "protocol" : "http",
  "endpoint" : "http://172.20.0.51:32000/http_notify",
  "extension" : {
    "header" : {
      "x-abc" : "1213",
      "x-abc-cba" : "test2"
    }
  }
}

Example Responses

Status code: 200

Detection succeeded.

{
  "request_id" : "adc82efa7e0042899722531681b1959a",
  "task_id" : "adc82efa7e0042899722531681b1959a"
}

Status code: 400

Detection failed.

{
  "request_id" : "373cdb9696e44454832ea02e61a2c689",
  "error_code" : "SMN.00011004",
  "error_msg" : "Parameter: Extension is invalid. Http header key is invalid."
}

SDK Sample Code

The SDK sample code is as follows.

Java

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.smn.v2.region.SmnRegion;
import com.huaweicloud.sdk.smn.v2.*;
import com.huaweicloud.sdk.smn.v2.model.*;

import java.util.Map;
import java.util.HashMap;

public class PublishHttpDetectSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        SmnClient client = SmnClient.newBuilder()
                .withCredential(auth)
                .withRegion(SmnRegion.valueOf("<YOUR REGION>"))
                .build();
        PublishHttpDetectRequest request = new PublishHttpDetectRequest();
        request.withTopicUrn("{topic_urn}");
        HttpDetectRequestBody body = new HttpDetectRequestBody();
        Map<String, String> listExtensionHeader = new HashMap<>();
        listExtensionHeader.put("x-abc", "1213");
        listExtensionHeader.put("x-abc-cba", "test2");
        HttpDetectRequestBodyExtension extensionbody = new HttpDetectRequestBodyExtension();
        extensionbody.withHeader(listExtensionHeader);
        body.withExtension(extensionbody);
        body.withEndpoint("http://172.20.0.51:32000/http_notify");
        body.withProtocol(HttpDetectRequestBody.ProtocolEnum.fromValue("http"));
        request.withBody(body);
        try {
            PublishHttpDetectResponse response = client.publishHttpDetect(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksmn.v2.region.smn_region import SmnRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksmn.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = SmnClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SmnRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = PublishHttpDetectRequest()
        request.topic_urn = "{topic_urn}"
        listHeaderExtension = {
            "x-abc": "1213",
            "x-abc-cba": "test2"
        }
        extensionbody = HttpDetectRequestBodyExtension(
            header=listHeaderExtension
        )
        request.body = HttpDetectRequestBody(
            extension=extensionbody,
            endpoint="http://172.20.0.51:32000/http_notify",
            protocol="http"
        )
        response = client.publish_http_detect(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    smn "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/smn/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := smn.NewSmnClient(
        smn.SmnClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.PublishHttpDetectRequest{}
	request.TopicUrn = "{topic_urn}"
	var listHeaderExtension = map[string]string{
        "x-abc": "1213",
        "x-abc-cba": "test2",
    }
	extensionbody := &model.HttpDetectRequestBodyExtension{
		Header: listHeaderExtension,
	}
	request.Body = &model.HttpDetectRequestBody{
		Extension: extensionbody,
		Endpoint: "http://172.20.0.51:32000/http_notify",
		Protocol: model.GetHttpDetectRequestBodyProtocolEnum().HTTP,
	}
	response, err := client.PublishHttpDetect(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Detection succeeded.

400

Detection failed.

403

Unauthorized

404

Not Found

429

Too Many Requests

500

Internal Server Error

Error Codes

See Error Codes.