查询流水线分组树
功能介绍
查询流水线分组树
调用方法
请参见如何调用API。
URI
GET /v5/{project_id}/api/pipeline-group/tree
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: CodeArts项目ID。 约束限制: 不涉及 取值范围: 32位字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of PipelineGroupVo objects |
参数解释: 流水线分组参数列表,PipelineGroupVo保存流水线分组参数,包含父、子分组的ID。 约束限制: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 分组ID。 取值范围: 32位字符。 |
domain_id |
String |
参数解释: 租户ID。 取值范围: 32位字符。 |
project_id |
String |
参数解释: 项目ID。 取值范围: 32位字符。 |
name |
String |
参数解释: 分组名。 取值范围: 32位字符。 |
parent_id |
String |
参数解释: 父分组ID。 取值范围: 32位字符。 |
path_id |
String |
参数解释: 分组路径ID。例如id1.id2.id3 代表分组id3的父分组为id2,分组id2的父分组为id1。 取值范围: 不涉及。 |
ordinal |
Integer |
参数解释: 序号。 取值范围: 大于等于1。 |
creator |
String |
参数解释: 创建用户ID。 取值范围: 32位字符。 |
updater |
String |
参数解释: 更新用户ID。 取值范围: 32位字符。 |
create_time |
Long |
参数解释: 创建时间。 取值范围: 不涉及。 |
update_time |
Long |
参数解释: 更新时间。 取值范围: 不涉及。 |
children |
Array of PipelineGroupVo objects |
参数解释: 子分组列表。 取值范围: 不涉及。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
参数解释: 错误信息。 取值范围: 不涉及。 |
error_code |
String |
参数解释: 错误码。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipeline-group/tree
响应示例
状态码: 200
参数解释: 流水线分组参数列表,PipelineGroupVo保存流水线分组参数,包含父、子分组的ID。 约束限制: 不涉及。
[ { "id" : "894daf0db79c4ccb839490770fa06596", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组22", "parent_id" : "", "path_id" : "894daf0db79c4ccb839490770fa06596", "ordinal" : 2, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698487536000, "update_time" : null, "children" : null }, { "id" : "2ca78947b25847a9ab68a07d8ef1347b", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组11", "parent_id" : "", "path_id" : "2ca78947b25847a9ab68a07d8ef1347b", "ordinal" : 1, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698487008000, "update_time" : null, "children" : null }, { "id" : "58d55f8a646443a984e7399632b3963e", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "G2", "parent_id" : "", "path_id" : "58d55f8a646443a984e7399632b3963e", "ordinal" : 0, "creator" : "847a5317086c41798469d0868535943a", "updater" : "847a5317086c41798469d0868535943a", "create_time" : 1698484566000, "update_time" : 1698485674000, "children" : [ { "id" : "d805c90bf99049d3a49e83d2024df6b8", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组3", "parent_id" : "58d55f8a646443a984e7399632b3963e", "path_id" : "58d55f8a646443a984e7399632b3963e.d805c90bf99049d3a49e83d2024df6b8", "ordinal" : 1, "creator" : "847a5317086c41798469d0868535943a", "updater" : "847a5317086c41798469d0868535943a", "create_time" : 1698487527000, "update_time" : 1698487868000, "children" : null }, { "id" : "ebb779b3b9f742e181b1f6829fa1aca0", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组", "parent_id" : "58d55f8a646443a984e7399632b3963e", "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0", "ordinal" : 0, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698485344000, "update_time" : null, "children" : [ { "id" : "1b80aa3df0984e9caffefdc4e557524e", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组4", "parent_id" : "ebb779b3b9f742e181b1f6829fa1aca0", "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0.1b80aa3df0984e9caffefdc4e557524e", "ordinal" : 2, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698487502000, "update_time" : null, "children" : null }, { "id" : "6bc8a3cda52c41fe84d71c9ff86161ea", "domain_id" : "ce8df55870164338a72d7e828a966a2a", "project_id" : "d80a8a6530324b7bac972cbb8a9f28ec", "name" : "新建分组3", "parent_id" : "ebb779b3b9f742e181b1f6829fa1aca0", "path_id" : "58d55f8a646443a984e7399632b3963e.ebb779b3b9f742e181b1f6829fa1aca0.6bc8a3cda52c41fe84d71c9ff86161ea", "ordinal" : 1, "creator" : "847a5317086c41798469d0868535943a", "updater" : null, "create_time" : 1698486710000, "update_time" : null, "children" : null } ] } ] } ]
SDK代码示例
SDK代码示例如下。
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 |
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.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; public class ShowPipelineGroupTreeSolution { 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); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>")) .build(); ShowPipelineGroupTreeRequest request = new ShowPipelineGroupTreeRequest(); try { ShowPipelineGroupTreeResponse response = client.showPipelineGroupTree(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.v2 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 = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowPipelineGroupTreeRequest() response = client.show_pipeline_group_tree(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/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 := codeartspipeline.NewCodeArtsPipelineClient( codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowPipelineGroupTreeRequest{} response, err := client.ShowPipelineGroupTree(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
参数解释: 流水线分组参数列表,PipelineGroupVo保存流水线分组参数,包含父、子分组的ID。 约束限制: 不涉及。 |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。