返回结果

状态码

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

对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。

响应消息头

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

对于“获取评测集列表”接口（GET /v1/ops/datasets）响应消息头如下所示：

图1 “获取评测集列表”接口响应消息头

响应消息体

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

对于“获取评测集列表”接口（GET /v1/ops/datasets）响应消息体如下所示：

{
    "datasets": [
        {
            "id": "ac9fa470-eb2c-46f8-ba4d-7cf5007d311d",
            "name": "科学知识类场景示例评测集",
            "description": "平台预置30条样本评测集",
            "latest_version_id": "a974a554-4952-4167-9600-4015abdc33ee",
            "latest_version": "0.0.1",
            "item_count": 30,
            "change_uncommitted": false,
            "turn_type": "single",
            "is_preset": true,
            "schemas": [
                {
                    "id": "5dbcea7e-0a37-4436-afe9-e7ca963a10a7",
                    "name": "input",
                    "type": "String",
                    "description": "输入问题",
                    "is_required": true
                },
                {
                    "id": "aa470638-af5f-40ca-aa40-edda6875c2f9",
                    "name": "reference_output",
                    "type": "String",
                    "description": "期望的标准回答",
                    "is_required": true
                },
                {
                    "id": "7c350216-a70e-4250-b1bf-2ed6eca3df86",
                    "name": "output",
                    "type": "String",
                    "description": "大模型的回答",
                    "is_required": true
                }
            ],
            "base_info": {
                "created_time": 1776395147242,
                "updated_time": 1776395147270,
                "created_by": {
                    "name": "hwPersonalaccount",
                    "user_id": "082c85016600258f0fe3c0080c949e20"
                },
                "updated_by": {
                    "name": "hwPersonalaccount",
                    "user_id": "082c85016600258f0fe3c0080c949e20"
                }
            },
            "can_delete": true,
            "reference_count": 0,
            "tags": null
        }
    ],
    "total": 1
}

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

{
    "request_id": "76bf84d8220529196cd80456be50c7be",
    "error_msg": "The API does not exist or has not been published in the environment",
    "error_code": "APIGW.0101"
}

其中，error_code表示错误码，error_msg表示错误描述信息。