更新时间:2025-07-28 GMT+08:00
分享

查询项目的模块列表

功能介绍

查询项目的模块列表

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/modules

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

正则表达式,[A-Za-z0-9]{32}。

取值范围:

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

分页索引,偏移量,offset是limit的整数倍数。

约束限制:

从0开始。

取值范围:

最小值:0,最大值:10000。

默认取值:

缺省值:0

limit

Integer

参数解释:

条数,每页显示查询的数量。

约束限制:

不涉及。

取值范围:

最小值:1,最大值:1000。

默认取值:

10

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

modules

Array of ProjectModule objects

参数解释:

模块列表

total

Integer

参数解释:

模块总数

取值范围:

不涉及

表4 ProjectModule

参数

参数类型

描述

children

Array of ProjectChildModule objects

参数解释:

子模块信息

deepth

Integer

参数解释:

模块层级

取值范围:

不涉及

is_parent

Boolean

参数解释:

是否是父级,true父模块, false非父模块。

取值范围:

true,false

module_id

Integer

参数解释:

模块id

取值范围:

不涉及

module_name

String

参数解释:

模块名称

取值范围:

不涉及

owner

ModuleOwner object

参数解释:

模块归属人信息

表5 ProjectChildModule

参数

参数类型

描述

deepth

Integer

参数解释:

模块层级

取值范围:

不涉及

is_parent

Boolean

参数解释:

是否是父级,true父模块, false非父模块。

取值范围:

true,false

module_id

Integer

参数解释:

模块id

取值范围:

不涉及

module_name

String

参数解释:

模块名称

取值范围:

不涉及

owner

ModuleOwner object

参数解释:

模板归属人信息

parent_module_id

Integer

参数解释:

父模块id

取值范围:

不涉及

表6 ModuleOwner

参数

参数类型

描述

nick_name

String

参数解释:

用户昵称。

取值范围:

不涉及。

user_id

String

参数解释:

用户32位字符串id。

取值范围:

不涉及。

user_name

String

参数解释:

用户名称。

取值范围:

不涉及。

user_num_id

Integer

参数解释:

用户数字id。

取值范围:

不涉及。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

Get https://{endpoint}/v4/projects/0792b7d26cb74bd799cbae80063dc74a/modules

响应示例

状态码:200

OK

{
  "total" : 1,
  "modules" : [ {
    "module_id" : 1,
    "module_name" : "demo",
    "owner" : {
      "user_id" : "09d75cde5180d4481f91c018e89cb8e2",
      "user_num_id" : 4091,
      "user_name" : "demo_user_name_06",
      "nick_name" : "demo"
    },
    "deepth" : 1,
    "is_parent" : true,
    "children" : [ {
      "module_id" : 1,
      "module_name" : "demo",
      "owner" : {
        "user_id" : "09d75cde5180d4481f91c018e89cb8e2",
        "user_num_id" : 4091,
        "user_name" : "demo_user_name_06",
        "nick_name" : "demo"
      },
      "deepth" : 1,
      "is_parent" : true,
      "parent_module_id" : 1
    } ]
  } ]
}

SDK代码示例

SDK代码示例如下。

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion;
import com.huaweicloud.sdk.projectman.v4.*;
import com.huaweicloud.sdk.projectman.v4.model.*;


public class ListProjectModulesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        ProjectManClient client = ProjectManClient.newBuilder()
                .withCredential(auth)
                .withRegion(ProjectManRegion.valueOf("<YOUR REGION>"))
                .build();
        ListProjectModulesRequest request = new ListProjectModulesRequest();
        request.withProjectId("{project_id}");
        try {
            ListProjectModulesResponse response = client.listProjectModules(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkprojectman.v4 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = ProjectManClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListProjectModulesRequest()
        request.project_id = "{project_id}"
        response = client.list_project_modules(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := projectman.NewProjectManClient(
        projectman.ProjectManClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListProjectModulesRequest{}
	request.ProjectId = "{project_id}"
	response, err := client.ListProjectModules(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档