API 메소드

다음 표에는 확장 프로그램을 관리하기 위해 실행할 수 있는 작업이 나열되어 있습니다:

공개 또는 비공개 ENDPOINT 를 사용하여 확장 프로그램을 관리할 수 있습니다. 엔드포인트에 대한 자세한 내용은 서비스 API 엔드포인트를 참조하세요.

REST API에 대한 자세한 내용은 확장 기능을 참조하세요.

UI를 통해 사용 가능한 확장 프로그램 목록 가져오기

IBM Cloud Logs UI를 통해 사용할 수 있는 확장 프로그램을 확인하려면 다음 단계를 완료하세요:

1. IBM Cloud Logs UI를 실행하십시오.

2. 통합 아이콘 > 확장 기능을 클릭합니다.

사용 가능한 확장 프로그램 목록이 표시됩니다.

API를 사용하여 사용 가능한 확장 프로그램 목록 가져오기

배포할 수 있는 확장 프로그램 목록과 배포된 확장 프로그램에 대한 추가 세부 정보를 확인하려면 다음 단계를 완료하세요:

1. 인증 토큰을 받습니다. API를 통한 인증을 참조하세요.

2. 확장 프로그램을 관리하려는 인스턴스의 엔드포인트를 가져옵니다. 서비스 API 엔드포인트를 참조하세요.

3. 확장 프로그램별 버전 및 배포된 리소스를 포함하여 모든 확장 프로그램을 나열합니다.

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions"
   

API를 사용하여 배포된 확장 프로그램 목록 가져오기

IBM Cloud Logs 인스턴스에 배포된 확장 기능에 대한 정보를 얻으려면 확장 기능 목록 가져오기 메서드를 사용하면 됩니다. 정보에는 버전 및 배포된 리소스에 대한 세부 정보가 포함됩니다.

예를 들어 다음 단계를 완료합니다:

1. 인증 토큰을 받습니다. API를 통한 인증을 참조하세요.

2. 확장 프로그램을 배포하려는 인스턴스의 엔드포인트를 가져옵니다. 서비스 API 엔드포인트를 참조하세요.

3. 배포된 확장 프로그램의 세부 정보를 확인하세요.

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions?deployed=true"
   

API를 사용하여 배포되지 않은 확장 프로그램 목록 가져오기

IBM Cloud Logs 인스턴스에 아직 배포되지 않은 확장 기능에 대한 정보를 얻으려면 확장 기능 목록 가져오기 메서드를 사용하면 됩니다.

예를 들어 다음 단계를 완료합니다:

1. 인증 토큰을 받습니다. API를 통한 인증을 참조하세요.

2. 확장 프로그램을 배포하려는 인스턴스의 엔드포인트를 가져옵니다. 서비스 API 엔드포인트를 참조하세요.

3. 배포된 확장 프로그램의 세부 정보를 확인하세요.

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions?deployed=false"
   

API를 사용하여 확장 프로그램 배포하기

확장 프로그램에 포함된 리소스를 배포하려면 확장 프로그램의 배포 또는 업데이트 배포 API 메서드를 사용할 수 있습니다.

확장 프로그램을 배포하려면 다음 단계를 완료하세요:

1. 인증 토큰을 받습니다. API를 통한 인증을 참조하세요.

2. 확장 프로그램을 배포하려는 인스턴스의 엔드포인트를 가져옵니다. 서비스 API 엔드포인트를 참조하세요.

3. 배포하려는 확장 프로그램의 ID를 가져옵니다. 사용 가능한 확장 프로그램 목록을 참조하세요.

4. 배포된 리소스에 대한 정보를 포함하여 ID별로 확장 프로그램의 세부 정보를 확인하세요.

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions/<ExtensionID>"
   

   예를 들어 Kubernetes 확장자에 대한 정보를 얻으려면 실행합니다:

   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<ENDPOINT>/v1/extensions/IBMCloudKubernetes"
   

   다음과 같은 응답이 표시됩니다:

   {
   "id": "IBMCloudKubernetes",
   "name": "IBM Cloud Kubernetes Service",
   "revisions": [
       {
           "version": "1.0.0",
           "description": "# IBM Cloud Kubernetes Service\nThe dashboard provides an in-depth analysis of IBM Cloud Kubernetes Service, offering a comprehensive view of cluster performance, node activity, pod logs, and error analysis. It enables quick issue identification, trend analysis, and efficient Kubernetes monitoring.\n",
           "excerpt": "",
           "labels": [
               "IBM",
               "Kubernetes",
               "Сluster",
               "K8S",
               "Cloud",
               "Compute",
               "Observability"
           ],
           "items": [
               {
                   "id": "1405e028-dd50-48a0-86c5-b361e029a3f1",
                   "name": "IBM Kubernetes",
                   "description": "Dashboard for IBM Cloud Kubernetes Service.",
                   "target_domain": "dashboard"
               },
               {
                   "id": "93cda01a-526e-4872-b29a-125645abf784",
                   "name": "IBM Kubernetes - No logs from service",
                   "description": "No logs have been received from the kubernetes service, indicating potential issues with logging configuration, service downtime, or connectivity problems affecting log transmission.",
                   "target_domain": "alert"
               },
               {
                   "id": "9e2099ee-78f4-4070-a1fd-7be109f136ce",
                   "name": "IBM Kubernetes - More than 5 erroneous cluster logs within 15 minutes",
                   "description": "Over five error logs have been recorded at the cluster level within a 15-minute window, indicating potential issues affecting the Kubernetes cluster's overall health or configuration.",
                   "target_domain": "alert"
               },
               {
                   "id": "f242dd8a-138a-4dcc-92b9-09f5ec1b4840",
                   "name": "IBM Kubernetes - More than 5 erroneous pod logs within 15 minutes",
                   "description": "More than five error logs have been detected in pod-level operations within 15 minutes, suggesting issues with workloads or pod-level configurations.",
                   "target_domain": "alert"
               },
               {
                   "id": "504c4f1a-4185-4619-bc7c-9d011b3f3245",
                   "name": "IBM Kubernetes - Host change",
                   "description": "A host change event has been detected, which might indicate a node replacement, scaling operation, or unexpected infrastructure changes.",
                   "target_domain": "alert"
               },
               {
                   "id": "c179c165-b12e-4f40-8e87-e4627d6dbdef",
                   "name": "IBM Kubernetes - Permission denied",
                   "description": "A permission denial has occurred during a Kubernetes operation, possibly caused by misconfigured access controls or insufficient permissions for the requested action.",
                   "target_domain": "alert"
               }
           ]
       }
   ],
   "changelog": [
       {
           "version": "1.0.0",
           "description_md": "### Changed\nRelease of an extension for the IBM Cloud Kubernetes Service.\n"
       }
   ]
   }
   

5. 확장을 배치하십시오. 예를 들어 다음 cURL 명령을 실행하여 Kubernetes 확장자를 부분적으로 배포할 수 있습니다. 이 샘플은 대시보드와 2개의 알림을 생성합니다:

   curl -X PUT --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data   '{
   "version": "1.0.0",
   "item_ids": [
     "1405e028-dd50-48a0-86c5-b361e029a3f1",
     "93cda01a-526e-4872-b29a-125645abf784",
     "9e2099ee-78f4-4070-a1fd-7be109f136ce"
   ],
   "applications": [
     "myapp"
   ],
   "subsystems": [
     "mysubsystem"
   ]
   
   

}' "https:// /v1/extensions/IBMCloudKubernetes/deployment"

## API를 사용하여 확장 프로그램 업데이트하기 {: #extensions-mgmt-update-api api}

새 버전의 확장 프로그램을 배포하거나, 추가 리소스를 배포하거나, 확장 프로그램과 관련된 데이터 소스로 구성된 애플리케이션 및 하위 시스템을 수정할 수 있습니다. 확장 프로그램에 포함된 리소스를 업데이트하려면 [확장 프로그램의 배포 또는 업데이트 배포](/apidocs/logs-service-api#update-extension-deployment) API 메서드를 사용할 수 있습니다.

확장 프로그램을 업데이트하려면 다음 단계를 완료하세요:

API 호출에서 현재 배포된 해당 확장 프로그램의 모든 리소스를 지정해야 합니다. 이 확장 프로그램에서 이전에 배포한 리소스를 수정한 경우 업데이트를 실행하기 전에 해당 리소스를 분리하세요. 이전에 배포한 모든 리소스를 포함하지 않으면 포함되지 않은 리소스는 제거됩니다.
{: attention}

1. 인증 토큰을 받습니다. [API를 통한 인증을](/apidocs/logs-service-api#authentication) 참조하세요.

2. 확장 프로그램을 배포하려는 인스턴스의 엔드포인트를 가져옵니다. [서비스 API 엔드포인트를](/docs/cloud-logs?topic=cloud-logs-endpoints_api) 참조하세요.

3. 배포하려는 확장 프로그램의 ID를 가져옵니다. [사용 가능한 확장 프로그램 목록을](#extensions-mgmt-list) 참조하세요.

4. 배포된 리소스에 대한 정보를 포함하여 ID별로 확장 프로그램의 세부 정보를 확인하세요. 배포 섹션에서 이미 배포된 리소스를 확인합니다.

   ```text {: codeblock}
   curl -X GET --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<API_ENDPOINT>/v1/extensions/<ExtensionID>"

5. 확장 프로그램을 업데이트합니다. 예를 들어 다음 cURL 명령을 실행하여 Kubernetes 확장자를 업데이트하고 대시보드 1개와 알림 1개만 유지할 수 있습니다:

   curl -X PUT --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data   '{
   "version": "1.0.0",
   "item_ids": [
     "1405e028-dd50-48a0-86c5-b361e029a3f1",
     "93cda01a-526e-4872-b29a-125645abf784"
   ],
   "applications": [
     "myapp"
   ],
   "subsystems": [
     "mysubsystem"
   ]
   
   

}' "https:// /v1/extensions/IBMCloudKubernetes/deployment"

## 확장 프로그램 배포 {: #extensions-mgmt-deploy-ui ui}

확장 프로그램을 배포하려면 다음 단계를 완료하세요:

1. [IBM Cloud 계정에 로그인](https://cloud.ibm.com/login){: external} 합니다.

2. [IBM Cloud Logs 인스턴스에 액세스](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. **통합 아이콘** ![통합 아이콘](/icons/integrations.svg "통합") > **확장 기능을** 클릭합니다.

4. 배포하려는 확장 프로그램의 타일에서 **배포를** 클릭합니다.

5. 확장이 적용될 *애플리케이션* 및 *하위 시스템을* 선택합니다.

6. 기본적으로 확장 프로그램에 정의된 모든 항목이 배포됩니다. 배포하지 않으려는 항목의 확인 표시를 제거할 수 있습니다.

7. **배포를** 클릭하여 IBM Cloud Logs 인스턴스에 확장 프로그램을 설치합니다.


## 배포된 확장 프로그램 수정하기 {: #extensions-mgmt-modify-ui ui}

새 버전의 확장 프로그램을 배포하거나, 추가 리소스를 배포하거나, 확장 프로그램과 관련된 데이터 소스로 구성된 애플리케이션 및 하위 시스템을 수정할 수 있습니다.

해당 확장 프로그램에서 현재 배포된 모든 리소스를 계속 선택했는지 확인하세요. 이 확장 프로그램에서 이전에 배포한 리소스를 수정한 경우 업데이트를 실행하기 전에 해당 리소스를 분리하세요. 이전에 배포한 모든 리소스를 포함하지 않으면 포함되지 않은 리소스는 제거됩니다.
{: attention}

확장 프로그램을 업데이트하려면 다음 단계를 완료하세요:

1. [IBM Cloud 계정에 로그인](https://cloud.ibm.com/login){: external} 합니다.

2. [IBM Cloud Logs 인스턴스에 액세스](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. **통합 아이콘** ![통합 아이콘](/icons/integrations.svg "통합") > **확장 기능을** 클릭합니다.

4. 수정하려는 배포된 확장 프로그램의 타일을 클릭합니다.

5. 필요에 따라 *애플리케이션* 및 *하위 시스템* 값을 변경합니다.

   확장 프로그램에서 *애플리케이션* 및 *하위 시스템* 값을 업데이트하면 배포하는 확장 프로그램의 모든 리소스가 새 *애플리케이션* 및 *하위 시스템* 값 목록으로 업데이트됩니다.
   {: attention}

6. **업데이트** 를 클릭하십시오.

## 확장 프로그램 제거하기 {: #extensions-mgmt-remove-ui ui}


인스턴스에 이미 배포한 확장 프로그램을 제거하려면 다음 단계를 완료하세요:

1. [IBM Cloud 계정에 로그인](https://cloud.ibm.com/login){: external} 합니다.

2. [IBM Cloud Logs 인스턴스에 액세스](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. **통합 아이콘** ![통합 아이콘](/icons/integrations.svg "통합") > **확장 기능을** 클릭합니다.

4. 제거하려는 배포된 확장 프로그램의 타일을 클릭합니다.

5. 클릭 **- 제거를** 클릭합니다.

6. 배포된 에셋을 삭제할지 유지할지 선택합니다.

   배포된 자산을 삭제하도록 선택하면 IBM Cloud Logs 인스턴스에서 확장 프로그램이 배포한 자산과 함께 확장 프로그램이 삭제됩니다.

   확장 프로그램을 삭제할 때 배포된 자산을 유지하도록 선택하면 확장 프로그램에서 배포한 자산은 IBM Cloud Logs 인스턴스에 남아 있지만 더 이상 확장 프로그램과 연결되지 않습니다. 확장 프로그램을 다시 배포하면 확장 프로그램의 새 복사본이 배포되고 이전에 배포된 자산은 IBM Cloud Logs 인스턴스에 남아 있으며 덮어쓰지 않습니다.

7. **제거**를 클릭하십시오.

## 배포된 확장 프로그램에서 리소스 분리하기 {: #extensions-mgmt-dettach-ui ui}

배포된 확장 프로그램에서 리소스를 분리하려면 다음 단계를 완료하세요:

1. [IBM Cloud 계정에 로그인](https://cloud.ibm.com/login){: external} 합니다.

2. [IBM Cloud Logs 인스턴스에 액세스](/docs/cloud-logs?topic=cloud-logs-instance-launch#instance-launch-cloud-ui)

3. **통합 아이콘** ![통합 아이콘](/icons/integrations.svg "통합") > **확장 기능을** 클릭합니다.

4. 제거하려는 배포된 확장 프로그램의 타일을 클릭합니다.

5. 클릭 **- 제거를** 클릭합니다.

6. IBM Cloud Logs 인스턴스에 확장 프로그램에서 배포한 수정된 에셋을 유지하려면 `Retain all assets` 을 선택합니다.

7. **제거**를 클릭하십시오.

   디태치 리소스는 더 이상 확장 프로그램과 연결되지 않습니다.

   확장 프로그램을 다시 배포하면 확장 프로그램의 새 복사본이 배포되고 이전에 배포된 자산은 IBM Cloud Logs 인스턴스에 남아 있으며 덮어쓰지 않습니다.


## 확장 프로그램 제거하기 {: #extensions-mgmt-remove-api api}


확장번호를 삭제하려면 다음 API 호출을 실행하면 됩니다:

```text {: codeblock}
% curl -X DELETE --location --header "Authorization: Bearer ${IAM_TOKEN}"   --header "Accept: application/json"   "https://<ENDPOINT>/v1/extensions/<ExtensionID>/deployment"