This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

List Private NAT IP

1 - 1.3

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Get Private NAT IP list.

State ACTIVE (CURRENT)

VersionNot Before
1.3-

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required		Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryip_address
optional		Private NAT IP Address
Example :
any of [string, null]None
querystate
optional		Private NAT IP State
Example :
any of [enum (RESERVED, ATTACHED, DELETED), null]None
queryattached_resource_type
optional		Private NAT IP Attached Resource Type
Example :
any of [enum (VM, BM, ALB, GPU_SERVER), null]None
queryattached_resource_id
optional		Private NAT IP Attached Resource ID
Example :
any of [string, null]None
queryattached_resource_name
optional		Private NAT IP Attached Resource Name
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatIpListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.3"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

2 - 1.2

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Get Private NAT IP list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.220270131

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required		Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryip_address
optional		Private NAT IP Address
Example :
any of [string, null]None
querystate
optional		Private NAT IP State
Example :
any of [enum (RESERVED, ATTACHED, DELETED), null]None
queryattached_resource_type
optional		Private NAT IP Attached Resource Type
Example :
any of [enum (VM, BM, ALB, GPU_SERVER), null]None
queryattached_resource_id
optional		Private NAT IP Attached Resource ID
Example :
any of [string, null]None
queryattached_resource_name
optional		Private NAT IP Attached Resource Name
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatIpListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.2"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

3 - 1.1

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Get Private NAT IP list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.120261130

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required		Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryip_address
optional		Private NAT IP Address
Example :
any of [string, null]None
querystate
optional		Private NAT IP State
Example :
any of [enum (RESERVED, ATTACHED, DELETED), null]None
queryattached_resource_type
optional		Private NAT IP Attached Resource Type
Example :
any of [enum (VM, BM, ALB, GPU_SERVER), null]None
queryattached_resource_id
optional		Private NAT IP Attached Resource ID
Example :
any of [string, null]None
queryattached_resource_name
optional		Private NAT IP Attached Resource Name
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatIpListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

4 - 1.0

get /v1/private-nats/{private_nat_id}/private-nat-ips

Description

Get Private NAT IP list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionNot Before
1.020251231

Parameters

TypeNameDescriptionSchemaDefault
pathprivate_nat_id
required		Private NAT ID
Example : 12f56e27070248a6a240a497e43fbe18
stringNone
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryip_address
optional		Private NAT IP Address
Example :
any of [string, null]None
querystate
optional		Private NAT IP State
Example :
any of [enum (RESERVED, ATTACHED, DELETED), null]None
queryattached_resource_type
optional		Private NAT IP Attached Resource Type
Example :
any of [enum (VM, BM, ALB, GPU_SERVER), null]None
queryattached_resource_id
optional		Private NAT IP Attached Resource ID
Example :
any of [string, null]None
queryattached_resource_name
optional		Private NAT IP Attached Resource Name
Example :
any of [string, null]None

Responses

HTTP CodeDescriptionSchema
200OKPrivateNatIpListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/private-nats/{private_nat_id}/private-nat-ips

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = vpc 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "page": 0,
    "private_nat_ips": [
        {
            "attached_resource_id": "",
            "attached_resource_name": "",
            "attached_resource_type": "VM",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "id": "",
            "ip_address": "",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "private_nat_id": "",
            "state": "RESERVED"
        }
    ],
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}