키 검색
다음을 사용하여 키에 대한 키 자료를 검색할 수 있습니다. IBM® Key Protect for IBM Cloud®.
작성자 또는 관리자 액세스 정책이 있는 경우, 키 자료 및 정책 세부사항과 같은 표준 키의 컨텐츠를 검색할 수 있습니다.
루트 키는데이터 서비스에 저장된 다른 키를 암호화 및 복호화하는 데 사용되는 대칭 랩핑 키입니다. 하드웨어 보안 모듈의 범위 내에서 유지됩니다 모듈의 범위 내에 있어야 합니다. 루트 키에 대한 키 자료를 검색할 수 없습니다.
API를 사용하여 키 검색
특정 키에 대한 자세한 정보를 보기 위해 다음 엔드포인트에 대한 GET 호출을 작성할 수 있습니다.
https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>
-
액세스하거나 관리할 키의 ID를 검색하십시오.
ID 값을 사용하여 키 자료와 같은 키에 대한 자세한 정보에 액세스할 수 있습니다.
GET /v2/keys요청을 작성하거나 Key Protect GUI에서 사용할 수 없습니다. -
다음
curl명령을 실행하여 키와 키 자료에 대한 세부사항을 가져오십시오.$ curl -X GET \ "https://<region>.kms.cloud.ibm.com/api/v2/keys/<key_ID_or_alias>" \ -H "accept: application/vnd.ibm.kms.key+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "x-kms-key-ring: <key_ring_ID>" \ -H "correlation-id: <correlation_ID>"다음 표에 따라 예제 요청의 변수를 대체하십시오.
| 가변 | 설명 |
|---|---|
| 지역 | 필수. Key Protect 인스턴스가 위치한 지역을 나타내는 us-south 또는 eu-gb 과 같은 지역 약어입니다.자세한 내용은 지역별 서비스 엔드포인트를 참조하세요. |
| IAM_token | 필수. 사용자의 IBM Cloud 액세스 토큰입니다. curl 요청에 Bearer 값을 포함하여 IAM 토큰의 전체 컨텐츠를 포함하십시오. 자세한 내용은 액세스 토큰 검색하기를 참조하세요. |
| instance_ID | 필수. Key Protect 서비스 인스턴스에 지정된 고유 ID입니다. 자세한 내용은 인스턴스 ID 검색하기를 참조하세요. |
| key_ring_ID | 선택사항. 키가 속한 키 링의 고유 ID입니다. 지정되지 않은 경우 Key Protect은(는) 지정된 인스턴스와 연관된 모든 키 링에서 키를 검색합니다. 보다 최적화된 요청을 위해 키 링 ID를 지정하는 것이 좋습니다. 참고: x-kms-key-ring 헤더 없이 생성된 키의 키 링 ID는 기본값입니다.For more information, see 키 그룹화. |
| correlation_ID | 선택사항. 트랜잭션을 추적하고 상관시키는 데 사용되는 고유 ID입니다. |
| key_ID_or_alias | 필수. 검색할 키의 ID 또는 별명입니다. |
정상적인 GET api/v2/keys/<key_ID_or_alias> 응답은 키 및 키 자료에 대한 세부사항을 리턴합니다. 다음 JSON 오브젝트는 표준 키의 리턴값 예를 표시합니다.
{
"metadata": {
"collectionType": "application/vnd.ibm.kms.key+json",
"collectionTotal": 1
},
"resources": [
{
"type": "application/vnd.ibm.kms.key+json",
"id": "02fd6835-6001-4482-a892-13bd2085f75d",
"name": "test-standard-key",
"aliases": [
"alias-1",
"alias-2"
],
"state": 1,
"expirationDate": "2020-03-15T03:50:12Z",
"extractable": true,
"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:12e8c9c2-a162-472d-b7d6-8b9a86b815a6:key:02fd6835-6001-4482-a892-13bd2085f75d",
"imported": false,
"creationDate": "2020-03-12T03:50:12Z",
"createdBy": "...",
"algorithmType": "Deprecated",
"algorithmMetadata": {
"bitLength": "256",
"mode": "Deprecated"
},
"algorithmBitSize": 256,
"algorithmMode": "Deprecated",
"lastUpdateDate": "2020-03-12T03:50:12Z",
"dualAuthDelete": {
"enabled": false
},
"deleted": false,
"payload": "Rm91ciBzY29yZSBhbmQgc2V2ZW4geWVhcnMgYWdv..."
}
]
}
다음 JSON 오브젝트는 루트 키의 리턴값 예를 표시합니다.
{
"metadata": {
"collectionType": "application/vnd.ibm.kms.key+json",
"collectionTotal": 1
},
"resources": [
{
"type": "application/vnd.ibm.kms.key+json",
"id": "2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
"aliases": [
"alias-1",
"alias-2"
],
"name": "test-root-key",
"state": 1,
"extractable": false,
"crn": "crn:v1:bluemix:public:kms:us-south:a/f047b55a3362ac06afad8a3f2f5586ea:30372f20-d9f1-40b3-b486-a709e1932c9c:key:2291e4ae-a14c-4af9-88f0-27c0cb2739e2",
"imported": false,
"creationDate": "2020-03-05T16:28:38Z",
"createdBy": "...",
"algorithmType": "Deprecated",
"algorithmMetadata": {
"bitLength": "256",
"mode": "Deprecated"
},
"algorithmBitSize": 256,
"algorithmMode": "Deprecated",
"lastUpdateDate": "2020-03-05T16:39:25Z",
"keyVersion": {
"id": "436901cb-f4e4-45f4-bd65-91a7f6d13461",
"creationDate": "2020-03-05T16:39:25Z"
},
"dualAuthDelete": {
"enabled": false
},
"deleted": false
}
]
}
payload 또는 루트 키에 대한 키 자료는 하드웨어 보안 모듈의 경계 내에 위치하고 검색될 수 없습니다.
응답 매개변수에 대한 자세한 설명은 Key Protect REST API 참조 문서.