文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 实例管理/ 查询企业项目列表
更新时间：2025-09-25 GMT+08:00
查看PDF
分享

查询企业项目列表

功能介绍

查询企业项目列表。

接口约束

实例资源类型和操作系统需支持pidstat命令。

调试

您可以在API Explorer中调试该接口。

URI

GET /v3/{project_id}/enterprise-projects?name_keyword={name_keyword}&offset={offset}&limit={limit}
表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

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

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

name_keyword

否

String

参数解释：

企业项目名称关键字。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为数字，不能为负数。

取值范围：

不涉及。

默认取值：

默认为0（偏移0条数据，表示从第一条数据开始查询）。

limit

否

Integer

参数解释：

查询记录数。

约束限制：

不能为负数。

取值范围：

最小值为1，最大值为1000。

默认取值：

100

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us。

响应参数

表3 响应参数

参数

参数类型

描述

enterprise_projects

Array of objects

参数解释：

企业项目列表。

total_count

Integer

参数解释：

企业项目总数。

取值范围：

不涉及。
表4 enterprise_projects字段数据结构说明

参数

参数类型

描述

id

String

参数解释：

企业项目ID。

取值范围：

不涉及。

name

String

参数解释：

企业项目名称。

取值范围：

不涉及。

description

String

参数解释：

企业项目描述。

取值范围：

不涉及。

status

String

参数解释：

企业项目状态。

取值范围：

  • 1：启用。
  • 2：停用。

created_at

String

参数解释：

创建时间，格式为UTC格式。如：2018-05-18T06:49:06Z。

取值范围：

不涉及。

updated_at

String

参数解释：

修改时间，格式为UTC格式。如：2018-05-28T02:21:36Z。

取值范围：

不涉及。

请求示例

https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/enterprise-projects?name_keyword=auto&offset=0&limit=100

响应示例

{ 
  "enterprise_projects" : [ { 
    "id" : "6fbcf2f3-3164-4d32-9a3e-a8886dc38c24", 
    "name" : "auto_test", 
    "description" : "auto_test description", 
    "status" : "1", 
    "created_at" : "2018-05-18T06:49:06Z", 
    "updated_at" : "2018-05-28T02:21:36Z" 
  } ], 
  "total_count" : 1 
}

状态码

错误码

请参见错误码。

父主题： 实例管理

相关文档