所有的返回结果都会带上 RequestId、Action、Version、Service、Region 等字段。本文介绍调用存储迁移服务 API 返回结果信息。

正常返回示例

接口调用成功后会返回 RequestId 和接口返回参数，我们称这样的返回为正常返回。HTTP 状态码为 2xx。

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****", 
        "Action": "CreateDataMigrateTask",
        "Version": "2018-01-01",
        "Service": "dms",
        "Region": "cn-beijing" 
    },
    "Result":"..."
}

请求被正常处理后，返回中会包含 ResponseMetadata 和 Result 两部分，Result 视请求的接口而定，不同的接口会有不同的 Result 返回。字段解释如下：

异常返回示例

接口调用出错后，会返回 RequestId 和错误信息，我们称这样的返回为异常返回。HTTP 状态码为 4xx 或者 5xx。
您可以根据接口错误代码 Code 和错误信息 Message，参考公共错误码和接口错误码排查错误。

{
    "ResponseMetadata": {
        "RequestId": "202010201722300102****",
        "Action": "CreateDataMigrateTask",
        "Version": "2018-01-01",
        "Service": "dms",
        "Region": "cn-beijing",
        "Error": {
            "Code": "InvalidStorageType",
            "Message": "Not support this source type."
        }
    }
}

相较于成功结果，错误结果将不再有 Result 部分，而 ResponseMetadata 中将额外出现 Error 字段，包括 Code 和 Message。字段解释如下：