이 가이드는 API 명세를 기반으로 자동 생성했습니다.
Classic/VPC 환경에서 이용 가능합니다.
Ncloud API 표준 규격을 적용한 API입니다.
역할 ID로 지정한 역할에 서버 인스턴스 등 하나 이상의 엔티티를 원자적으로 연결합니다. 연결할 수 없는 항목이 하나라도 포함되면 어떤 엔티티도 연결하지 않고 실패 항목별 오류를 반환합니다. Account 유형 엔티티는 이 오퍼레이션으로 연결할 수 없으며, 역할로 전환할 대상 계정은 attach-account로 연결합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /roles/{roleId}/attach-entities |
요청 헤더
Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
roleId |
String (uuid) | Required | 대상 역할의 식별자
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
roleEntities |
List<RoleEntityParam> | Required | 연결할 역할 엔터티 목록
|
RoleEntityParam
역할에 연결할 엔터티 정보
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
id |
String | Required | 연결할 엔터티의 식별자. Server 유형은 서버 인스턴스 번호, Service 유형은 서비스 이름을 사용
|
type |
String | Required | 연결할 엔터티의 유형. 역할의 유형과 같은 유형만 연결 가능. Account 유형은 이 오퍼레이션으로 연결할 수 없으며, 역할로 전환할 대상 계정은 attach-account로 연결. SSO와 NcloudStorage는 각 서비스가 관리하는 유형이라 지정 불가. 값은 V1 API와 같은 역할 유형 코드를 그대로 사용
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://subaccount.apigw.gov-ntruss.com/api/v2/roles/4e066e50-9c3a-11e7-8a66-1e5021fa7c80/attach-entities' \
--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 '{
"roleEntities": [
{
"id": "12345",
"type": "Server"
}
]
}'
응답
응답 형식을 설명합니다.
응답 상태 코드
Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.
이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.
| HTTP 상태 코드 | 코드 | 메시지 | 설명 |
|---|---|---|---|
| 204 | - | - | 요청을 정상적으로 처리했으며 응답 본문 없음 |
| 400 | BadRequest | The request is malformed or contains an error such as an invalid parameter value or a missing required parameter. | 입력값 검증에 실패했거나 항목별 실패 원인이 혼재(혼재 시 400 대표 코드). 원자적 처리로 어떤 자원도 변경되지 않으며, 실패 원인은 항목별로 failures 본문에 담아 반환 |
| 403 | Forbidden | You do not have sufficient permissions to perform this action. | 요청 자원에 대한 접근 권한이 없거나 허용되지 않는 자원이 포함됨. 원자적 처리로 어떤 자원도 변경되지 않으며, 실패 원인은 항목별로 failures 본문에 담아 반환 |
| 404 | RoleNotFound | The specified role could not be found. | 지정한 역할이 존재하지 않음 |
| 404 | NotFound | One or more of the resources in the request does not exist in the system. | 요청한 항목 중 존재하지 않는 항목 있음. 원자적 처리로 어떤 자원도 변경되지 않으며, 실패 원인은 항목별로 failures 본문에 담아 반환 |
| 409 | AlreadyExists | A resource with the requested identifier already exists. | 요청한 항목 중 이미 연결된 엔터티 있음 |
| 409 | ResourceInUse | The specified resource is in use. | 요청한 서버 중 다른 역할에 연결된 서버 있음 |