日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

Retrieve an entitlement

10/23/2024 共同作成者

PDF

GET /accounts/{account_id}/core/v1/entitlements/{entitlement_id}

Returns the stored Entitlement API resource in the JSON response body.

Parameters

Name	Type	In	Required	Description
account_id	string	path	True	ID of the containing account resource example: {{.Account}}
entitlement_id	string	path	True	ID of the entitlement collection to list

Name

Type

Required

Description

account_id

string

path

True

ID of the containing account resource

example: {{.Account}}

entitlement_id

string

path

True

ID of the entitlement collection to list

Response

Status: 200, Returns the stored Entitlement API resource in the JSON response body.

Name	Type	Required	Description
type	string	True	Media type of the resource. Defined values are: "application/astra-entitlement"
version	string	True	Version of the resource. Defined values are: "1.0"
id	string	True	Globally unique identifier of the resource. Defined values are: Conforms to the UUIDv4 Schema
allocation	string	False	JSON string containing the ID of the object that the entitlement is allocated to. Only present when the entitlement is allocated. String contents not validated by the schema.
product	string	False	JSON string containing the product string extracted from the license or subscription. String contents not validated by the schema.
productVersion	string	False	JSON string containing the version string extracted from the license or subscription. String contents not validated by the schema.
entitlementType	string	True	JSON string containing the type of the entitlement. This is extracted from the license or subscription. String contents not validated by the schema.
entitlementValue	string	True	JSON string containing the capacity associated with the entitlement. String contents not validated by the schema.
entitlementConsumption	string	False	JSON string containing the amount of the capacity associated with the entitlement that is currently in use. String contents not validated by the schema.
sourceLicense	string	False	JSON string containing the license object ID that the entitlement is sourced from. Defined values are: Conforms to the Astra Identifier Schema
sourceSubscription	string	False	JSON string containing the ID of the subscription object that the entitlement is sourced from. Defined values are: Conforms to the Astra Identifier Schema
validFromTimestamp	string	False	JSON string containing a timestamp indicating when the entitlement becomes valid. Defined values are: Conforms to the ISO-8601 Date Time Schema
validUntilTimestamp	string	False	JSON string containing a timestamp indicating when the entitlement is no longer valid. Defined values are: Conforms to the ISO-8601 Date Time Schema
metadata	type_astra_metadata	True	Client and service-specified metadata associated with the resource. Defined values are: Conforms to the Astra Metadata Schema

Name

Type

Required

Description

type

string

True

Media type of the resource. Defined values are:

"application/astra-entitlement"

version

string

True

Version of the resource. Defined values are:

"1.0"

string

True

Globally unique identifier of the resource. Defined values are:

Conforms to the UUIDv4 Schema

allocation

string

False

JSON string containing the ID of the object that the entitlement is allocated to. Only present when the entitlement is allocated. String contents not validated by the schema.

product

string

False

JSON string containing the product string extracted from the license or subscription. String contents not validated by the schema.

productVersion

string

False

JSON string containing the version string extracted from the license or subscription. String contents not validated by the schema.

entitlementType

string

True

JSON string containing the type of the entitlement. This is extracted from the license or subscription. String contents not validated by the schema.

entitlementValue

string

True

JSON string containing the capacity associated with the entitlement. String contents not validated by the schema.

entitlementConsumption

string

False

JSON string containing the amount of the capacity associated with the entitlement that is currently in use. String contents not validated by the schema.

sourceLicense

string

False

JSON string containing the license object ID that the entitlement is sourced from. Defined values are:

Conforms to the Astra Identifier Schema

sourceSubscription

string

False

JSON string containing the ID of the subscription object that the entitlement is sourced from. Defined values are:

Conforms to the Astra Identifier Schema

validFromTimestamp

string

False

JSON string containing a timestamp indicating when the entitlement becomes valid. Defined values are:

Conforms to the ISO-8601 Date Time Schema

validUntilTimestamp

string

False

JSON string containing a timestamp indicating when the entitlement is no longer valid. Defined values are:

Conforms to the ISO-8601 Date Time Schema

metadata

type_astra_metadata

True

Client and service-specified metadata associated with the resource. Defined values are:

Conforms to the Astra Metadata Schema

Example response

{
  "type": "application/astra-entitlement",
  "version": "1.0",
  "id": "8bdafc19-bde6-5f45-9808-4893c845c9f5",
  "product": "Astra SDS",
  "productVersion": "1.0",
  "entitlementType": "capacity",
  "entitlementValue": "2",
  "entitlementConsumption": "1",
  "sourceLicense": "c8aa757a-5318-489f-8134-a2a1a6956a3e",
  "validFromTimestamp": "2020-08-06T00:00:00.000000Z",
  "validUntilTimestamp": "2021-08-06T00:00:00.000000Z",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Response

Status: 401, Unauthorized

Name	Type	Required
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Response

Status: 400, Bad request

Name	Type	Required	Description
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False
invalidParams	array[invalidParams]	False	List of invalid query parameters

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

invalidParams

array[invalidParams]

False

List of invalid query parameters

Example response

{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Response

Status: 403, Forbidden

Name	Type	Required
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

Example response

{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Error

Status: 404, Not found

Name	Type	Required
type	string	True
title	string	True
detail	string	False
status	string	True
correlationID	string	False

Name

Type

Required

Description

type

string

True

title

string

True

detail

string

False

status

string

True

correlationID

string

False

Example error response

{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Definitions

See Definitions

type_astra_label

Name	Type	Required	Description
name	string	True
value	string	True

Name

Type

Required

Description

name

string

True

value

string

True

type_astra_metadata

Client and service-specified metadata associated with the resource. Defined values are:

Conforms to the Astra Metadata Schema

Name	Type	Required
labels	array[type_astra_label]	True
creationTimestamp	string	True
modificationTimestamp	string	True
createdBy	string	True
modifiedBy	string	False

Name

Type

Required

Description

labels

array[type_astra_label]

True

creationTimestamp

string

True

modificationTimestamp

string

True

createdBy

string

True

modifiedBy

string

False

invalidParams

Name	Type	Required	Description
name	string	True	Name of the invalid query parameter
reason	string	True	Reason why the query parameter is invalid

Name

Type

Required

Description

name

string

True

Name of the invalid query parameter

reason

string

True

Reason why the query parameter is invalid

Retrieve an entitlement

Creating your file...

Parameters

Response

Response

Response

Response

Error

Definitions