更新时间:2023-12-28 GMT+08:00
分享

返回结果

状态码

请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。

状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码

对于创建&更新北向NA信息接口,如果调用后返回状态码为“200”,则表示请求成功。

响应消息头

对应请求消息头,响应同样也有消息头,如“Content-type”等。

对于创建&更新北向NA信息接口,平台会返回“Content-type”、Date等消息头。

响应消息体

响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。

对于创建&更新北向NA信息接口,返回如下消息体。为篇幅起见,这里只展示部分内容。

{
  "application/json" : {
    "name" : "北向系统1",
    "description" : "这是一个北向NA",
    "endpoint" : "https://068b72f3b75444dda67cc6e2286a4c20.apic.cn-south-1.huaweicloudapis.com",
    "auth_type" : "AKSK",
    "auth_aksk_info" : {
      "secret" : "123456"
    },
    "access_type" : "ROMA",
    "access_roma_info" : {
      "app_key" : "ebf59208-4c6b-4b06-9b69-494e9df475a3",
      "app_secret" : "fa3c8cd144b29771b5873ae6a7efa25b393c86665d2e9ffa34d1309c5cd704ea"
    }
  }
}

  
当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。
{   
    "errorCode": "IoTEdge.03004005", 
    "errorMsg": "The NA name is already used."
}

其中,errorCode表示错误码,errorMsg表示错误描述信息。

相关文档