文档

ListAccessConfigurations - 查询访问配置列表

更新时间:
一键部署

调用ListAccessConfigurations查询访问配置列表。

接口说明

本文将提供一个示例,查询目录d-00fc2p61****下的访问配置列表。返回结果显示,一共有VPC-AdminECS-Admin两个访问配置。

调试

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

授权信息

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

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

请求参数

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

目录 ID。

d-00fc2p61****
NextTokenstring

查询返回结果下一页的令牌。首次调用 API 不需要NextToken

当您首次调用 API 时,如果返回数据总条数超过MaxResults限制,数据会被截断,只返回MaxResults条数据,同时,返回参数IsTruncatedtrue,返回一个NextToken。您可以使用上一次返回的NextToken继续调用 API,其他请求参数保持不变,查询被截断的数据。您可以按此方法多次查询,直到IsTruncatedfalse,表示全部数据查询完毕。

K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResultsinteger

每页的最大数据条数。

取值范围:1~100。

默认值:10。

10
Filterstring

过滤条件。

格式: ,不区分大小写。目前,只支持 AccessConfigurationName,只支持 eq(Equals)和 sw(Start With)。

示例:Filter = "AccessConfigurationName sw test",表示查询名称以 test 开头的全部访问配置。Filter = "AccessConfigurationName eq TestAccessConfiguration",表示查询名称为 TestAccessConfiguration 的访问配置。

AccessConfigurationName sw test
StatusNotificationsstring

状态通知信息,用于查询的过滤条件。

取值:ReprovisionRequired,表示查询需要重新部署的访问配置。

ReprovisionRequired

返回参数

名称类型描述示例值
object

返回结果。

AccessConfigurationsobject []

访问配置列表。

AccessConfigurationNamestring

访问配置名称。

ECS-Admin
SessionDurationinteger

会话持续时间。

云 SSO 用户使用访问配置访问 RD 账号时,会话最多保持的时间。

单位:秒。

900
Descriptionstring

访问配置的描述。

This is an access configuration.
RelayStatestring

初始访问页面。

云 SSO 用户使用访问配置访问 RD 账号时,初始访问的页面地址。

https://cloudsso.console.aliyun.com
CreateTimestring

访问配置的创建时间。

2021-11-02T08:44:23Z
UpdateTimestring

访问配置的修改时间。

2021-11-02T08:44:23Z
StatusNotificationsarray

状态通知信息。

string

状态通知信息。取值:

  • 空:表示没有状态通知信息。
  • ReprovisionRequired:表示该访问配置需要重新部署。
ReprovisionRequired
AccessConfigurationIdstring

访问配置 ID。

ac-00jhtfl8thteu6uj****
NextTokenstring

查询返回结果下一页的令牌。

说明 只有IsTruncatedtrue时,才显示该参数。
K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestIdstring

请求 ID。

2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2
MaxResultsinteger

每页的最大数据条数。

10
TotalCountsinteger

符合请求参数条件的数据总条数。

2
IsTruncatedboolean

返回结果是否被截断。取值:

  • true:已截断。
  • false:未截断。
false

示例

正常返回示例

JSON格式

{
  "AccessConfigurations": [
    {
      "AccessConfigurationName": "ECS-Admin",
      "SessionDuration": 900,
      "Description": "This is an access configuration.",
      "RelayState": "https://cloudsso.console.aliyun.com",
      "CreateTime": "2021-11-02T08:44:23Z",
      "UpdateTime": "2021-11-02T08:44:23Z",
      "StatusNotifications": [
        "ReprovisionRequired"
      ],
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****"
    }
  ],
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2",
  "MaxResults": 10,
  "TotalCounts": 2,
  "IsTruncated": false
}

错误码

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

  • 本页导读 (1)