ListIntegrationPolicies - 查询接入中心策略列表信息

查询接入中心策略列表信息

接口说明

查询集成列表

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cms:ListIntegrationPolicies

list

*全部资源

*

请求语法

GET /integration-policies HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

policyId

string

策略 ID。

policy-93817a401f78435596d745a97d2e85a1

policyName

string

规则名称。

prod-database

policyType

string

策略类型

CS

addonName

string

Addon 名称。

cs-default

filterRegionIds

string

用于 Region 查询,以英文逗号分隔

cn-beijing,cn-hangzhou

resourceGroupId

string

资源组 id。

rg-xxxxx

tag

array<object>

标签列表。

object

标签列表,JSON 格式。

key

string

标签键

test

value

string

标签值

value

nextToken

string

用来返回更多结果。第一次查询不需要提供这个参数,后续查询所需使用的 Token,从返回结果中获取。

mvnX6zqg3P

maxResults

integer

最大返回结果数。默认 30,最大值 100。

30

entityGroupIds

string

实体 ID 的过滤,以英文逗号分隔

eg-1,eg-2,eg-3

workspace

string

工作空间。

demo

query

string

用于通用查询

test

prometheusInstanceId

string

实例 id。

cmee-622d27c2e87d49debceeebc7c642610e

bindResourceId

string

绑定的资源 Id

622d27c2e87d49debceeebc7c642610e

返回参数

名称

类型

描述

示例值

object

maxResults

integer

分页大小 默认值: 50 最大值: 50

100

nextToken

string

分页 Token

44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE

policies

array<object>

接入策略列表

array<object>

接入策略

bindResource

object

绑定的资源信息

clusterId

string

集群 ID。

cv68tt87d78vyc89zy9v

clusterType

string

集群类型。

ManagedKubernetes

vpcCidr

string

VPC 网段

100.100.0.1/16

vpcId

string

虚拟专有网络。

vpc-uf664nyle5khp5d4d7hdo

entityGroup

object

实体组

description

string

描述。

xxxx

entityGroupId

string

实体组 ID

eg-b79f65d11fb94e779867cf937c3a3002

entityGroupName

string

实体组名称

test-eg

entityRules

object

实体组

annotations

array<object>

注释

object

注释

op

string

执行的操作。

add

tagKey

string

标签的键。

key

tagValues

array

标签的值

string

标签的值

value

entityTypes

array

实体类型列表

string

实体类型

ECS

fieldRules

array<object>

字段规则

object

字段规则

fieldKey

string

字段的唯一标识。

test

fieldValues

array

字段内容,多值用英文,分隔。

string

字段内容,多值用英文,分隔。

field1,fieled2

op

string

执行的操作。

add

instanceIds

array

实例 ID。

string

实例 ID。

6fq8fvvcb,owqeq789r

ipMatchRule

object

IP 匹配规则

ipCidr

string

IP 网段

100.100.1.0/16

ipFieldKey

string

IP 字段的 key

xxxx

labels

array<object>

标签

object

标签value值。

op

string

执行的操作。

add

tagKey

string

标签键。

test

tagValues

array

标签的值

string

标签的值

value1

regionIds

array

地域 ID 列表

string

地域 ID

cn-beijing,cn-hangzhou

resourceGroupId

string

资源组 ID。

rg-5i6dbwxfxuqihk7k

tags

array<object>

实例的标签信息。

object

标签值

op

string

执行的操作。

add

tagKey

string

标签键。

key

tagValues

array

标签值。

string

标签值。

value1

query

string

搜索的关键词,支持文档库名称和描述

哈弗

regionId

string

区域 ID。

cn-heyuan

userId

string

用户 ID

1236812738

workspace

string

工作空间。

test-api

managedInfo

object

策略网络管理信息。

securityGroupId

string

安全组 ID

sg-xxxxx

vswitchId

string

交换机 ID。

vsw-xxxxxx

eniId

string

托管探针的 eni 网卡 id。例如: eni-xxxx。

eni-12345678

policyId

string

策略 ID。

policy-ac38a7cb02d14ff48bc9f97d0a75063e

policyName

string

规则名称。

6f5HSsg3AP

policyType

string

接入中心策略类型

ECS

regionId

string

区域 ID。

cn-heyuan

resourceGroupId

string

资源组 ID。

rg-xxxxx

tags

array<object>

资源标签 key 值。

object

标签。

key

string

标签键

key

value

string

匹配值。

value

userId

string

用户 ID

128470923

workspace

string

工作空间。

test-api

feePackage

string

计费类型。

枚举值:

  • CS_Pro :

    CS_Pro

  • CS_Basic :

    CS_Basic

CS_Pro

subAddonRelease

object

子 Release 数量

total

integer

规则数量。

278

ready

integer

已就绪的子 Release 数量

30

csUmodelStatus

boolean

容器环境 umodel 安装状态。

true

requestId

string

Id of the request

CD8BA7D6-995D-578D-9941-78B0FECD14B5

totalCount

integer

条目总数

0

示例

正常返回示例

JSON格式

{
  "maxResults": 100,
  "nextToken": "44ANBjKZmQeKnaB1fXRq06w7sFYK3MUcCALMD9qQbmEiE",
  "policies": [
    {
      "bindResource": {
        "clusterId": "cv68tt87d78vyc89zy9v",
        "clusterType": "ManagedKubernetes",
        "vpcCidr": "100.100.0.1/16",
        "vpcId": "vpc-uf664nyle5khp5d4d7hdo"
      },
      "entityGroup": {
        "description": "xxxx",
        "entityGroupId": "eg-b79f65d11fb94e779867cf937c3a3002",
        "entityGroupName": "test-eg",
        "entityRules": {
          "annotations": [
            {
              "op": "add",
              "tagKey": "key",
              "tagValues": [
                "value"
              ]
            }
          ],
          "entityTypes": [
            "ECS"
          ],
          "fieldRules": [
            {
              "fieldKey": "test",
              "fieldValues": [
                "field1,fieled2"
              ],
              "op": "add"
            }
          ],
          "instanceIds": [
            "6fq8fvvcb,owqeq789r"
          ],
          "ipMatchRule": {
            "ipCidr": "100.100.1.0/16",
            "ipFieldKey": "xxxx"
          },
          "labels": [
            {
              "op": "add",
              "tagKey": "test",
              "tagValues": [
                "value1"
              ]
            }
          ],
          "regionIds": [
            "cn-beijing,cn-hangzhou"
          ],
          "resourceGroupId": "rg-5i6dbwxfxuqihk7k",
          "tags": [
            {
              "op": "add",
              "tagKey": "key",
              "tagValues": [
                "value1"
              ]
            }
          ]
        },
        "query": "哈弗",
        "regionId": "cn-heyuan",
        "userId": "1236812738",
        "workspace": "test-api"
      },
      "managedInfo": {
        "securityGroupId": "sg-xxxxx",
        "vswitchId": "vsw-xxxxxx",
        "eniId": "eni-12345678"
      },
      "policyId": "policy-ac38a7cb02d14ff48bc9f97d0a75063e",
      "policyName": "6f5HSsg3AP",
      "policyType": "ECS",
      "regionId": "cn-heyuan",
      "resourceGroupId": "rg-xxxxx",
      "tags": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "userId": "128470923",
      "workspace": "test-api",
      "feePackage": "CS_Pro",
      "subAddonRelease": {
        "total": 278,
        "ready": 30
      },
      "csUmodelStatus": true
    }
  ],
  "requestId": "CD8BA7D6-995D-578D-9941-78B0FECD14B5",
  "totalCount": 0
}

错误码

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

变更历史

更多信息,参考变更详情