GetImage - 从媒体集中获取一张图片的信息

调用GetImage接口从媒体集中获取一张图片的信息。

接口说明

此接口已不再维护,建议使用新版(2020-09-30 版本)接口 GetFileMeta 。关于新版与旧版 API 的对比,请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:GetImage
*全部资源
*

请求参数

名称类型必填描述示例值
Projectstring

项目名称。

immimagetest
SetIdstring

媒体集的唯一标识。

set001
ImageUristring

图片的 OSS URI。

OSS 地址规则为oss://bucket/object,其中 bucket 为和当前项目处于同一区域的 OSS Bucket 名称,object 为文件路径。

oss://imm-test/testcases/face1.jpg

返回参数

名称类型描述示例值
object
ImageQualityobject

图片质量分数。

OverallScorefloat

综合质量分数。

0.7759467363357544
Colorfloat

当前版本不支持此参数。

图片色度。

0.6101377010345459
ColorScorefloat

当前版本不支持此参数。

图片色度的分数。

0.6101377010345459
ContrastScorefloat

当前版本不支持此参数。

图片对比度的分数。

0.6101377010345459
Contrastfloat

当前版本不支持此参数。

图片对比度。

0.6101377010345459
ExposureScorefloat

当前版本不支持此参数。

图片曝光程度的分数。

0.6101377010345459
ClarityScorefloat

当前版本不支持此参数。

图片曝光程度的分数。

0.6101377010345459
Clarityfloat

当前版本不支持此参数。

图片清晰度。

0.6101377010345459
Exposurefloat

当前版本不支持此参数。

图片曝光程度。

0.6101377010345459
CompositionScorefloat

当前版本不支持此参数。

图片构成的分数。

0.6101377010345459
ModifyTimestring

图片的修改时间。

添加图片后,如果未修改过图片,则图片的修改时间和图片的创建时间相同。

2020-11-24T10:56:52.461Z
Addressobject

图片地理位置检测结果。

只有图片中包含地理位置信息时,检测结果才有值。

Townshipstring

图片地理位置所在街道(或同级)。

转塘街道
Districtstring

图片地理位置所在区(或同级)。

西湖区
AddressLinestring

图片地理位置的完整地址。

中国浙江省杭州市西湖区转塘街道石龙山西路
Countrystring

图片地理位置所在国家或地区。

中国
Citystring

图片地理位置所在城市(或同级)。

杭州市
Provincestring

图片地理位置所在省(或同级)。

浙江省
SourceTypestring

源数据的类型。

image
SourceUristring

图片的 OSS Uri。

oss://imm-test/testcases/face1.jpg
FacesFailReasonstring

人脸识别的失败原因。

只有当人脸识别失败时,此参数才有值。

Timeout
CroppingSuggestionStatusstring

提供裁剪建议的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed:失败

您可以根据该状态决定读取结果、等待或重试。

NotProcessed
CroppingSuggestionFailReasonstring

裁剪建议提供失败的原因。

只有当图片裁剪建议提供失败时,此参数才有值。

Timeout
AddressFailReasonstring

图片地理位置检测的失败原因。

只有当图片地理位置检测失败时,此参数才有值。

Timeout
RemarksAstring

标记信息。

remarka
AddressModifyTimestring

图片地理位置检测的更新时间。

2020-11-24T10:56:52.461Z
RemarksBstring

标记信息。

remarkb
ImageFormatstring

图片格式。

jpg
TagsFailReasonstring

标签识别的失败原因。格式为[HTTPStatusCode ErrorCode] ErrorMessage,例如[400 InvalidResource] Specified resource is too large. Please check.

只有当标签识别失败时,此参数才有值。

Timeout
RemarksArrayBstring

标记信息列表。

["remarkb1","remarkb2"]
FacesModifyTimestring

人脸识别的更新时间。

2020-11-24T10:56:52.461Z
Exifstring

图片原始 EXIF 信息,以 JSON Object 序列化后的格式存储。

{"FileSize":{"value":"29304"},"Format":{"value":"jpg"},"ImageHeight":{"value":"417"},"ImageWidth":{"value":"500"},"ResolutionUnit":{"value":"2"},"XResolution":{"value":"96/1"},"YResolution":{"value":"96/1"}}
RemarksCstring

标记信息。

remarkc
RemarksDstring

标记信息。

remarkd
ImageWidthinteger

图片宽度。

500
RemarksArrayAstring

标记信息列表。

["remarka1","remarka2"]
SourcePositionstring

只有当 SourceType 为 video 时,此参数才生效。

视频中该图片帧处于源视频的时间轴位置。格式为00000000.010,即%8.3f。

00000000.010
Tagsarray<object>

标签识别结果。

Tagsobject
TagNamestring

标签名称。

TagConfidencefloat

标签置信度。

0.9812195897102356
CentricScorefloat

标签主体分数。用于提示该标签内容在图片中的主要程度,越高则说明该标签越可能为图片主体。取值范围为 0~1。

0
TagLevelinteger

标签级别,取值范围为 1~4。

2
ParentTagNamestring

父级标签名称。

人物
Facesarray<object>

人脸识别结果。

Facesobject
Genderstring

性别,可选项包括 MALE 和 FEMALE。

MALE
GenderConfidencefloat

性别置信度。

1
FaceIdstring

人脸 ID。

59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51
FaceAttributesobject

人脸其他属性。

GlassesConfidencefloat

是否戴眼镜置信度。

1
Glassesstring

是否带眼镜。

NONE
Maskstring

是否带口罩。

NONE
BeardConfidencefloat

是否有胡子置信度。

1
MaskConfidencefloat

是否带口罩置信度。

1
FaceBoundaryobject

人脸框信息。

Topinteger

顶点 Y 坐标,距离顶端距离。单位为 px。

191
Widthinteger

人脸框宽度。单位为 px。

269
Heightinteger

人脸框高度。单位为 px。

252
Leftinteger

顶点 X 坐标,距离左端距离。单位为 px。

95
HeadPoseobject

头部朝向。

Pitchfloat

人脸的俯仰角,取值范围为-180~+180度,可信的范围建议为-30~+30度。

18.385589599609375
Rollfloat

内偏转角,取值范围为-180~+180度,可信的建议范围为-45~+45度。

4.204030513763428
Yawfloat

人脸的左右偏转角,取值范围为-180~+180度,可信的范围建议为-80~+80度。

2.4945924282073975
Beardstring

是否有胡子。

NONE
FaceQualityfloat

人脸质量。

0.9321779608726501
Emotionstring

心情。

HAPPY
Agestring

年龄。

29
FaceConfidencefloat

人脸置信度。

0.9608758687973022
EmotionConfidencefloat

心情置信度。

0.7079545259475708
Attractivefloat

人脸吸引力,分数越高吸引力越强,取值范围为 0~1。

0.96
GroupIdstring

人脸分组 ID。如果人脸未分组,则此参数返回值为 group-not-grouped。

group-not-grouped
EmotionDetailsobject

七种心情对应的置信度。

HAPPYfloat

HAPPY 心情置信度。

0.7079545259475708
CALMfloat

CALM 心情置信度。

0.2918718755245209
SURPRISEDfloat

SURPRISED 心情置信度。

0.00006676767952740192
DISGUSTEDfloat

DISGUSTED 心情置信度。

0.000033771051676012576
ANGRYfloat

ANGRY 心情置信度。

0.00001282201901631197
SADfloat

SAD 心情置信度。

0.00001527295717096422
SCAREDfloat

SCARED 心情置信度。

0.0000014976058082538657
AddressStatusstring

图片地理位置检测的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed:失败

您可以根据该状态决定读取结果、等待或重试。

Success
FacesStatusstring

人脸识别的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed:失败

您可以根据该状态决定读取结果、等待或重试。

Success
ImageQualityModifyTimestring

图片质量打分的更新时间。

2020-11-24T10:56:52.461Z
CroppingSuggestionarray<object>

图片的裁减建议。

CroppingSuggestionobject
Scorefloat

该裁剪方案的美学分数,分数越高表示该方案效果越好,取值范围为 0~1。

0.8979608535766602
CroppingBoundaryobject

裁剪框信息。

Topinteger

顶点 Y 坐标,距离顶端距离。单位为 px。

30
Widthinteger

裁剪框宽度。单位为 px。

200
Heightinteger

裁剪框高度。单位为 px。

300
Leftinteger

顶点 X 坐标,距离左端距离。单位为 px。

10
AspectRatiostring

图片裁剪比例列表。

2:3
RequestIdstring

当次请求的 Request ID。

D349D345-4744-472C-ABDC-7A29A5E04042
CreateTimestring

图片加入媒体集的时间。

2020-11-24T9:56:52.461Z
ExternalIdstring

外部 ID,用于和您的应用层的 ID(如果有)进行绑定。

externalId001
TagsModifyTimestring

标签识别的更新时间。当 TagsStatus 更改时更新。

2020-11-24T10:56:52.461Z
ImageQualityFailReasonstring

图片质量打分失败原因。

Timeout
Orientationstring

图片旋转值,从 EXIF 信息中获取。

如果图片 EXIF 信息无此信息,则返回结果中无此参数。

{"val":"Right-top","type":3}
ImageUristring

图片的 OSS URI。

oss://imm-test/testcases/face1.jpg
OCRStatusstring

OCR 识别的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed:失败

您可以根据该状态决定读取结果、等待或重试。

NotProcessed
OCRModifyTimestring

OCR 识别的更新时间。

2020-11-24T10:56:52.461Z
ImageTimestring

图片的拍摄日期,该日期从 EXIF 信息中获取。

如果图片 EXIF 信息无此信息,则返回结果中无此参数。

2020-11-24T10:56:52.461Z
CroppingSuggestionModifyTimestring

提供最新裁剪建议的时间。

2020-11-24T10:56:52.461Z
ImageHeightinteger

图片高度。

861
ImageQualityStatusstring

图片质量打分状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed:失败

您可以根据该状态决定读取结果、等待或重试。

Success
TagsStatusstring

标签识别的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed:失败

您可以根据该状态决定读取结果、等待或重试。

Success
OCRFailReasonstring

OCR 识别的失败原因。

Timeout
SetIdstring

媒体集的唯一标识。

set001
FileSizeinteger

文件大小,单位为字节。

69732
Locationstring

图片地理位置,从 EXIF 信息中获取,格式为lat,long,以英文逗号(,)分隔的浮点数。

如果图片 EXIF 信息无此信息,则返回结果中无此参数。

30.134390,120.074997
OCRarray<object>

OCR 识别结果。

OCRobject
OCRConfidencefloat

文字置信度。

0.8254936695098877
OCRContentsstring

文字内容。

欢迎使用智能媒体管理
OCRBoundaryobject

文字位置框信息。

Topinteger

顶点 Y 坐标,距离顶端距离。单位为 px。

12
Widthinteger

文字位置框宽度。单位为 px。

12
Heightinteger

文字位置框高度。单位为 px。

12
Leftinteger

顶点 X 坐标,距离左端距离。单位为 px。

12

示例

正常返回示例

JSON格式

{
  "ImageQuality": {
    "OverallScore": 0.7759467363357544,
    "Color": 0.6101377010345459,
    "ColorScore": 0.6101377010345459,
    "ContrastScore": 0.6101377010345459,
    "Contrast": 0.6101377010345459,
    "ExposureScore": 0.6101377010345459,
    "ClarityScore": 0.6101377010345459,
    "Clarity": 0.6101377010345459,
    "Exposure": 0.6101377010345459,
    "CompositionScore": 0.6101377010345459
  },
  "ModifyTime": "2020-11-24T10:56:52.461Z",
  "Address": {
    "Township": "转塘街道",
    "District": "西湖区",
    "AddressLine": "中国浙江省杭州市西湖区转塘街道石龙山西路",
    "Country": "中国",
    "City": "杭州市",
    "Province": "浙江省"
  },
  "SourceType": "image",
  "SourceUri": "oss://imm-test/testcases/face1.jpg",
  "FacesFailReason": "Timeout",
  "CroppingSuggestionStatus": "NotProcessed",
  "CroppingSuggestionFailReason": "Timeout",
  "AddressFailReason": "Timeout",
  "RemarksA": "remarka",
  "AddressModifyTime": "2020-11-24T10:56:52.461Z",
  "RemarksB": "remarkb",
  "ImageFormat": "jpg",
  "TagsFailReason": "Timeout",
  "RemarksArrayB": "[\"remarkb1\",\"remarkb2\"]",
  "FacesModifyTime": "2020-11-24T10:56:52.461Z",
  "Exif": "{\"FileSize\":{\"value\":\"29304\"},\"Format\":{\"value\":\"jpg\"},\"ImageHeight\":{\"value\":\"417\"},\"ImageWidth\":{\"value\":\"500\"},\"ResolutionUnit\":{\"value\":\"2\"},\"XResolution\":{\"value\":\"96/1\"},\"YResolution\":{\"value\":\"96/1\"}}",
  "RemarksC": "remarkc",
  "RemarksD": "remarkd",
  "ImageWidth": 500,
  "RemarksArrayA": "[\"remarka1\",\"remarka2\"]",
  "SourcePosition": "00000000.010",
  "Tags": [
    {
      "TagName": "脸",
      "TagConfidence": 0.9812195897102356,
      "CentricScore": 0,
      "TagLevel": 2,
      "ParentTagName": "人物"
    }
  ],
  "Faces": [
    {
      "Gender": "MALE",
      "GenderConfidence": 1,
      "FaceId": "59edc040d0a8f4952b183d1b5044913a0ccd8739500ee2705ffe4965a0406a51",
      "FaceAttributes": {
        "GlassesConfidence": 1,
        "Glasses": "NONE",
        "Mask": "NONE",
        "BeardConfidence": 1,
        "MaskConfidence": 1,
        "FaceBoundary": {
          "Top": 191,
          "Width": 269,
          "Height": 252,
          "Left": 95
        },
        "HeadPose": {
          "Pitch": 18.385589599609375,
          "Roll": 4.204030513763428,
          "Yaw": 2.4945924282073975
        },
        "Beard": "NONE"
      },
      "FaceQuality": 0.9321779608726501,
      "Emotion": "HAPPY",
      "Age": "29",
      "FaceConfidence": 0.9608758687973022,
      "EmotionConfidence": 0.7079545259475708,
      "Attractive": 0.96,
      "GroupId": "group-not-grouped",
      "EmotionDetails": {
        "HAPPY": 0.7079545259475708,
        "CALM": 0.2918718755245209,
        "SURPRISED": 0.00006676767952740192,
        "DISGUSTED": 0.000033771051676012576,
        "ANGRY": 0.00001282201901631197,
        "SAD": 0.00001527295717096422,
        "SCARED": 0.0000014976058082538657
      }
    }
  ],
  "AddressStatus": "Success",
  "FacesStatus": "Success",
  "ImageQualityModifyTime": "2020-11-24T10:56:52.461Z",
  "CroppingSuggestion": [
    {
      "Score": 0.8979608535766602,
      "CroppingBoundary": {
        "Top": 30,
        "Width": 200,
        "Height": 300,
        "Left": 10
      },
      "AspectRatio": "2:3"
    }
  ],
  "RequestId": "D349D345-4744-472C-ABDC-7A29A5E04042",
  "CreateTime": "2020-11-24T9:56:52.461Z",
  "ExternalId": "externalId001",
  "TagsModifyTime": "2020-11-24T10:56:52.461Z",
  "ImageQualityFailReason": "Timeout",
  "Orientation": "{\"val\":\"Right-top\",\"type\":3}",
  "ImageUri": "oss://imm-test/testcases/face1.jpg",
  "OCRStatus": "NotProcessed",
  "OCRModifyTime": "2020-11-24T10:56:52.461Z",
  "ImageTime": "2020-11-24T10:56:52.461Z",
  "CroppingSuggestionModifyTime": "2020-11-24T10:56:52.461Z",
  "ImageHeight": 861,
  "ImageQualityStatus": "Success",
  "TagsStatus": "Success",
  "OCRFailReason": "Timeout",
  "SetId": "set001",
  "FileSize": 69732,
  "Location": "30.134390,120.074997",
  "OCR": [
    {
      "OCRConfidence": 0.8254936695098877,
      "OCRContents": "欢迎使用智能媒体管理",
      "OCRBoundary": {
        "Top": 12,
        "Width": 12,
        "Height": 12,
        "Left": 12
      }
    }
  ]
}

错误码

访问错误中心查看更多错误码。