ListExperimentPlans-阿里云帮助中心

Lists experiment plans.

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

eflo:ListExperimentPlans

list

*ExperimentPlan

acs:eflo:{#regionId}:{#accountId}:experimentplan/*

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceName	array	No	The resources.
	string	No	The name of the resource.	cls-pim0anlrtm3ef4vstou001
PlanTaskStatus	array	No	The execution status.
	string	No	The status.	RUNNING
CreatTimeOrder	string	No	The sort order for the creation time.	desc
StartTimeOrder	string	No	The sort order for the start time.	desc
EndTimeOrder	string	No	The sort order for the end time.	desc
Page	integer	No	The page number.	1
Size	integer	No	The number of entries per page.	100
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzij65sf2rr5i
Tag	array<object>	No	The tags.
	object	No	The tag. You can specify up to 20 tags.
Key	string	No	The tag key.	owner
Value	string	No	The tag value.	test
TemplateId	integer	No	The template ID.	96
ResourceId	integer	No	The resource ID.	189

Response elements

Parameter	Type	Description	Example
	object	The query result.
Data	array<object>	The data.
	object	The query result.
PlanId	integer	The ID of the plan.	189
CreateTime	string	The time when the plan was created.	2024-07-08 10:12:42
UpdateTime	string	The time when the plan was last updated.	2024-07-08 10:12:42
TemplateId	integer	The ID of the associated experiment plan template.	6
TemplateName	string	The name of the associated experiment plan template.	test
ResourceName	string	The name of the associated resource.	q_ecs_xpec_postpay_c
PlanTaskStatus	object	The execution status of the experiment plan.
	integer	The status.	1
StartTime	string	The start time.	2024-07-08 10:12:42
EndTime	string	The end time.	2024-07-08 10:22:42
ResourceGroupId	string	The ID of the resource group.	rg-aek5behqmwbfhuy
Tags	array<object>	The tags.
	object	The tag.
TagKey	string	The tag key.	owner
TagValue	string	The tag value.	test
ResourceId	integer	The resource ID.	189
RequestId	string	The request ID.	FA9F1DE7-103B-5C18-AE9E-EB2BFF11C685
TotalCount	integer	The total number of entries.	0
AccessDeniedDetail	string	The details about the access denial.	{}

Examples

Success response

JSON format

{
  "Data": [
    {
      "PlanId": 189,
      "CreateTime": "2024-07-08 10:12:42",
      "UpdateTime": "2024-07-08 10:12:42",
      "TemplateId": 6,
      "TemplateName": "test",
      "ResourceName": "q_ecs_xpec_postpay_c",
      "PlanTaskStatus": {
        "key": 1
      },
      "StartTime": "2024-07-08 10:12:42",
      "EndTime": "2024-07-08 10:22:42",
      "ResourceGroupId": "rg-aek5behqmwbfhuy",
      "Tags": [
        {
          "TagKey": "owner",
          "TagValue": "test"
        }
      ],
      "ResourceId": 189
    }
  ],
  "RequestId": "FA9F1DE7-103B-5C18-AE9E-EB2BFF11C685",
  "TotalCount": 0,
  "AccessDeniedDetail": "{}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.