メインコンテンツへスキップ

get-attribute-workload-details 

dci get-attribute-workload-details [body]

Decodes a workloadId into the workload's name, type, namespace, cluster and account. It reads no cost data and takes no date range. Use it to show which workload a workloadId names. Get a workloadId from a workload row of queryAttributeWorkloadsTable. An ID that does not decode returns 404.

Authenticate with Authorization: Bearer <token>. Omit X-Tenant-Id when the credential resolves to one customer. When the credential can act on several customers, send X-Tenant-Id: <tenant-id> to select one.

Pass the request body as name: value arguments or pipe JSON on stdin — see Command structure.

Request​

Content-Type: application/json

FieldTypeRequiredDescription
workloadIdstringyesOpaque ID of one workload. Copy it unchanged from the workloadId of a workload row of queryAttributeWorkloadsTable; do not build or change it. An ID that does not decode returns 404.
Raw JSON schema
{
  "type": "object",
  "required": [
    "workloadId"
  ],
  "properties": {
    "workloadId": {
      "type": "string",
      "minLength": 1,
      "description": "Opaque ID of one workload. Copy it unchanged from the `workloadId` of a `workload` row of\n`queryAttributeWorkloadsTable`; do not build or change it. An ID that does not decode\nreturns 404."
    }
  }
}

Output​

OK - The workload's key fields.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
workloadIdstring
namestringWorkload name.
typestringWorkload type.
namespacestringKubernetes namespace. Empty when the workload has none.
accountIdstringThe cloud account of the cluster.
platformobject
platform.namestring
platform.typestring
platform.regionstring
platformCloudProviderstringThe cloud the cluster runs on. Absent when the ID does not carry it.
Raw JSON schema
{
  "type": "object",
  "required": [
    "workloadId",
    "name",
    "type",
    "namespace",
    "accountId",
    "platform"
  ],
  "properties": {
    "workloadId": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "description": "Workload name."
    },
    "type": {
      "type": "string",
      "description": "Workload type."
    },
    "namespace": {
      "type": "string",
      "description": "Kubernetes namespace. Empty when the workload has none."
    },
    "accountId": {
      "type": "string",
      "description": "The cloud account of the cluster."
    },
    "platform": {
      "type": "object",
      "required": [
        "name",
        "type",
        "region"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "region": {
          "type": "string"
        }
      }
    },
    "platformCloudProvider": {
      "type": "string",
      "description": "The cloud the cluster runs on. Absent when the ID does not carry it."
    }
  }
}

Errors​

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping
HTTP statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
40921RESOURCE_CONFLICTThe operation conflicts with the resource's current state.
500, 502, 50340API_SERVER_ERRORThe API failed to process the request. Retryable; contact DoiT support if it persists.

Aliases: getattributeworkloaddetails