You can call this operation to query configuration templates.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request headers

This operation uses common request headers, instead of special request headers. For more information, see the "Common request headers" section in "Common request and response headers."

Request syntax

GET /pop/v1/wam/configTemplate HTTP/1.1

Request parameters

Parameter Type Required? Example Description
AppId String Yes wa-5d1d9d8c85c7f86e2ef*****

The ID of the application to which the configuration templates to be queried belong.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The number of entries to return on each page.

TemplateName String No template-name

The name of the configuration template to be queried.

TemplateSearch String No template

The keyword used to query configuration templates.

Response parameters

Parameter Type Example Description
Code String OK

The response code. The value is OK if the request is successful.

ConfigTemplates

The array of the configuration templates queried.

AppId String wa-5d1d9d8c85c7f86e2ef*****

The ID of the application to which the configuration template queried belongs.

AppName String testApplication

The name of the application to which the configuration template queried belongs.

CreateTime Long 1562298470970

The time when the configuration template was created.

PkgVersionId String wp-5d1daece08350d1dd94*****

The ID of the deployment package version.

PkgVersionLabel String 1562226365

The label of the deployment package version.

StackId String ws-6c937c98a9c0296d0c48*****

The ID of the technology stack.

StackName String Tomcat 8.5 / Java 8 / Aliyun Linux 2.1903

The name of the technology stack.

TemplateDescription String this is a new description.

The description of the configuration template.

TemplateId String wct-5d1eca8dd56beb722b7*****

The ID of the configuration template.

TemplateName String new-template-name

The name of the configuration template.

UpdateTime Long 1562298470970

The time when the configuration template was last updated.

Message String success

The response message. The value is success if the request is successful.

PageNumber Integer 1

The number of the page returned.

PageSize Integer 10

The number of entries returned on each page.

RequestId String 5CD6AF45-920A-4F5C-BD00-B41D6AE*****

The ID of the request.

TotalCount Integer 1

The total number of entries returned.

Examples

Sample request


http://webplus.cn-hangzhou.aliyuncs.com/pop/v1/wam/configTemplate?ServiceCode=webx&AppId=wa-5d1d9d8c85c7f86e2ef*****&PageSize=10&PageNumber=1&Search=template&<Common request parameters>

Sample success response

XML format

<DescribeConfigTemplatesResponse>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <Message>success</Message>
    <PageSize>10</PageSize>
    <RequestId>9CFC8370-B02A-40EE-AAB8-8005DA9*****</RequestId>
    <ConfigTemplates>
        <ConfigTemplate>
            <TemplateName>new-template-name</TemplateName>
            <TemplateDescription>this is a new description. </TemplateDescription>
            <StackId>ws-6c937c98a9c0296d0c48*****</StackId>
            <CreateTime>1562299021581</CreateTime>
            <PkgVersionLabel>1562226365</PkgVersionLabel>
            <AppId>wa-5d1d9d8c85c7f86e2ef*****</AppId>
            <UpdateTime>1562577497233</UpdateTime>
            <AppName>user1</AppName>
            <TemplateId>wct-5d1eca8dd56beb722b7*****</TemplateId>
            <PkgVersionId>wp-5d1daece08350d1dd94*****</PkgVersionId>
            <StackName>Tomcat 8.5 / Java 8 / Aliyun Linux 2.1903</StackName>
        </ConfigTemplate>
    </ConfigTemplates>
    <Code>OK</Code>
</DescribeConfigTemplatesResponse>

JSON format

{
	"PageNumber":1,
	"TotalCount":1,
	"Message":"success",
	"PageSize":10,
	"RequestId":"4D769F04-E1C2-49A6-8A5B-017E2EF*****",
	"ConfigTemplates":{
		"ConfigTemplate":[
			{
				"TemplateName":"new-template-name",
				"TemplateDescription":"this is a new description.",
				"StackId":"ws-6c937c98a9c0296d0c48*****",
				"CreateTime":1562299021581,
				"PkgVersionLabel":"1562226365",
				"AppId":"wa-5d1d9d8c85c7f86e2ef*****",
				"UpdateTime":1562577497233,
				"AppName":"user1",
				"PkgVersionId":"wp-5d1daece08350d1dd94*****",
				"StackName":"Tomcat 8.5 / Java 8 / Aliyun Linux 2.1903",
				"TemplateId":"wct-5d1eca8dd56beb722b7*****"
			}
		]
	},
	"Code":"OK"
}

Error codes

HTTP status code Error code Error message Description
403 ResourceAuthFailed The specified resource does not exist or it does not belong to this Alibaba Cloud account. The error message returned because the specified resource does not exist or it does not belong to your Alibaba Cloud account.
400 AppNotExist A corresponding application was not found based on the application ID. The error message returned because the application of the specified ID does not exist.

For more information about error codes, see API Error Center.