查询租户下文件列表
功能介绍
查询租户下文件列表。
调用方法
请参见如何调用API。
URI
GET /v2/keystore/list
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_size |
否 |
Integer |
参数解释: 每页显示的条目数量。 约束限制: page_size小于等于100。 取值范围: 1-100。 默认取值: 10 |
page |
否 |
Integer |
参数解释: 分页页码,表示从此页开始查询。 约束限制: page大于等于1。 取值范围: 不涉及。 默认取值: 1 |
search |
否 |
String |
参数解释: 搜索的文件名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。(响应消息头中X-Subject-Token的值)。通过调用IAM服务接口获取,参考获取IAM用户Token。 约束限制: 不支持租户全局token,请使用scope为project的region级token。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 租户下文件列表。 取值范围: 不涉及。 |
error |
String |
参数解释: 返回错误信息。 取值范围: 不涉及。 |
status |
String |
参数解释: 返回状态信息。 取值范围: ● success:表示接口调用成功。 ● fail:表示接口调用失败。 |
参数 |
参数类型 |
描述 |
---|---|---|
total |
Number |
参数解释: 总数。 取值范围: 不涉及。 |
keystore_list |
Array of keystore_list objects |
参数解释: 文件列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 文件ID。 取值范围: 不涉及。 |
permission |
permission object |
参数解释: 权限。 取值范围: 不涉及。 |
create_time_stamp |
String |
参数解释: 创建时间戳。 取值范围: 不涉及。 |
update_time_stamp |
String |
参数解释: 修改时间戳。 取值范围: 不涉及。 |
domain_id |
String |
参数解释: 租户ID。 取值范围: 不涉及。 |
domain_name |
String |
参数解释: 租户名。 取值范围: 不涉及。 |
keystore_name |
String |
参数解释: 文件名。 取值范围: 不涉及。 |
create_user_id |
String |
参数解释: 文件创建者用户ID。 取值范围: 不涉及。 |
create_user_name |
String |
参数解释: 文件创建者用户名。 取值范围: 不涉及。 |
update_user_id |
String |
参数解释: 文件修改者用户ID。 取值范围: 不涉及。 |
update_user_name |
String |
参数解释: 文件修改者用户名。 取值范围: 不涉及。 |
share |
Number |
参数解释: 是否共享,开启后允许租户内所有成员在编译构建中使用该文件。 取值范围: 不涉及。 |
create_time |
String |
参数解释: 更新时间。 取值范围: 不涉及。 |
update_time |
String |
参数解释: 更新时间。 取值范围: 不涉及。 |
description |
String |
参数解释: 描述信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
keystore_id |
String |
参数解释: 文件ID。 取值范围: 不涉及。 |
setting |
Boolean |
参数解释: 是否有设置权限。 取值范围: ● true:有设置权限。 ● false:没有设置权限。 |
delete |
Boolean |
参数解释: 是否有删除权限。 取值范围: ● true:有删除权限。 ● false:没有删除权限。 |
modify |
Boolean |
参数解释: 是否有修改权限。 取值范围: ● true:有修改权限。 ● false:没有修改权限。 |
usage |
Boolean |
参数解释: 是否有使用权限。 取值范围: ● true:有使用权限。 ● false:没有使用权限。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v2/keystore/list
响应示例
状态码:200
OK
{ "result" : { "total" : 1, "keystore_list" : [ { "id" : "787dd84682aa4e78947af56277422259", "permission" : { "setting" : true, "delete" : true, "modify" : true, "usage" : true, "keystore_id" : "787dd84682aa4e78947af56277422259" }, "create_time_stamp" : "1727084554", "update_time_stamp" : "1727084565", "domain_id" : "60021bab32fd450aa2cb89226f425e06", "domain_name" : "testUser", "keystore_name" : "settings1111.xml", "create_user_id" : "ae22fd035f354cfa8d82a3f1c8940446", "create_user_name" : "testUser", "update_user_id" : "ae22fd035f354cfa8d82a3f1c8940446", "update_user_name" : "testUser", "share" : 1, "create_time" : "2024-9-23 17:42", "update_time" : "2024-9-23 17:42", "description" : "" } ] }, "error" : null, "status" : "success" }
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.codeartsbuild.v3.region.CodeArtsBuildRegion; import com.huaweicloud.sdk.codeartsbuild.v3.*; import com.huaweicloud.sdk.codeartsbuild.v3.model.*; public class ListKeystoreSearchSolution { 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); CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>")) .build(); ListKeystoreSearchRequest request = new ListKeystoreSearchRequest(); try { ListKeystoreSearchResponse response = client.listKeystoreSearch(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 huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsbuild.v3 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 = CodeArtsBuildClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListKeystoreSearchRequest() response = client.list_keystore_search(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" codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/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 := codeartsbuild.NewCodeArtsBuildClient( codeartsbuild.CodeArtsBuildClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListKeystoreSearchRequest{} response, err := client.ListKeystoreSearch(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。