Query Template Variable Values with GetLinkageAttributesTemplate - CADT - Alibaba Cloud - Cloud Architect Design Tools

Retrieves the optional values for template variables.

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

bpstudio:GetLinkageAttributesTemplate

get

*Template

acs:bpstudio::{#accountId}:template/{#TemplateId}

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
TemplateId	string	Yes	The template ID.	XFKR6WYRVS24S07R
AreaId	string	No	The region ID.	cn-hangzhou
Instances	array<object>	No	The list of instances to be replaced.
	object	No
NodeName	string	No	The name of the instance in the graph.	vpc
NodeType	string	No	The instance type.	vpc
Id	string	No	The instance ID.	vpc-1q56taq40*****
Variables	object	No	The values for the parameters in the template. If you do not specify this parameter, the default values are used.
	any	No	The parameter value.	{"${instance_type}":"ecs.c6.3xlarge"}
TargetVariable	string	Yes	The template variable to query.	${instance_type}
NextToken	string	No	The token to retrieve the next page of results.	2
MaxResults	integer	No	The number of entries to return on each page.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
Message	string	The error message.	Success
RequestId	string	The request ID.	A07FFDF2-78FA-1B48-9E38-88E833A93187
Data	object	The data that is returned.
OptionalValues	string	The optional values.	[ { "label": "ecs.c6.2xlarge (8c 16g)", "value": "ecs.c6.2xlarge" }, { "label": "ecs.c6.3xlarge (12c 24g)", "value": "ecs.c6.3xlarge" } ]
ErrorCode	string	The error code.	400
ErrorMessage	string	The error message.	SyntaxError
TotalCount	integer	The total number of entries.	19
NextToken	string	The token that is used to retrieve the next page of results.	2
Code	string	The status code.	200
AccessDeniedDetail	string	The details of the access denial.	{ "PolicyType": "", "AuthPrincipalOwnerId": "", "EncodedDiagnosticMessage": "", "AuthPrincipalType": "", "AuthPrincipalDisplayName": "", "NoPermissionType": "", "AuthAction": "" }

Examples

Success response

JSON format

{
  "Message": "Success",
  "RequestId": "A07FFDF2-78FA-1B48-9E38-88E833A93187",
  "Data": {
    "OptionalValues": "[\n      {\n        \"label\": \"ecs.c6.2xlarge (8c 16g)\",\n        \"value\": \"ecs.c6.2xlarge\"\n      },\n      {\n        \"label\": \"ecs.c6.3xlarge (12c 24g)\",\n        \"value\": \"ecs.c6.3xlarge\"\n      }\n]",
    "ErrorCode": "400",
    "ErrorMessage": "SyntaxError",
    "TotalCount": 19,
    "NextToken": "2"
  },
  "Code": "200",
  "AccessDeniedDetail": "{\n    \"PolicyType\": \"\",\n    \"AuthPrincipalOwnerId\": \"\",\n    \"EncodedDiagnosticMessage\": \"\",\n    \"AuthPrincipalType\": \"\",\n    \"AuthPrincipalDisplayName\": \"\",\n    \"NoPermissionType\": \"\",\n    \"AuthAction\": \"\"\n  }"
}

Error codes

HTTP status code	Error code	Error message	Description
200	Success	The transaction is successful.
400	ParameterEmpty	You must specify the request parameter.	You must specify request parameters.
403	NoPermissions	No permissions.
404	EntityNotExist.ResourceGroup	The resource group does not exist.
404	EntityNotExist.ResourceId	The resource does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.