Jump to

• Request
• Response

List addon for a cluster.

get

/20180222/clusters/{cluster_id}/addons

List addon for a provisioned cluster.

Request

Supported Media Types

• application/json

Path Parameters

• clusterId(required): string
  The OCID of the cluster.

Query Parameters

• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: 0
• sortBy: string
  The optional field to sort the results by.

  Allowed Values: [ "NAME", "TIME_CREATED" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of addon summary objects.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object AddonSummary
  The properties that define an addon summary.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AddonSummary"
    }
}

Nested Schema : AddonSummary

Type: object

The properties that define an addon summary.

Show Source

• addonError: object AddonError
  The error info of the addon.
• currentInstalledVersion: string
  current installed version of the addon

  Example: x.y.z
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "ACTIVE", "DELETING", "DELETED", "UPDATING", "NEEDS_ATTENTION", "FAILED" ]

  The state of the addon.

  Example: UPDATING
• name(required): string
  The name of the addon.

  Example: Flannel
• timeCreated: string(date-time)
  The time the cluster was created.

  Example: 2017-07-21T16:11:29Z
• version: string
  selected addon version, or null indicates autoUpdate

  Example: x.y.z

{
    "type":"object",
    "description":"The properties that define an addon summary.",
    "required":[
        "name",
        "lifecycleState"
    ],
    "properties":{
        "name":{
            "type":"string",
            "example":"Flannel",
            "description":"The name of the addon."
        },
        "version":{
            "type":"string",
            "description":"selected addon version, or null indicates autoUpdate",
            "example":"x.y.z"
        },
        "currentInstalledVersion":{
            "type":"string",
            "description":"current installed version of the addon",
            "example":"x.y.z"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "example":"2017-07-21T16:11:29Z",
            "description":"The time the cluster was created."
        },
        "lifecycleState":{
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/AddonLifecycleState",
            "enum":[
                "CREATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "UPDATING",
                "NEEDS_ATTENTION",
                "FAILED"
            ],
            "description":"The state of the addon.",
            "example":"UPDATING"
        },
        "addonError":{
            "description":"The error info of the addon.",
            "$ref":"#/definitions/AddonError"
        }
    }
}

Nested Schema : AddonError

Type: object

The error info of the addon.

Show Source

• code: string
  A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).

  Example: LimitExceeded
• message: string
  A human-readable error string of the upstream error.

  Example: error validating payload
• status: string
  The status of the HTTP response encountered in the upstream error.

  Example: 429

{
    "type":"object",
    "description":"The error info of the addon.",
    "properties":{
        "code":{
            "type":"string",
            "example":"LimitExceeded",
            "description":"A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string of the upstream error."
        },
        "status":{
            "type":"string",
            "example":"429",
            "description":"The status of the HTTP response encountered in the upstream error."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top