跳转到内容
Appaloft 文档 v0.6.0

resources.diagnosticSummary

GET
/resources/{resourceId}/diagnostic-summary
 
curl --request GET \
  --url 'https://example.com/api/resources/example/diagnostic-summary?tailLines=20'

Returns a support-safe diagnostic summary. Public docs: /docs/observe/diagnostics/#diagnostic-summary-copy-support-payload

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
resourceId
required
string
>= 1 characters

Query Parameters

Section titled “Query Parameters ”
deploymentId
string
>= 1 characters
includeDeploymentLogTail
Any of:
boolean
includeRuntimeLogTail
Any of:
boolean
includeProxyConfiguration
Any of:
boolean
tailLines
integer
default: 20 <= 50
locale
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
schemaVersion
required
string
Allowed value: resources.diagnostic-summary/v1
generatedAt
required
string
focus
required
object
resourceId
required
string
requestedDeploymentId
string
deploymentId
string
context
required
object
projectId
required
string
environmentId
required
string
resourceName
required
string
resourceSlug
required
string
resourceKind
required
string
Allowed values: application service database cache compose-stack worker static-site external
destinationId
string
serverId
string
runtimeStrategy
string
Allowed values: docker-container docker-compose-stack host-process
buildStrategy
string
Allowed values: dockerfile compose-deploy buildpack static-artifact prebuilt-image workspace-commands
packagingMode
string
Allowed values: split-deploy all-in-one-docker compose-bundle host-process-runtime optional-future-binary
targetKind
string
Allowed values: single-server future-multi-server future-k8s
targetProviderKey
string
services
required
Array<object>
object
name
required
string
kind
required
string
Allowed values: web api worker database cache service
networkProfile
object
internalPort
required
integer
> 0 <= 9007199254740991
upstreamProtocol
required
string
default: http
Allowed values: http tcp
exposureMode
required
string
default: reverse-proxy
Allowed values: none reverse-proxy direct-port
targetServiceName
string
>= 1 characters
hostPort
integer
> 0 <= 9007199254740991
deployment
object
id
required
string
status
required
string
Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back
lifecyclePhase
required
string
Allowed values: created planning planned running cancel-requested succeeded failed canceled rolled-back
runtimePlanId
required
string
sourceKind
required
string
Allowed values: local-folder local-git remote-git git-public git-github-app git-deploy-key zip-artifact dockerfile-inline docker-compose-inline docker-image compose
sourceDisplayName
required
string
serverId
required
string
destinationId
required
string
createdAt
required
string
startedAt
string
finishedAt
string
logCount
required
number
lastError
object
timestamp
required
string
phase
required
string
Allowed values: detect plan package deploy verify rollback
message
required
string
access
required
object
status
required
string
Allowed values: available empty not-configured not-requested unavailable failed unknown
generatedUrl
string
durableUrl
string
serverAppliedUrl
string
plannedUrl
string
proxyRouteStatus
string
Allowed values: unknown ready not-ready failed
lastRouteRealizationDeploymentId
string
reasonCode
string
phase
string
proxy
required
object
status
required
string
Allowed values: available empty not-configured not-requested unavailable failed unknown
providerKey
string
proxyRouteStatus
string
Allowed values: unknown ready not-ready failed
configurationIncluded
required
boolean
configurationStatus
string
Allowed values: not-configured planned applied stale failed
configurationGeneratedAt
string
routeCount
number
sectionCount
number
sections
Array<object>
object
id
required
string
title
required
string
format
required
string
Allowed values: docker-labels file command yaml json text
redacted
required
boolean
source
required
string
Allowed values: provider-rendered snapshot diagnostic
tlsRoutes
Array<object>
object
hostname
required
string
pathPrefix
required
string
tlsMode
required
string
Allowed values: auto disabled
scheme
required
string
Allowed values: http https
automation
required
string
Allowed values: disabled provider-local
certificateSource
required
string
Allowed values: none provider-local
appaloftCertificateManaged
required
boolean
message
required
string
warnings
Array<object>
object
code
required
string
message
required
string
details
object
key
additional properties
Any of:
string
reasonCode
string
phase
string
deploymentLogs
required
object
status
required
string
Allowed values: available empty not-configured not-requested unavailable failed unknown
tailLimit
required
number
lineCount
required
number
lines
required
Array<object>
object
timestamp
string
source
string
Allowed values: appaloft application
phase
string
Allowed values: detect plan package deploy verify rollback
level
string
Allowed values: debug info warn error
stream
string
Allowed values: stdout stderr unknown
serviceName
string
message
required
string
masked
required
boolean
reasonCode
string
phase
string
runtimeLogs
required
object
status
required
string
Allowed values: available empty not-configured not-requested unavailable failed unknown
tailLimit
required
number
lineCount
required
number
lines
required
Array<object>
object
timestamp
string
source
string
Allowed values: appaloft application
phase
string
Allowed values: detect plan package deploy verify rollback
level
string
Allowed values: debug info warn error
stream
string
Allowed values: stdout stderr unknown
serviceName
string
message
required
string
masked
required
boolean
reasonCode
string
phase
string
system
required
object
entrypoint
required
string
Allowed values: cli http rpc system
requestId
required
string
locale
required
string
readinessStatus
string
Allowed values: ready degraded
databaseDriver
string
databaseMode
string
sourceErrors
required
Array<object>
object
source
required
string
Allowed values: deployment access proxy deployment-logs runtime-logs system copy
code
required
string
category
required
string
phase
required
string
retryable
required
boolean
relatedEntityId
string
relatedState
string
message
string
redaction
required
object
policy
required
string
Allowed value: deployment-environment-secrets
masked
required
boolean
maskedValueCount
required
number
copy
required
object
json
required
string
markdown
string
plainText
string
Example 
{
  "schemaVersion": "resources.diagnostic-summary/v1",
  "context": {
    "resourceKind": "application",
    "runtimeStrategy": "docker-container",
    "buildStrategy": "dockerfile",
    "packagingMode": "split-deploy",
    "targetKind": "single-server",
    "services": [
      {
        "kind": "web"
      }
    ],
    "networkProfile": {
      "upstreamProtocol": "http",
      "exposureMode": "none"
    }
  },
  "deployment": {
    "status": "created",
    "lifecyclePhase": "created",
    "sourceKind": "local-folder",
    "lastError": {
      "phase": "detect"
    }
  },
  "access": {
    "status": "available",
    "proxyRouteStatus": "unknown"
  },
  "proxy": {
    "status": "available",
    "proxyRouteStatus": "unknown",
    "configurationStatus": "not-configured",
    "sections": [
      {
        "format": "docker-labels",
        "source": "provider-rendered"
      }
    ],
    "tlsRoutes": [
      {
        "tlsMode": "auto",
        "scheme": "http",
        "automation": "disabled",
        "certificateSource": "none"
      }
    ]
  },
  "deploymentLogs": {
    "status": "available",
    "lines": [
      {
        "source": "appaloft",
        "phase": "detect",
        "level": "debug",
        "stream": "stdout"
      }
    ]
  },
  "runtimeLogs": {
    "status": "available",
    "lines": [
      {
        "source": "appaloft",
        "phase": "detect",
        "level": "debug",
        "stream": "stdout"
      }
    ]
  },
  "system": {
    "entrypoint": "cli",
    "readinessStatus": "ready"
  },
  "sourceErrors": [
    {
      "source": "deployment"
    }
  ],
  "redaction": {
    "policy": "deployment-environment-secrets"
  }
}