批量绑定SSH密钥对
功能介绍
给指定的虚拟机批量绑定新的SSH密钥对。
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/keypairs/batch-associate
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
batch_keypairs |
是 |
Array of AssociateKeypairRequestBody objects |
最多可同时选择10个弹性云服务器绑定密钥对。 约束:只支持选择相同的密钥对,弹性云服务器处于“运行中”状态,并未绑定密钥对。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
keypair_name |
是 |
String |
SSH密钥对的名称 |
server |
是 |
EcsServerInfo object |
需要绑定密钥对的虚拟机信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
需要绑定(替换或重置)SSH密钥对的虚拟机id |
auth |
否 |
Auth object |
可选字段,鉴权认证类型。替换时需要该参数,重置时不需要该参数。 |
disable_password |
否 |
Boolean |
|
port |
否 |
Long |
SSH监听端口。 |
响应参数
状态码: 202
参数 |
参数类型 |
描述 |
---|---|---|
tasks |
Array of TaskResponseBody objects |
批量绑定密钥对任务。 |
参数 |
参数类型 |
描述 |
---|---|---|
task_id |
String |
任务下发成功返回的ID。 |
server_id |
String |
绑定的虚拟机id。 |
status |
String |
任务下发的状态。SUCCESS或FAILED。 |
error_code |
String |
任务下发失败返回的错误码。 |
error_msg |
String |
任务下发失败返回的错误信息。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
{ "batch_keypairs" : [ { "keypair_name" : "1", "server" : { "id" : "fxxx16e3-74b8-4025-9852-1f451932c20c", "disable_password" : false, "auth" : { "type" : "password", "key" : "password" } } }, { "keypair_name" : "1", "server" : { "id" : "4xxxxfc4-b4bf-49c2-b983-a1811c9760c1", "disable_password" : false, "auth" : { "type" : "password", "key" : "password" } } } ] }
响应示例
状态码: 202
请求已成功。
{ "tasks" : [ { "server_id" : "xxx", "task_id" : "xxx", "status" : "SUCCESS" }, { "server_id" : "xxx", "status" : "Failed", "error_code" : "xxxx", "error_msg" : "xxxx" } ] }
状态码: 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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
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.*; import java.util.List; import java.util.ArrayList; public class BatchAssociateKeypairSolution { 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(); BatchAssociateKeypairRequest request = new BatchAssociateKeypairRequest(); BatchAssociateKeypairRequestBody body = new BatchAssociateKeypairRequestBody(); Auth authServer = new Auth(); authServer.withType(Auth.TypeEnum.fromValue("password")) .withKey("password"); EcsServerInfo serverBatchKeypairs = new EcsServerInfo(); serverBatchKeypairs.withId("4xxxxfc4-b4bf-49c2-b983-a1811c9760c1") .withAuth(authServer) .withDisablePassword(false); Auth authServer1 = new Auth(); authServer1.withType(Auth.TypeEnum.fromValue("password")) .withKey("password"); EcsServerInfo serverBatchKeypairs1 = new EcsServerInfo(); serverBatchKeypairs1.withId("fxxx16e3-74b8-4025-9852-1f451932c20c") .withAuth(authServer1) .withDisablePassword(false); List<AssociateKeypairRequestBody> listbodyBatchKeypairs = new ArrayList<>(); listbodyBatchKeypairs.add( new AssociateKeypairRequestBody() .withKeypairName("1") .withServer(serverBatchKeypairs1) ); listbodyBatchKeypairs.add( new AssociateKeypairRequestBody() .withKeypairName("1") .withServer(serverBatchKeypairs) ); body.withBatchKeypairs(listbodyBatchKeypairs); request.withBody(body); try { BatchAssociateKeypairResponse response = client.batchAssociateKeypair(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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# 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 = BatchAssociateKeypairRequest() authServer = Auth( type="password", key="password" ) serverBatchKeypairs = EcsServerInfo( id="4xxxxfc4-b4bf-49c2-b983-a1811c9760c1", auth=authServer, disable_password=False ) authServer1 = Auth( type="password", key="password" ) serverBatchKeypairs1 = EcsServerInfo( id="fxxx16e3-74b8-4025-9852-1f451932c20c", auth=authServer1, disable_password=False ) listBatchKeypairsbody = [ AssociateKeypairRequestBody( keypair_name="1", server=serverBatchKeypairs1 ), AssociateKeypairRequestBody( keypair_name="1", server=serverBatchKeypairs ) ] request.body = BatchAssociateKeypairRequestBody( batch_keypairs=listBatchKeypairsbody ) response = client.batch_associate_keypair(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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
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.BatchAssociateKeypairRequest{} typeAuth:= model.GetAuthTypeEnum().PASSWORD keyAuth:= "password" authServer := &model.Auth{ Type: &typeAuth, Key: &keyAuth, } disablePasswordServer:= false serverBatchKeypairs := &model.EcsServerInfo{ Id: "4xxxxfc4-b4bf-49c2-b983-a1811c9760c1", Auth: authServer, DisablePassword: &disablePasswordServer, } typeAuth1:= model.GetAuthTypeEnum().PASSWORD keyAuth1:= "password" authServer1 := &model.Auth{ Type: &typeAuth1, Key: &keyAuth1, } disablePasswordServer1:= false serverBatchKeypairs1 := &model.EcsServerInfo{ Id: "fxxx16e3-74b8-4025-9852-1f451932c20c", Auth: authServer1, DisablePassword: &disablePasswordServer1, } var listBatchKeypairsbody = []model.AssociateKeypairRequestBody{ { KeypairName: "1", Server: serverBatchKeypairs1, }, { KeypairName: "1", Server: serverBatchKeypairs, }, } request.Body = &model.BatchAssociateKeypairRequestBody{ BatchKeypairs: listBatchKeypairsbody, } response, err := client.BatchAssociateKeypair(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
202 |
请求已成功。 |
400 |
Error response |
错误码
请参见错误码。