备案控制台
文档
产品文档
输入文档关键字查找
首页 云企业网 开发参考 API参考 API目录 流量调度 流量标记策略 ListTrafficMarkingPolicies - 查询流量标记策略的信息

ListTrafficMarkingPolicies - 查询流量标记策略的信息

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

调用ListTrafficMarkingPolicies接口查询流量标记策略的状态、流量标记策略的优先级等详细信息。

接口说明

在调用 ListTrafficMarkingPolicies 接口过程中：

  • TransitRouterId 和 TrafficMarkingPolicyId 参数需至少输入一个。
  • 如果您未输入流量标记策略 ID（即未指定 TrafficMarkingPolicyId 参数的值），则接口会根据 TransitRouterId、TrafficMarkingPolicyName 和 TrafficMarkingPolicyDescription 参数的值仅返回流量标记策略的信息，并不会返回流量标记策略下流分类规则的信息（即响应中不包含 TrafficMatchRules 字段）。
  • 如果您输入了流量标记策略 ID（即指定了 TrafficMarkingPolicyId 参数的值），则接口会为您返回该流量标记策略的信息以及该流量标记策略下流分类规则的信息（即响应中包含 TrafficMatchRules 字段）。 如果 TrafficMatchRules 字段为空数组，则表示当前流量标记策略下并不存在流分类规则。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
TransitRouterIdstring否

转发路由器实例 ID。

tr-bp1rmwxnk221e3fas****
TrafficMarkingPolicyIdstring否

流量标记策略 ID。

tm-iz5egnyitxiroq****
TrafficMarkingPolicyNamestring否

流量标记策略的名称。

名称可以为空或长度为 1～128 个字符，不能以 http://或 https://开头。

nametest
TrafficMarkingPolicyDescriptionstring否

流量标记策略的描述信息。

描述可以为空或长度为 1～256 个字符，不能以 http://或 https://开头。

desctest
MaxResultsinteger否

分批次查询时每次显示的条目数。取值范围：1~100，默认值：20。

20
NextTokenstring否

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

是否拥有下一次查询的令牌（Token）。

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

请求 ID。

699989E4-64A0-5F78-8B93-CDB32D98971F
TotalCountinteger

列表条目数。

1
MaxResultsinteger

分批次查询时每次显示的条目数。

20
TrafficMarkingPoliciesobject []

流量标记策略列表。

TrafficMarkingPolicyStatusstring

流量标记策略的状态。

  • Creating：创建中。
  • Active：可用。
  • Modifying：修改中。
  • Deleting：删除中。
Creating
TrafficMarkingPolicyIdstring

流量标记策略 ID。

tm-iz5egnyitxiroq****
MarkingDscpinteger

流量标记策略的 DSCP 值。

5
TrafficMarkingPolicyNamestring

流量标记策略的名称。

nametest
Priorityinteger

流量标记策略的优先级。

数字越小，优先级越高。

5
TrafficMarkingPolicyDescriptionstring

流量标记策略的描述信息。

desctest
TrafficMatchRulesobject []

流分类规则列表。

MatchDscpinteger

流量报文的 DSCP 值。

说明 如果 MatchDscp 返回值为-1 则表示匹配任意的 DSCP 值。
6
DstCidrstring

流量报文的目标网段。

192.168.120.0/24
TrafficMatchRuleDescriptionstring

流分类规则的描述信息。

desctest
Protocolstring

流量报文的协议类型。

说明 流量标记策略支持匹配多种协议类型，各个协议类型详情请自行查阅文档。
HTTP
TrafficMatchRuleIdstring

流分类规则 ID。

tm-rule-fa9kgq1e90rmhc****
SrcCidrstring

流量报文的源网段。

192.168.10.0/24
TrafficMatchRuleNamestring

流分类规则的名称。

nametest
TrafficMatchRuleStatusstring

流分类规则的状态。

  • Creating：创建中。
  • Active：可用。
  • Deleting：删除中。
Creating
DstPortRangearray

流分类规则待匹配的目的端口范围。

integer

流分类规则待匹配的目的端口范围。

接口会返回两个目的端口号：

  • 如果两个目的端口号相同，例如 80 和 80，则表示流分类规则匹配目的端口号为 80 的流量。

      如果两个目的端口号均为-1，则表示流分类规则匹配任意目的端口号的流量。

  • 如果两个目的端口号不相同，例如 1 和 200，则表示流分类规则匹配目的端口号在 1 至 200 范围内的流量。

80,80
SrcPortRangearray

流分类规则待匹配的源端口范围。

integer

流分类规则待匹配的源端口范围。

接口会返回两个源端口号：

  • 如果两个源端口号相同，例如 80 和 80，则表示流分类规则匹配源端口号为 80 的流量。

      如果两个源端口号均为-1，则表示流分类规则匹配任意源端口号的流量。

  • 如果两个源端口号不相同，例如 1 和 200，则表示流分类规则匹配源端口号在 1 至 200 范围内的流量。

1,200
TransitRouterIdstring

转发路由器实例 ID。

tr-ccni***

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "699989E4-64A0-5F78-8B93-CDB32D98971F",
  "TotalCount": 1,
  "MaxResults": 20,
  "TrafficMarkingPolicies": [
    {
      "TrafficMarkingPolicyStatus": "Creating",
      "TrafficMarkingPolicyId": "tm-iz5egnyitxiroq****",
      "MarkingDscp": 5,
      "TrafficMarkingPolicyName": "nametest",
      "Priority": 5,
      "TrafficMarkingPolicyDescription": "desctest",
      "TrafficMatchRules": [
        {
          "MatchDscp": 6,
          "DstCidr": "192.168.120.0/24",
          "TrafficMatchRuleDescription": "desctest",
          "Protocol": "HTTP",
          "TrafficMatchRuleId": "tm-rule-fa9kgq1e90rmhc****",
          "SrcCidr": "192.168.10.0/24",
          "TrafficMatchRuleName": "nametest",
          "TrafficMatchRuleStatus": "Creating",
          "DstPortRange": [
            0
          ],
          "SrcPortRange": [
            0
          ]
        }
      ],
      "TransitRouterId": "tr-ccni***"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400MissingParam.TransitRouterIdOrTrafficMarkingPolicyIdEither TransitRouterId or TrafficMarkingPolicyId must be specified.缺少参数TransitRouterId或TrafficMarkingPolicyId。
400IllegalParam.NextTokenThe specified NextToken is invalid.NextToken是无效的。
400InvalidNameName is invalid.name不合法。
400InvalidDescriptionDescription is invalid.描述不合法。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-12-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 400 变更
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
2023-03-09OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：400
2021-11-26新增 OpenAPI看变更集
文档推荐
  • 本页导读 （1）
文档反馈