SelectObject_对象存储_API文档-阿里云OpenAPI开发者门户

接口说明

此操作要求您对该 Object 有读权限。
正确执行时，该 API 返回 206。如果 SQL 语句不正确，或者和文件不匹配，则会返回 400 错误。
关于 SelectObject 的功能介绍请参见使用 SelectObject 查询文件。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

oss:GetObject	Get	Object acs:oss:oss-{#regionId}:{#accountId}:{#BucketName}/{#ObjectName}	oss:ExistingObjectTag acs:UserAgent acs:AccessId oss:BucketTag oss:DataAccessPointArn oss:AccessPointNetworkOrigin oss:DataAccessPointAccount oss:TLSVersion	oss:GetObjectTagging

请求语法

POST /{key} HTTP/1.1
Host: BucketName.oss-cn-hangzhou.aliyuncs.com
<?xml version="1.0" encoding="UTF-8"?>
<SelectRequest>
  <Expression>string</Expression>
  <InputSerialization>
    <CompressionType>string</CompressionType>
    <CSV>
      <FileHeaderInfo>string</FileHeaderInfo>
      <RecordDelimiter>string</RecordDelimiter>
      <FieldDelimiter>string</FieldDelimiter>
      <QuoteCharacter>string</QuoteCharacter>
      <CommentCharacter>string</CommentCharacter>
      <Range>string</Range>
      <AllowQuotedRecordDelimiter>boolean</AllowQuotedRecordDelimiter>
    </CSV>
    <JSON>
      <Type>string</Type>
      <Range>string</Range>
      <ParseJsonNumberAsString>boolean</ParseJsonNumberAsString>
    </JSON>
  </InputSerialization>
  <OutputSerialization>
    <CSV>
      <RecordDelimiter>string</RecordDelimiter>
      <FieldDelimiter>string</FieldDelimiter>
    </CSV>
    <JSON>
      <RecordDelimiter>string</RecordDelimiter>
    </JSON>
    <KeepAllColumns>boolean</KeepAllColumns>
    <OutputHeader>boolean</OutputHeader>
    <OutputRawData>boolean</OutputRawData>
    <EnablePayloadCrc>boolean</EnablePayloadCrc>
  </OutputSerialization>
  <Options>
    <SkipPartialDataRecord>boolean</SkipPartialDataRecord>
    <MaxSkippedRecordsAllowed>integer</MaxSkippedRecordsAllowed>
  </Options>
</SelectRequest>

路径参数

字段名称	字段详情
keystring	Object 的完整路径。示例值:exampledir/exampleobject.txt

请求参数

字段名称	字段详情
bucketstring	Bucket 名称。示例值:examplebucket
x-oss-processstring	如果是 csv 文件，该值需要设置为 csv/select；如果是 json 文件，则需要设置为 json/select。示例值:csv/select
bodyobject	保存 SelectObject 请求的容器。

返回参数

字段名称	字段详情
string<binary>	若 header x-oss-select-output-raw 值为 true，则表明返回结果是对象数据（而不是 Frame 包装的），客户端可以完全按照 Get API 的方式获取数据。展开详情示例值:无

返回示例

变更历史

	变更时间	变更内容概要	操作
	2025-03-04	新增请求参数body 新增请求参数x-oss-process

SelectObject_对象存储_API文档

接口说明

流控信息

授权信息

请求语法

路径参数

请求参数

返回参数

返回示例

变更历史

相关示例