This is the multi-page printable view of this section. Click here to print.
Create PrivateLink Endpoint
1 - 1.2
scpcli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Endpoint.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name required | string | PrivateLink Endpoint Name | EndpointName |
| endpoint_ip_address required | string | Endpoint IP Address | 192.167.1.5 |
| description optional | string | Description | PrivateLink Endpoint Description |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |
2 - 1.1
scpcli vpc privatelink-endpoint create
--subnet_id <value>
--name <value>
--endpoint_ip_address <value>
[--description <value>]
[--privatelink_service_id <value>]
[--security_group_ids <value>]
[--tags <value>]
Description
Create PrivateLink Endpoint.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| subnet_id required | string | Subnet Id | 023c57b14f11483689338d085e061492 |
| name required | string | PrivateLink Endpoint Name | EndpointName |
| endpoint_ip_address required | string | Endpoint IP Address | 192.167.1.5 |
| description optional | string | Description | PrivateLink Endpoint Description |
| privatelink_service_id optional | string | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids optional | array | Security Group List | [ |
| tags optional | array | Tag List | '{"key": "", "value": ""}' |
Responses
| Name | Description | Example |
|---|---|---|
| id | PrivateLink Endpoint ID | bba6d4de3ad64e41b3a1b6c88983ec02 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| approval_type | PrivateLink Service Approval Type | AUTO |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | PrivateLink Endpoint Description |
| endpoint_ip_address | Endpoint IP Address | 192.167.1.5 |
| endpoint_ip_port_id | Endpoint IP Port ID | b44417b8-e5c5-4d44-a2ea-c8a8b23fbb6e |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| name | PrivateLink Endpoint Name | EndpointName |
| privatelink_service_id | PrivateLink Service ID | e3df2e8e3b374fbb81d4e322b52ca50d |
| security_group_ids | Security Group List | [‘17776b52-0a64-440d-9e93-b4fc37be935b’] |
| state | PrivateLink Endpoint State | ACTIVE |
| subnet_id | Subnet Id | 023c57b14f11483689338d085e061492 |
| vpc_id | VPC Id | 7df8abb4912e4709b1cb237daccca7a8 |