Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.
Centro de ayuda/ Cloud Container Engine/ Referencia de la API/ API/ Gestión de clústeres/ Consulta de un trabajo
Actualización más reciente 2023-04-13 GMT+08:00
Ver PDF
Compartir

Consulta de un trabajo

Función

Esta API se utiliza para obtener información sobre un trabajo a través del ID de trabajo devuelto después de entregar una solicitud de consulta.

  • El URL para la gestión de clústeres tiene el formato https://Endpoint/uri. En el URL, uri indica la ruta del recurso, es decir, la ruta para el acceso a la API.

  • Puede invocar a esta API cuando:

    • Creación o eliminación de un clúster

    • Creación o eliminación de un nodo

URI

GET /api/v3/projects/{project_id}/jobs/{job_id}

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener más información sobre cómo obtener el valor, consulta Cómo obtener parámetros en el URI de API.

job_id

Sí

String

ID del trabajo. Para obtener más información sobre cómo obtener el valor, consulta Cómo obtener parámetros en el URI de API.

Parámetros de solicitud

Tabla 2 Parámetros de cabecera de solicitud

Parámetro

Obligatorio

Tipo

Descripción

Content-Type

Sí

String

Tipo de cuerpo del mensaje (formato).

X-Auth-Token

Sí

String

Las solicitudes para invocar a una API pueden autenticarse usando un token o AK/SK. Si se utiliza la autenticación basada en token, este parámetro es obligatorio y se debe establecer en un token de usuario. Para obtener más información, consulte Obtención de un token de usuario.

Parámetros de respuesta

Código de estado: 200

Tabla 3 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

kind

String

Tipo de la API. El valor se fija en Job y no se puede cambiar.

apiVersion

String

Versión de la API. El valor se fija en v3 y no se puede cambiar.

metadata

Objeto de JobMetadata

Metadatos de trabajo

spec

Objeto de JobSpec

Parámetros de trabajo detallados

status

Objeto de JobStatus

Estado del trabajo
Tabla 4 JobMetadata

Parámetro

Tipo

Descripción

uid

String

ID del trabajo

creationTimestamp

String

Hora en que se creó la tarea

updateTimestamp

String

Hora en que se actualizó la tarea
Tabla 5 JobSpec

Parámetro

Tipo

Descripción

type

String

Tipo del trabajo. Un valor de ejemplo es CreateCluster.

clusterUID

String

ID del clúster donde se ejecuta el trabajo.

resourceID

String

ID del recurso en el que se ejecuta el trabajo.

resourceName

String

Nombre del recurso en el que se ejecuta el trabajo.

extendParam

Map<String,String>

Parámetros extendidos

subJobs

Matriz de objetos de Job

Lista de subtrabajos.

  • La lista contiene detalles sobre todos los subtrabajos.

  • Generalmente, un trabajo de creación de clúster/nodo consta de varios subtrabajos. El trabajo se completa solo después de que todos los subtrabajos se hayan completado.
Tabla 6 Job

Parámetro

Tipo

Descripción

kind

String

Tipo de la API. El valor se fija en Job y no se puede cambiar.

apiVersion

String

Versión de la API. El valor se fija en v3 y no se puede cambiar.

metadata

Objeto de JobMetadata

Metadatos de trabajo

spec

Objeto de JobSpec

Parámetros de trabajo detallados

status

Objeto de JobStatus

Estado del trabajo
Tabla 7 JobStatus

Parámetro

Tipo

Descripción

phase

String

Estado del trabajo. Valores posibles:

  • JobPhaseInitializing JobPhase = "Initializing"

  • JobPhaseRunning JobPhase = "Running"

  • JobPhaseFailed JobPhase = "Failed"

  • JobPhaseSuccess JobPhase = "Success"

reason

String

Motivo por el que el trabajo está en el estado actual.

Ejemplo de las solicitudes

No hay

Ejemplo de las respuestas

Código de estado: 200

El progreso del trabajo especificado se obtiene correctamente.

{
  "kind" : "Job",
  "apiVersion" : "v3",
  "metadata" : {
    "uid" : "354331b2c-229a-11e8-9c75-0255ac100ceb",
    "creationTimestamp" : "2018-08-02 08:12:40.672772389 +0000 UTC",
    "updateTimestamp" : "2018-08-02 08:21:50.478108569 +0000 UTC"
  },
  "spec" : {
    "type" : "CreateCluster",
    "clusterUID" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
    "resourceID" : "6f4dcb2c-229a-11e8-9c75-0255ac100ceb",
    "resourceName" : "cluster-name",
    "extendParam" : {
      "serverID" : "bc467e3a-2338-11e8-825b-0255ac100c13"
    },
    "subJobs" : [ {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "fd474fab-9606-11e8-baa9-0255ac10215d",
        "creationTimestamp" : "2018-08-02 03:52:34.615819618 +0000 UTC",
        "updateTimestamp" : "2018-08-02 04:05:29.196243031 +0000 UTC"
      },
      "spec" : {
        "type" : "InstallMaster",
        "clusterUID" : "fcc72de0-9606-11e8-baa8-0255ac10215d",
        "resourceID" : "fd3b4ac0-9606-11e8-baa8-0255ac10215d",
        "extendParam" : {
          "serverID" : "fd3b4ac0-9606-11e8-baa8-0255ac10215d"
        }
      },
      "status" : {
        "phase" : "Success"
      }
    }, {
      "kind" : "Job",
      "apiVersion" : "v3",
      "metadata" : {
        "uid" : "fd474f82-9606-11e8-baa8-0255ac10215d",
        "creationTimestamp" : "2018-08-02 03:52:33.859150791 +0000 UTC",
        "updateTimestamp" : "2018-08-02 03:52:34.615655429 +0000 UTC"
      },
      "spec" : {
        "type" : "CreatePSMCert",
        "clusterUID" : "fcc72de0-9606-11e8-baa8-0255ac10215d"
      },
      "status" : {
        "phase" : "Success"
      }
    } ]
  },
  "status" : {
    "phase" : "Running",
    "reason" : ""
  }
}

Códigos de estado

Código de estado

Descripción

200

El progreso del trabajo especificado se obtiene correctamente.

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de clústeres