QueryTagInfoBySelection - 查询标签信息

查询标签信息。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dytns:QueryTagInfoBySelection

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

IndustryId

integer

行业 ID。

58

SceneId

integer

场景 ID。

83

TagId

integer

标签 ID。

71

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

1C3B8084-3A7D-570B-BC84-BF945A9CF65E

Message

string

返回状态码描述。

OK

Data

array

返回的数据内容。

object

返回的数据内容。

SceneId

integer

场景 ID。

41

IndustryId

integer

行业 ID。

83

SceneName

string

场景名称。

通用

TagName

string

标签名称。

号码归属

FlowName

string

流程名称。

查询

EnumDefinitionAddress

string

枚举值定义链接。

example.aliyundoc.com

TagId

integer

标签 ID。

31

AuthCodeList

array

可用的授权码列表。

string

IndustryName

string

行业名称。

物流

DocAddress

string

API 文档链接。

https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.2573870.0.0.3aa921cbOrtqJz

DemoAddress

string

API demo 链接。

https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.2573870.0.0.3aa921cbOrtqJz

ParamList

array

标签参数列表。

object

标签参数。

ValueDict

array

枚举值定义,code:desc

object

枚举值定义,code:desc

Desc

string

中文名。

阿里云

Code

string

英文名。

Aliyun

Type

string

类型,EnumUIWidgetTypes 对应的 code。

aqzx

Hint

string

输入提示。

Code

string

参数英文名。

preame

Must

boolean

是否必填。

false

Name

string

参数中文名。

RichTextDescription

string

富文本描述信息,仅复杂标签有此字段。

ComplexityType

string

标签类型。

SINGLE_STAGE

Code

string

请求状态码。 OK 为成功。

OK

Success

boolean

是否成功。取值:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "RequestId": "1C3B8084-3A7D-570B-BC84-BF945A9CF65E",
  "Message": "OK",
  "Data": [
    {
      "SceneId": 41,
      "IndustryId": 83,
      "SceneName": "通用",
      "TagName": "号码归属",
      "FlowName": "查询",
      "EnumDefinitionAddress": "example.aliyundoc.com\n",
      "TagId": 31,
      "AuthCodeList": [
        "无"
      ],
      "IndustryName": "物流",
      "DocAddress": "https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.2573870.0.0.3aa921cbOrtqJz",
      "DemoAddress": "https://help.aliyun.com/document_detail/388997.html?spm=a2c4g.2573870.0.0.3aa921cbOrtqJz",
      "ParamList": [
        {
          "ValueDict": [
            {
              "Desc": "阿里云",
              "Code": "Aliyun"
            }
          ],
          "Type": "aqzx",
          "Hint": "无",
          "Code": "preame",
          "Must": false,
          "Name": "无"
        }
      ],
      "RichTextDescription": "无",
      "ComplexityType": "SINGLE_STAGE"
    }
  ],
  "Code": "OK",
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParameter Invalid parameter. 无效参数
400 AuthCodeIllegal Illegal authCode. 鉴权时使用的authcode不可用于该接口
500 InternalError A system error occurred. 系统异常
500 RequestTimeout Request supplier timed out. 请求供应商超时
500 RequestSupplierError Request supplier error. 请求第三方服务异常。

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

变更历史

更多信息,参考变更详情