获取流水线模板列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListPipelineTemplates | 系统规定参数。取值:ListPipelineTemplates。 |
OrgId | String | 是 | 60c9a7d084be085424a2e69c | 企业ID |
PageStart | Integer | 否 | 0 | 分页起始位置,最小值为0 |
PageNum | Integer | 否 | 10 | 本次读取的最大数据记录数量,合法值为1-100 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | D58BD623-80FA-4C1F-8371-3EA12532ABFD | Id of the request |
Data | Object | 返回数据 |
|
Total | Float | 12 | 模板总数 |
DataList | Array of 模板列表 | 本次请求获取的模板列表 |
|
TemplateName | String | 示例模板 | 模板名称 |
Id | Long | 1 | 模板ID |
示例
请求示例
http(s)://[Endpoint]/?Action=ListPipelineTemplates
&OrgId=60c9a7d084be085424a2e69c
&PageStart=0
&PageNum=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListPipelineTemplatesResponse>
<RequestId>D58BD623-80FA-4C1F-8371-3EA12532ABFD</RequestId>
<Data>
<Total>12</Total>
<DataList>
<TemplateName>示例模板</TemplateName>
<Id>1</Id>
</DataList>
</Data>
</ListPipelineTemplatesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D58BD623-80FA-4C1F-8371-3EA12532ABFD",
"Data" : {
"Total" : 12,
"DataList" : [ {
"TemplateName" : "示例模板",
"Id" : 1
} ]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidUser.UserNotInCurrentOrganization | The user does not belong to the specified organization. | 当前用户不属于该企业 |
404 | InvalidOrganization.NotFound | The specified organization doe not exist. | 企业信息有误,未找到该企业 |
404 | InvalidUser.NotFound | The specified user does not exist. | 用户数据有误,未找到该用户 |
500 | SystemError.UnKnownError | An error occurred while processing your request. | 系统未知异常 |
访问错误中心查看更多错误码。