Skip to content
Internal API Catalog
/
Data Services API
/
issues

Data Services API (1.3.0)

Data Services API

Download OpenAPI description
index.json
index.yaml
Overview
License

HPE End User License Agreement

Languages
Servers
Mock server

https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/

https://us-west.api.greenlake.hpe.com/

https://eu-west.api.greenlake.hpe.com/

https://eu-central.api.greenlake.hpe.com/

https://ap-northeast.api.greenlake.hpe.com/

async-operations

Async Operations API

Operations

dual-auth-operations

Dual Authorization API

Operations

issues

Issues API

Operations

List active issues

Request

Returns the list of active issues for the account and user obtained from the request header. The list includes issues only for the resource-types that the user has permissions to view. Active issues are issues in the CREATED state. Clients using this API must process the returned issues for any desired groupings.

Security
bearer
Query
offsetinteger

Use offset in conjunction with limit for paging. The offset is the number of items from the beginning of the result set to the first item included in the response.

limitinteger[ 1 .. 100 ]

Use limit in conjunction with offset for paging. The limit is the maximum number of items to include in the response.

Default 10
filterstring

The expression used to filter responses. You can filter on the following properties: issueType, severity, category, state, createdAt, services, sourceResourceId, sourceResourceType. You can combine multiple comparison operators using “and”. The returned set of resources must match the criteria in the filter query parameter A comparison compares a property name to a literal. The comparisons supported are the following: “eq” : Is a property equal to value. Valid for number, boolean and string properties. “gt” : Is a property greater than a value. Valid for number or string timestamp properties. “lt” : Is a property less than a value. Valid for number or string timestamp properties “in” : Is a value in a property. The property is an array of number, boolean or string properties. "contains": Is a substring value that is equal to a portion of the property value. Valid for strings. Syntax: “eq” : filter=<property> eq <value> {host:port}/data-services/v1beta1/issues?filter=<property> eq <value> “gt” : filter=<property> gt <value> {host:port}/data-services/v1beta1/issues?filter=<property> gt <value> “lt” : filter=<property> lt <value> {host:port}/data-services/v1beta1/issues?filter=<property> lt <value> “in” : filter=<property> in <value> {host:port}/data-services/v1beta1/issues?filter=<property> in <value> “contains” : filter=contains(property,value) {host:port}/data-services/v1beta1/issues?filter=contains(property,value)

  • Can use and to add more filter inputs {host:port}/data-services/v1beta1/issues?filter=<property1> eq <value1> and <property2> lt <value2>
  • To filter multiple values on one property e.g. filter=severity in ('CRITICAL','WARNING') {host:port}/data-services/v1beta1/issues?filter=severity%20in%20CRITICAL%2CWARNING Examples: GET /data-services/v1beta1/issues?filter=issueType eq 'ISSUE' GET /data-services/v1beta1/issues?filter=issueType eq 'ISSUE' & state eq 'CREATED' GET /data-services/v1beta1/issues?filter=contains(sourceResourceType,'orchestrator') GET /data-services/v1beta1/issues?filter='data-ops-manager' in services Filters are supported on following attributes: issueType, severity, category, state, createdAt, services, sourceResourceId, sourceResourceType
sortstring

resource property to sort, with an order appended Order may only be either “asc” (ascending) or “desc” (descending)

Example: sort=/issues?sort=id desc
selectstring

The select query parameter is used to limit the properties returned with a resource or collection-level GET. Multiple properties can be listed to be returned. The server must only return the set of properties requested by the client. The property “select” is the name of the select query parameter; its value is the list of properties to return separated by commas.

curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/issues \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Issues list

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(IssueDetails)required

The issues returned by the query.

items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​createdAtstring(date-time)required
items[].​updatedAtstring(date-time)required
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

items[].​customerIdstringread-onlyrequired

The customer application identifier

items[].​namestring

A system specified name for the resource.

items[].​bodystring

Long description with more details including possible remediations.

items[].​categorystring

Category of the issue. PERFORMANCE, CAPACITY, etc

items[].​clearedAtstring(date-time)

Time when the issue was cleared. RFC 3339 timestamp

items[].​groupsArray of objects(GroupIDNamePair)

Groups this issue is associated with.

items[].​issueTypestring

The type of the issue. Eg: ISSUE

items[].​lastOccurredAtstring(date-time)

Time when the issue last occurred. RFC 3339 timestamp

items[].​occurrenceCountinteger

Indicates the number of occurrences of the issue

items[].​recommendationstring

Recommendation to address the underlying issue.

items[].​relatedResourcesArray of objects(IssueRelatedResourcesReference)

Details of the resources related to the issue

items[].​servicesArray of strings

Details of the services this issue belongs to

items[].​severitystring

Severity of the issue. For issue: CRITICAL, WARNING, INFO. For reco: HIGH, MEDIUM, LOW

items[].​snoozedboolean

An auxiliary calculated attribute to help the end-user filter snoozed and un-snoozed issues

items[].​snoozedBystring

The email id of the last user who snoozed this issue.

items[].​snoozedForstring
Enum"NONE""DAY""WEEK"
items[].​snoozedUntilstring(date-time)

Date-time until this issue will be considered snoozed/inactive until this time. RFC 3339

items[].​sourceResourceIdstring

Identifier for the source resource that is contained in relatedResources

items[].​sourceResourceTypestring

Type of the source resource that is contained in the relatedResources

items[].​statestring

State of the issue. Eg: CREATED, ASSIGNED, CLOSED, SNOOZED, DELETED, etc

totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Returns all the supported Issues metadata relevant to the UI and API clients

Request

Returns the list of values of category, services, and severity supported by Issues. Functionalities like query parameters, filtering, sorting, grouping, and paging are not supported.

Security
bearer
Query
offsetinteger

The number of items to skip before starting to collect the result set

limitinteger[ 1 .. 100 ]

The numbers of items to return

Default 10
curl -i -X GET \
  https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/issues-metadata \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Issues Metadata

Bodyapplication/json
countintegerrequired

Number of items in this response.

offsetintegerrequired

The offset query parameter from the request.

itemsArray of objects(IssuesMetadata)required

The issues metadata returned by the query.

items[].​idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

items[].​typestringread-onlyrequired

The type of resource.

items[].​generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

items[].​createdAtstring(date-time)required
items[].​updatedAtstring(date-time)required
items[].​resourceUristringread-onlyrequired

The self reference for this resource.

items[].​customerIdstringread-onlyrequired

The customer application identifier

items[].​namestring

A system specified name for the resource.

items[].​categoriesArray of objects(IssuesMetadataKeyValuePair)
items[].​servicesArray of objects(IssuesMetadataKeyValuePair)
items[].​severitiesArray of objects(IssuesMetadataKeyValuePair)
totalinteger

Total number of items matching the filter parameter in the request.

Response
application/json
{
  "count": 0,
  "offset": 0,
  "total": 0,
  "items": [
    { … }
  ]
}

Get a singular issue

Request

Returns an active issue with the specified id for the account obtained from the request header. The issue must be in the CREATED state

Security
bearer
Path
idstring(uuid)required

The UUID of the issue

Query
selectstring

Limits the properties returned with a resource or collection-level GET. Specify a comma-separated list of properties. (e.g.: "?select=id,type,customerId,services,createdAt,lastOccurredAt,generation,resourceUri")

curl -i -X GET \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/issues/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Details of the issue with the given Id

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

bodystring

Long description with more details including possible remediations.

categorystring

Category of the issue. PERFORMANCE, CAPACITY, etc

clearedAtstring(date-time)

Time when the issue was cleared. RFC 3339 timestamp

groupsArray of objects(GroupIDNamePair)

Groups this issue is associated with.

issueTypestring

The type of the issue. Eg: ISSUE

lastOccurredAtstring(date-time)

Time when the issue last occurred. RFC 3339 timestamp

occurrenceCountinteger

Indicates the number of occurrences of the issue

recommendationstring

Recommendation to address the underlying issue.

relatedResourcesArray of objects(IssueRelatedResourcesReference)

Details of the resources related to the issue

servicesArray of strings

Details of the services this issue belongs to

severitystring

Severity of the issue. For issue: CRITICAL, WARNING, INFO. For reco: HIGH, MEDIUM, LOW

snoozedboolean

An auxiliary calculated attribute to help the end-user filter snoozed and un-snoozed issues

snoozedBystring

The email id of the last user who snoozed this issue.

snoozedForstring
Enum"NONE""DAY""WEEK"
snoozedUntilstring(date-time)

Date-time until this issue will be considered snoozed/inactive until this time. RFC 3339

sourceResourceIdstring

Identifier for the source resource that is contained in relatedResources

sourceResourceTypestring

Type of the source resource that is contained in the relatedResources

statestring

State of the issue. Eg: CREATED, ASSIGNED, CLOSED, SNOOZED, DELETED, etc

Response
application/json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "body": "string",
  "category": "string",
  "clearedAt": "2019-08-24T14:15:22Z",
  "groups": [
    { … }
  ],
  "issueType": "string",
  "lastOccurredAt": "2019-08-24T14:15:22Z",
  "occurrenceCount": 0,
  "recommendation": "string",
  "relatedResources": [
    { … }
  ],
  "services": [
    "string"
  ],
  "severity": "string",
  "snoozed": true,
  "snoozedBy": "string",
  "snoozedFor": "NONE",
  "snoozedUntil": "2019-08-24T14:15:22Z",
  "sourceResourceId": "string",
  "sourceResourceType": "string",
  "state": "string"
}

Changes the attributes of an existing Issue object

Request

To snooze an Issue, this API should get a request with body {snoozedFor: timeperiod}. Currently, the allowed time-period for snoozing can be a day, a week, a month or infinite. Hence, the values for snoozedFor should be from this set {"DAY", "WEEK", "MONTH", "INFINITE", "NONE"}. "NONE" corresponds to unsnoozing a snoozed issue. When the Issue is unsnoozed, the snoozed_until is set to zero timestamp. If any other value is received, HTTP 422 may be returned. Also, no other parameters will be accepted in the body. The caller may get HTTP 422.

Security
bearer
Path
idstring(uuid)required

The UUID of the issue

Bodyapplication/merge-patch+jsonrequired
snoozedForstringrequired
Enum"NONE""DAY""WEEK"
generationstringrequired

A monotonically increasing value incremented every time the resource is updated

curl -i -X PATCH \
  'https://stage-developer-portal-hpe.redocly.app/_mock/docs/greenlake/services/data-services/public/openapi/data-services-public-v1beta1/data-services/v1beta1/issues/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "generation": "string",
    "snoozedFor": "NONE"
  }'

Responses

Details of the issue with the given Id

Bodyapplication/json
idstring(uuid)read-onlyrequired

An identifier for the resource, usually a UUID.

typestringread-onlyrequired

The type of resource.

generationinteger(int64)read-onlyrequired

A monotonically increasing value. This value updates when the resource is updated and can be used as a short way to determine if a resource has changed or which of two different copies of a resource is more up to date.

createdAtstring(date-time)required
updatedAtstring(date-time)required
resourceUristringread-onlyrequired

The self reference for this resource.

customerIdstringread-onlyrequired

The customer application identifier

namestring

A system specified name for the resource.

bodystring

Long description with more details including possible remediations.

categorystring

Category of the issue. PERFORMANCE, CAPACITY, etc

clearedAtstring(date-time)

Time when the issue was cleared. RFC 3339 timestamp

groupsArray of objects(GroupIDNamePair)

Groups this issue is associated with.

issueTypestring

The type of the issue. Eg: ISSUE

lastOccurredAtstring(date-time)

Time when the issue last occurred. RFC 3339 timestamp

occurrenceCountinteger

Indicates the number of occurrences of the issue

recommendationstring

Recommendation to address the underlying issue.

relatedResourcesArray of objects(IssueRelatedResourcesReference)

Details of the resources related to the issue

servicesArray of strings

Details of the services this issue belongs to

severitystring

Severity of the issue. For issue: CRITICAL, WARNING, INFO. For reco: HIGH, MEDIUM, LOW

snoozedboolean

An auxiliary calculated attribute to help the end-user filter snoozed and un-snoozed issues

snoozedBystring

The email id of the last user who snoozed this issue.

snoozedForstring
Enum"NONE""DAY""WEEK"
snoozedUntilstring(date-time)

Date-time until this issue will be considered snoozed/inactive until this time. RFC 3339

sourceResourceIdstring

Identifier for the source resource that is contained in relatedResources

sourceResourceTypestring

Type of the source resource that is contained in the relatedResources

statestring

State of the issue. Eg: CREATED, ASSIGNED, CLOSED, SNOOZED, DELETED, etc

Response
application/json
{
  "createdAt": "2019-08-24T14:15:22Z",
  "customerId": "string",
  "generation": 0,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "resourceUri": "string",
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z",
  "body": "string",
  "category": "string",
  "clearedAt": "2019-08-24T14:15:22Z",
  "groups": [
    { … }
  ],
  "issueType": "string",
  "lastOccurredAt": "2019-08-24T14:15:22Z",
  "occurrenceCount": 0,
  "recommendation": "string",
  "relatedResources": [
    { … }
  ],
  "services": [
    "string"
  ],
  "severity": "string",
  "snoozed": true,
  "snoozedBy": "string",
  "snoozedFor": "NONE",
  "snoozedUntil": "2019-08-24T14:15:22Z",
  "sourceResourceId": "string",
  "sourceResourceType": "string",
  "state": "string"
}

secret-assignments

Secret Assignment Management APIs

Operations

secrets

Secret Management APIs

Operations

settings

Settings API

Operations

software-releases

Software Releases

Operations

storage-locations

storage-locations API.

Operations

tags

Tags APIs

Operations