# 发布探测消息 - PublishHttpDetect #### 功能介绍 基于主题发送http/https探测消息，探测当前http/https 终端是否可用，SMN出口是否能够正常访问该终端。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-smn/smn_api_30000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-smn/smn_api_80000.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI POST /v2/{project_id}/notifications/topics/{topic_urn}/detection 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | 项目ID。 获取项目ID请参考 [获取项目ID](https://support.huaweicloud.com/api-smn/smn_api_66000.html)。 | | topic_urn | 是 | String | Topic的唯一的资源标识，可通过[查询主题列表](https://support.huaweicloud.com/api-smn/smn_api_51004.html)获取该标识。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | protocol | 是 | String | 协议类型，当前仅支持http/https，不可为空 枚举值： - **http** - **https** | | endpoint | 是 | String | 待探测的终端地址，当前仅支持以http:// 或https://开头，不可为空 | | extension | 否 | [extension] object | Http/Https协议可以指定多个K/V对，在发送Http/Https协议消息时会携带这些K/V对作为请求header。extension字段允许为空，header字段允许为空。 | 表4extension | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | header | 否 | Map\ | header应满足如下要求： 1. key值限定为：包含英文字母(\[A-Za-z\])、数字(\[0-9\])、中划线(-)hyphens，中划线不得作为开头和结尾，不得连续出现。 2. K/V不得超过10个 3. key需要以字母开头，不能以"x-smn"开头，正确示例:abc,x-abc 4. 所有K/V长度总和不得超过1024个字符 5. key不区分大小写 6. key值不可重复 7. value值限定为ASCII码，不支持中文或其他Unicode，支持空格 | #### 响应参数 **状态码：200** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求ID | | task_id | String | 探测任务ID | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | error_code | String | 返回信息对应的代码。 | | error_msg | String | 服务异常错误信息描述。 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | code | String | 服务异常错误信息编码。 | | message | String | 服务异常错误信息描述。 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | code | String | 服务异常错误信息编码。 | | message | String | 服务异常错误信息描述。 | **状态码：429** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | code | String | 服务异常错误信息编码。 | | message | String | 服务异常错误信息描述。 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | request_id | String | 请求的唯一标识ID。 | | code | String | 服务异常错误信息编码。 | | message | String | 服务异常错误信息描述。 | #### 请求示例 正确调用接口示例 ``` POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_create_topic_v2/detection { "protocol" : "http", "endpoint" : "http://172.20.0.51:32000/http_notify", "extension" : { "header" : { "x-abc" : "1213", "x-abc-cba" : "test2" } } } ``` #### 响应示例 **状态码：200** 发送http探测成功 ``` { "request_id" : "adc82efa7e0042899722531681b1959a", "task_id" : "adc82efa7e0042899722531681b1959a" } ``` **状态码：400** 发送http探测失败 ``` { "request_id" : "373cdb9696e44454832ea02e61a2c689", "error_code" : "SMN.00011004", "error_msg" : "Parameter: Extension is invalid. Http header key is invalid." } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 正确调用接口示例 ``` 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("")) .build(); PublishHttpDetectRequest request = new PublishHttpDetectRequest(); request.withTopicUrn("{topic_urn}"); HttpDetectRequestBody body = new HttpDetectRequestBody(); Map 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.HttpDetectRequestBody.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] 正确调用接口示例 ``` # 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("")) \ .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] 正确调用接口示例 ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := smn.SmnClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := smn.NewSmnClient(hcClient) 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) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SMN/sdk?api=PublishHttpDetect&version=v2)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 发送http探测成功 | | 400 | 发送http探测失败 | | 403 | Unauthorized | | 404 | Not Found | | 429 | Too Many Requests | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-smn/ErrorCode.html)。