CAPI API 만들기

  • 릴리스 버전: Australia
  • 업데이트 날짜 2026년 03월 12일
  • 소요 시간: 7분

    • 기존 CAPI API가 제공자의 CAPI 인터페이스와 통합되지 않은 경우 API를 만들 수 있습니다. 자원 블록의 단계에서는 작업이 실행될 때 API 메서드를 호출할 수 있습니다.

    시작하기 전에

    • 필요한 역할: 관리자
    • 생성하려는 제공자와 제품이 없는지 검토 기본 CAPI API 하고 확인합니다.
    • 제공자에 대한 REST 호출을 만드는 방법을 알 수 있도록 클라우드 제공자 API를 숙지하십시오. 제공자 API에 전달할 수 있는 헤더, 인증 요구 사항, 엔드포인트 및 데이터를 숙지하지 않은 경우 고유한 CAPI 구성요소를 빌드할 수 없습니다.

    이 태스크 정보

    이 항목에서는 CAPI API를 만들기 위한 지침을 제공합니다. CAPI, 자원 블록, Blueprint 및 자격 증명 매핑의 구성에 대해서도 설명합니다.

    프로시저

    1. 에서 클라우드 관리자 포털다음으로 이동합니다. 디자인 > 클라우드 API.
    2. API 탭을 클릭합니다.
    3. 새로 만들기를 클릭합니다.
    4. 양식 필드에 내용을 입력합니다(표 참조).
      필드 설명
      클라우드 API 설명적인 이름을 입력합니다.
      인터페이스 필요한 작업을 제공하는 기존 인터페이스 중에서 선택합니다.
      커넥터 커넥터가 바로 사용 가능하며 수정할 수 없는 Java 커넥터인 경우 스크립트 커넥터가 이 필드에 나타납니다. 이러한 스크립트 커넥터는 수정할 필요가 없습니다.
      제품 제공자에 속하는 제품을 선택합니다. 제품에는 CMDB의 자원 유형이 포함되어 있습니다.
      버전 이 API를 식별하는 버전 번호를 입력합니다. 이 API가 첫 번째 버전인 경우 1.0 을 입력합니다. 동일한 API의 여러 버전을 만든 다음 자원 블록의 운영 단계에서 특정 버전을 참조할 수 있습니다.
      스크립트됨 인터페이스 값이 스크립트 커넥터인 경우 이 필드가 선택됩니다.
      스크립트 유형 스크립트에 사용할 언어를 선택합니다.
      주:

      JavaScript를 권장합니다. 메서드 매퍼는 Javascript로 작성된 스크립트 포함을 사용합니다 MID 서버 .
      ExecuteScriptOnInstance
      설명 이 API에 대한 설명을 입력합니다.
    5. 필요한 모든 작업이 CAPI 메서드 매퍼 관련 목록에 나타나는지 확인합니다.

      CAPI 메서드 매퍼 목록의 작업은 사용자가 선택한 인터페이스에서의 작업과 동일합니다. 이 작업이 API에 한정됩니다. 목록에서 작업을 추가하거나 제거할 수 없습니다. 일부 작업, 특히 Azure 작업에서는 API에 대한 실제 구현을 수행하는 스크립트 포함을 사용합니다 MID 서버 . 이 스크립트에는 AWS 또는 Azure와 같은 제공자의 REST API에 대한 호출이 포함되어 있습니다. 제공자의 설명서에서 API를 찾을 수 있어야 합니다.

    6. CAPI 메서드 매퍼에 대한 스크립트 포함을 보려면 다음을 수행합니다.
      1. CAPI 메서드 매퍼 관련 목록에서 기어 아이콘(기어 아이콘)을 클릭하고 선택됨 열에 요청 스크립트 필드를 추가한 다음 확인을 클릭합니다.
        요청 스크립트 필드 추가
        이제 스크립트 포함이 MID 서버 메서드 매퍼 목록에 나타납니다.
      2. 스크립트 포함을 보려면 스크립트 이름을 클릭하십시오.
        이 예시에서 CreateNode 작업은 스크립트 포함을 azure-compute-1.0-CreateNode 사용합니다.
        CreateNode 예
        이 스크립트 포함에는 다음 코드가 포함되어 있습니다.
        
createNode();
function createNode(){
   var acp = new AzureComputeVirtualMachine(this.parameters, this.headers);
    //this passes the parameters and headers into the AzureComputeVirtualMachine script include.
   var vm = acp.createVirtualMachine();

   return vm;
}

        코드는 애플리케이션에서 기본적으로 사용할 수 있는 스크립트 포함을 호출 AzureComputeVirtualMachine 합니다 클라우드 프로비저닝 및 거버넌스 . 여기에는 가상 머신에 대한 Azure에 대한 모든 API 호출이 포함되어 있습니다.

    7. 필요한 자격 증명 정보를 클라우드 제공자에 전달하는 API 구성 재정의를 만듭니다.

      클라우드 제공자 REST API에 필요한 헤더 정보도 전달해야 합니다. 인스턴스에서 클라우드 제공자 API에 대한 REST 호출을 수행할 때 자격 증명 데이터가 포함되지 않기 때문에 API 구성 재정의가 필요합니다.

      팁:
      만들려는 API 구성 재정의를 모르는 경우 CAPI에 있는 유사한 API를 확인하고 동일한 재정의를 사용하십시오. 예를 들어 AWS 저장소와 같은 API를 만드는 경우 AWS 블록 저장소 또는 AWS Compute와 같은 다른 AWS API를 살펴보십시오.
      1. API 구성 재정의 관련 목록에서 신규를 클릭합니다.
      2. 조회 아이콘을 클릭하고 기존 구성 매개변수를 선택합니다.
        ID, 자격 증명 등 많은 유용한 매개변수가 기본적으로 제공됩니다.
      3. 재정의 값을 입력합니다.

        정적 값을 설정하거나 시스템에서 $(CloudCredential.attribute_name) 형식으로 값을 끌어올 수 있습니다. CloudCredential 부분은 자격 증명 저장소에서 잠금을 해제합니다. attribute_name 부분은 검색하려는 특정 자격 증명이나 별칭 또는 엔드포인트 URL에 따라 달라지는 속성입니다.

        다음으로 이동하는 경우 연결 및 자격 증명 > 자격 증명 및 AWS 자격 증명을 연 다음 접근 키 ID 필드를 마우스 오른쪽 버튼으로 클릭하고 접근 키가 저장된 자격 증명 테이블의 열 이름을 볼 수 있습니다. 이 경우 접근 키는 access_key 열에 저장됩니다. 따라서 재정의 값은 $(CloudCredential.access_key)여야 합니다.
        접근 키
    8. API 구성 재정의에 사용할 구성 매개변수를 만들어야 하는 경우 다음 절차를 수행하십시오.
      1. API 구성 재정의 양식에서 구성 매개변수 필드의 조회 아이콘을 클릭합니다.
      2. 구성 매개변수 창에서 새로 만들기 를 클릭한 다음 양식을 작성합니다.
        필드 설명
        구성 매개변수 이름 설명적인 이름을 입력합니다.
        기본값 옵션 기본값을 설정합니다.
        엔드포인트 이 필드는 읽기 전용입니다.
        설명 유용한 설명을 입력합니다.
        구성 데이터 유형 데이터 유형 선택:
        • 문자열
        • 날짜/시간
        • 날짜
        • 길게
        • 암호
        • 부울
        구성 유형 구성 유형 선택:
        • 헤더: 이 값을 사용하여 재정의 값을 헤더로 전달합니다. API의 일부로 스크립트 포함이 MID 서버 있고 this.headers를 매개변수로 사용하는 경우 재정의 값이 제공자 API에 전달됩니다.
        • 구성
        • URI 구성
    9. 필요한 경우 클라우드 제공자 API에 대해 작업을 실행하는 스크립트 포함을 수정합니다.
      1. 클라우드 API 양식의 CAPI 메서드 매퍼 관련 목록에서 CAPI 인터페이스 작업 옆에 있는 정보 아이콘( 정보 아이콘)을 클릭합니다.
        CAPI 인터페이스 작업 이름 자체는 클릭하지 마십시오.
      2. 기록 열기를 클릭합니다.
      3. 작업 양식에서 다음 필드 값을 수정할 수 있습니다.
        필드 설명
        엔드포인트 운영 기본 스크립트 실행 엔드포인트 작업을 유지합니다.
        버전에서 지원됨 일반적으로 이 값은 변경할 필요가 없습니다.

        다른 버전의 API에서 메서드 매퍼를 사용하도록 지원되는 버전을 변경합니다. 기본적으로 메서드 매퍼는 소속된 API와 같은 버전 번호로 설정됩니다.
      4. 요청 스크립트 필드에서 자리 표시자 MID 서버 스크립트 포함 옆에 있는 정보 아이콘(정보 아이콘)을 클릭하여 수정합니다.
      5. 스크립트 포함 양식에서 스크립트를 만듭니다.

        다음 예 JavaScript에는 Azure 부하 분산 장치가 나열되어 있습니다. 다음과 같은 유용한 설명을 참고하십시오.

        
getResourceInfo();

function getResourceInfo() {
	var anpi = new AzureLoadBalancer(this.parameters, this.headers);
       
       //this calls the 'AzureLoadBalancer' MID 서버 script include, which in turn
       //calls the 'AzureCloudAPIBase' script include, both of which 
       //are already in your instance by default. 
       //The 'AzureCloudBase' script include runs a query for resources of a given type in a
	//specified region.

	var items = anpi.listResourcesByRegionOrIDs();
       //This function is in the 'AzureCloudAPIBase' script include. It calls the Azure API.

	return items;
}
        이 작업에 대해 제공되는 재정의는 Azure에서 부하 분산 장치를 찾는 데 필요한 클라이언트 ID, 테넌트 ID, 비밀 키 및 엔드포인트 URL입니다.
        API 구성 재정의

        Google Cloud 통합 예 MID 서버 의 경우 JAR 파일도 필요합니다.

      6. 제출을 클릭합니다.
      7. 각 작업에 대한 스크립트 포함을 수정합니다.