SourceDeploy scenario list
- Print
- PDF
SourceDeploy scenario list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
View the SourceDeploy scenario list.
Requests
API URL
GET {SOURCEPIPELINE_API_URL}/sourcedeploy/project/{projectId}/stage/{stageId}/scenario
Request parameters
| Item | Type | Requirement status | Description | Remarks |
|---|---|---|---|---|
| projectId | string | Y | SourceDeploy project ID | View with sourceDeployProjectList API |
| stageId | string | Y | SourceDeploy stage ID | View with sourceDeployStageList API |
Request queries
| Item | Type | Requirement status | Description | Remarks |
|---|---|---|---|---|
| pageNo | string | N | Page number. Forward the entire list if there is no pageNo or pageSize | required if pageSize exist |
| pageSize | string | N | Page size. Forward the entire list if there is no pageNo or pageSize | required if pageNo exist |
| searchWord | string | N | Scenario name to search (forward scenario list including strings) |
Request bodies
None
Responses
Response bodies
{
"scenarioList": [
{
"id": "integer",
"name": "string",
"source": {
"type": "string",
"target": "TSourceSourceBuild" | "TSourceObjectStorage" | "TSourceKubernetes"
}
}
]
}
| Item | Type | Description | Remarks |
|---|---|---|---|
| id | integer | Scenario ID | |
| name | string | Scenario name | |
| source.type | string | Deployment target type | "SourceBuild"| "ObjectStorage" |"KubernetesService" |
| source.target | TSourceSourceBuild | TSourceObjectStorage | TSourceKubernetes | Deployment target type | When source.type= SourceBuild, TSourceSourceBuild When source.type= ObjectStorage, TSourceObjectStorage When source.type= KubernetesService, TSourceKubernetes |
TSourceSourceBuild
{
"projectName": "string"
}
| Item | Type | Description | Remarks |
|---|---|---|---|
| source.target.projectName | string | Build project name | required if deploy.type is SourceBuild |
TSourceObjectStorage
{
"file": "string"
}
| Item | Type | Description | Remarks |
|---|---|---|---|
| source.target.file | string | Object Storage file, including path | required if deploy.type is ObjectStorage |
TSourceKubernetes
{
"manifest": "string"
}
| Item | Type | Description | Remarks |
|---|---|---|---|
| source.target.manifest | string | Manifest file path and name | required if deploy.type is KubernetesService |
Was this article helpful?