SkipVMDeployMachine - Skip machine deployment

Updated at:

Applicable editions

Central edition, Region edition

Endpoints and authorization information

  • Obtain an endpoint to replace {domain} in the request syntax.

  • Obtain a personal access token.

  • Obtain the organizationId: Required only for the Central edition. Go to the Basic Information page in the Tenant Management console to retrieve the organization ID.

Product

Resource

Required permission

Pipeline

Host deployment

Read/Write

Request syntax

Central edition

PUT https://{domain}/oapi/v1/flow/organizations/{organizationId}/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/skip

Region edition

PUT https://{domain}/oapi/v1/flow/pipelines/{pipelineId}/deploy/{deployOrderId}/machine/{machineSn}/skip

Request headers

Parameter

Type

Required

Description

Example

x-yunxiao-token

string

Yes

Your personal access token.

pt-0fh3****0fbG_35af****0484

Request parameters

Parameter

Type

Position

Required

Description

Example

organizationId

string

path

  • Yes: Central edition

  • No: Region edition

The ID of the organization.

5ebbc0228123212b59xxxxx

pipelineId

string

path

Yes

The ID of the pipeline.

123

deployOrderId

string

path

Yes

The ID of the deployment order.

1111

machineSn

string

path

Yes

The serial number (SN) of the machine.

asssssssxsx

Request examples

Central edition

curl -X 'PUT' \
  'https://{domain}/oapi/v1/flow/organizations/5ebbc0228123212b59xxxxx/pipelines/123/deploy/1111/machine/asssssssxsx/skip' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region edition

curl -X 'PUT' \
  'https://{domain}/oapi/v1/flow/pipelines/123/deploy/1111/machine/asssssssxsx/skip' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Response parameters

Parameter

Type

Description

Example

-

boolean

Whether the request was successful.

true

Response example

true

Error codes

For API error codes, see Error Code Center.