获取仓库保护Tag列表
功能介绍
获取仓库保护Tag列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v4/repositories/{repository_id}/protected-tags
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
repository_id |
是 |
Integer |
参数解释: 仓库的ID,通过查询用户所有仓库接口查询项目列表获取。 约束限制: 不涉及。 取值范围: 1-2147483647 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
参数解释: 偏移量,从0开始。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
参数解释: 返回数量。 取值范围: 1-100 默认取值: 20 |
search |
否 |
String |
参数解释: 查询关键字,可模糊匹配保护Tag名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
[数组元素] |
Array of RepositoryProtectedTagDto objects |
仓库保护Tag列表 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 保护Tag ID。 取值范围: 1-2147483647 |
name |
String |
参数解释: 分支名称或通配符。 取值范围: 不涉及 |
actions |
Array of RepositoryProtectedActionDto objects |
参数解释: 事件列表。 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
action |
String |
参数解释: 事件名称。 取值范围: 不涉及。 |
enable |
Boolean |
参数解释: 是否启用。 取值范围:
|
users |
Array of RepositoryUserDto objects |
参数解释: 白名单用户列表。 取值范围: 不涉及。 |
user_teams |
Array of UserTeamBasicDto objects |
参数解释: 白名单用户组列表。 取值范围: 不涉及。 |
roles |
Array of BasicRoleDto objects |
参数解释: 白名单角色列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 用户id。 取值范围: 1-2147483647 |
name |
String |
参数解释: 用户名称。 |
username |
String |
参数解释: 用户名。 |
state |
String |
参数解释: 用户状态。 取值范围:
枚举值:
|
avatar_url |
String |
参数解释: 头像地址。 取值范围: 不涉及。 |
nick_name |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
tenant_name |
String |
参数解释: 所属租户名称。 取值范围: 不涉及。 |
请求示例
无
响应示例
状态码:200
仓库保护Tag列表
[ { "id" : 124607, "name" : "ttt7", "actions" : [ { "action" : "create", "enable" : true, "users" : [ { "id" : 9087, "name" : "test11", "username" : "04ef19ad5eaf4b8c9cf2451d3536202d", "state" : "blocked", "avatar_url" : "", "nick_name" : "", "tenant_name" : "t1" }, { "id" : 9090, "name" : "test3", "username" : "ba1bd837aa09470ba4ccf0cebb837f89", "state" : "blocked", "avatar_url" : "", "nick_name" : "", "tenant_name" : "t1" }, { "id" : 9093, "name" : "test444", "username" : "a225d72a70df46c3a15915285be1eeb3", "state" : "blocked", "avatar_url" : "", "nick_name" : "", "tenant_name" : "t1" } ], "user_teams" : [ { "id" : 247, "name" : "team-1" } ], "roles" : [ { "id" : 23836595, "name" : "Administrator", "related_role_id" : "7a96af96176e4f728f571b8af8551dec", "chinese_name" : "项目管理员" }, { "id" : 23836597, "name" : "Test manager", "related_role_id" : "24f72d0b611746c3a43da596ea5065f5", "chinese_name" : "测试经理" }, { "id" : 23836612, "name" : "customer_role_1", "related_role_id" : "31bcd56943f0491fbc2f410d163f70cc", "chinese_name" : "customer_role_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.codehub.v4.region.CodeHubRegion; import com.huaweicloud.sdk.codehub.v4.*; import com.huaweicloud.sdk.codehub.v4.model.*; public class ListProtectedTagsSolution { 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); CodeHubClient client = CodeHubClient.newBuilder() .withCredential(auth) .withRegion(CodeHubRegion.valueOf("<YOUR REGION>")) .build(); ListProtectedTagsRequest request = new ListProtectedTagsRequest(); request.withRepositoryId({repository_id}); try { ListProtectedTagsResponse response = client.listProtectedTags(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 huaweicloudsdkcodehub.v4.region.codehub_region import CodeHubRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodehub.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 = CodeHubClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeHubRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListProtectedTagsRequest() request.repository_id = {repository_id} response = client.list_protected_tags(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" codehub "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codehub/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 := codehub.NewCodeHubClient( codehub.CodeHubClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListProtectedTagsRequest{} request.RepositoryId = int32({repository_id}) response, err := client.ListProtectedTags(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
仓库保护Tag列表 |
错误码
请参见错误码。