本文以 CreateCloudServer
接口为例,分别对成功返回结果和错误返回结果进行说明。
接口调用成功的返回结果示例如下:
{ "ResponseMetadata": { "RequestId": "20230519170908A23BB9F74AC95F68****", "Action": "CreateCloudServer", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" }, "Result": { "cloud_server_identity": "cloudserver-hgvbfwkpnsq****" } }
接口调用成功后,返回结果中会包含 ResponseMetadata
和 Result
两部分。接口不同,返回的 Result
部分内容也会不同。ResponseMetadata
字段解释如下:
字段 | 说明 |
---|---|
RequestID | RequestID 为每个 API 请求的唯一标识。 |
Action | 接口的名称。 |
Version | 接口的版本。 |
Service | 请求的服务。 |
Region | 请求的 Region。 |
接口调用失败的返回结果示例如下:
{ "ResponseMetadata": { "RequestId": "20230628195604A7B1D0D1B76CB85B****", "Action": "CreateCloudServer", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1", "Error": { "Code": "ImageNotFound", "Message": "Image not found" } } }
相较于成功返回结果,错误返回结果将不再有 Result
部分,ResponseMetadata
中会出现 Error
字段。Error
字段解释如下:
字段 | 说明 |
---|---|
Code | |
Message | Message 描述了错误发生的具体原因,供您排查问题参考。 |