Querying Third-Party Pipeline Notifications
Function
This API is used to query third-party pipeline notifications.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/api/pipeline-notices/{pipeline_id}/notice/message
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
pipeline_id |
Yes |
String |
Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
notice_id |
String |
Message ID. |
pipeline_id |
String |
Pipeline ID. |
notice_type |
String |
Message type. |
notice_status |
Boolean |
Message status. |
send_url |
String |
Sending URL. |
notice_events |
Array of strings |
Event type. |
notice_contents |
Array of strings |
Message content. |
notice_users |
Array of strings |
User who sends the message. |
secret_info |
String |
Key information. |
sort_index |
Integer |
Sorting. |
Example Requests
GET http://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline-notices/0747d5a7099e45f69dc1d099945909a9/notice/message
Example Responses
Status code: 200
Response body.
[ { "notice_id" : "dd58644df44d426d862eea6f8a456b43", "pipeline_id" : "0747d5a7099e45f69dc1d099945909a9", "notice_type" : "feishu", "notice_status" : false, "send_url" : "http://123", "notice_events" : [ "pipelineRun.pause" ], "notice_contents" : [ "projectName" ], "notice_users" : [ "12" ], "secret_info" : "12", "sort_index" : 0 } ]
Status Codes
Status Code |
Description |
---|---|
200 |
Response body. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot