

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

# DescribeDataSet
<a name="API_DescribeDataSet"></a>

描述数据集。此操作不支持包含上传文件作为源的数据集。

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

```
GET /accounts/AwsAccountId/data-sets/DataSetId HTTP/1.1
```

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

请求使用以下 URI 参数。

 ** [AwsAccountId](#API_DescribeDataSet_RequestSyntax) **   <a name="QS-DescribeDataSet-request-AwsAccountId"></a>
AWS 账户 ID。  
长度限制：固定长度为 12。  
模式：`^[0-9]{12}$`  
必需：是

 ** [DataSetId](#API_DescribeDataSet_RequestSyntax) **   <a name="QS-DescribeDataSet-request-DataSetId"></a>
要创建的数据集的 ID。对于每个 AWS 账户，此 ID 在每个 AWS 区域 中都是唯一的。  
必需：是

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

该请求没有请求体。

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

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

{
   "DataSet": { 
      "Arn": "string",
      "ColumnGroups": [ 
         { 
            "GeoSpatialColumnGroup": { 
               "Columns": [ "string" ],
               "CountryCode": "string",
               "Name": "string"
            }
         }
      ],
      "ColumnLevelPermissionRules": [ 
         { 
            "ColumnNames": [ "string" ],
            "Principals": [ "string" ]
         }
      ],
      "ConsumedSpiceCapacityInBytes": number,
      "CreatedTime": number,
      "DataSetId": "string",
      "DataSetUsageConfiguration": { 
         "DisableUseAsDirectQuerySource": boolean,
         "DisableUseAsImportedSource": boolean
      },
      "FieldFolders": { 
         "string" : { 
            "columns": [ "string" ],
            "description": "string"
         }
      },
      "ImportMode": "string",
      "LastUpdatedTime": number,
      "LogicalTableMap": { 
         "string" : { 
            "Alias": "string",
            "DataTransforms": [ 
               { 
                  "CastColumnTypeOperation": { 
                     "ColumnName": "string",
                     "Format": "string",
                     "NewColumnType": "string"
                  },
                  "CreateColumnsOperation": { 
                     "Columns": [ 
                        { 
                           "ColumnId": "string",
                           "ColumnName": "string",
                           "Expression": "string"
                        }
                     ]
                  },
                  "FilterOperation": { 
                     "ConditionExpression": "string"
                  },
                  "ProjectOperation": { 
                     "ProjectedColumns": [ "string" ]
                  },
                  "RenameColumnOperation": { 
                     "ColumnName": "string",
                     "NewColumnName": "string"
                  },
                  "TagColumnOperation": { 
                     "ColumnName": "string",
                     "Tags": [ 
                        { 
                           "ColumnDescription": { 
                              "Text": "string"
                           },
                           "ColumnGeographicRole": "string"
                        }
                     ]
                  },
                  "UntagColumnOperation": { 
                     "ColumnName": "string",
                     "TagNames": [ "string" ]
                  }
               }
            ],
            "Source": { 
               "DataSetArn": "string",
               "JoinInstruction": { 
                  "LeftJoinKeyProperties": { 
                     "UniqueKey": boolean
                  },
                  "LeftOperand": "string",
                  "OnClause": "string",
                  "RightJoinKeyProperties": { 
                     "UniqueKey": boolean
                  },
                  "RightOperand": "string",
                  "Type": "string"
               },
               "PhysicalTableId": "string"
            }
         }
      },
      "Name": "string",
      "OutputColumns": [ 
         { 
            "Description": "string",
            "Name": "string",
            "Type": "string"
         }
      ],
      "PhysicalTableMap": { 
         "string" : { 
            "CustomSql": { 
               "Columns": [ 
                  { 
                     "Name": "string",
                     "Type": "string"
                  }
               ],
               "DataSourceArn": "string",
               "Name": "string",
               "SqlQuery": "string"
            },
            "RelationalTable": { 
               "Catalog": "string",
               "DataSourceArn": "string",
               "InputColumns": [ 
                  { 
                     "Name": "string",
                     "Type": "string"
                  }
               ],
               "Name": "string",
               "Schema": "string"
            },
            "S3Source": { 
               "DataSourceArn": "string",
               "InputColumns": [ 
                  { 
                     "Name": "string",
                     "Type": "string"
                  }
               ],
               "UploadSettings": { 
                  "ContainsHeader": boolean,
                  "Delimiter": "string",
                  "Format": "string",
                  "StartFromRow": number,
                  "TextQualifier": "string"
               }
            }
         }
      },
      "RowLevelPermissionDataSet": { 
         "Arn": "string",
         "FormatVersion": "string",
         "Namespace": "string",
         "PermissionPolicy": "string",
         "Status": "string"
      },
      "RowLevelPermissionTagConfiguration": { 
         "Status": "string",
         "TagRules": [ 
            { 
               "ColumnName": "string",
               "MatchAllValue": "string",
               "TagKey": "string",
               "TagMultiValueDelimiter": "string"
            }
         ]
      }
   },
   "RequestId": "string"
}
```

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

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

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

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

 ** [DataSet](#API_DescribeDataSet_ResponseSyntax) **   <a name="QS-DescribeDataSet-response-DataSet"></a>
有关数据集的信息。  
类型：[DataSet](API_DataSet.md) 对象

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

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

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

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

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

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

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

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

## 示例
<a name="API_DescribeDataSet_Examples"></a>

### 示例
<a name="API_DescribeDataSet_Example_1"></a>

此示例说明了一种用法 DescribeDataSet.

#### 示例请求
<a name="API_DescribeDataSet_Example_1_Request"></a>

```
GET /accounts/{AwsAccountId}/data-sets/{DataSetId} HTTP/1.1
Content-type: application/json
```

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

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