Overview
SCP에서 제공하는 IaaS/PaaS 상품을 프로그램적으로 이용할 수 있도록 지원하는 명령 줄 인터페이스(Command-line interface, CLI)를 제공합니다.
본 가이드는 CloudControl 서비스에 대한 간략한 설명 및 CLI를 호출하는 방법을 제공합니다.
Version
| Version | Status | Supported Until |
|---|---|---|
| 1.0 | CURRENT | - |
이 섹션의 다중 페이지 출력 화면임. 여기를 클릭하여 프린트.
Cloud Control
- 1: CLIs
- 1.1: AddBaselineAssignment
- 1.1.1: 1.0
- 1.2: CreateAccountFactoryAccount
- 1.2.1: 1.0
- 1.3: CreateLandingZone
- 1.3.1: 1.0
- 1.4: DeleteLandingZone
- 1.4.1: 1.0
- 1.5: DisableGuardrailBindings
- 1.5.1: 1.0
- 1.6: EnableGuardrailBindings
- 1.6.1: 1.0
- 1.7: ListBaselineAssignments
- 1.7.1: 1.0
- 1.8: ListGuardrails
- 1.8.1: 1.0
- 1.9: ListGuardrailsForTarget
- 1.9.1: 1.0
- 1.10: ListTargetsForGuardrail
- 1.10.1: 1.0
- 1.11: ShowGuardrail
- 1.11.1: 1.0
- 1.12: ShowLandingZone
- 1.12.1: 1.0
- 1.13: UpdateBaselineAssignment
- 1.13.1: 1.0
1 - CLIs
1.1 - AddBaselineAssignment
1.1.1 - 1.0
scpcli cloudcontrol baseline assignment add
--assignment_id <value>
--resource_type <value>
--landing_zone_id <value>
[--agree_yn <value>]
[--parent_unit_id <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]
Description
add a new baseline assignment
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| resource_type required | string | OU/ACCOUNT | OU |
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn optional | **** | 약관 동의 여부 | Y |
| parent_unit_id optional | string | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| sso_user_name optional | string | ID Center 사용자명 | testuser |
| sso_user_real_name optional | string | ID Center 사용자 실명 | test user |
Responses
| Name | Description | Example |
|---|---|---|
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
| resource_id | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| resource_type | OU/ACCOUNT | OU |
1.2 - CreateAccountFactoryAccount
1.2.1 - 1.0
scpcli cloudcontrol account create from factory
--parent_unit_id <value>
--name <value>
--landing_zone_id <value>
[--email <value>]
[--sso_user_email <value>]
[--sso_user_name <value>]
[--sso_user_real_name <value>]
Description
create an account using account factory.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| parent_unit_id required | string | 상위 조직 단위 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| name required | string | 계정명 | foo-account |
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| email optional | string | 계정 이메일 | myaccount@example.com |
| sso_user_email optional | string | ID Center 사용자 이메일 | user_email@example.com |
| sso_user_name optional | string | ID Center 사용자 이름 | John Doe |
| sso_user_real_name optional | string | ID Center 사용자 실명 | John Doe |
Responses
| Name | Description | Example |
|---|---|---|
| account_id | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
1.3 - CreateLandingZone
1.3.1 - 1.0
scpcli cloudcontrol landing zone create
--sso_type <value>
--log_archive_login_id <value>
--log_archive_account_name <value>
--basic_ou_name <value>
--audit_login_id <value>
--audit_account_name <value>
--agree_yn <value>
--additional_ou_name <value>
Description
Create a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| sso_type required | string | Account 액세스 구성 | ID_CENTER |
| log_archive_login_id required | string | 로그인 ID | log-archive@samsung.com |
| log_archive_account_name required | string | 로그 아카이브 계정명 | LOG_ARCHIVE |
| basic_ou_name required | string | 기본 조직 단위명 | Security |
| audit_login_id required | string | 로그인 ID | audit@samsung.com |
| audit_account_name required | string | 감사 계정명 | AUDIT |
| agree_yn required | string | 약관 동의 여부 | Y |
| additional_ou_name required | string | 추가 조직 단위명 | Sandbox |
Responses
| Name | Description | Example |
|---|---|---|
| job_id | ID | 0a36e0746dbf4908acf0357829701381 |
| landing_zone_id | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
1.4 - DeleteLandingZone
1.4.1 - 1.0
scpcli cloudcontrol landing zone delete
--landing_zone_id <value>
Description
Delete a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
1.5 - DisableGuardrailBindings
1.5.1 - 1.0
scpcli cloudcontrol guardrail disable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]
Description
disable guardrail bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_ids required | array | 타겟 정보 | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| guardrail_ids required | array | 가드레일 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
1.6 - EnableGuardrailBindings
1.6.1 - 1.0
scpcli cloudcontrol guardrail enable
--unit_ids <value>
--guardrail_ids <value>
[--landing_zone_id <value>]
Description
enable guardrail bindings
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| unit_ids required | array | 타겟 정보 | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| guardrail_ids required | array | 가드레일 목록 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| error_code | error code | CloudControl.AlreadyEnabledGuardrails |
| failed_caused | 실패 원인 | guardrail already enabled |
| guardrail_id | 가드레일 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| unit_id | 타겟 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
1.7 - ListBaselineAssignments
1.7.1 - 1.0
scpcli cloudcontrol baseline assignment list
[--landing_zone_id <value>]
[--resource_type <value>]
[--assignment_id <value>]
[--status <value>]
Description
get baseline assignment list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| resource_type optional | **** | OU/ACCOUNT | OU |
| assignment_id optional | string | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| status optional | **** | 상태 | REGISTRATION_FAILED |
Responses
| Name | Description | Example |
|---|---|---|
| id | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| account_assigned_count | 등록된 계정 수 | 3 |
| account_count | 전체 계정 수 | 4 |
| ou_assigned_count | 등록된 조직 단위 수 | 5 |
| ou_count | 전체 조직 단위 수 | 10 |
| preventive_guardrail_activated_count | 활성화된 예방 가드레일 수 | 8 |
| sso_user_name | ID Center 사용자명 | testuser |
| status | 상태 | REGISTERED |
| type | OU/ACCOUNT | OU |
1.8 - ListGuardrails
1.8.1 - 1.0
scpcli cloudcontrol guardrail list
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
[--exclude_unit_id <value>]
[--guidance <value>]
[--service_name <value>]
[--status <value>]
Description
get guardrails list
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 가드레일명 | foo-guardrail |
| exclude_unit_id optional | string | 연결된(제외) 유닛 ID | ou-c29a138f8f1d78e24dbfa8681fc2fc8 |
| guidance optional | string | 정책 가이드 | MANDATORY |
| service_name optional | string | Organization | iam |
| status optional | string | 적용 상태 | ENABLED |
Responses
| Name | Description | Example |
|---|---|---|
| id | 가드레일 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| description | 가드레일 설명 | This is an example guardrail. |
| guidance | 정책 가이드 | MANDATORY |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 가드레일명 | foo-guardrail |
| service_name | Organization | iam |
| srn | 가드레일 SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | 적용 상태 | |
| type | 가드레일 유형 | PREVENTIVE |
1.9 - ListGuardrailsForTarget
1.9.1 - 1.0
scpcli cloudcontrol target guardrail list
--target_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
list guardrails for target
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_id required | string | 타겟 ID | ou-1a2b3c4d5e6f7g8h9i0j1k2l3m4n5 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 가드레일명 | guardrail-example |
Responses
| Name | Description | Example |
|---|---|---|
| id | ID | 0a36e0746dbf4908acf0357829701381 |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| guidance | 정책 가이드 | MANDATORY |
| link_types | 연결 유형 | {‘directed’: [{’target_id’: ‘1a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ’example-target’}], ‘inherited’: [{’target_id’: ‘2a2b3c4d5e6f7g8h9i0j1k2l3m4n5’, ’target_name’: ‘root’}]} |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 가드레일명 | foo-guardrail |
| service_name | Organization | iam |
| type | 가드레일 유형 | PREVENTIVE |
1.10 - ListTargetsForGuardrail
1.10.1 - 1.0
scpcli cloudcontrol guardrail target list
--target_type <value>
--guardrail_id <value>
[--landing_zone_id <value>]
[--size <value>]
[--page <value>]
[--sort <value>]
[--name <value>]
Description
list targets for guardrail
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| target_type required | **** | 타겟유형 | ACCOUNT |
| guardrail_id required | string | 가드레일 ID | f98e76d54c32b10a9z8y7x6w5v4u3 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| name optional | string | 타겟명 | ou-test |
Responses
| Name | Description | Example |
|---|---|---|
| id | 조직 계정 ID | b4d3f2h1j0l9n8p7r6t5v4x3z2y1w0 |
| 계정 이메일 | score@samsung.com | |
| name | 계정명 | score-account |
| parent_unit_id | ROOT 또는 부모 조직 단위 ID | ou-fc8c29a138d78e24bf1fa86812fc8b |
| parent_unit_name | ROOT 또는 부모 조직 단위명 | parent-unit-name |
1.11 - ShowGuardrail
1.11.1 - 1.0
scpcli cloudcontrol guardrail show
--guardrail_id <value>
[--landing_zone_id <value>]
Description
show a specific guardrail.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| guardrail_id required | string | 가드레일 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| landing_zone_id optional | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 가드레일 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| binding_ous | ||
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| description | 가드레일 설명 | This is an example guardrail. |
| guidance | 정책 가이드 | MANDATORY |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| name | 가드레일명 | foo-guardrail |
| service_name | Organization | iam |
| srn | 가드레일 SRN | srn:dev2:::::cloudcontrol:guardrail/2c8a138f8d78e1fc29a449dbfa8681 |
| status | 적용 상태 | |
| type | 가드레일 유형 | PREVENTIVE |
1.12 - ShowLandingZone
1.12.1 - 1.0
scpcli cloudcontrol landing zone show
--landing_zone_id <value>
Description
Show a landing zone
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
Responses
| Name | Description | Example |
|---|---|---|
| id | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn | 약관 동의 여부 | Y |
| created_at | 생성 일시 | 2024-12-19 01:09:05.000 |
| created_by | 생성자 | c23fb561c689455993874fa5d5ed4a2f |
| creator_name | 생성자 성, 이름 | John Doe na |
| identity_center_id | Identity Center ID | 0xnw6g1xh2q5 |
| modified_at | 수정 일시 | 2023-10-15 14:30:00 |
| modified_by | 수정자 | c23fb561c689455993874fa5d5ed4a2f |
| modifier_name | 수정자 성, 이름 | Alice |
| organization_id | 조직 ID | o-x9y8z7w6v5u4t3s2r1q0p9o8n7m6l5 |
| region | 리전 | kr-west1 |
| service_name | 서비스명 | Cloud Control |
| srn | 랜딩 존 SRN | srn:dev2::a8a2f3c2659646ecaaf28fc8f783921a:::cloudcontrol:landingzone/f7a1ef0b17e34a37811cc2fa7a6bd50b |
| sso_type | Account 액세스 구성 | ID_CENTER |
| status | 상태 | ACTIVE |
| version_id | 랜딩 존 버전 | 1.0 |
1.13 - UpdateBaselineAssignment
1.13.1 - 1.0
scpcli cloudcontrol baseline assignment update
--assignment_id <value>
--landing_zone_id <value>
[--agree_yn <value>]
Description
update a specific baseline assignment.
상태 ACTIVE (CURRENT)
| 버전 | 최소 지원 보장일 |
|---|---|
| 1.0 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| assignment_id required | string | 루트/조직 단위/계정 ID | ou-b30e9fcc39f84a20bf9e7458e5ec3801 |
| landing_zone_id required | string | 랜딩 존 ID | 2c8a138f8d78e1fc29a449dbfa8681 |
| agree_yn optional | **** | 약관 동의 여부 | Y |