tencent cloud

Cloud Virtual Machine

동향 및 공지
제품 동향
공용 이미지 업데이트 동향
운영 체제 공식 지원 종료 계획
제품 공지
제품 소개
CVM 개요
제품 장점
기본 개념
리전 및 가용존
신규 사용자 가이드
Service Regions and Service Providers
제품 요금
요금 개요
과금 방식
과금 항목
과금 방식 변경 개요
인스턴스 구매
사양 변경 요금 설명
연체 설명
빠른 시작
사용자 정의 Linux 인스턴스 구매
사용자 정의 Windows 인스턴스 구매
사용자 가이드
운영 가이드 개요
사용 제한 개요
인스턴스
스팟 인스턴스
예약 인스턴스
이미지
스토리지
백업 및 복구
네트워크
보안
비밀번호/키
모니터링 및 알람
운영 관리
편리한 기능
서버 마이그레이션
온라인 마이그레이션
마이그레이션 요금
장애 처리
CVM에 로그인할 수 없는 문제 처리 방법
Windows 인스턴스 로그인 관련 장애
Linux 인스턴스 로그인 관련 장애
기타 인스턴스 로그인 관련 장애
인스턴스 실행 장애
Linux 인스턴스 메모리 장애
네트워크 장애
실습 튜토리얼
CVM 선택 제안
환경 구축
웹사이트 구축
애플리케이션 구축
시각화 페이지 구축
로컬 파일을 CVM에 업로드
네트워크 성능 테스트
기타 실습 튜토리얼
API 참조
History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
보안 및 컴플라이언스
Cloud Access Management(CAM)
네트워크
자주 묻는 질문
리전 및 가용존 문제
요금
인스턴스 문제
스토리지 문제
이미지 관련 문제
서버 마이그레이션 관련 문제
네트워크 관련 문제
보안 관련 문제
운영 체제 관련 문제
운영 및 모니터링 관련 문제
CAM 관련 문제
NTP 서비스 관련 문제
적용 시나리오 관련 문제
Agreements
CVM Service Level Agreements
Red Hat Enterprise Linux Image Service Agreement
Public IP Service Level Agreement
용어집

ImportKeyPair

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-10-30 21:37:48

1. API Description

Domain name for API request: cvm.intl.tencentcloudapi.com.

This API is used to import key pairs.

  • You can use this API to import key pairs to a user account, but the key pairs will not be automatically associated with any instance. You may use AssociasteInstancesKeyPair to associate key pairs with instances.
  • You need to specify the names of the key pairs and the content of the public keys.
  • If you only have private keys, you can convert them to public keys with the SSL tool before importing them.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ImportKeyPair.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
KeyName Yes String Key pair name, which can contain numbers, letters, and underscores, with a maximum length of 25 characters.
ProjectId Yes Integer The project ID to which the key pair belongs after it is created.

You can obtain the project ID in the following ways:
  • Check the project list in the Project management page.
  • Call the DescribeProject API and view the projectId in the response.

    If you want to use the default project, specify 0 for the parameter.
  • PublicKey Yes String Content of the public key in the key pair in the OpenSSH RSA format.
    TagSpecification.N No Array of TagSpecification Tag description list. This parameter is used to bind a tag to a key pair.

    3. Output Parameters

    Parameter Name Type Description
    KeyId String Key pair ID
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Importing a key pair

    Input Example

    POST / HTTP/1.1
    Host: cvm.intl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ImportKeyPair
    <Common request parameters>
    
    {
        "ProjectId": "0",
        "KeyName": "operation_key",
        "PublicKey": "ssh-rsa XXXXXXXXXXXX== skey_45071"
    }

    Output Example

    {
        "Response": {
            "KeyId": "skey-4e5ty7i8",
            "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
        }
    }

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalServerError Internal error.
    InvalidKeyPair.LimitExceeded The number of key pairs exceeds the limit.
    InvalidKeyPairName.Duplicate Key pair name already exists.
    InvalidKeyPairNameEmpty The key name cannot be empty.
    InvalidKeyPairNameIncludeIllegalChar The key name contains invalid characters. Key names can only contain letters, numbers and underscores.
    InvalidKeyPairNameTooLong The key name cannot exceed 25 characters.
    InvalidParameterValue Incorrect parameter value.
    InvalidProjectId.NotFound Invalid project ID: the specified project ID does not exist.
    InvalidPublicKey.Duplicate Invalid public key: the specified key already exists.
    InvalidPublicKey.Malformed Invalid public key: the specified public key does not meet the OpenSSH RSA format requirements.
    LimitExceeded.TagResourceQuota Exceeded the upper limit of resources bound to the tag.
    MissingParameter Missing parameter.

    도움말 및 지원

    문제 해결에 도움이 되었나요?

    피드백