이 가이드는 API 명세를 기반으로 자동 생성했습니다.
Classic/VPC 환경에서 이용 가능합니다.
Ncloud API 표준 규격을 적용한 API입니다.
지정한 정책이 연결된 서브 계정·그룹·역할을 페이지 단위로 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /policies/{policyId}/resources |
요청 헤더
Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
policyId |
String (uuid) | Required | 대상 정책의 식별자
|
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
pageNo |
Integer (int32) | Optional | 페이지 번호. 0부터 시작
|
pageSize |
Integer (int32) | Optional | 페이지당 항목 수
|
sort |
List<String> | Optional | 정렬 조건. 형식: property,(asc|desc). 허용 값: resourceName, resourceType. 값이 고유하지 않은 정렬 키를 사용하면 동일한 값을 가진 항목 사이의 순서는 보장되지 않음
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v2/policies/4e066e50-9c3a-11e7-8a66-1e5021fa7c80/resources' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
resources |
List<PolicyResource> | - | 현재 페이지의 리소스 목록 |
totalElements |
Integer (int64) | - | 조건에 맞는 전체 항목 수
|
totalPages |
Integer (int32) | - | 전체 페이지 수
|
pageNo |
Integer (int32) | - | 현재 페이지 번호. 0부터 시작
|
pageSize |
Integer (int32) | - | 페이지당 항목 수
|
PolicyResource
정책이 연결된 리소스(서브 계정·그룹·역할) 정보
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
resourceType |
String | - | 리소스의 유형. SubAccount(서브 계정), Group(그룹), Role(역할) 중 하나
|
resourceId |
String (uuid) | - | 리소스의 식별자. 리소스 유형에 따라 서브 계정·그룹·역할의 식별자
|
resourceName |
String | - | 리소스의 이름. 서브 계정은 로그인 아이디, 그룹·역할은 이름
|
nrn |
String | - | 리소스를 고유하게 식별하는 NAVER Cloud 리소스 이름(NRN)
|
응답 상태 코드
Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.
이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 200 | - | - | 정책이 연결된 서브 계정·그룹·역할 목록을 페이지 단위로 반환 |
| 400 | BadRequest | The request is malformed or contains an error such as an invalid parameter value or a missing required parameter. | 유효하지 않은 요청. policyId UUID 형식 위반, pageNo/pageSize 범위 위반, 지원하지 않는 sort 속성 등 경로·쿼리 파라미터 검증 실패 |
| 403 | Forbidden | You do not have sufficient permissions to perform this action. | 요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환 |
| 404 | NotFound | One or more of the resources in the request does not exist in the system. | 요청한 자원을 찾을 수 없음 |
응답 예시
응답 예시는 다음과 같습니다.
{
"resources": [
{
"resourceType": "SubAccount",
"resourceId": "4e066e50-9c3a-11e7-8a66-1e5021fa7c80",
"resourceName": "my-sub-account",
"nrn": "nrn:GOV:IAM::25000000:SubAccount/4e066e50-9c3a-11e7-8a66-1e5021fa7c80"
}
],
"totalElements": 150,
"totalPages": 8,
"pageNo": 0,
"pageSize": 20
}