Recuperar um direito
GET /accounts/{account_id}/core/v1/entitlements/{entitlement_id}
Retorna o recurso da API Entitlement armazenado no corpo da resposta JSON.
Parâmetros
| Nome | Tipo | Em | Obrigatório | Descrição |
|---|---|---|---|---|
id_da_conta |
string |
caminho |
Verdadeiro |
ID do recurso de conta que o contém
|
entitlement_id |
string |
caminho |
Verdadeiro |
ID da coleção de direitos a ser listada |
Resposta
Status: 200, Returns the stored Entitlement API resource in the JSON response body.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
Tipo de mídia do recurso. Os valores definidos são:
|
versão |
string |
Verdadeiro |
Versão do recurso. Os valores definidos são:
|
id |
string |
Verdadeiro |
Identificador globalmente único do recurso. Os valores definidos são:
|
alocação |
string |
Falso |
String JSON contendo o ID do objeto ao qual o direito está alocado. Presente apenas quando o direito está alocado. O conteúdo da string não foi validado pelo esquema. |
produto |
string |
Falso |
Cadeia JSON contendo a string do produto extraída da licença ou assinatura. O conteúdo da string não foi validado pelo esquema. |
productVersion |
string |
Falso |
String JSON contendo a string de versão extraída da licença ou assinatura. O conteúdo da string não foi validado pelo esquema. |
entitlementType |
string |
Verdadeiro |
String JSON contendo o tipo de direito. Este valor é extraído da licença ou assinatura. O conteúdo da string não foi validado pelo esquema. |
entitlementValue |
string |
Verdadeiro |
String JSON contendo a capacidade associada ao entitlement. O conteúdo da string não foi validado pelo esquema. |
entitlementConsumption |
string |
Falso |
String JSON contendo a quantidade de capacidade associada à licença que está atualmente em uso. O conteúdo da string não foi validado pelo esquema. |
sourceLicense |
string |
Falso |
String JSON contendo o ID do objeto de licença do qual a entitlement é originada. Os valores definidos são:
|
sourceSubscription |
string |
Falso |
String JSON contendo o ID do objeto de assinatura do qual o direito é originado. Os valores definidos são:
|
validFromTimestamp |
string |
Falso |
String JSON contendo um carimbo de data/hora indicando quando o direito se torna válido. Os valores definidos são:
|
validUntilTimestamp |
string |
Falso |
String JSON contendo um carimbo de data/hora indicando quando o direito deixa de ser válido. Os valores definidos são:
|
metadados |
Verdadeiro |
Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:
|
Exemplo de resposta
{
"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"
}
}
Resposta
Status: 401, Unauthorized
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
Exemplo de resposta
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Resposta
Status: 400, Bad request
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
|
invalidParams |
array["invalidParams"] |
Falso |
Lista de parâmetros de consulta inválidos |
Exemplo de resposta
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Resposta
Status: 403, Forbidden
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
Exemplo de resposta
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Erro
Status: 404, Not found
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
|
status |
string |
Verdadeiro |
|
ID de correlação |
string |
Falso |
Exemplo de resposta de erro
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definições
Ver definições
tipo_astra_label
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome |
string |
Verdadeiro |
|
valor |
string |
Verdadeiro |
tipo_metadados_astra
Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:
-
Conforme o esquema de metadados Astra
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
etiquetas |
array["tipo_astra_label"] |
Verdadeiro |
|
CriaçãoTimestamp |
string |
Verdadeiro |
|
Alteração do Timestamp |
string |
Verdadeiro |
|
CreatedBy |
string |
Verdadeiro |
|
modifiedBy |
string |
Falso |
invalidParams
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome |
string |
Verdadeiro |
Nome do parâmetro de consulta inválido |
razão |
string |
Verdadeiro |
Motivo pelo qual o parâmetro de consulta é inválido |