Uploading Consistency Verification Results
Function
This API is called by the Agent to upload the consistency verification results of a task.
Calling Method
For details, see Calling APIs.
Authorization
Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.
- If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
- If you are using identity policy-based authorization, the permission listed below is required.
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
sms:server:updateConsistencyCheckResult
Write
server *
-
- sms:server:migrationServer
-
URI
POST /v3/tasks/{task_id}/consistency-result
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
task_id |
Yes |
String |
The task ID. |
Request
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
The user token. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
consistency_result |
No |
Array of ConsistencyResult objects |
The consistency verification results. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
dir_check |
Yes |
String |
The directory verified. |
|
num_total_files |
Yes |
Integer |
The total number of files verified. Range 0 to 1000000 |
|
num_different_files |
Yes |
Integer |
The number of files inconsistent. Range 0 to 1000000 |
|
num_target_miss_files |
Yes |
Integer |
The number of files missing at the target. Range 0 to 1000000 |
|
num_target_more_files |
Yes |
Integer |
The number of files redundant at the target. Range 0 to 1000000 |
Response
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
- |
String |
The consistency verification results were updated. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
|
encoded_authorization_message |
String |
The encrypted authorization information. |
|
error_param |
Array of strings |
Invalid parameters. |
|
details |
Array of details objects |
The error details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The SMS error code. |
|
error_msg |
String |
The SMS error message. |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
Status code: 500
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
The error code. |
|
error_msg |
String |
The error message. |
Example Request
This example updates the brief consistency verification results of the task whose ID is 137224b7-8d7c-4919-b33e-ed159778xxxx.
POST https://{endpoint}/v3/137224b7-8d7c-4919-b33e-ed159778xxxx/consistency-result
{
"consistency_result" : [ {
"dir_check" : "/root/data",
"num_total_files" : 1235,
"num_different_files" : 12,
"num_target_miss_files" : 12,
"num_target_more_files" : 12
}, {
"dir_check" : "/var",
"num_total_files" : 1235,
"num_different_files" : 12,
"num_target_miss_files" : 12,
"num_target_more_files" : 12
} ]
}
Example Response
Status code: 200
The consistency verification results were updated.
{ }
Status code: 403
Authentication failed.
{
"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 Sample Code
The sample code is as follows.
This example updates the brief consistency verification results of the task whose ID is 137224b7-8d7c-4919-b33e-ed159778xxxx.
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 61 62 63 64 65 66 67 68 |
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.*; import java.util.List; import java.util.ArrayList; public class UpdateConsistencyResultSolution { 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("<YOUR REGION>")) .build(); UpdateConsistencyResultRequest request = new UpdateConsistencyResultRequest(); request.withTaskId("{task_id}"); SetConsistencyResultRequestBody body = new SetConsistencyResultRequestBody(); List<ConsistencyResult> listbodyConsistencyResult = new ArrayList<>(); listbodyConsistencyResult.add( new ConsistencyResult() .withDirCheck("/root/data") .withNumTotalFiles(1235) .withNumDifferentFiles(12) .withNumTargetMissFiles(12) .withNumTargetMoreFiles(12) ); listbodyConsistencyResult.add( new ConsistencyResult() .withDirCheck("/var") .withNumTotalFiles(1235) .withNumDifferentFiles(12) .withNumTargetMissFiles(12) .withNumTargetMoreFiles(12) ); body.withConsistencyResult(listbodyConsistencyResult); request.withBody(body); try { UpdateConsistencyResultResponse response = client.updateConsistencyResult(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()); } } } |
This example updates the brief consistency verification results of the task whose ID is 137224b7-8d7c-4919-b33e-ed159778xxxx.
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 |
# 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("<YOUR REGION>")) \ .build() try: request = UpdateConsistencyResultRequest() request.task_id = "{task_id}" listConsistencyResultbody = [ ConsistencyResult( dir_check="/root/data", num_total_files=1235, num_different_files=12, num_target_miss_files=12, num_target_more_files=12 ), ConsistencyResult( dir_check="/var", num_total_files=1235, num_different_files=12, num_target_miss_files=12, num_target_more_files=12 ) ] request.body = SetConsistencyResultRequestBody( consistency_result=listConsistencyResultbody ) response = client.update_consistency_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) |
This example updates the brief consistency verification results of the task whose ID is 137224b7-8d7c-4919-b33e-ed159778xxxx.
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 |
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 := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := sms.NewSmsClient( sms.SmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateConsistencyResultRequest{} request.TaskId = "{task_id}" var listConsistencyResultbody = []model.ConsistencyResult{ { DirCheck: "/root/data", NumTotalFiles: int32(1235), NumDifferentFiles: int32(12), NumTargetMissFiles: int32(12), NumTargetMoreFiles: int32(12), }, { DirCheck: "/var", NumTotalFiles: int32(1235), NumDifferentFiles: int32(12), NumTargetMissFiles: int32(12), NumTargetMoreFiles: int32(12), }, } request.Body = &model.SetConsistencyResultRequestBody{ ConsistencyResult: &listConsistencyResultbody, } response, err := client.UpdateConsistencyResult(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK code examples in more programming languages, visit API Explorer and click the Sample Code tab. Example code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The consistency verification results were updated. |
|
400 |
The request parameters were missing. |
|
403 |
Authentication failed. |
|
404 |
The task was not found. |
|
500 |
Uploading the brief consistency verification results failed. |
Error Codes
For details, see Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot