resolveSubAccountNos

이 가이드는 API 명세를 기반으로 자동 생성했습니다.

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

Ncloud API 표준 규격을 적용한 API입니다.

요청한 서브 계정 번호를 각각에 대응하는 서브 계정 식별자로 변환해 반환합니다. 변환 대상은 인증된 계정에 속한 서브 계정으로 한정되며, 소속되지 않은 번호는 결과에 포함되지 않습니다. 존재하지 않는 번호도 결과에 포함되지 않으며, 삭제된 서브 계정의 번호는 변환됩니다. 같은 번호를 여러 번 지정하면 결과에는 한 번만 포함됩니다.

요청

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

메서드	URI
POST	/sub-accounts/resolve-nos

요청 헤더

Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`subAccountNos`	List<Integer (int64)>	Required	변환할 서브 계정 번호 목록 항목 수: 1 ~ 100 <예시> `[23229, 26040]`

요청 예시

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

curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v2/sub-accounts/resolve-nos' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "subAccountNos": [
    23229,
    26040
  ]
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`subAccountIds`	List<SubAccountIdMapping>	-	요청한 서브 계정 번호와 그에 대응하는 서브 계정 식별자 목록

SubAccountIdMapping

서브 계정 번호와 서브 계정 식별자의 변환 결과

필드	타입	필수 여부	설명
`subAccountNo`	Integer (int64)	-	요청한 서브 계정 번호 <예시> 23229
`subAccountId`	String (uuid)	-	해당 번호에 대응하는 서브 계정 식별자 <예시> 558f4b00-1923-11f1-bdf6-246e966ebec4

응답 상태 코드

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.	유효하지 않은 요청. 필수 필드 누락, 형식 오류 등 입력값 검증 실패
403	Forbidden	You do not have sufficient permissions to perform this action.	요청한 자원(또는 상위 자원)에 대한 접근 권한 없음. 자원의 존재 여부와 무관하게 우선 반환

응답 예시

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

{
  "subAccountIds": [
    {
      "subAccountNo": 23229,
      "subAccountId": "558f4b00-1923-11f1-bdf6-246e966ebec4"
    }
  ]
}