QueryTagInfoBySelection

更新时间:
复制 MD 格式

This operation queries information about tags.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dytns:QueryTagInfoBySelection

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

IndustryId

integer

No

The industry ID.

58

SceneId

integer

No

The scenario ID.

83

TagId

integer

No

The tag ID.

71

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

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

Message

string

The description of the status code.

OK

Data

array<object>

The returned data.

array<object>

The returned data.

SceneId

integer

The scenario ID.

41

IndustryId

integer

The industry ID.

83

SceneName

string

The scenario name.

通用

TagName

string

The tag name.

号码归属

FlowName

string

The flow name.

查询

EnumDefinitionAddress

string

The URL for the enumeration definition.

example.aliyundoc.com

TagId

integer

The tag ID.

31

AuthCodeList

array

The list of available authorization codes.

string

None

IndustryName

string

The industry name.

物流

DocAddress

string

The URL of the API reference.

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

DemoAddress

string

The URL of the API demo.

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

ParamList

array<object>

The list of tag parameters.

array<object>

The tag parameter.

ValueDict

array<object>

The enumeration definition. Format: code:desc

object

The enumeration definition. Format: code:desc

Desc

string

The name in Chinese.

阿里云

Code

string

The name in English.

Aliyun

Type

string

The type. This is the code that corresponds to EnumUIWidgetTypes.

aqzx

Hint

string

The input prompt.

Code

string

The name of the parameter in English.

preame

Must

boolean

Indicates whether the parameter is required.

false

Name

string

The name of the parameter in Chinese.

RichTextDescription

string

The rich text description. This field is returned only for complex tags.

ComplexityType

string

The tag type.

SINGLE_STAGE

Code

string

The request status code. OK indicates a successful request.

OK

Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter Invalid parameter.
400 AuthCodeIllegal Illegal authCode.
500 InternalError A system error occurred.
500 RequestTimeout Request supplier timed out. Request supplier timeout
500 RequestSupplierError Request supplier error. Request supplier error.

See for a complete list.

Release notes

See Release Notes for a complete list.