Tenant Partitioning

Description

Tenant partitioning API details

Security

Secured (HTTP Basic Authentication)

DEFAULT

POST ``/api/v2/hocapi/v1/provider/{provider-name}/cluster/{cluster-name}/_check_feature_support``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

cluster-name

path

Yes

string

Generated header parameter. Example value =’test-cluster’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

features

No

array of string

{
    "features": [
        "somestring",
        "somestring"
    ]
}

Responses

200

Type: CheckFeatureSupportResponse

Example:

{
    "provisioning": true
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/hocapi/v1/provider/{provider-name}/cluster/{cluster-name}/_provision/``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

cluster-name

path

Yes

string

Generated header parameter. Example value =’test-cluster’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

scan

No

array of string

{
    "scan": [
        "somestring",
        "somestring"
    ]
}

Responses

200

Type: ProvisionResponse

Example:

{
    "workflow": {
        "workflow-id": "somestring"
    }
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/hpcapi/v3/provider/{provider-name}/tenant/{tenant-name}/logical-partition``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

tenant-name

path

Yes

string

Generated header parameter. Example value =’test-tenant’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

logical-partition

No

Logical-partition

{
    "logical-partition": {
        "name": "somestring",
        "type": "somestring"
    }
}

Responses

200

Type: CreateLogicalPartitionResponse

Example:

{
    "logical-partition": {
        "a10-url": "somestring",
        "app-type": "somestring",
        "name": "somestring",
        "running-version": 1,
        "type": "somestring",
        "uuid": "somestring",
        "vnp-id": 1
    }
}

Security

Security Schema

Scopes

Secured

POST ``/api/v2/hpcapi/v3/subscriber``

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

subscriber

No

Subscriber

{
    "subscriber": {
        "receiver-list": [
            {
                "uuid": "somestring"
            },
            {
                "uuid": "somestring"
            }
        ],
        "uuid": "somestring"
    }
}

Responses

200

Type: CreateSubscriberResponse

Example:

{
    "extension": {
        "msg": "somestring"
    },
    "subscriber": {
        "a10-url": "somestring",
        "receiver-list": [
            {
                "uuid": "somestring"
            },
            {
                "uuid": "somestring"
            }
        ],
        "uuid": "somestring"
    }
}

Security

Security Schema

Scopes

Secured

PUT ``/api/v2/hpcapi/v3/provider/{provider-name}/cluster/{cluster-name}/partition``

Parameters

Name

Located in

Required

Type

Format

Properties

Description

provider-name

path

Yes

string

Generated header parameter. Example value =’root’

cluster-name

path

Yes

string

Generated header parameter. Example value =’test-cluster’

Request

Headers

provider: Generated header parameter. Example value ='root'

Body

Name

Required

Type

Format

Properties

Description

partition-list

No

array of Partition-list

{
    "partition-list": [
        {
            "id": 1,
            "lp-uuid": "somestring",
            "name": "somestring",
            "partition-uuid": "somestring",
            "tenant-uuid": "somestring"
        },
        {
            "id": 1,
            "lp-uuid": "somestring",
            "name": "somestring",
            "partition-uuid": "somestring",
            "tenant-uuid": "somestring"
        }
    ]
}

Responses

200

Type: UpdatePartitionResponse

Example:

{
    "partition-list": [
        {
            "a10-url": "somestring",
            "id": 1,
            "log-rate": 1,
            "lp-uuid": "somestring",
            "name": "somestring",
            "partition-uuid": "somestring",
            "tenant-uuid": "somestring",
            "uuid": "somestring"
        },
        {
            "a10-url": "somestring",
            "id": 1,
            "log-rate": 1,
            "lp-uuid": "somestring",
            "name": "somestring",
            "partition-uuid": "somestring",
            "tenant-uuid": "somestring",
            "uuid": "somestring"
        }
    ]
}

Security

Security Schema

Scopes

Secured

Data Structures

Check Feature Support Request Model Structure

Name

Required

Type

Format

Properties

Description

features

No

array of string

Check Feature Support Response Model Structure

Name

Required

Type

Format

Properties

Description

provisioning

No

boolean

Create Logical Partition Request Model Structure

Name

Required

Type

Format

Properties

Description

logical-partition

No

Logical-partition

Create Logical Partition Response Model Structure

Name

Required

Type

Format

Properties

Description

logical-partition

No

CreateLogicalPartitionResponse_Logical-partition

Create Logical Partition Response Logical-partition Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

app-type

No

string

name

No

string

running-version

No

integer

int32

type

No

string

uuid

No

string

vnp-id

No

integer

int32

Create Subscriber Request Model Structure

Name

Required

Type

Format

Properties

Description

subscriber

No

Subscriber

Create Subscriber Response Model Structure

Name

Required

Type

Format

Properties

Description

extension

No

Extension

subscriber

No

CreateSubscriberResponse_Subscriber

Create Subscriber Response Subscriber Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

receiver-list

No

array of CreateSubscriberResponse_Subscriber_Receiver-list

uuid

No

string

Create Subscriber Response Subscriber Receiver-list Model Structure

Name

Required

Type

Format

Properties

Description

uuid

No

string

Extension Model Structure

Name

Required

Type

Format

Properties

Description

msg

No

string

Logical Partition Model Structure

Name

Required

Type

Format

Properties

Description

name

No

string

type

No

string

Partition List Model Structure

Name

Required

Type

Format

Properties

Description

id

No

integer

int32

lp-uuid

No

string

name

No

string

partition-uuid

No

string

tenant-uuid

No

string

Provision Request Model Structure

Name

Required

Type

Format

Properties

Description

scan

No

array of string

Provision Response Model Structure

Name

Required

Type

Format

Properties

Description

workflow

No

Workflow

Receiver List Model Structure

Name

Required

Type

Format

Properties

Description

uuid

No

string

Subscriber Model Structure

Name

Required

Type

Format

Properties

Description

receiver-list

No

array of Receiver-list

uuid

No

string

Update Partition Request Model Structure

Name

Required

Type

Format

Properties

Description

partition-list

No

array of Partition-list

Update Partition Response Model Structure

Name

Required

Type

Format

Properties

Description

partition-list

No

array of UpdatePartitionResponse_Partition-list

Update Partition Response Partition List Model Structure

Name

Required

Type

Format

Properties

Description

a10-url

No

string

id

No

integer

int32

log-rate

No

integer

int32

lp-uuid

No

string

name

No

string

partition-uuid

No

string

tenant-uuid

No

string

uuid

No

string

Workflow Model Structure

Name

Required

Type

Format

Properties

Description

workflow-id

No

string