文档首页/ IAM 身份中心/ API参考/ 如何调用API/ 返回结果
更新时间：2024-02-06 GMT+08:00
查看PDF
分享

返回结果

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

状态码

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

对于列出实例接口，如果调用后返回状态码为“200”，则表示请求成功。

响应消息头

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

详细的公共响应消息头字段请参见下表。
表1 公共响应消息头

消息头名称

描述

Content-Type

资源内容的类型。

类型：String

默认值：无。

Connection

指明与服务器的连接是长连接还是短连接。

类型：String

有效值：keep-alive | close。

默认值：无。

Date

服务器响应的时间。

类型：String

默认值：无。

X-Request-Id

由服务创建来唯一确定本次请求的值，可以通过该值来定位问题。

类型：String

默认值：无。

响应消息体

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

对于列出实例接口，返回如下消息体。 
{
    "instances": [
        {
            "identity_store_id": "d-66f****b80",
            "instance_id": "ins-2c1e********f3c6",
            "alias": null,
            "instance_urn": "IdentityCenter::system:instance:ins-2c1e********f3c6"
        }
    ],
    "page_info": {
        "next_marker": null,
        "current_count": 1
    }
}

当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。

{
    "error_code": "IIC.1215",
    "error_msg": "only organizations administrator account can operate，please log in to the administrator account!",
    "request_id": "e311530********************51311"
}

其中，error_code表示错误码，error_msg表示错误描述信息，request_id表示由服务创建来唯一确定本次请求的值，可以通过该值来定位问题。

父主题： 如何调用API

相关文档