DescribeInstanceRdAccounts

更新时间:
复制 MD 格式

Retrieves the account in a resource directory for an instance.

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

yundun-cloudfirewall:DescribeInstanceRdAccounts

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

SourceIp

string

No

The IP address of the requester.

47.100.170.XXX

Lang

string

No

The language type for the request and response messages.

Valid values:

  • en :

    English.

  • zh :

    Chinese.

zh

CurrentPage

string

No

The page number of the current page.

1

PageSize

string

No

The number of entries per page.

10

MemberUid

string

No

The UID of the member accounts.

258039427902****

MemberDisplayName

string

No

The name of the Cloud Firewall member accounts.

cloudfirewall_2

MemberDesc

string

No

The remarks of the Cloud Firewall member accounts.

renewal

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

06D1EC07-C9EB-58AC-A750-C87C9A0****

Accounts

array<object>

The account information.

object

The account information.

DisplayName

string

The name of the member account.

test

AccountId

string

The ID of the member accounts.

171054237268****

Examples

Success response

JSON format

{
  "RequestId": "06D1EC07-C9EB-58AC-A750-C87C9A0****",
  "Accounts": [
    {
      "DisplayName": "test",
      "AccountId": "171054237268****"
    }
  ]
}

Error codes

HTTP status code

Error code

Error message

Description

400 ErrorParamsNotEnough Parameters are insufficient. Parameters are insufficient.
400 ErrorNoInstanceInDb no instance for process in db. The specified instance does not exist.
400 ErrorParamsInvalid Invalid Params The parameter is invalid.
400 ErrorInstanceAliuidNotDaMa instance aliuid not DA or MA. The Alibaba Cloud account to which Cloud Firewall belongs is not specified as a delegated administrator account or management account.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.