Code Pipeline
Code Pipeline
Document
- Documentation
Code PipelineAPI ReferenceMethods of invocationReturned results
Copy page
Download PDFMethods of invocation
Returned results
Copy pageDownload PDFReturned results
After calling the OpenAPI, all response results will include the RequestId, Action, Version, Service, Region, and many other fields.
Normal Sample Response
After a successful API call, the request ID and response parameters are returned. HTTP status code is 2xx.
{
"ResponseMetadata": {
"RequestId": "202010201722300102****",
"Action": "{Action}",
"Version": "{Version}",
"Service": "{Service}",
"Region": "{Region}"
},
"Result":"..."
}
After the request is successfully processed, the back will contain two parts: ResponseMetadata and Result. The Result depends on the API being called; different APIs will return different Result in the back. Field descriptions
field | Explanation |
RequestID | Unique identifier for each API request. |
Action | The interface name is a common parameter in requests. |
Version | The version number is a common parameter in requests. |
Service | The requested service is one of the common parameters in a request. |
Region Code | Region is a common parameter required in requests. |
Exceptional Sample Response
When an interface call fails, it returns the request ID and error information. The HTTP status code is 4xx or 5xx.
You can use the interface error code (Code) and error message (Message), and refer to general error codes and specific interface error codes to troubleshoot errors.
{
"ResponseMetadata": {
"RequestId": "202010201722300102****",
"Action": "{Action}",
"Version": "{Version}",
"Service": "{Service}",
"Region": "{Region}",
"Error": {
"Code": "InvalidActionOrVersion",
"Message": "Could not find operation ListPipelines for version 2023-05-01"
}
}
}
Last updated: 2025.09.10 17:37:28
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
