更新时间:2023-10-23 GMT+08:00

查询企业项目

功能介绍

查询企业项目。

URI

GET /v3/{project_id}/enterprise-projects

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

索引位置,偏移量。从第一条数据偏移offset条数据后开始查询,默认为0(偏移0条数据,表示从第一条数据开始查询),必须为数字,不能为负数。

limit

Integer

查询记录数。默认为100,不能为负数,最小值为1,最大值为100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

String

请求语言类型。默认en-us。

取值范围:

  • en-us
  • zh-cn

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

enterprise_projects

Array of EnterpriseProjectItem objects

企业项目信息列表。

total_count

Integer

总数。

表5 EnterpriseProjectItem

参数

参数类型

描述

id

String

企业项目ID。

name

String

企业项目名称。

description

String

描述。

status

String

状态。

  • 1:正常。
  • 0:异常。

created

String

创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

updated

String

更新时间,格式为“yyyy-mm-ddThh:mm:ssZ”。其中,T指某个时间的开始;Z指时区偏移量,例如偏移1个小时显示为+0100。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询企业项目。

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/enterprise-projects

响应示例

状态码: 200

Success.

{
  "total_count" : 4,
  "enterprise_projects" : [ {
    "id" : 0,
    "name" : "default",
    "description" : null,
    "status" : 1,
    "created" : null,
    "updated" : null
  }, {
    "id" : "5c7d11e0-3201-4558-bcce-1172137cf7e2",
    "name" : "sjw-eps",
    "description" : null,
    "status" : 1,
    "created" : "2023-06-12T02:14:28+0000",
    "updated" : "2023-06-12T02:14:28+0000"
  }, {
    "id" : "12093327-28dc-46c5-8ba6-d42c9236f9d6",
    "name" : "adf",
    "description" : null,
    "status" : 1,
    "created" : "2023-05-06T08:33:03+0000",
    "updated" : "2023-05-06T08:33:03+0000"
  }, {
    "id" : "07d90b3f-422b-40c9-b9b3-6d00d1d7a60b",
    "name" : "eps-test",
    "description" : null,
    "status" : 1,
    "created" : "2023-03-16T01:38:13+0000",
    "updated" : "2023-03-16T01:38:13+0000"
  } ]
}

状态码

请参见状态码

错误码

请参见错误码