文档

CreateAccessConfiguration - 创建访问配置

更新时间:
一键部署

创建访问配置。

接口说明

关于访问配置的介绍,请参见访问配置概述

本文将提供一个示例,创建一个名为ECS-Admin的访问配置。

调试

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

授权信息

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

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

请求参数

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

目录 ID。

d-00fc2p61****
AccessConfigurationNamestring

访问配置名称。

格式:包含英文字母、数字或短划线(-)。

长度:最大 32 个字符。

ECS-Admin
Descriptionstring

访问配置的描述。

长度:最大 1024 个字符。

This is an access configuration.
SessionDurationinteger

会话持续时间。

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

单位:秒。

取值范围:900~43200(15 分钟~12 小时)。

默认值:3600(1 小时)。

3600
RelayStatestring

初始访问页面。

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

该页面必须是阿里云控制台页面。默认为空,表示跳转到阿里云控制台首页。

https://cloudsso.console.aliyun.com

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

A3A41736-A050-50B6-ABC5-590F376A0044
AccessConfigurationobject

访问配置信息。

AccessConfigurationNamestring

访问配置名称。

ECS-Admin
SessionDurationinteger

会话持续时间。

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

单位:秒。

3600
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****

示例

正常返回示例

JSON格式

{
  "RequestId": "A3A41736-A050-50B6-ABC5-590F376A0044",
  "AccessConfiguration": {
    "AccessConfigurationName": "ECS-Admin",
    "SessionDuration": 3600,
    "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****"
  }
}

错误码

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

  • 本页导读 (1)