CreateKeyPair - - Alibaba Cloud Dokümantasyon Merkezi

Operation description

CreateKeyPair çağrısı yaparak bir anahtar çifti oluşturmanın yanı sıra, bir anahtar çifti oluşturmak için üçüncü taraf bir araç kullanabilir ve ardından bunu bir bölgeye (ImportKeyPair) yükleyebilirsiniz. Üçüncü taraf bir araçla oluşturulan anahtar çiftinin kullanımı, sistem tarafından oluşturulan anahtar çiftinin kullanımıyla aynıdır.

Her bölgede en fazla 500 anahtar çiftiniz olabilir. Daha fazla bilgi için Sınırlar sayfasına bakın.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:CreateKeyPair

create

*KeyPair

acs:ecs:{#regionId}:{#accountId}:keypair/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Anahtar çiftinin bölge kimliği. En son bölge listesini sorgulamak için DescribeRegions API'sini çağırabilirsiniz.	cn-hangzhou
KeyPairName	string	Yes	Anahtar çiftinin adı. Ad 2 ila 128 karakter uzunluğunda olmalıdır ve harf, rakam, iki nokta üst üste (:), alt çizgi (_) ve tire (-) içerebilir. Ad bir harfle başlamalıdır ve http:// veya https:// ile başlayamaz.	testKeyPairName
ResourceGroupId	string	No	SSH anahtar çiftinin ait olduğu kaynak grubunun kimliği.	rg-bp67acfmxazb4p****
Tag	array<object>	No	Etiketler.
	object	No	Etiketler.
Key	string	No	Anahtar çiftinin N etiketinin anahtarı. N için geçerli değerler: 1 ile 20 arası. Etiket anahtarı boş bir dize olamaz. Etiket anahtarı en fazla 128 karakter uzunluğunda olabilir ve aliyun veya acs: ile başlayamaz. Etiket anahtarı http:// veya https:// içeremez.	TestKey
Value	string	No	Anahtar çiftinin N etiketinin değeri. N için geçerli değerler: 1 ile 20 arası. Etiket değeri boş bir dize olabilir. Etiket değeri en fazla 128 karakter uzunluğunda olabilir ve acs: ile başlayamaz. Etiket değeri http:// veya https:// içeremez.	TestValue

Response elements

Element	Type	Description	Example
	object
PrivateKeyBody	string	Anahtar çiftinin özel anahtarı. Özel anahtar PKCS#8 formatında PEM kodludur.	MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****
KeyPairName	string	Anahtar çiftinin adı.	testKeyPairName
KeyPairId	string	SSH anahtar çiftinin kimliği.	ssh-bp67acfmxazb4p****
RequestId	string	İstek kimliği.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
KeyPairFingerPrint	string	Anahtar çiftinin parmak izi. Ortak anahtar parmak izi formatı RFC 4716 tarafından tanımlanmıştır ve MD5 mesaj özeti algoritmasını kullanır. Daha fazla bilgi için RFC 4716 belgesine bakın.	89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:**

Examples

Success response

JSON format

{
  "PrivateKeyBody": "MIIEpAIBAAKCAQEAtReyMzLIcBH78EV2zj****",
  "KeyPairName": "testKeyPairName",
  "KeyPairId": "ssh-bp67acfmxazb4p****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "KeyPairFingerPrint": "89:f0:ba:62:ac:b8:aa:e1:61:5e:fd:81:69:86:6d:6b:f0:c0:5a:**"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidKeyPairName.Malformed	Specified Key Pair name is not valid.	The key pair name is invalid.
400	KeyPair.AlreadyExist	The key pair already exist.	A key pair with the same name already exists. Key pair names must be unique.
400	Duplicate.TagKey	The Tag.N.Key contain duplicate key.	The specified tag key already exists. Tag keys must be unique.
400	InvalidTagKey.Malformed	The specified Tag.n.Key is not valid.	The specified Tag.N.Key parameter is invalid.
400	InvalidTagValue.Malformed	The specified Tag.n.Value is not valid.	The specified tag value is invalid.
403	QuotaExceed.KeyPair	The key pair quota exceeds.
403	QuotaExceed.Tags	%s	The number of specified tags exceeds the upper limit. %s is a variable. An error message is dynamically returned based on call conditions.
404	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.	Region information error
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	The specified resource group does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.