文档

ProvisionAccessConfiguration - 将访问配置部署到RD账号上

更新时间:
一键部署

调用ProvisionAccessConfiguration将访问配置部署到RD账号上。

接口说明

该 API 的操作为异步操作。您可以使用返回参数中的TaskId,调用 GetTask 查询任务执行状态。

本文将提供一个示例,将访问配置ac-00jhtfl8thteu6uj****部署到 RD 账号114240524784****上。

调试

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

授权信息

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

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

请求参数

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

目录 ID。

d-00fc2p61****
AccessConfigurationIdstring

访问配置 ID。

ac-00jhtfl8thteu6uj****
TargetTypestring

任务目标类型。取值:RD-Account,表示任务目标类型为 RD 账号。

RD-Account
TargetIdstring

任务目标 ID。

114240524784****

返回参数

名称类型描述示例值
object

返回结果。

Tasksobject []

任务信息。

Statusstring

任务状态。取值:

  • InProgress:任务执行中。
  • Success:任务执行成功。
  • Failed:任务执行失败。
InProgress
TaskIdstring

任务 ID。

t-shqlhd8uvt280rtm****
TargetPathstring

任务目标在资源目录中的路径 ID。

rd-3G****/r-Wm****/114240524784****
TargetNamestring

任务目标名称。

dev-test
TargetIdstring

部署目标 ID。

114240524784****
AccessConfigurationNamestring

访问配置名称。

ECS-Admin
TargetPathNamestring

任务目标在资源目录中的路径名称。

rd-3G****/root/dev-test
TaskTypestring

任务类型。取值:ProvisionAccessConfiguration,表示部署访问配置任务。

ProvisionAccessConfiguration
TargetTypestring

任务目标类型。取值:RD-Account,表示任务目标类型为 RD 账号。

RD-Account
AccessConfigurationIdstring

访问配置 ID。

ac-00jhtfl8thteu6uj****
RequestIdstring

请求 ID。

DFDC16B2-4509-5FA6-9FA5-3CD35E4292FB

示例

正常返回示例

JSON格式

{
  "Tasks": [
    {
      "Status": "InProgress",
      "TaskId": "t-shqlhd8uvt280rtm****",
      "TargetPath": "rd-3G****/r-Wm****/114240524784****",
      "TargetName": "dev-test",
      "TargetId": "114240524784****",
      "AccessConfigurationName": "ECS-Admin",
      "TargetPathName": "rd-3G****/root/dev-test",
      "TaskType": "ProvisionAccessConfiguration",
      "TargetType": "RD-Account",
      "AccessConfigurationId": "ac-00jhtfl8thteu6uj****"
    }
  ],
  "RequestId": "DFDC16B2-4509-5FA6-9FA5-3CD35E4292FB"
}

错误码

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

  • 本页导读 (1)