키 관리 서비스 API를 사용하여 키 관리

IBM Cloud® Hyper Protect Crypto Services 는 암호화 키를 저장, 검색 및 생성하기 위한 키 관리 서비스 API 를 제공합니다.

IBM Cloud 인증 정보 검색

API 관련 작업을 수행하려면 서비스 및 인증용 인증 정보를 생성해야 합니다. 신임 정보를 수집하려면 다음 작업을 수행하십시오.

  1. IBM Cloud IAM 액세스 토큰을 생성하십시오.
  2. Hyper Protect Crypto Services 서비스 인스턴스를 고유하게 식별하는 인스턴스 ID를 검색하십시오.

키 관리 서비스 API 요청 구성

서비스에 대한 API 호출을 작성할 때 처음에 Hyper Protect Crypto Services의 인스턴스를 프로비저닝한 방법에 따라 API 요청을 구조화하십시오.

요청을 빌드하려면 지역 서비스 엔드포인트를 해당 인증용 인증 정보와 쌍으로 묶으십시오. 예를 들어, us-south 지역의 서비스 인스턴스를 작성한 경우 다음 엔드포인트 및 API 헤더를 사용하여 서비스에서 키를 찾아보십시오.

특정 지역에서 2024년 4월 12일 이후에 인스턴스를 작성하는 경우 새 형식이 <instance_ID>.ep11.<REGION>.hs-crypto.appdomain.cloud 인 새 API 엔드포인트를 사용해야 할 수 있습니다. 가능한 날짜는 지역에 따라 다릅니다. 지원되는 지역, 가용성 날짜 및 새 엔드포인트 URL에 대한 자세한 정보는 새 엔드포인트 를 참조하십시오.

curl -X GET \
    https://<INSTANCE_ID>.api.us-south.hs-crypto.appdomain.cloud/api/v2/keys \
    -H 'accept: application/vnd.ibm.collection+json' \
    -H 'authorization: Bearer <access_token>' \
    -H 'bluemix-instance: <instance_ID>'
  • <port>을(를) API 엔드포인트의 포트 번호로 대체하십시오. 개요 > 키 관리 엔드포인트 URL 을 통해 프로비저닝된 서비스 인스턴스 대시보드에서 <port> 를 가져올 수 있습니다. 또는 동적으로 API 엔드포인트 URL을 검색할 수 있습니다.

    Hyper Protect Crypto Services 인스턴스의 포트 범위는 8000- 19999 사이에 있습니다.

    리턴값에는 다음이 포함됩니다.

    {
      "instance_id": "<instance_ID>",
      "kms": {
        "public": "<instance_ID>.api.<region>.hs-crypto.appdomain.cloud",
        "private":"<instance_ID>.api.private.<region>.hs-crypto.appdomain.cloud"
      },
        "ep11": {
        "public": "<instance_ID>.ep11.<region>.hs-crypto.appdomain.cloud",
        "private":"<instance_ID>.ep11.private.<region>.hs-crypto.appdomain.cloud"
      }
    }
    

    키 관리 서비스의 경우 kms 섹션의 <region><instance_ID>을(를) 사용하십시오.

  • <access_token><instance_ID>을(를) 검색된 서비스 및 인증 신임 정보로 대체하십시오.

문제가 발생하는 경우 API 요청을 추적하시겠습니까? cURL 요청의 일부로 -v 플래그를 포함하면 응답 헤더에 correlation-id 값을 갖게 됩니다. 이 값을 사용하여 디버깅을 위해 요청을 상관시키고 추적할 수 있습니다.

다음에 수행할 작업

암호화 키 및 데이터 관리를 시작할 준비가 되었습니다. 프로그래밍 방식으로 키를 관리하는 방법에 대해 자세히 알아보려면 키 관리 서비스 API 참조 문서를 확인하십시오.