QueryRelationList - Expenses and Costs - Alibaba Cloud Documentation Center

Queries a list of the relationships of member accounts.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

bssapi:QueryRelationList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
UserId	integer	Yes	The UID of the Alibaba Cloud account.	1990699401005016
PageNum	integer	No	The page number. The default value is 1.	1
PageSize	integer	No	The number of entries per page. The default value is 20.	20
StatusList	array	No	A list of relationship statuses. The value is an enumeration of RelationshipStatusEnum. If you do not specify this parameter, only relationships that are in effect are queried.	RELATED
	string	No		RELATED

Definition of the RelationshipStatusEnum type:

Value	Description	Notes
INITIAL	Initialized	The relationship is not in effect.
CONFIRMING	Invitated	The relationship is not in effect.
REJECTED	Rejected	The relationship is not in effect.
CONNECTION_CANCELED	Terminated	The relationship is not in effect.
RELATED	Linked	The relationship is in effect.
CHANGE_CONFIRMING	Change confirmation pending	The relationship is in effect.
CONNECTION_MASTER_CANCEL	Confirmation canceled	The relationship is not in effect.

Response elements

Parameter	Type	Description	Example
	object
Code	string	The status code.	Success
Message	string	The returned message.	Successful!
RequestId	string	The ID of the request.	7FC5D662-37FD-40A6-85B1-33442D815184
Success	boolean	Indicates whether the request was successful.	true
Data	object	The returned data.
PageNum	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries.	100
FinancialRelationInfoList	array<object>	The list of relationships.
	object
EndTime	string	The time when the relationship expires. If this parameter is empty, the relationship does not expire.	2021-03-08T15:12Z
RelationType	string	The relationship type. `FinancialManagement` indicates Financial Management and `FinancialTrusteeship` indicates finance trusteeship.	FinancialManagement
AccountNickName	string	The display name of the account.	test4
StartTime	string	The time when the relationship takes effect. The time is in UTC and follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-03-02T15:12Z
State	string	The status of the relationship. The value is an enumeration of RelationshipStatusEnum.	RELATED
AccountId	integer	The UID of the Alibaba Cloud account.	1851253838840762
SetupTime	string	The time when the relationship was established. The time is in UTC and follows the ISO 8601 standard in the `YYYY-MM-DDThh:mm:ssZ` format.	2021-03-02T15:12Z
AccountType	string	The type of the financial account. Valid values: MASTER and MEMBER.	MEMBER
AccountName	string	The logon name of the Alibaba Cloud account.	caiwuyun_test4
RelationId	integer	The relationship ID.	51463

Examples

Success response

JSON format

{
  "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
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified request contains invalid parameters.
400	MissingParameter	The specified request lacks essential parameters.
500	InternalError	An error occurred in the internal server.	System exception, please try again

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.