GetChangeOrder - Get change order details
Applicable editions | Centralized edition, region edition |
Endpoint and authorization
- Obtain a service endpoint to replace the
{domain}placeholder in the API request syntax. - Obtain a personal access token.
- Obtain the organization ID from the Basic Information page in the organization management console. This ID is required for the centralized edition only.
Product | Resource | Required permission |
application delivery | change order | Read-only |
Request syntax
Centralized edition
GET https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}/changeOrders/{changeOrderSn}Region edition
GET https://{domain}/oapi/v1/appstack/apps/{appName}/changeOrders/{changeOrderSn}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 | In | Required | Description | Example |
appName | string | path | Yes | The application name. | my-web-service |
changeOrderSn | string | path | Yes | The change order SN. | 66c0c9fffeb86b450c199fcd |
organizationId | string | path |
| The organization ID. | ec766e63aee3437d9a51f334d6exe671 |
Request examples
Centralized edition
curl -X 'GET' \
'https://{domain}/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/apps/my-web-service/changeOrders/66c0c9fffeb86b450c199fcd' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Region edition
curl -X 'GET' \
'https://{domain}/oapi/v1/appstack/apps/my-web-service/changeOrders/66c0c9fffeb86b450c199fcd' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'Response parameters
Parameter | Type | Description | Example |
| - | object | The response object. | |
| creator | string | The user who created the change order. | 10df6011-2837-4fdb-ad92-356a679a60ca |
| description | string | The description of the change order. | Routine deployment for daily requirements |
| endedAt | string | The end time of the change order. | 2024-10-08T09:11:38Z |
| gmtCreate | string | The creation time of the change order. | 2024-10-08T09:11:38Z |
| jobs | array | A list of jobs associated with the change order. | |
| - | object | Summary of a deployment job. | |
| envName | string | The environment name. | |
| sn | string | The job SN. | |
| state | string | The job status. | |
| name | string | The name of the change order. | 20241008171130-Deploy |
| sn | string | The SN of the change order. | bc62b3e953714aa8be431f47b9c9b72a |
| startedAt | string | The start time of the change order. | 2024-10-08T09:11:38Z |
| state | string | The status of the change order. Valid values: | SUCCESS |
| type | string | The type of the change order. Valid values: | Deploy |
| version | string | The deployment version. | 20241008171130-762 |
Response example
{
"creator": "10df6011-2837-4fdb-ad92-356a679a60ca",
"description": "Routine deployment for daily requirements",
"endedAt": "2024-10-08T09:11:38Z",
"gmtCreate": "2024-10-08T09:11:38Z",
"jobs": [
{
"envName": "prod-env",
"sn": "job-12345",
"state": "SUCCESS"
}
],
"name": "20241008171130-Deploy",
"sn": "bc62b3e953714aa8be431f47b9c9b72a",
"startedAt": "2024-10-08T09:11:38Z",
"state": "SUCCESS",
"type": "Deploy",
"version": "20241008171130-762"
}Error codes
For a list of API error codes, see the error code center.