ObtainDomainProxyToken - Identity as a Service - Alibaba Cloud Documentation Center

Obtains the proxy token for a domain name in an EIAM 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

eiam:ObtainDomainProxyToken

get

*DomainProxyToken

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/domain/{#DomainId}/domainproxytoken/{#DomainProxyTokenId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
DomainId	string	Yes	The domain ID.	dm_examplexxxxx
DomainProxyTokenId	string	Yes	The ID of the domain name proxy token.	pt_examplexxxx

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
DomainProxyToken	object	The information about the proxy token.
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
DomainProxyTokenId	string	The ID of the domain name proxy token.	pt_examplexxxx
DomainProxyToken	string	The domain name proxy token.	PTxxxxxxxx
DomainId	string	The domain ID.	dm_examplexxxx
Status	string	The status of the token. Valid values: enabled: The token is enabled. disabled: The token is disabled.	enabled
CreateTime	integer	The time when the domain name proxy token was created. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000
UpdateTime	integer	The time when the domain name proxy token was last updated. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000
LastUsedTime	integer	The time when the domain name proxy token was last used. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "DomainProxyToken": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "DomainProxyTokenId": "pt_examplexxxx",
    "DomainProxyToken": "PTxxxxxxxx",
    "DomainId": "dm_examplexxxx",
    "Status": "enabled",
    "CreateTime": 1649830226000,
    "UpdateTime": 1649830226000,
    "LastUsedTime": 1649830226000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.