全部产品
Search
文档中心

阿里云交易和账单管理API:QueryRelationList - 查询企业财务关系列表

更新时间:Mar 01, 2024

查询有主子关系权限的账号的成员账号关系列表。

调试

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

授权信息

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

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

请求参数

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

阿里云账号 UID。

1990699401005016
PageNuminteger

页码,默认 1。

1
PageSizeinteger

页大小,默认 20。

20
StatusListarray

关系状态列表,状态是 RelationshipStatusEnum 的枚举值。默认不传值查询当前生效状态。

string
RELATED

RelationshipStatusEnum 类型定义:

枚举值描述备注
INITIAL初始化状态关系未生效
CONFIRMING邀约状态关系未生效
REJECTED被拒绝状态关系未生效
CONNECTION_CANCELED关系解除状态关系未生效
RELATED已关联状态关系已生效
CHANGE_CONFIRMING生效后变更待确认状态关系已生效
CONNECTION_MASTER_CANCEL取消确认状态关系未生效

返回参数

名称类型描述示例值
object
Codestring

状态码。

Success
Messagestring

消息说明。

Successful!
RequestIdstring

请求 ID。

7FC5D662-37FD-40A6-85B1-33442D815184
Successboolean

是否成功。

true
Dataobject

消息体

PageNuminteger

页码

1
PageSizeinteger

页大小

20
TotalCountinteger

总数

100
FinancialRelationInfoListobject []

关系列表

EndTimestring

关系失效时间。为空表示没有失效

2021-03-08T15:12Z
RelationTypestring

关系策略:FinancialManagement 表示财务管理,FinancialTrusteeship 表示财务托管

FinancialManagement
AccountNickNamestring

用户显示名称

test4
StartTimestring

关系生效时间。符合 ISO8601 标准的 utc 时间格式,如 2016-05-23T12:00:00Z(为北京时间 2016 年 5 月 23 日 20 点 0 分 0 秒)

2021-03-02T15:12Z
Statestring

关系状态。取值是 RelationshipStatusEnum 的枚举值。

RELATED
AccountIdlong

阿里云账号 UID

1851253838840762
SetupTimestring

关系建立时间。符合 ISO8601 标准的 utc 时间格式,如 2016-05-23T12:00:00Z(为北京时间 2016 年 5 月 23 日 20 点 0 分 0 秒)

2021-03-02T15:12Z
AccountTypestring

企业财务账号类型:MASTER 和 MEMBER。

MEMBER
AccountNamestring

阿里云账号登录名

caiwuyun_test4
RelationIdlong

关系 ID

51463

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "7FC5D662-37FD-40A6-85B1-33442D815184",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "FinancialRelationInfoList": [
      {
        "EndTime": "2021-03-08T15:12Z",
        "RelationType": "FinancialManagement",
        "AccountNickName": "test4",
        "StartTime": "2021-03-02T15:12Z",
        "State": "RELATED",
        "AccountId": 1851253838840762,
        "SetupTime": "2021-03-02T15:12Z",
        "AccountType": "MEMBER",
        "AccountName": "caiwuyun_test4",
        "RelationId": 51463
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified request contains invalid parameters.请求中包含无效参数。
400MissingParameterThe specified request lacks essential parameters.该请求缺少必要参数。
500InternalErrorAn error occurred in the internal server.-

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