查询模型工程列表
功能介绍
- 查询当前用户加入项目下的所有模型工程。
- 查询指定项目下的所有模型工程。
URI
GET /v1/modelprojects
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 否 | String | 参数解释: 所属项目id,传参查询项目下工程,不传则查询用户加入的所有项目下的工程。 通过查询用户的项目获取。 约束限制: 由数字、字母、'-'组成。 取值范围: 0-50位。 默认取值: 不涉及。 |
| offset | 否 | Integer | 参数解释: 偏移量,表示从此偏移量开始查询需配合limit一起使用。 约束限制: 不涉及。 取值范围: 大于等于0。 默认取值: 0。 |
| limit | 否 | Integer | 参数解释: 每次查询的条目数量。 约束限制: 不涉及。 取值范围: 1到200。 默认取值: 10。 |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 接口返回的状态信息 取值范围: success:执行成功, failed:执行失败。 |
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
| result | Object | 参数解释: 响应对象。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| content | Array of content objects | 参数解释: 模型工程响应体内容。 取值范围: 不涉及。 |
| count | Integer | 参数解释: 分页返回的总条数。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| project_id | String | 参数解释: 项目id。 取值范围: 不涉及。 |
| project_name | String | 参数解释: 项目名称。 取值范围: 不涉及。 |
| model_project_uuid | String | 参数解释: 软件建模工程id。 取值范围: 不涉及。 |
| model_project_name | String | 参数解释: 模型工程名称。 取值范围: 不涉及。 |
| description | String | 参数解释: 描述 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v1/modelprojects?project_id=g00e5bfdb9c8846b7af2af550a7ee43aa&offset=0&limit=10 响应示例
状态码: 200
success
{
"status": "success",
"error_code": null,
"error_msg": null,
"result": {
"content": [
{
"project_id": "g00e5bfdb9c8846b7af2af550a7ee43aa",
"project_name": "cloudmodeling-AlphaTest",
"model_project_uuid": "4cb78b8245124259bfaab9c1f6825472",
"model_project_name": "基线变更评审测试",
"description": ""
}
],
"count": 1
}
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | success |
错误码
参考错误码。