Traffic Policy 조회

Classic/VPC 환경에서 이용 가능합니다.

지정한 조건에 따라 Traffic Policy를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/policies

요청 헤더

Traffic Policy API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Traffic Policy API의 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`page`	Integer	Optional	페이징된 결과의 페이지 번호 0 (기본값)
`size`	Integer	Optional	한 페이지에 보여줄 결과 개수 20 (기본값)
`applyYn`	Boolean	Optional	적용 여부 `true` \| `false` `true`: 적용함 `false`: 적용 안 함
`domainName`	String	Optional	Profile 이름
`name`	String	Optional	Policy 이름

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://globaltrafficmanager.apigw.gov-ntruss.com/gtm/v1/policies?size=2&applyYn=false' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 PolicyListResponse를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "content": [
        {
            "sid": ****,
            "name": "policy000",
            "lbType": "ROUND_ROBIN",
            "memo": null,
            "monitoringYn": true
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true,
            "empty": true
        },
        "pageNumber": 0,
        "pageSize": 2,
        "offset": 0,
        "paged": true,
        "unpaged": false
    },
    "last": true,
    "totalPages": 1,
    "totalElements": 1,
    "first": true,
    "sort": {
        "sorted": false,
        "unsorted": true,
        "empty": true
    },
    "number": 0,
    "numberOfElements": 1,
    "size": 2,
    "empty": false
}
```<p class="platform-info type-classic-vpc">Classic/VPC 환경에서 이용 가능합니다.</p>

지정한 조건에 따라 Traffic Policy를 조회합니다.

## 요청 <a name="요청"></a>

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

| 메서드 | URI |
| :--- | :--- |
| GET | /gtm/v1/policies |

### 요청 헤더 <a name="요청헤더"></a>

Traffic Policy API에서 공통으로 사용하는 헤더에 대한 정보는 [Traffic Policy API 요청 헤더](/docs/policy-overview#요청헤더)를 참조해 주십시오.

### 요청 쿼리 파라미터 <a name="요청쿼리파라미터"></a>

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

| 필드 | 타입 | 필수 여부 | 설명 |
| :---- | :---- | :---- | :---- |
| `page` | Integer | Optional | 페이징된 결과의 페이지 번호<ul><li>0 (기본값)</li></ul> |
| `size` | Integer | Optional |한 페이지에 보여줄 결과 개수<ul><li>20 (기본값)</li></ul> |
| `applyYn` | Boolean | Optional | 적용 여부<ul><li>`true` \| `false`<ul><li>`true`: 적용함</li><li>`false`: 적용 안 함</li></ul></li></ul> |
| `domainName` | String | Optional | Profile 이름 |
| `name` | String | Optional | Policy 이름 |

### 요청 예시 <a name="요청예시"></a>

요청 예시는 다음과 같습니다.

```shell
curl --location --request GET 'https://globaltrafficmanager.apigw.gov-ntruss.com/gtm/v1/policies?size=2&applyYn=false' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답