# 获取工程关联的公共关键字信息和公共关键字所属公共关键字库信息 - ListPublicLibAndAws #### 功能介绍 根据工程唯一标识获取工程关联的公共关键字信息和公共关键字所属公共关键字库信息 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI GET /v1/project/{project_id}/public_aw_lib_and_aws 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **约束限制**: 不涉及 **取值范围**: 项目uuid应符合如下规则：长度等于32位字符，包含大小写字母、数字 **默认取值**: 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 接口调用失败错误码 **取值范围** 不超过256个字符组成的字符串 | | error | [CommonResponseErrorOfAPITest] object | **参数解释** 统一错误返回 **取值范围** 不涉及 | | reason | String | **参数解释** 接口调用失败原因 **取值范围** 不超过1000个字符组成的字符串 | | result | Array of [GetPublicLibAndAwsResp] objects | **参数解释** 公共关键字信息 **取值范围** 不涉及 | | status | String | **参数解释** '状态值，如success、error' **取值范围** - success，请求成功 - error，请求报错 | 表4CommonResponseErrorOfAPITest | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释** 接口调用失败错误码 **取值范围** 不超过256个字符组成的字符串 | | reason | String | **参数解释** 接口调用失败原因 **取值范围** 不超过1000个字符组成的字符串 | 表5GetPublicLibAndAwsResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | aw_tag | String | **参数解释** 公共关键字分组信息 **取值范围** 不超过300个字符组成的字符串 | | document_link | String | **参数解释** 公共关键字帮助文档链接 **取值范围** 不超过300个字符组成的字符串 | | is_favorite | Integer | **参数解释** 是否是当前工程的收藏关键字，该字段不存数据库，每次获取时实时判断 **取值范围** - 0,未收藏 - 1,已收藏 | | public_aw_description | String | **参数解释** 公共关键字描述 **取值范围** 不超过500个字符组成的字符串 | | public_aw_id | String | **参数解释** 公共关键字唯一标识 **取值范围** 32个字符组成的字符串 | | public_aw_lib_id | String | **参数解释** 公共关键库唯一标识 **取值范围** 32个字符组成的字符串 | | public_aw_lib_name | String | 公共关键字库名称 | | public_aw_mark | Integer | 保留字段 | | public_aw_name | String | 公共关键字名称 | **状态码：401** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | **状态码：403** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释** 接口调用失败错误码 **取值范围** 12-18个字符组成的字符串 | | error_msg | String | **参数解释** 接口调用失败错误信息 **取值范围** 3-1000个字符组成的字符串 | #### 请求示例 ``` get https://{endpoint}/v1/26927372bbae40b184fe764e7a0d21f7/public_aw_lib_and_aws ``` #### 响应示例 **状态码：200** SUCCESS ``` { "status" : "success", "result" : [ { "public_aw_id" : "dbc1256e4de44381bad5c426d9341b62", "public_aw_name" : "DubboClient", "public_aw_description" : "访问dubbo服务器。", "public_aw_mark" : null, "is_favorite" : 1, "public_aw_lib_id" : "2111fa8bc9724b999b2c1fea6bc1e8f2", "public_aw_lib_name" : "dubbo-operation-aw", "aw_tag" : "协议", "document_link" : "https://support.huaweicloud.com/usermanual-testman/cloudtest_01_1320.html" } ], "reason" : null, "error" : null, "code" : null } ``` #### SDK代码示例 SDK代码示例如下。 #### Java ``` 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.cloudtest.v1.region.CloudtestRegion; import com.huaweicloud.sdk.cloudtest.v1.*; import com.huaweicloud.sdk.cloudtest.v1.model.*; public class ListPublicLibAndAwsSolution { 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); CloudtestClient client = CloudtestClient.newBuilder() .withCredential(auth) .withRegion(CloudtestRegion.valueOf("")) .build(); ListPublicLibAndAwsRequest request = new ListPublicLibAndAwsRequest(); request.withProjectId("{project_id}"); try { ListPublicLibAndAwsResponse response = client.listPublicLibAndAws(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 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcloudtest.v1.region.cloudtest_region import CloudtestRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcloudtest.v1 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 = CloudtestClient.new_builder() \ .with_credentials(credentials) \ .with_region(CloudtestRegion.value_of("")) \ .build() try: request = ListPublicLibAndAwsRequest() request.project_id = "{project_id}" response = client.list_public_lib_and_aws(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 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" cloudtest "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cloudtest/v1/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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := cloudtest.CloudtestClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := cloudtest.NewCloudtestClient(hcClient) request := &model.ListPublicLibAndAwsRequest{} request.ProjectId = "{project_id}" response, err := client.ListPublicLibAndAws(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudTest/sdk?api=ListPublicLibAndAws)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | SUCCESS | | 401 | Unauthorized | | 403 | Forbidden | | 404 | Not Found | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。