API를 사용하여 운영 메트릭 모니터링
IBM® Key Protect 서비스 인스턴스를 설정한 후 서비스 API를 사용하여 모니터링 메트릭을 관리할 수 있습니다.
메트릭 설정
Key Protect 서비스 인스턴스에 대한 메트릭은 사용자가 Key Protect 인스턴스에 저장되는 루트 키를 사용하십시오. 이 정책을 사용으로 설정하면 Monitoring를 사용하여 Key Protect 인스턴스에 저장되는 루트 키를 사용하십시오.
메트릭은 Key Protect API. Key Protect API 액세스에 대한 자세한 정보는 API 설정을 참조하십시오.
운영 메트릭을 Key Protect 인스턴스에 대해 사용으로 설정하기 전에 다음 고려사항을 기억하십시오.
-
Key Protect 인스턴스에 대한 메트릭을 사용하는 경우, 메트릭은 정책이 사용으로 설정된 후에만 보고됩니다. 메트릭 정책이 사용으로 설정되면 정책이 활성화된 후 인스턴스에서 발생하는 모든 API 요청에 대한 운영 메트릭이 표시됩니다. 정책이 사용으로 설정되기 전에는 메트릭이 표시되지 않습니다.
-
메트릭을 확인하려면 정책에 맞게 Monitoring 인스턴스를 프로비저닝해야 합니다. 다음을 수행해야 합니다 같은 지역에 위치한 Monitoring 인스턴스를 프로비저닝해야 합니다 인스턴스를 프로비저닝해야 합니다 운영 메트릭을 수신하려는 Key Protect 인스턴스와 동일한 지역에 있는 인스턴스여야 합니다. 다음 Monitoring 인스턴스를 사용하려면 다음을 수행해야 합니다 플랫폼 지표를 활성화해야 합니다.
콘솔을 사용하여 Key Protect 인스턴스에 대한 메트릭 사용 설정
Key Protect 인스턴스를 작성하고 Monitoring을(를) 프로비저닝하며 플랫폼 메트릭을 사용으로 설정한 후 다음 단계를 완료하여 메트릭 정책을 사용으로 설정하십시오.
-
메뉴 > 리소스 목록으로 이동하여 리소스 목록을 보십시오.
-
IBM Cloud 리소스 목록에서 Key Protect의 프로비저닝된 인스턴스를 선택하십시오.
-
인스턴스 정책 페이지에서 메트릭 정책 섹션의 사용 단추를 클릭하십시오.
API를 사용하여 Key Protect 인스턴스에 대한 메트릭 사용 설정
인스턴스 관리자로서, 메트릭 정책을 Key Protect 인스턴스를 만들어서
PUT
호출을 작성할 수 있습니다.
https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=metrics
-
API를 사용하여 인증 정보를 검색하십시오.
메트릭 정책을 사용으로 설정하려면 관리자 IAM 액세스 정책을 Key Protect 인스턴스에 저장되는 루트 키를 사용하십시오. IAM 역할이 Key Protect 서비스 조치에 맵핑되는 방법을 알아보려면 서비스 액세스 역할을 확인하십시오.
-
메트릭 정책을 Key Protect 인스턴스에 대해 사용으로 설정하려면
curl
명령을 실행하십시오.curl -X PUT \ "https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=metrics" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "content-type: application/vnd.ibm.kms.policy+json" \ -d '{ "metadata": { "collectionType": "application/vnd.ibm.kms.policy+json", "collectionTotal": 1 }, "resources": [ { "policy_type": "metrics", "policy_data": { "enabled": false } } ] }'
다음 표에 따라 예제 요청의 변수를 대체하십시오.
가변 | 설명 |
---|---|
지역 | 필수. 지역 약어(예: us-south 또는 eu-gb )로, Key Protect 인스턴스가 있는 지리적 영역을 나타냅니다For more information, see 지역 서비스 엔드포인트. |
IAM_token | 필수. 사용자의 IBM Cloud 액세스 토큰입니다. curl 요청에 Bearer 값을 포함하여 IAM 토큰의 전체 컨텐츠를 포함하십시오. For more information, see 액세스 토큰 검색하기. |
instance_ID | 필수. Key Protect 서비스 인스턴스에 지정된 고유 ID입니다. For more information, see 인스턴스 ID 검색하기. |
A successful request returns an HTTP `204 No Content` response, which
indicates that your Key Protect instance
is now enabled for reporting operational metrics.
This new policy only reports on operations that occur after the policy is
enabled.
{: note}
-
선택사항: 다음 인스턴스에 사용 가능한 정책을 찾아보기하여 메트릭 정책이 작성되었는지 확인하십시오. Key Protect 인스턴스에 저장되는 루트 키를 사용하십시오.
$ curl -X GET \ "https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=metrics" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>"
API를 사용하여 Key Protect 인스턴스에 대한 메트릭 사용 안함 설정
인스턴스 관리자로서, 기존 메트릭 정책을 Key Protect 인스턴스를 만들어서
PUT
호출을 작성할 수 있습니다.
https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=metrics
-
API를 사용하여 인증 정보를 검색하십시오.
메트릭 정책을 사용 안함으로 설정하려면, 관리자 액세스 정책을 Key Protect 인스턴스에 저장되는 루트 키를 사용하십시오. IAM 역할이 Key Protect 서비스 조치에 맵핑되는 방법을 알아보려면 서비스 액세스 역할을 확인하십시오.
-
기존 메트릭 정책을 Key Protect 인스턴스에 대해 사용으로 설정하려면
curl
명령을 실행하십시오.$ curl -X PUT \ "https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=metrics" \ -H "accept: application/vnd.ibm.kms.policy+json" \ -H "authorization: Bearer <IAM_token>" \ -H "bluemix-instance: <instance_ID>" \ -H "content-type: application/vnd.ibm.kms.policy+json" \ -d '{ "metadata": { "collectionType": "application/vnd.ibm.kms.policy+json", "collectionTotal": 1 }, "resources": [ { "type": "application/vnd.ibm.kms.policy+json", "metrics": { "enabled": false } } ] }'
다음 표에 따라 예제 요청의 변수를 대체하십시오.
가변 | 설명 |
---|---|
지역 | 필수. 지역 약어(예: us-south 또는 eu-gb )로, Key Protect 인스턴스가 있는 지리적 영역을 나타냅니다For more information, see 지역 서비스 엔드포인트. |
IAM_token | 필수. 사용자의 IBM Cloud 액세스 토큰입니다. curl 요청에 Bearer 값을 포함하여 IAM 토큰의 전체 컨텐츠를 포함하십시오. For more information, see 액세스 토큰 검색하기. |
instance_ID | 필수. Key Protect 서비스 인스턴스에 지정된 고유 ID입니다. For more information, see 인스턴스 ID 검색하기. |
A successful request returns an HTTP `204 No Content` response, which
indicates that the metrics policy was updated for your service
instance.
선택사항: 다음 인스턴스에 사용 가능한 정책을 찾아보기하여 메트릭 정책이 업데이트되었는지 확인하십시오. Key Protect 인스턴스에 저장되는 루트 키를 사용하십시오.
```sh {: codeblock}
$ curl -X GET \
"https://<region>.kms.cloud.ibm.com/api/v2/instance/policies?policy=metrics" \
-H "accept: application/vnd.ibm.kms.policy+json" \
-H "authorization: Bearer <IAM_token>" \
-H "bluemix-instance: <instance_ID>"
```
다음에 수행할 작업
- 다음 Key Protect 인스턴스를 Monitoring(으)로 구성하는 방법에 대해 자세히 알아보려면, 운영 메트릭 모니터링을 참조하십시오.