Liste todos os recursos AppMirror
GET /accounts/{account_id}/k8s/v1/appMirrors
Retorna uma matriz JSON com todos os recursos correspondentes na coleção. Se campos individuais forem especificados na solicitação, a matriz JSON de itens conterá os campos solicitados para cada recurso correspondente na ordem especificada.
Parâmetros
| Nome | Tipo | Em | Obrigatório | Descrição |
|---|---|---|---|---|
id_da_conta |
string |
caminho |
Verdadeiro |
ID do recurso de conta que o contém
|
incluir |
string |
consulta |
Falso |
Indica quais campos devem ser retornados ao listar uma coleção. Exemplos de URL: "include=id", "include=id,name" Exemplos OpenAPI: "id" |
limite |
string |
consulta |
Falso |
Indica o número máximo de recursos a serem retornados ao listar uma coleção. Exemplos de URL: "limit=2" Exemplos OpenAPI: "2" |
filtro |
string |
consulta |
Falso |
Indica quais campos devem ser correspondidos para retornar um recurso ao listar uma coleção. Os operadores suportados são:
Exemplo de URL: "filter=field%20eq%20%27value%27" Exemplos OpenAPI: "campo eq 'valor'" |
Resposta
Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
itens |
array[Qualquer um de: "appMirror_1.0_get_response_body", array[]] |
Verdadeiro |
|
metadados |
Verdadeiro |
Exemplo de resposta
{
"type": "application/astra-appMirrors",
"version": "1.0",
"items": [
{
"type": "application/astra-appMirror",
"version": "1.0",
"id": "f1c98c2e-6391-42d3-8b21-3e75dac048a3",
"sourceAppID": "efd639b6-fc92-4112-8841-0c0ab7890ae0",
"sourceClusterID": "5789e026-c2e2-41e9-ab00-9766bcfa8951",
"destinationAppID": "cd7b6d91-fc19-4983-a754-9a7bb4d80a7b",
"destinationClusterID": "c5d023a9-4061-4a8a-bfbf-3be11ff06226",
"namespaceMapping": [
{
"clusterID": "5789e026-c2e2-41e9-ab00-9766bcfa8951",
"namespaces": [
"ns1-src",
"ns2-src"
]
},
{
"clusterID": "c5d023a9-4061-4a8a-bfbf-3be11ff06226",
"namespaces": [
"ns1-dest",
"ns2-dest"
]
}
],
"state": "established",
"stateTransitions": [
{
"from": "establishing",
"to": [
"established",
"deleting"
]
},
{
"from": "established",
"to": [
"failingOver",
"deleting"
]
},
{
"from": "failingOver",
"to": [
"failedOver",
"deleting"
]
},
{
"from": "failedOver",
"to": [
"establishing",
"deleting"
]
},
{
"from": "deleting",
"to": [
"deleted"
]
}
],
"stateDesired": "established",
"stateAllowed": [
"failedOver",
"deleted"
],
"stateDetails": [
{
"type": "https://astra.netapp.io/stateDetails/1",
"title": "AppMirror relationship established",
"detail": "The AppMirror relationship has been successfully established."
}
],
"healthState": "normal",
"healthStateTransitions": [
{
"from": "indeterminate",
"to": [
"normal",
"warning",
"critical"
]
},
{
"from": "normal",
"to": [
"indeterminate",
"warning",
"critical"
]
},
{
"from": "warning",
"to": [
"indeterminate",
"normal",
"critical"
]
},
{
"from": "critical",
"to": [
"indeterminate",
"normal",
"warning"
]
}
],
"healthStateDetails": [
{
"type": "https://astra.netapp.io/stateDetails/2",
"title": "SnapMirror syncing successfully",
"detail": "All SnapMirror relationships are synchronizing as expected."
}
],
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa"
}
}
],
"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
namespaceMapping
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ID do cluster |
string |
Falso |
Identificador do cluster para o qual os namespaces são especificados. Os valores definidos são:
|
espaços de nomes |
array[string] |
Falso |
Lista de namespaces a serem usados no cluster. Correlacionada com a lista de namespaces de outro cluster por índice. Os valores definidos são:
|
storageClasses
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ID do cluster |
string |
Falso |
Identificador do cluster para o qual a classe de armazenamento está especificada. Os valores definidos são:
|
storageClassName |
string |
Falso |
Nome da classe de armazenamento a ser usada ao criar PVCs no cluster especificado em "clusterID". Os valores definidos são:
|
type_astra_stateTransition
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
de |
string |
Verdadeiro |
|
para |
array[string] |
Verdadeiro |
type_astra_stateDetail
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tipo |
string |
Verdadeiro |
|
título |
string |
Verdadeiro |
|
detalhe |
string |
Verdadeiro |
tipo_astra_label
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
nome |
string |
Verdadeiro |
|
valor |
string |
Verdadeiro |
type_astra_metadados_update
Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:
-
Está em conformidade com o esquema de metadados Astra. Se não for especificado na criação, um objeto de metadados será criado sem rótulos. Se não for especificado na atualização, os rótulos do objeto de metadados, creationTimestamp e createdBy, serão preservados sem modificação.
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
etiquetas |
array["tipo_astra_label"] |
Falso |
|
CriaçãoTimestamp |
string |
Falso |
|
Alteração do Timestamp |
string |
Falso |
|
CreatedBy |
string |
Falso |
|
modifiedBy |
string |
Falso |
appMirror_1.0_get_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:
|
ID do aplicativo de origem |
string |
Verdadeiro |
Identificador do aplicativo de origem. Atualizado somente quando o sourceAppID é trocado pelo destinationAppID. Os valores definidos são:
|
ID do cluster de origem |
string |
Verdadeiro |
Identificador do cluster gerenciado que hospeda o aplicativo de origem. Este campo é somente leitura e é determinado com base no cluster host do aplicativo de origem. Se fornecido em uma atualização, ele deve corresponder ao ID do cluster do aplicativo de origem, portanto, só pode ser alterado ao trocar o sourceAppID pelo destinationAppID. Os valores definidos são:
|
ID do aplicativo de destino |
string |
Falso |
Identificador do aplicativo de destino. Não pode ser fornecido na criação, pois um novo ID de aplicativo será gerado como parte da inicialização do relacionamento. Só pode ser atualizado ao trocar sourceAppID pelo destinationAppID. Os valores definidos são:
|
ID do cluster de destino |
string |
Verdadeiro |
Identificador do cluster gerenciado que hospedará o aplicativo de destino. Deve ser fornecido na criação, pois determina em qual cluster o aplicativo de destino será criado. Se fornecido na atualização, deve corresponder ao ID do cluster de destino do aplicativo de destino, portanto, só pode ser alterado ao trocar sourceAppID por destinationAppID. Os valores definidos são:
|
namespaceMapping |
array["namespaceMapping"] |
Falso |
O namespace ou namespaces a serem usados ao criar o aplicativo de destino, correspondentes aos namespaces do aplicativo de origem. Cada objeto JSON contém os campos "clusterID" e "namespaces", onde o valor de "clusterID" é a string JSON que identifica o cluster de origem ou de destino, e o valor de "namespaces" é um array JSON de strings JSON. Deve haver exatamente um objeto JSON para cada cluster, e os namespaces serão correlacionados por índice. Se não forem fornecidos, o mesmo namespace do cluster de origem será usado no cluster de destino. Os valores definidos são:
|
storageClasses |
array["storageClasses"] |
Falso |
A classe de armazenamento a ser usada no cluster de destino ao criar novas Persistent Volume Claims (PVCs). Cada objeto JSON contém os campos "clusterID" e "storageClassName", onde o valor "clusterID" é o ID em formato de string JSON do cluster de origem ou cluster de destino, e o "storageClassName" é a classe de armazenamento a ser usada ao criar PVCs nesse cluster. Se não for fornecido ou se o valor estiver ausente para um cluster, a classe de armazenamento padrão será usada para esse cluster. Os valores definidos são:
|
estado |
string |
Verdadeiro |
O estado do relacionamento. Os valores definidos são:
|
stateTransitions |
array["type_astra_stateTransition"] |
Falso |
Transições de estado permitidas. As seguintes transições de estado são possíveis para este recurso:
|
stateDesired |
string |
Verdadeiro |
O estado desejado para o relacionamento. Na criação, o único valor válido é "estabelecido". Os valores definidos são:
|
stateAllowed |
array[string] |
Falso |
Estados que podem ser solicitados em um determinado estado. Os seguintes estados podem ser solicitados em cada estado definido:
|
stateDetails |
array["type_astra_stateDetail"] |
Verdadeiro |
Detalhes adicionais sobre o estado atual, incluindo o motivo pelo qual esse estado foi alcançado. Se não houver detalhes disponíveis, essa matriz estará vazia. Os valores definidos são:
|
transferState |
string |
Falso |
Estado da transferência de instantâneo atual ou mais recente. Os valores definidos são:
|
transferStateTransitions |
array["type_astra_stateTransition"] |
Falso |
Transições de estado permitidas a partir de um determinado estado definido. As seguintes transições de estado são possíveis para este recurso:
|
transferStateDetails |
array["type_astra_stateDetail"] |
Falso |
Detalhes adicionais sobre o estado atual, incluindo o motivo pelo qual esse estado foi alcançado. Se não houver detalhes disponíveis, essa matriz estará vazia. Os valores definidos são:
|
healthState |
string |
Verdadeiro |
Estado de saúde do recurso. Os valores definidos são:
|
healthStateTransitions |
array["type_astra_stateTransition"] |
Verdadeiro |
Transições de estado permitidas a partir de um determinado estado definido. As seguintes transições de estado são possíveis para este recurso:
|
healthStateDetails |
array["type_astra_stateDetail"] |
Verdadeiro |
Detalhes adicionais sobre o estado atual, incluindo o motivo pelo qual esse estado foi alcançado. Se não houver detalhes disponíveis, essa matriz estará vazia. Os valores definidos são:
|
metadados |
Verdadeiro |
Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:
|
type_astra_metadata_list
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
continuar |
string |
Falso |
|
contar |
número |
Falso |
|
etiquetas |
array["tipo_astra_label"] |
Falso |
|
CriaçãoTimestamp |
string |
Falso |
|
Alteração do Timestamp |
string |
Falso |
|
CreatedBy |
string |
Falso |
|
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 |