Crear una nueva suscripción
POST /accounts/{account_id}/core/v1/subscriptions
Indica los valores deseados para el recurso Subscription API que se va a crear.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
Cuerpo de la solicitud
Indica los valores deseados para el recurso Subscription API que se va a crear.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
customerProfileID |
cadena |
Falso |
Cadena JSON que contiene el ID del perfil del cliente de "Authorize.net", que fue invocado por la interfaz de usuario, no está establecido para el periodo de prueba. Devuelve una cadena vacía durante la operación de lectura, si no está establecido. Los valores definidos son:
|
paymentFirstName |
cadena |
Falso |
Cadena JSON que contiene un nombre largo especificado por el usuario que se utiliza para la facturación de pagos. Se especifica solo cuando se está refacturando la suscripción. Los valores definidos son:
|
paymentLastName |
cadena |
Falso |
Cadena JSON que contiene un apellido largo especificado por el usuario y utilizado para la facturación del pago. Se especifica solo cuando se está refacturando la suscripción. Los valores definidos son:
|
paymentAddress |
Falso |
Objeto JSON que contiene una colección de cadenas JSON que especifican una dirección de facturación. Se especifica solo cuando se está refacturando la suscripción. Si existe esta clave, estarán presentes las seis cadenas JSON contenidas. Si el usuario no ha proporcionado nada, la cadena estará vacía. |
|
paymentProfileID |
cadena |
Falso |
Cadena JSON que contiene el ID del perfil de pago de "Authorize.net" que fue invocado por la interfaz de usuario, no establecido para el periodo de prueba. Devuelve una cadena vacía durante la operación de lectura si no se establece. Los valores definidos son:
|
paymentExpiry |
cadena |
Falso |
Cadena JSON que contiene una marca de tiempo que indica cuándo caduca el método de pago. Esto se obtiene de authorize.net(http://authorize.net y lo establece la interfaz de usuario. Los valores definidos son:
|
mercado |
cadena |
Falso |
Cadena JSON que indica el marketplace de una cuenta donde se registrarán los pagos. Valores definidos:
|
términos |
cadena |
Verdadero |
Cadena JSON que indica el nivel actual de la cuenta. Los valores definidos son:
|
metadatos |
Falso |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
Ejemplo de solicitud
{
"type": "application/astra-subscription",
"version": "1.2",
"terms": "trial"
}
Respuesta
Status: 201, Returns the newly created subscription resource in the JSON response body.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
id |
cadena |
Verdadero |
Identificador único global del recurso. Los valores definidos son:
|
customerProfileID |
cadena |
Verdadero |
Cadena JSON que contiene el ID del perfil del cliente de "Authorize.net", que fue invocado por la interfaz de usuario, no está establecido para el periodo de prueba. Devuelve una cadena vacía durante la operación de lectura, si no está establecido. Los valores definidos son:
|
paymentProfileID |
cadena |
Falso |
Cadena JSON que contiene el ID del perfil de pago de "Authorize.net" que fue invocado por la interfaz de usuario, no establecido para el periodo de prueba. Devuelve una cadena vacía durante la operación de lectura si no se establece. Los valores definidos son:
|
paymentExpiry |
cadena |
Falso |
Cadena JSON que contiene una marca de tiempo que indica cuándo caduca el método de pago. Esto se obtiene de authorize.net(http://authorize.net y lo establece la interfaz de usuario. Los valores definidos son:
|
purchaseOrderNumber |
cadena |
Falso |
Cadena JSON que contiene el número de orden de compra para el método de pago. Los valores definidos son:
|
mercado |
cadena |
Falso |
Cadena JSON que indica el marketplace de una cuenta donde se registrarán los pagos. Valores definidos:
|
licenciaSN |
cadena |
Falso |
Cadena JSON que contiene el número de serie de la licencia para el método de pago. Los valores definidos son:
|
términos |
cadena |
Verdadero |
Cadena JSON que indica el nivel actual de la cuenta. Los valores definidos son:
|
estado |
cadena |
Verdadero |
Cadena JSON que indica el estado actual de la suscripción. Los valores definidos son:
|
appLimit |
número |
Verdadero |
Número JSON que indica el límite de aplicación para esta suscripción. Un valor de -1 indica que no hay límite. |
namespaceLimit |
número |
Verdadero |
Número JSON que indica el límite de espacio de nombres para esta suscripción. Un valor de -1 indica que no hay límite. |
subscriptionPeriod |
número |
Verdadero |
Número JSON que indica el periodo de suscripción. Un valor de -1 indica que no hay límite. Unidad: días |
gracePeriod |
número |
Verdadero |
Número JSON que indica el periodo de gracia después de que caduque la suscripción de prueba o se cancele una suscripción de pago. Unidad: días |
reminderBeforePeriod |
número |
Verdadero |
Número JSON que indica el número de días antes de que finalice la suscripción de prueba cuando comenzarán las notificaciones al cliente. El valor se expresa en días con un valor de -1 que indica que no es aplicable. |
onboardStatus |
cadena |
Verdadero |
Cadena JSON que indica el estado actual de la incorporación del cliente. Los valores válidos son "no iniciado", "en curso", "correcto", "fallido". Los valores definidos son:
|
costPerAppUnit |
número |
Verdadero |
Número JSON que indica el coste por unidad de app. Para una versión de prueba, el valor es 0. Unidad: dólares estadounidenses |
costPerNamespaceUnit |
número |
Verdadero |
Número JSON que indica el coste por unidad de espacio de nombres. Para una versión de prueba, el valor es 0. Unidad: dólares estadounidenses |
metadatos |
Verdadero |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
Ejemplo de respuesta
{
"type": "application/astra-subscription",
"version": "1.2",
"id": "40b4106f-b743-5d83-95c7-d539b2b45f63",
"customerProfileID": "2157047189",
"paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
"paymentExpiry": "2022-02-01T00:00:00Z",
"purchaseOrderNumber": "72384632",
"marketplace": "netapp",
"licenseSN": "278343",
"terms": "trial",
"status": "active",
"appLimit": 0,
"namespaceLimit": 10,
"subscriptionPeriod": 90,
"gracePeriod": 7,
"reminderBeforePeriod": 30,
"onboardStatus": "in progress",
"costPerAppUnit": 0,
"costPerNamespaceUnit": 0.005,
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Respuesta
Status: 401, Unauthorized
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Respuesta
Status: 400, Bad request
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos no válidos en el cuerpo de la solicitud |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Respuesta
Status: 409, Conflict
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos no válidos en el cuerpo de la solicitud |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
Respuesta
Status: 403, Forbidden
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"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
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta de error
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definiciones
Ver definiciones
paymentAddress
Objeto JSON que contiene una colección de cadenas JSON que especifican una dirección de facturación. Se especifica solo cuando se está refacturando la suscripción. Si existe esta clave, estarán presentes las seis cadenas JSON contenidas. Si el usuario no ha proporcionado nada, la cadena estará vacía.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
addressCountry |
cadena |
Verdadero |
Cadena JSON que contiene el nombre del país o el código de país asociado a la dirección postal, tal como se especifica en ISO 3166 Alfa-2. Los valores definidos son:
|
addressLocality |
cadena |
Verdadero |
Cadena JSON que contiene la localidad (por ejemplo, ciudad) asociada a la dirección postal. Los valores definidos son:
|
addressRegion |
cadena |
Verdadero |
Cadena JSON que contiene la región (por ejemplo, estado) asociada a la dirección postal. Los valores definidos son:
|
postalCode |
cadena |
Verdadero |
Cadena JSON que contiene el código postal asociado a la dirección postal. Los valores definidos son:
|
streetAddress1 |
cadena |
Verdadero |
Cadena JSON que contiene la dirección de la calle asociada a la dirección postal. Los valores definidos son:
|
streetAddress2 |
cadena |
Falso |
Cadena JSON que contiene información auxiliar opcional sobre la dirección, el apartado de correos y más. Los valores definidos son:
|
etiqueta_tipo_astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
|
valor |
cadena |
Verdadero |
type_astra_metadatos_update
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
-
Se ajusta al esquema de metadatos de Astra Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
etiquetas |
array["etiqueta_tipo_astra"] |
Falso |
|
CreationTimestamp |
cadena |
Falso |
|
Modificación.Marca de hora |
cadena |
Falso |
|
CreatedBy |
cadena |
Falso |
|
modifiedBy |
cadena |
Falso |
invalidParams
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del parámetro de consulta no válido |
motivo |
cadena |
Verdadero |
Razón por la que el parámetro de consulta no es válido |
invalidFields
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del campo no válido del cuerpo de la solicitud |
motivo |
cadena |
Verdadero |
Motivo por el que el campo del cuerpo de la solicitud no es válido |