Push Cluster Policy Mapping to Legacy CA Setting

This API is used to help in deploying policy in cluster of policy central type.

Request Structure

Endpoint: /kube-cluster-policy-mapping-push
Type: POST
Sample URL: https://<IP/HostName/TenantName>:<GWPORT>/avxapi/kube-cluster-policy-mapping-push?gwsource=kube

To understand the elements of the sample URL, click here.
Headers:
Content-Type: application/json
Table 1. Input Parameter
Name Description
sessionId

Header

 (Mandatory) A unique identifier assigned to a user's session upon successful authentication. The session ID remains valid until it expires, and it can contain alphanumeric characters.

Type: String

Constraints: The session ID is used when username and password are not provided.

Example: A1B2c3d4E5F6
gwsource

Query

 (Mandatory) Source from which the request is triggered.

Type: String

Example: DataCenterA
payload

Body

 (Mandatory) Input data for request body in application/json format. For payload details, see Payload section.

Payload

Table 2. Input Parameter
Name Description
policyName

String

Name of the cluster poicy.
clusterPolicyType

String

Type of the cluster policy.

Possible Value: Legacy Policy
policyMappingInfos

Object

List containing mapping information for clusters.
comment

String

Optional comment provided for the mapping.

Response Structure

  • Status Code: 200 OK
  • Message: SUCCESS
  • Headers:
    • Content-Type: application/json
Name Description
response

String

 Successfully performed action on selected Objects
message

String

 Success message or failure description in case of error.
appStatusCode

String

 Application specific status code for the response. Will be non-null for failure response.
tags More info in case of failure response.

Status Codes

Table 3. Status Codes and Description
HTTP Status code appStatusCode Message and Possible remediation
200 OK NA Success
200 FAILURE KUBEPLUS_0024 Selected Issuer CA is in a state where action cannot be performed. Please check its state
400 Bad Request AVX-VLDTN-001 Mandatory field is missing or invalid values specified - <<field name>>

Possible remediation: Check and ensure that valid value is provided for <<field name>> field in the request.
401 Unauthorized AVX_GW_003 Authentication failed, reason - Invalid Credentials

Possible remediation: Ensure that valid username and password or valid sessionId is provided as the header param.

Sample Request/Response

Use case: Push the cluster policy mapping to a legacy CA settings.
Request URL

https://<IP/HostName/TenantName>:<GWPORT>/avxapi/kube-cluster-policy-mapping-push?gwsource=kube

Sample Request 
POST Content type: application/json Username: <> Password: <>
{
    "payload": {
        "policyName": "cluster-policy",
        "clusterPolicyType": "Legacy Policy",
        "policyMappingInfos": [
            {
                "clusterName": "kubeplus",
                "kubeCaSettingName": "amazon-private-ca-cluster-wide",
                "caSettingType": "CA Setting Cluster"
            }
        ],
        "comment": "comment"
    }
}
Sample Response 
{
    "response": {
        "messageType": "SUCCESS",
        "message": "Successfully performed action on selected Objects"
    },
    "message": "Successfully performed action on selected Objects",
    "appStatusCode": "success",
    "tags": null,
    "headers": null
}

Reference

Understanding the sample URL: This section provides an explanation of each component of the sample URL structure used in API requests. For quick reference, this section is referenced in all the API topics as Reference in this guide.
  • IP/HostName/TenantName: Replace with the actual IP address, hostname, or tenant name based on the specific configuration in AppViewX.
    • IP: A unique identifier assigned to each device connected to a computer network that uses the Internet Protocol for communication

      The IP address will be included in the endpoint URL for an on-prem deployment.

    • HostName: A human-readable label assigned to a device (host) on a network

      The hostname will be included in the endpoint URL for an on-prem deployment.

    • TenantName: An identifier label for a tenant given to indicate which tenant's data the API request will access/modify

      The tenant name will be included in the endpoint URL for a SaaS deployment.

  • GWPORT: AppViewX gateway port

    A gateway port refers to a network port through which data is sent and received to communicate with a gateway in an on-prem deployment.

    Example: 31443

  • avxapi: Path parameter value (static) that is part of the endpoint's URL
  • Endpoint: Endpoint of the API, for example: execute-hook
  • gwsource: Source or origin of a gateway, for example: external.

What's Next