Add role (Server, Service) application target

Prev Next

Available in Classic and VPC

Add an application target assigned to a server or service role.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/roles/{roleNo}/entities

Request headers

For information about the headers common to all Sub Account APIs, see Sub Account request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
roleNo String Required Role ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
roleEntityList Array Required Role application target list

roleEntityList

The following describes roleEntityList.

Field Type Required Description
type String Optional Role type
  • Server | Service
id String Optional Role application target ID or name
  • Server role: server instance ID
  • Service role: Datafence | DataFlow | ExternalAccess

Request example

The request example is as follows:

curl --location --request POST 'https://subaccount.apigw.ntruss.com/api/v1/roles/5befa3a0-****-****-****-246e96591a38/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 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "roleEntityList": [
    {
      "type": "Server",
      "id": "100****57"
    }
  ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API call success status
  • true | false
    • true: succeeded
    • false: failed
id String - Role application target ID or name
name String - Action type

Response status codes

For information about the HTTP status codes common to all Sub Account APIs, see Sub Account status codes.

Response example

The response example is as follows:

[
  {
    "success": true,
    "id": "100****57",
    "name": "addEntity"
  }
]