Queries access configurations.

Usage notes

This topic provides an example on how to query the access configurations within the directory d-00fc2p61****. The returned result shows that the directory contains the VPC-Admin and ECS-Admin access configurations.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListAccessConfigurations

The operation that you want to perform. Set the value to ListAccessConfigurations.

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

NextToken String No K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****

The token to return for the next page. If this is your first time to call this operation, you do not need to specify the NextToken parameter.

When you call this operation for the first time, if the total number of entries to return exceeds the value of MaxResults, the entries are truncated. Only the entries that match the value of MaxResults are returned, and the excess entries are not returned. In this case, the value of the response parameter IsTruncated is true, and NextToken is returned. In the next call, you can use the value of NextToken and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of IsTruncated becomes false. This way, all entries are returned.

MaxResults Integer No 10

The number of entries to return on each page.

Valid values: 1 to 100.

Default value: 10.

Filter String No AccessConfigurationName sw test

The filter condition.

Specify the value in the <Attribute> <Operator> <Value> format. The value is not case sensitive. You can set <Attribute> only to AccessConfigurationName and <Operator> only to eq or sw. The value eq indicates Equals. The value sw indicates Starts With.

For example, if you set Filter to AccessConfigurationName sw test, the operation queries all access configurations whose names start with test. If you set Filter to AccessConfigurationName eq TestAccessConfiguration, the operation queries the access configuration whose name is TestAccessConfiguration.

StatusNotifications String No ReprovisionRequired

The status notification. The status notification can be used to filter access configurations.

Set the value to ReprovisionRequired, which indicates that the operation queries all access configurations that need to be re-provisioned.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
AccessConfigurations Array of AccessConfiguration

The access configurations.

AccessConfigurationName String ECS-Admin

The name of the access configuration.

SessionDuration Integer 900

The duration of a session in which a CloudSSO user accesses an account in your resource directory by using the access configuration.

Unit: seconds.

Description String This is an access configuration.

The description of the access configuration.

RelayState String https://cloudsso.console.aliyun.com

The initial web page that is displayed after a CloudSSO user accesses an account in your resource directory by using the access configuration.

CreateTime String 2021-11-02T08:44:23Z

The time when the access configuration was created.

UpdateTime String 2021-11-02T08:44:23Z

The time when the information about the access configuration was modified.

StatusNotifications Array of String ReprovisionRequired

The status notification. Valid values:

  • Empty: No status notifications are sent.
  • ReprovisionRequired: The access configuration needs to be re-provisioned.
AccessConfigurationId String ac-00jhtfl8thteu6uj****

The ID of the access configuration.

NextToken String K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****

The token that is returned for the next page.

Note This parameter is returned only when the IsTruncated parameter is set to true.
RequestId String 2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2

The ID of the request.

MaxResults Integer 10

The number of entries returned per page.

TotalCounts Integer 2

The total number of entries returned.

IsTruncated Boolean false

Indicates whether the queried entries are truncated. Valid values:

  • true: The queried entries are truncated.
  • false: The queried entries are not truncated.

Examples

Sample requests

https://[Endpoint]/?Action=ListAccessConfigurations
&DirectoryId=d-00fc2p61****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<ListAccessConfigurationsResponse>
    <AccessConfigurations>
        <AccessConfiguration>
            <AccessConfigurationName>VPC-Admin</AccessConfigurationName>
            <SessionDuration>3600</SessionDuration>
            <Description></Description>
            <RelayState></RelayState>
            <CreateTime>2021-06-30T09:39:44Z</CreateTime>
            <UpdateTime>2021-07-26T03:02:11Z</UpdateTime>
            <StatusNotifications>ReprovisionRequired</StatusNotifications>
            <AccessConfigurationId>ac-00ccule7tadaijxc****</AccessConfigurationId>
        </AccessConfiguration>
        <AccessConfiguration>
            <AccessConfigurationName>ECS-Admin</AccessConfigurationName>
            <SessionDuration>900</SessionDuration>
            <Description>This is an access configuration.</Description>
            <RelayState></RelayState>
            <CreateTime>2021-11-02T08:44:23Z</CreateTime>
            <UpdateTime>2021-11-02T08:44:23Z</UpdateTime>
            <AccessConfigurationId>ac-00jhtfl8thteu6uj****</AccessConfigurationId>
        </AccessConfiguration>
    </AccessConfigurations>
    <RequestId>2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2</RequestId>
    <MaxResults>10</MaxResults>
    <TotalCounts>2</TotalCounts>
    <IsTruncated>false</IsTruncated>
</ListAccessConfigurationsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AccessConfigurations" : [ {
    "AccessConfigurationName" : "VPC-Admin",
    "SessionDuration" : 3600,
    "Description" : "",
    "RelayState" : "",
    "CreateTime" : "2021-06-30T09:39:44Z",
    "UpdateTime" : "2021-07-26T03:02:11Z",
    "StatusNotifications" : [ "ReprovisionRequired" ],
    "AccessConfigurationId" : "ac-00ccule7tadaijxc****"
  }, {
    "AccessConfigurationName" : "ECS-Admin",
    "SessionDuration" : 900,
    "Description" : "This is an access configuration.",
    "RelayState" : "",
    "CreateTime" : "2021-11-02T08:44:23Z",
    "UpdateTime" : "2021-11-02T08:44:23Z",
    "StatusNotifications" : [ ],
    "AccessConfigurationId" : "ac-00jhtfl8thteu6uj****"
  } ],
  "RequestId" : "2BC0CBAC-45E1-5BD3-BF6E-F69D1D5391C2",
  "MaxResults" : 10,
  "TotalCounts" : 2,
  "IsTruncated" : false
}

Error codes

For a list of error codes, visit the API Error Center.