文档

ListAssociatedTransferSetting - 获取关联转组功能设置

更新时间:

调用ListAssociatedTransferSetting获取关联转组功能设置。

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
当前API无需请求参数

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

7556FD65-45D2-5C45-9FC9-A7DE831C775C
AssociatedTransferSettingobject

关联转组功能设置。

AccountIdstring

阿里云账号(主账号)ID。

121998723923****
Statusstring

关联转组功能开通状态。取值:

  • Enable:开启。
  • Disable:关闭。
Enable
RuleSettingsobject []

关联转组功能规则设置。

AssociatedResourceTypestring

关联资源的资源类型。

disk
MasterResourceTypestring

主资源的资源类型。

instance
AssociatedServicestring

关联资源的云服务代码。

ecs
MasterServicestring

主资源的云服务代码。

ecs
Statusstring

关联转组功能开通状态。取值:

  • Enable:开启。
  • Disable:关闭。
Enable
EnableExistingResourcesTransferstring

是否启动存量关联资源跟随转组任务。取值:

  • false:不启动存量关联资源跟随转组任务。
  • true:启动存量关联资源跟随转组任务。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "7556FD65-45D2-5C45-9FC9-A7DE831C775C",
  "AssociatedTransferSetting": {
    "AccountId": "121998723923****",
    "Status": "Enable",
    "RuleSettings": [
      {
        "AssociatedResourceType": "disk",
        "MasterResourceType": "instance",
        "AssociatedService": "ecs",
        "MasterService": "ecs",
        "Status": "Enable"
      }
    ],
    "EnableExistingResourcesTransfer": "true"
  }
}

错误码

HTTP status code错误码错误信息
404EntityNotExists.AssociatedTransferSettingThe associated transfer setting does not EXIST.

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

变更历史

变更时间变更内容概要操作
2024-01-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更