跳转至

查询 AWS Role 云账号



GET /api/v1/cloud_account/do/list

Query 请求参数

参数名 类型 必选 说明
uuid string 云账号 UUID
例子: clac_example
允许为空: False
area custom_enum 区域 ID
例子: cn
允许为空: False
可选值: ['cn', 'intl']
accountId string 账号 ID
例子: string
允许为空: False
accountName string 用户名
例子: string
允许为空: False
pageSize integer 每页返回数量
允许为空: False
例子: 10
pageIndex integer 页码
允许为空: False
例子: 1

参数补充说明

端到端步骤参见 通过 OpenAPI 接入 AWS 云账号。示例中的 Endpoint 取自 OpenAPI 站点列表。

仅返回当前工作空间的 AWS assume_role 记录;需要 cloudAccount.accountManage,不会因具有临时凭证读取权限而自动放开管理接口。

  • 使用 uuid 精确定位;accountId/accountName 沿用模糊查询,恢复创建结果时须精确比对字段并遍历分页。页码从 1 开始,默认每页 10 条。响应分页在顶层 pageInfo,记录位于 content.data,content.declaration 沿用工作空间声明。
  • 每条记录保留既有列表结构,在顶层补充 platformAccountId 和 platformAuthorizationStatus。使用 config.externalId 配置信任策略。
  • 平台账号 ID 是按当前工作空间品牌及记录分区取得的当前公开配置,不是历史身份快照。不可用时保留记录及 External ID,平台 ID 为 null、状态为 unavailable;正常为 available,不回退其他品牌。
  • isAvailable 是可能滞后的健康状态;请用修改接口 dryRun=true 执行本次验证,正式保存用 dryRun=false。后续获取临时凭证仍执行实时验证。
  • 不接收 provider/authType/工作空间覆盖参数。创建响应丢失时先查询恢复,不重新生成 External ID。

请求例子

curl '<Endpoint>/api/v1/cloud_account/do/list?uuid=clac_example&pageIndex=1&pageSize=10' -H 'DF-API-KEY: <DF-API-KEY>'

响应

{
    "code": 200,
    "success": true,
    "errorCode": "",
    "message": "",
    "content": {
        "data": [
            {
                "uuid": "clac_example",
                "provider": "aws",
                "config": {
                    "authType": "assume_role",
                    "area": "intl",
                    "accountId": "123456789012",
                    "roleName": "collection/Guance",
                    "accountName": "example",
                    "externalId": "generated-external-id",
                    "extraTags": []
                },
                "isAvailable": false,
                "platformAccountId": "111111111111",
                "platformAuthorizationStatus": "available"
            }
        ],
        "declaration": {}
    },
    "traceId": "TRACE-example",
    "pageInfo": {
        "pageIndex": 1,
        "pageSize": 10,
        "count": 1,
        "totalCount": 1
    }
}

文档评价

文档内容是否对您有帮助?