本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# DescribeTemplate
<a name="API_DescribeTemplate"></a>

描述模板的元数据。

## 请求语法
<a name="API_DescribeTemplate_RequestSyntax"></a>

```
GET /accounts/AwsAccountId/templates/TemplateId?alias-name=AliasName&version-number=VersionNumber HTTP/1.1
```

## URI 请求参数
<a name="API_DescribeTemplate_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [AliasName](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-AliasName"></a>
您要描述的模板的别名。如果您命名特定别名，则说明该别名指向的版本。您可以通过提供关键字，指定最新版本的模板`$LATEST`中的`AliasName`参数。关键字`$PUBLISHED`不适用于模板。  
长度限制：最小长度为 1。长度上限为 2048。  
模式：`[\w\-]+|(\$LATEST)|(\$PUBLISHED)`

 ** [AwsAccountId](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-AwsAccountId"></a>
的 IDAWS包含您正在描述的模板的账户。  
长度限制：固定长度为 12。  
模式：`^[0-9]{12}$`  
必需：是

 ** [TemplateId](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-TemplateId"></a>
模板的 ID。  
长度限制：最小长度为 1。长度上限为 2048。  
模式：`[\w\-]+`  
必需：是

 ** [VersionNumber](#API_DescribeTemplate_RequestSyntax) **   <a name="QS-DescribeTemplate-request-VersionNumber"></a>
(可选) 要描述的版本的编号。如果`VersionNumber`未提供参数值，则描述模板的最新版本。  
有效范围：最小值为 1。

## 请求正文
<a name="API_DescribeTemplate_RequestBody"></a>

该请求没有请求体。

## 响应语法
<a name="API_DescribeTemplate_ResponseSyntax"></a>

```
HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "Template": { 
      "Arn": "string",
      "CreatedTime": number,
      "LastUpdatedTime": number,
      "Name": "string",
      "TemplateId": "string",
      "Version": { 
         "CreatedTime": number,
         "DataSetConfigurations": [ 
            { 
               "ColumnGroupSchemaList": [ 
                  { 
                     "ColumnGroupColumnSchemaList": [ 
                        { 
                           "Name": "string"
                        }
                     ],
                     "Name": "string"
                  }
               ],
               "DataSetSchema": { 
                  "ColumnSchemaList": [ 
                     { 
                        "DataType": "string",
                        "GeographicRole": "string",
                        "Name": "string"
                     }
                  ]
               },
               "Placeholder": "string"
            }
         ],
         "Description": "string",
         "Errors": [ 
            { 
               "Message": "string",
               "Type": "string"
            }
         ],
         "Sheets": [ 
            { 
               "Name": "string",
               "SheetId": "string"
            }
         ],
         "SourceEntityArn": "string",
         "Status": "string",
         "ThemeArn": "string",
         "VersionNumber": number
      }
   }
}
```

## 响应元素
<a name="API_DescribeTemplate_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 响应。

 ** [Status](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-Status"></a>
请求的 HTTP 状态。

服务以 JSON 格式返回的以下数据。

 ** [RequestId](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-RequestId"></a>
这些区域有：AWS用于此操作的请求 ID。  
类型: 字符串

 ** [Template](#API_DescribeTemplate_ResponseSyntax) **   <a name="QS-DescribeTemplate-response-Template"></a>
您要描述的对象的模板结构。  
类型：[Template](API_Template.md) 对象

## 错误
<a name="API_DescribeTemplate_Errors"></a>

有关所有操作共有的错误的信息，请参阅[常见错误](CommonErrors.md).

 ** AccessDeniedException **   
您无权访问此项目。无法验证提供的凭证。您可能无权执行请求。确保您的账户已获得使用亚马逊的授权 QuickSight 服务，您的策略具有正确的权限，并且您使用的是正确的访问密钥。  
HTTP 状态代码：401

 ** ConflictException **   
更新或删除资源可能会导致状态不一致。  
HTTP 状态代码：409

 ** InternalFailureException **   
出现内部故障。  
HTTP 状态代码：500

 ** InvalidParameterValueException **   
一个或多个参数的值无效。  
HTTP 状态代码：400

 ** ResourceExistsException **   
已存在指定的资源。  
HTTP 状态代码：409

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ThrottlingException **   
访问受限。  
HTTP 状态代码：429

 ** UnsupportedUserEditionException **   
该错误指示您正在 Amazon 上调用某个操作 QuickSight该版本不支持该操作的订阅。亚马逊Amazon QuickSight 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。  
HTTP 状态代码：403

## 另请参阅
<a name="API_DescribeTemplate_SeeAlso"></a>

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息，请参阅以下内容：
+  [AWS 命令行界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/DescribeTemplate) 
+  [适用于 .NET 的 AWS SDK](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/DescribeTemplate) 
+  [适用于 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DescribeTemplate) 
+  [适用于 Go 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/DescribeTemplate) 
+  [适用于 Java V2 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/DescribeTemplate) 
+  [AWS适用于的开发工具包 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/DescribeTemplate) 
+  [适用于 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeTemplate) 
+  [适用于 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DescribeTemplate) 
+  [适用于 Ruby V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeTemplate)