# 上报服务端命令执行结果 - UpdateCommandResult #### 功能介绍 迁移Agent调用该接口向SMS服务端反馈指定指令的执行结果。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-sms/sms_api_0007.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-sms/sms_api_8001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | sms:server:updateCommandResult | Write | server \* | - | sms:server:migrationServer | - | | sms:server:updateCommandResult | Write | - | g:EnterpriseProjectId | sms:server:migrationServer | - | #### URI POST /v3/sources/{server_id}/command_result 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | server_id | 是 | String | 上报命令执行结果的命令所对应的服务端ID 最小长度：**1** 最大长度：**36** | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | X-Auth-Token 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 最小长度：**1** 最大长度：**16384** | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | command_name | 是 | String | 命令名称，分为：START、STOP、DELETE、SYNC、UPLOAD_LOG、RSET_LOG_ACL 最小长度：**0** 最大长度：**255** | | result | 是 | String | 命令执行结果  success代表执行命令成功  fail代表命令执行失败 最小长度：**0** 最大长度：**255** | | result_detail | 是 | Object | JSON格式的命令执行结果，只用于保存数据库，没有其他作用 | #### 响应参数 **状态码：200** 无 **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 最小长度：**0** 最大长度：**255** | | error_msg | String | 错误信息 最小长度：**0** 最大长度：**1024** | **状态码：401** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 最小长度：**0** 最大长度：**255** | | error_msg | String | 错误信息 最小长度：**0** 最大长度：**1024** | **状态码：403** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误代码 最小长度：**0** 最大长度：**255** | | error_msg | String | 错误信息 最小长度：**0** 最大长度：**255** | | encoded_authorization_message | String | 加密授权信息 最小长度：**0** 最大长度：**65535** | | error_param | Array of strings | 错误参数 最小长度：**0** 最大长度：**65535** 数组长度：**1 - 20** | | details | Array of [details] objects | 详细错误信息 数组长度：**1 - 20** | 表7details | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | SMS错误代码 最小长度：**0** 最大长度：**65535** | | error_msg | String | SMS错误信息 最小长度：**0** 最大长度：**65535** | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 最小长度：**0** 最大长度：**255** | | error_msg | String | 错误信息 最小长度：**0** 最大长度：**1024** | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 最小长度：**0** 最大长度：**255** | | error_msg | String | 错误信息 最小长度：**0** 最大长度：**1024** | #### 请求示例 反馈指定指令的执行结果给SMS服务端。指令为START，执行结果是"success"。 ``` POST https://{endpoint}/v3/sources/f32ab4d6-d150-4fb3-aa55-edbb5cf9xxxx/command_result { "command_name" : "START", "result" : "success", "result_detail" : { "msg" : "xxx" } } ``` #### 响应示例 **状态码：200** 无 **状态码：403** ``` { "error_code" : "SMS.9004", "error_msg" : "The current account does not have the permission to execute policy. You do not have permission to perform action XXX on resource XXX.", "encoded_authorization_message" : "XXXXXX", "error_param" : [ "You do not have permission to perform action XXX on resource XXX." ], "details" : [ { "error_code" : "SMS.9004", "error_msg" : "You do not have permission to perform action XXX on resource XXX." } ] } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 反馈指定指令的执行结果给SMS服务端。指令为START，执行结果是"success"。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.sms.v3.region.SmsRegion; import com.huaweicloud.sdk.sms.v3.*; import com.huaweicloud.sdk.sms.v3.model.*; public class UpdateCommandResultSolution { 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"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); SmsClient client = SmsClient.newBuilder() .withCredential(auth) .withRegion(SmsRegion.valueOf("")) .build(); UpdateCommandResultRequest request = new UpdateCommandResultRequest(); request.withServerId("{server_id}"); CommandBody body = new CommandBody(); body.withResultDetail("{\"msg\":\"xxx\"}"); body.withResult("success"); body.withCommandName("START"); request.withBody(body); try { UpdateCommandResultResponse response = client.updateCommandResult(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] 反馈指定指令的执行结果给SMS服务端。指令为START，执行结果是"success"。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdksms.v3.region.sms_region import SmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksms.v3 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"] credentials = GlobalCredentials(ak, sk) client = SmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(SmsRegion.value_of("")) \ .build() try: request = UpdateCommandResultRequest() request.server_id = "{server_id}" request.body = CommandBody( result_detail="{\"msg\":\"xxx\"}", result="success", command_name="START" ) response = client.update_command_result(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] 反馈指定指令的执行结果给SMS服务端。指令为START，执行结果是"success"。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" sms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/sms/v3/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") auth, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := sms.SmsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := sms.NewSmsClient(hcClient) request := &model.UpdateCommandResultRequest{} request.ServerId = "{server_id}" var resultDetailCommandBody interface{} = "{\"msg\":\"xxx\"}" request.Body = &model.CommandBody{ ResultDetail: &resultDetailCommandBody, Result: "success", CommandName: "START", } response, err := client.UpdateCommandResult(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/SMS/sdk?api=UpdateCommandResult)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 上报服务端命令执行结果成功 | | 400 | Bad Request | | 401 | Unauthorized | | 403 | 鉴权失败 | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-sms/ErrorCode.html)。