Shadow API Discovery: Management API

개요

이 페이지에서는 Apigee Management(APIM) API에서 Apigee Shadow API Discovery를 관리하기 위한 참조 문법을 제공합니다. 요청의 각 필드에 대한 정보를 포함하여 Shadow API Discovery와 관련된 Management API 문서는 https://cloud.google.com/apigee/docs/reference/apis/apim/rest 및 https://cloud.google.com/apigee/docs/reference/apis/apim/rpc에서 확인할 수 있습니다.

Shadow API Discovery에 대한 개요와 Cloud 콘솔에서 Apigee UI를 사용하여 이를 관리하는 방법은 Shadow API Discovery를 참조하세요. Shadow API Discovery의 일반적인 동작 및 제한사항에 대한 정보는 동작 및 제한사항에서 확인할 수 있습니다.

참조 API 호출의 파라미터

이 페이지의 API 호출은 Apigee 계정 정보(예: 프로젝트) 또는 관찰 작업을 만들 때 사용되는 정보를 참조하는 다음 파라미터를 사용할 수 있습니다. 이러한 각 필드에 대한 자세한 내용은 관찰 작업 만들기를 참조하세요.

OBSERVATION_JOB_LOCATION은 관찰 작업의 위치입니다.
OBSERVATION_JOB_NAME은 관찰 작업의 이름입니다.
OBSERVATION_SOURCE_LOCATION는 관찰 작업의 소스 위치입니다.
OBSERVATION_SOURCE_NAME은 관찰 소스의 이름입니다.
PROJECT는 Apigee 프로젝트입니다.

관찰 작업 만들기

관찰 작업을 만들려면 여러 단계/API 요청이 필요합니다.

관찰 소스 만들기: 기존 관찰 소스를 사용하는 대신 새 관찰 소스를 만들려면 관찰 소스 세부정보를 사용하여 observationSources 엔드포인트에 POST 요청을 수행합니다.

curl \ https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources?observation_source_id=OBSERVATION_SOURCE_NAME \
-X POST \
-H 'Content-type: application/json' \
-d @- <<'EOF'
{
  "gclbObservationSource": {
    "pscNetworkConfigs": [
      {
        "network": "projects/PROJECT/global/networks/{network_name}",
        "subnetwork":"projects/PROJECT/regions/OBSERVATION_SOURCE_LOCATION/subnetworks/{subnet_name}"
      }
    ]
  }
}
EOF

관찰 소스를 만들려면 몇 분이 걸리며 다음과 같이 응답과 함께 LRO를 시작합니다.

{
"name": "projects/{project/locations/OBSERVATION_SOURCE_LOCATION/operations/operation-",
"metadata": {
  "@type": "type.googleapis.com/google.cloud.apim.vl.ApiDiscoveryOperationMetadata",
  "createTime": "",
  "target": "projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME",
  "verb": "create",
  "requestedCancellation": false,
  "apiVersion": "vl"
},
"done": false
}

새로 만든 관찰 소스를 보려면 다음을 수행합니다.

curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME

관찰 작업 만들기: 만든 소스를 사용하여 섀도 API를 찾는 작업을 만듭니다.

curl \
https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs?observation_job_id=OBSERVATION_JOB_NAME \
-X POST \
-H 'Content-type: application/json' \
-d @- <<'EOF'
{
  "sources": [
    "projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME"
  ]
}
EOF

관찰 작업 사용 설정

새 관찰 작업을 사용 설정하거나 사용 중지된 기존 작업을 사용 설정하려면 다음 명령어를 사용하세요.

curl https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs/OBSERVATION_JOB_NAME:enable \
-X POST \
-H 'Content-type: application/json' \
-d @- <<'EOF'
{}
EOF

검색된 API 보기

사용 설정된 관찰 작업에서 발견된 API를 보려면 다음 명령어를 제출합니다.

curl https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs/OBSERVATION_JOB_NAME/apiObservations \
-X GET

관찰 결과의 태그 관리

결과에 이미 추가된 태그를 나열하려면 다음 단계를 따르세요.

curl -H "https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION:listApiObservationTags"

태그를 관리하려면 다음 단계를 따르세요.

curl -H "Content-Type: appication/json" \
"https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs/OBSERVATION_JOB_NAME/apiObservations:batchEditTags" \
-X POST -d @- <<'EOF'
{
  "requests": [
    {
      "apiObservationId": "API_OBSERVATION_ID",
      "tagActions": [
      {
        "tag": "demo",
        "action": "REMOVE"
      },
      {
        "tag": "Needs Attentions",
        "action": "ADD"
      }]
    }
  ]
}
EOF

관찰 작업 사용 중지

이 요청은 관찰 작업을 삭제하지 않고 사용 중지합니다.

curl https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationsJobs/OBSERVATION_JOB_NAME:disable \
-X POST \
-H 'Content-type: application/json' \
-d @- <<'EOF'
{
}

관찰 작업 삭제

이 요청은 관찰 작업을 삭제합니다.

curl -X DELETE https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_JOB_LOCATION/observationJobs/OBSERVATION_JOB_NAME

관찰 소스 삭제

이 요청은 관찰 소스를 삭제합니다.

curl -X DELETE https://apim.googleapis.com/v1alpha/projects/PROJECT/locations/OBSERVATION_SOURCE_LOCATION/observationSources/OBSERVATION_SOURCE_NAME