文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ User/ 获取当前用户的gpg_key列表
更新时间:2025-09-28 GMT+08:00
分享

获取当前用户的gpg_key列表

功能介绍

获取当前用户的gpg_key列表

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v4/user/gpg-keys

表1 Query参数

参数

是否必选

参数类型

描述

query

String

参数解释:

key的标题名称。

取值范围:

字符串长度不少于1,不超过2000。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

Integer

参数解释:

记录id。

取值范围:

1-2147483647

created_at

String

参数解释:

创建时间。

取值范围:

字符串长度不少于1,不超过1000。

emails_with_verified_status

Map<String,Boolean>

参数解释:

解析到的邮箱列表以及是否生效。

fingerprint

String

参数解释:

主密/公钥的指纹格式。

取值范围:

字符串长度不少于1,不超过1000。

key

String

参数解释:

gpg的公钥。

取值范围:

字符串长度不少于1,不超过1000。

description

String

参数解释:

描述。

取值范围:

字符串长度不少于1,不超过1000。

title

String

参数解释:

gpg_key的标题。

取值范围:

字符串长度不少于1,不超过1000。

primary_keyid

String

参数解释:

主密/公钥primary_key的id。

取值范围:

字符串长度不少于1,不超过1000。

active

Boolean

参数解释:

是否生效。

subkeys

Array of GpgSubKeyDto objects

参数解释:

子钥列表。

取值范围:

列表长度不少于0,不超过1000。

表4 GpgSubKeyDto

参数

参数类型

描述

id

Integer

参数解释:

子公钥subkey的id。

取值范围:

1-2147483647

fingerprint

String

参数解释:

子公钥的指纹格式。

取值范围:

字符串长度不少于1,不超过1000。

gpg_key_id

Integer

参数解释:

gpg_key的id。

取值范围:

1-2147483647

keyid

String

参数解释:

子密钥的id。

取值范围:

字符串长度不少于1,不超过1000。

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:403

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

状态码:404

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/user/gpg-keys

响应示例

状态码:200

获取当前用户的gpg_key列表

{
  "id" : 116,
  "created_at" : "2025-04-09T17:37:49.000+08:00",
  "emails_with_verified_status" : {
    "1@email.com" : false
  },
  "fingerprint" : "---",
  "key" : "-----",
  "description" : "---",
  "title" : "test_gpg",
  "primary_keyid" : "---",
  "active" : true,
  "subkeys" : [ {
    "id" : 159,
    "fingerprint" : "---",
    "gpg_key_id" : 116,
    "keyid" : "---"
  } ]
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码:403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限,请升级权限后重试。"
}

状态码:404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "Group Not Found。Group Not Found"
}

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
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 ListUserGpgKeysSolution {

    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();
        ListUserGpgKeysRequest request = new ListUserGpgKeysRequest();
        try {
            ListUserGpgKeysResponse response = client.listUserGpgKeys(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
# 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 = ListUserGpgKeysRequest()
        response = client.list_user_gpg_keys(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
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.ListUserGpgKeysRequest{}
	response, err := client.ListUserGpgKeys(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

获取当前用户的gpg_key列表

401

Unauthorized

403

Bad Request

404

Not Found

错误码

请参见错误码

相关文档