查询SSH密钥对列表
功能介绍
查询SSH密钥对列表
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/keypairs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
String |
每页返回的个数。 默认值:50。 |
marker |
否 |
String |
分页查询起始的资源id,为空时为查询第一页 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
SSH密钥对的名称 |
type |
String |
SSH密钥对的类型,值为“ssh”或“x509” |
scope |
String |
租户级或者用户级。domain或user。 |
public_key |
String |
SSH密钥对对应的publicKey信息 |
fingerprint |
String |
SSH密钥对应指纹信息 |
is_key_protection |
Boolean |
是否托管密钥 |
frozen_state |
String |
冻结状态
|
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
返回下一页的查询地址 |
previous_marker |
String |
返回上一页的查询地址 |
current_count |
Integer |
返回条目数量 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
无
响应示例
状态码: 200
请求已成功
{ "keypairs" : [ { "keypair" : { "name" : "1hprr3TI", "type" : "ssh", "scope" : "user", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABjV8GvwpSs.....", "fingerprint" : "65:ca:87:0a:16:86:59:ea:57:ea:18:37:58:e2:04:b0", "is_key_protection" : false, "frozen_state" : 0 } } ], "page_info" : { "next_marker" : "KeyPair-dxxx", "previous_marker" : "KeyPair-xxxx", "current_count" : 49 } }
状态码: 400
Error response
{ "error_code" : "KPS.XXX", "error_msg" : "XXX" }
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 46 47 |
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.kps.v3.region.KpsRegion; import com.huaweicloud.sdk.kps.v3.*; import com.huaweicloud.sdk.kps.v3.model.*; public class ListKeypairsSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); KpsClient client = KpsClient.newBuilder() .withCredential(auth) .withRegion(KpsRegion.valueOf("<YOUR REGION>")) .build(); ListKeypairsRequest request = new ListKeypairsRequest(); try { ListKeypairsResponse response = client.listKeypairs(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 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkkps.v3.region.kps_region import KpsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkkps.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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = KpsClient.new_builder() \ .with_credentials(credentials) \ .with_region(KpsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListKeypairsRequest() response = client.list_keypairs(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 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" kps "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kps/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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := kps.NewKpsClient( kps.KpsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListKeypairsRequest{} response, err := client.ListKeypairs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求已成功 |
400 |
Error response |
错误码
请参见错误码。