보안 작업 API

이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.

Apigee Edge 문서 보기

Apigee UI에서 보안 작업을 사용하는 것 외에도 Apigee API를 통해 모든 보안 작업 기능에 액세스할 수 있습니다.

보안 작업에 대한 제한사항

보안 작업은 Apigee 환경 수준에서 적용됩니다. 환경마다 보안 작업에 다음과 같은 제한사항이 있습니다.

  • 언제든지 환경에 대해 최대 1,000개의 사용 설정된 작업이 허용됩니다.
  • 각 작업에 대해 플래그 헤더를 최대 5개까지 추가할 수 있습니다.

지연 시간

보안 작업의 지연 시간은 다음과 같습니다.

  • 보안 작업을 만들 때 작업이 적용되기까지 최대 10분이 걸릴 수 있습니다. 작업이 적용되고 일부 API 트래픽에 적용된 후에는 보안 작업 세부정보 페이지에서 작업의 효과를 확인할 수 있습니다. 참고: 작업이 적용된 경우에도 일부 API 트래픽에 작업이 적용되지 않으면 보안 작업 세부정보 페이지에서 확인할 수 없습니다.
  • 사용 설정된 보안 작업으로 API 프록시 응답 시간이 (2% 미만으로) 약간 증가합니다.

보안 작업 만들기

다음 예에서는 API 호출을 사용하여 보안 작업을 만드는 방법을 보여줍니다. 모든 예에서 다음을 확인할 수 있습니다.

  • ORG는 조직입니다.
  • ENV는 보안 작업을 위한 환경입니다.
  • ACTION_NAME은 보안 작업 이름입니다.

거부 작업 만들기

거부 작업을 만들려면 다음과 유사한 명령어를 입력합니다.

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
       -H "Content-Type: application/json" \
       -d '{"state": "ENABLED", "deny": {"response_code": 404}, "condition_config": {"ip_address_ranges": ["100.0.225.0"]}}'

이렇게 하면 ip_address_ranges 뒤에 나열된 IP 주소에 대한 요청에 대한 액세스를 거부하고 응답 코드 404를 반환하는 보안 작업이 생성됩니다.

플래그 작업 만들기

플래그 작업을 만들려면 다음과 유사한 명령어를 입력합니다.

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME" \
        -H "Content-Type: application/json" \
        -d '{"state": "ENABLED", "flag": {"headers": [{"name": "senseflag", "value": "flagvalue"}]}, "condition_config": {"ip_address_ranges": ["100.0.230.0"]}}'

이렇게 하면 ip_address_ranges 뒤에 나열된 IP 주소의 요청에 플래그를 지정하고 값이 flagvalue인 senseflag 헤더를 추가하는 보안 작업이 생성됩니다.

허용 작업 만들기

허용 작업을 만들려면 다음과 유사한 명령어를 입력합니다.

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions?security_action_id=ACTION_NAME \
        -H "Content-Type: application/json" \
        -d '{"state": "ENABLED", "allow": {}, "condition_config": {"ip_address_ranges": ["100.0.220.0", "200.0.0.0"]}}'

이렇게 하면 ip_address_ranges 뒤에 나열된 IP 주소의 요청을 허용하는 보안 작업이 생성됩니다.

보안 작업 사용 설정 또는 사용 중지

다음 예시에서는 보안 작업을 사용 설정하거나 사용 중지하는 API 호출을 보여줍니다.

보안 작업 사용 설정

보안 작업을 사용 설정하려면 다음과 유사한 명령어를 입력합니다.

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:enable"

그러면 다음과 같은 응답이 반환됩니다.

{
      "name": "ACTION_ALLOW",
      "state": "ENABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:19:26.650965481Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
   }

보안 작업 사용 중지

보안 작업을 사용 중지하려면 다음과 유사한 명령어를 입력합니다.

curl -XPOST "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME:disable"

그러면 다음과 같은 응답이 반환됩니다.

{
      "name": "actionallow",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04.874540001Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
   }

보안 작업 가져오기 또는 나열

다음 예에서는 보안 작업을 가져오거나 나열하는 방법을 보여줍니다.

보안 작업 가져오기

보안 작업을 가져오려면 다음과 유사한 명령어를 입력합니다.

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions/ACTION_NAME"

그러면 다음과 같은 응답이 반환됩니다.

{
      "name": "ACTION_NAME",
      "state": "DISABLED",
      "createTime": "2022-12-29T18:27:31Z",
      "updateTime": "2023-01-03T23:13:04Z",
      "conditionConfig": {
        "ipAddressRanges": [
          "100.0.220.0",
          "200.0.0.0"
        ]
      },
      "allow": {},
      "expireTime": "2028-01-01T00:00:00Z"
    }

보안 작업 나열

모든 보안 작업을 나열하려면 다음과 유사한 명령어를 입력합니다.

curl -XGET  "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActions"

보안 작업 일시중지 또는 재개

다음 예에서는 보안 작업을 일시중지하거나 재개하는 방법을 보여줍니다.

모든 보안 작업 일시중지

모든 보안 작업을 일시중지하려면 다음과 유사한 명령어를 입력합니다.

curl -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -H "Content-Type: application/json" \
                -d '{"enabled": "false", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

그러면 다음과 같은 응답이 반환됩니다.

{
      "name": "organizations//environments/ENV/securityActionsConfig",
      "enabled": false,
      "updateTime": "2023-01-23T21:44:58.063807Z"
    }
}

일시중지된 보안 작업 재개

일시중지된 보안 작업을 재개하려면 다음과 유사한 명령어를 입력합니다.

curl  -XPATCH "https://apigee.googleapis.com/v1/organizations/ORG/environments/ENV/securityActionsConfig" \
                -H "Content-Type: application/json" \
                -d '{"enabled": "true", "name": "organizations/ORG/environments/ENV/securityActionsConfig"}'

그러면 다음과 같은 응답이 반환됩니다.

{
      "name": "organizations/ORG/environments/ENV/securityActionsConfig",
      "enabled": true,
      "updateTime": "2023-01-23T21:44:58.063807Z"
    }
}