상태별 키 검색

Key Protect 인스턴스에서 특정 키의 상태를 필터링하여 지정한 상태의 키를 검색할 수 있습니다.

예를 들어, Key Protect 인스턴스에 활성, 일시중단됨 및 삭제됨 상태의 키가 있을 수 있지만, 키 목록을 검색할 때 활성 상태의 키만 검색하려고 합니다.

키 상태에 대한 자세한 정보는 키 상태 및 상태 전이를 참조하십시오.

키를 작성하거나 기존 키를 서비스로 가져오고 나면 키를 볼 수 있는 두 가지 옵션이 있습니다. 첫 번째 옵션인 리소스 목록을 통한 키 보기는 세분화된 액세스 권한이 있는 키를 제외한 모든 키에 대해 작동합니다. 세분화된 액세스 권한이 있는 키 보기에 대한 자세한 내용은 세분화된 액세스 권한 키 IAM 보기를 참조하세요.

키 목록 검색

상위 레벨 보기의 경우에는 다음 엔드포인트에 대한 GET 호출을 작성하여 Key Protect의 프로비저닝된 인스턴스에서 관리되는 키를 찾아볼 수 있습니다.

https://<region>.kms.cloud.ibm.com/api/v2/keys

1. 인증 정보를 검색하여 서비스에서 키에 대한 작업을 수행하십시오.

2. 다음 curl 명령을 실행하여 키에 대한 일반 특성을 보십시오.

   $ curl -X GET \
       "https://<region>.kms.cloud.ibm.com/api/v2/keys" \
       -H "accept: application/vnd.ibm.collection+json" \
       -H "authorization: Bearer <IAM_token>" \
       -H "bluemix-instance: <instance_ID>" \
       -H "x-kms-key-ring: <key_ring_ID>" \
       -H "correlation-id: <correlation_ID>"
   

   표 1의 정보에 따라 예제 요청의 변수를 바꾸십시오. 키 검색 기능을 포함하여 키 콜렉션을 볼 때 사용 가능한 선택적 매개변수에 대한 자세한 정보는 List keys 메소드에 대한 API 문서를 참조하십시오.

성공한 GET api/v2/keys 요청은 Key Protect 서비스 인스턴스에서 사용 가능한 키의 콜렉션을 리턴합니다.

{
    "metadata": {
        "collectionType": "application/vnd.ibm.kms.key+json",
        "collectionTotal": 2
    },
    "resources": [
        {
            "id": "02fd6835-6001-4482-a892-13bd2085f75d",
            "type": "application/vnd.ibm.kms.key+json",
            "name": "Root-key",
            "state": 1,
            "crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
            "createdBy": "...",
            "creationDate": "2020-03-11T16:30:06Z",
            "lastUpdateDate": "2020-03-11T16:30:06Z",
            "algorithmMetadata": {
                "bitLength": "256",
                "mode": "Deprecated"
            },
            "extractable": false,
            "imported": true,
            "algorithmMode": "Deprecated",
            "algorithmBitSize": 256,
            "dualAuthDelete": {
                "enabled": false
            }
        },
        {
            "id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
            "type": "application/vnd.ibm.kms.key+json",
            "name": "Standard-key",
            "state": 1,
            "expirationDate": "2020-03-14T03:50:12Z",
            "crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:30372f20-d9f1-40b3-b486-a709e1932c9c:key:2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
            "createdBy": "...",
            "creationDate": "2020-03-12T03:50:12Z",
            "lastUpdateDate": "2020-03-12T03:50:12Z",
            "algorithmMetadata": {
                "bitLength": "256",
                "mode": "Deprecated"
            },
            "extractable": true,
            "imported": false,
            "algorithmMode": "Deprecated",
            "algorithmBitSize": 256,
            "dualAuthDelete": {
                "enabled": false
            }
        }
    ]
}

기본적으로 GET api/v2/keys는 처음 200개의 키를 리턴하지만 조회 시 limit 매개변수를 사용하여 이 한계를 조정할 수 있습니다. limit 및 offset에 대해 자세히 보려면 키의 서브세트 검색을 참조하십시오.

키의 전체 목록이 표시되지 않습니까? limit 및 offset 를 참조하거나 관리자에게 문의하여, 해당 인스턴스의 키에 대해 올바른 수준의 액세스 권한이 할당되었는지 확인해야 할 수도 있습니다. 자세히 알아보려면 키를 보거나 나열할 수 없음을 참조하십시오.

키의 서브세트 검색

조회 시 limit 및 offset 매개변수를 지정하면 지정하는 offset 값부터 시작하여 키의 서브세트를 검색할 수 있습니다.

예를 들어, Key Protect 인스턴스에 저장된 총 3000개의 키가 있지만 GET /keys 요청을 작성할 때 200 - 300 키를 검색하려고 합니다.

다음 예제 요청을 사용하여 다른 키 세트를 검색할 수 있습니다.

$ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys?offset=<offset>&limit=<limit>" \
    -H "accept: application/vnd.ibm.collection+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>"

다음 표에 따라 요청의 limit 및 offset 변수를 대체하십시오.

오프셋은 데이터 세트에 있는 특정 키의 위치입니다. offset 값은 0부터 시작합니다. 즉, 데이터 세트의 열 번째 암호화 키는 오프셋 9에 있습니다.

상태별 키 검색

조회 시 state 매개변수를 지정하여 지정하는 상태의 키를 검색할 수 있습니다.

예를 들어, Key Protect 인스턴스에 활성, 일시중단됨 및 영구 삭제됨 상태의 키가 있을 수 있지만 GET /keys 요청을 작성할 때 활성 상태의 키만 검색하려고 합니다.

상태 조회 매개변수는 공백 또는 후행 쉼표 없이 쉼표로 구분된 0 - 5 사이의 정수 목록에 포함됩니다. 키 상태에 대한 자세한 정보는 키 상태 및 상태 전이를 참조하십시오.

다음 예제 요청을 사용하여 다른 키 세트를 검색할 수 있습니다.

$ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys?state=<state_integers>" \
    -H "accept: application/vnd.ibm.collection+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>"

다음 표에 따라 요청의 state 변수를 대체하십시오.

사용법 참고사항은 state 조회 매개변수 설정에 대한 다음 예제를 확인하십시오.

추출 가능한 값별로 키 검색

조회 시 extractable 매개변수를 지정하여 서비스를 종료할 수 있는 자료가 있는 키를 검색할 수 있습니다.

예를 들어, Key Protect 인스턴스에 표준 키와 루트 키가 모두 있을 수 있지만 GET /keys 요청을 할 때 추출 가능한 키 자료가 있는 키만 검색하려고 합니다.

추출 가능한 조회 매개변수는 부울을 사용합니다.

다음 예제 요청을 사용하여 다른 키 세트를 검색할 수 있습니다.

$ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys?extractable=<extractable>" \
    -H "accept: application/vnd.ibm.collection+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>"

다음 표에 따라 요청의 extractable 변수를 대체하십시오.

사용법 참고사항은 extractable 조회 매개변수 설정에 대한 다음 예제를 확인하십시오.

키 목록 정렬하기

하나 이상의 키 특성을 기반으로 리턴된 조회 문자열 키 목록을 정렬합니다. 에서 sort 매개변수를 사용합니다. 속성을 내림차순으로 정렬하려면 용어 앞에 "-"를 붙입니다. 여러 개의 주요 속성을 정렬하려면 쉼표를 사용하여 각 속성을 구분합니다. 쉼표로 구분된 목록의 첫 번째 속성이 다음 속성보다 먼저 평가됩니다.

$ curl -X GET \
    "https://<region>.kms.cloud.ibm.com/api/v2/keys?sort=<sort-value>" \
    -H "accept: application/vnd.ibm.collection+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>"