구성 API - updateSiteGeneralDetails

Prev Next

Cato API 지원 정책을 사용하기 전에 반드시 검토하시기 바랍니다.

updateSiteGeneralDetails 개요

Cato 관리 애플리케이션(NETWork > Sites > {사이트 이름} > Site Configuration > General)에서 사이트에 대해 일반 섹션의 설정을 업데이트하려면 updateSiteGeneralDetails mutation API를 사용하세요

  • 이름

  • 설명

  • 유형

  • 시간대

  • 국가

  • 주

  • 주소

계정의 accountId 찾기

이 계정 ID는 Cato 관리 애플리케이션에 표시되지 않으며, 대신 Cato 관리 애플리케이션의 URL 에 있는 숫자입니다. 예를 들어 다음 URL의 계정 ID는 26입니다: https://cc.catonetworks.com/#!/26/topology.

사이트 생성 API의 accountId 인수에 이 ID를 입력하세요. 예를 들어:

site(accountId: 26) {
    addSocketSite(input: $addSocketSite) { 
        siteId 
    } 
}

사이트에 대한 siteID 찾기

Cato 관리 애플리케이션에서는 site ID가 표시되지 않습니다. site ID를 찾을 수 있는 방법:

  • entityLookup API 쿼리를 사용하여 (Cato API - EntityLookup 참조), type을 site 값으로 설정합니다.

    site의 이름을 값으로 하여 search 매개변수도 사용할 수 있으며 쿼리는 site ID를 반환합니다.

  • 사이트를 선택했을 때 Cato 관리 애플리케이션의 URL에 표시되는 숫자 (Network > Sites > {site name}). 예를 들어, 다음 URL에서 사이트 ID는 12345입니다: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

updateSiteGeneralDetails 인수에 대한 세부정보

이는 Cato 구성 API를 사용하여 사이트에 대해 다음 일반 설정을 업데이트하기 위한 인수입니다. 선택적이라고 표시되지 않는 한 인수는 필수입니다:

  • name - 사이트의 이름

  • siteType - 조직 내 사이트의 유형, 예: Cloud Data Center

  • description - (선택 사항) 사이트에 대한 설명

  • siteLocation - 사이트 물리적 위치에 대한 데이터

updateSiteGeneralDetails 이름

사이트의 이름을 업데이트합니다.

updateSiteGeneralDetails siteType

siteType은 Cato 관리 애플리케이션의 모니터링 > 토폴로지 화면에서 사이트에 사용되는 아이콘을 결정하는 사이트 유형을 정의하는 열거형 인수입니다.

다음은 가능한 옵션입니다:

  • BRANCH - 물리적 또는 가상 사이트

  • HEADQUARTERS - 본사를 위한 물리적 사이트

  • CLOUD_DC - 클라우드 기반 데이터센터를 위한 가상 사이트

  • DATACENTER - 데이터센터를 위한 물리적 사이트

updateSiteGeneralDetails 설명 (선택 사항)

설명은 사이트를 설명하기 위한 선택적 자유 텍스트 필드입니다.

updateSiteGeneralDetails siteLocation

siteLocation 인수는 사이트에 대한 다음 물리적 세부 정보를 정의합니다. countryCode는 계정의 특정 지역의 사용 가능한 사이트 라이선스 수와 관련이 있습니다.

이 인수에 대한 값을 검색하려면 entityLookup API 쿼리를 사용할 수 있습니다. Cato API - EntityLookup를 참조하세요.

다음은 siteLocation 인수입니다:

  • countryCode - 사이트가 위치한 국가에 대한 두 글자 코드(ISO 3166-1 alpha-2)

    entityLookup의 경우 유형을 국가 값으로 사용합니다

  • stateCode - (선택 사항) 해당 국가의 주(州)에서 사이트가 위치한 장소

    entityLookup의 경우 유형을 countryState 값으로 사용합니다

  • timezone - 사이트의 시간대, 소켓 및 v소켓 업그레이드를 위한 유지보수 창의 시간 프레임을 설정하는 데 사용됩니다

    entityLookup의 경우 유형을 시간대 값으로 사용합니다

  • 주소 - (선택 사항) 물리적 사이트의 거리 주소

샘플 Postman 스크립트

mutation updateSiteGeneralDetails ($accountId: ID!, $siteID: ID!, $input: UpdateSiteGeneralDetailsInput!) {
    site(accountId: $accountId) {
        updateSiteGeneralDetails (siteId: $siteID, input: $input) {
            siteId
        }
    }
}

GraphQL 변수

{
    "accountId": "",
    "siteID": "",
    "input": {
        "name": "MySite",
        "description": "My first DC using the API",
        "siteType": "DATACENTER",
        "siteLocation": {
            "countryCode": "FR",
            "timezone": "Europe/Paris"
        }
    }
}

관련 자원