DescribeCrTemplates - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

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

servicemesh:DescribeCrTemplates

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IstioVersion	string	Yes	The Istio version that the service mesh uses.	v1.18.0.160-gcc1f41cd-aliyun
Kind	string	Yes	The type of Istio resource for which you want to obtain common templates. Valid values: AuthorizationPolicy RequestAuthentication PeerAuthentication WorkloadGroup WorkloadEntry Sidecar EnvoyFilter ServiceEntry Gateway DestinationRule VirtualService	VirtualService

Response elements

Element	Type	Description	Example
	object	The returned parameters.
RequestId	string	The request ID.	74E97AE2-2900-55C1-A069-C3C1EA*****
Templates	array<object>	The common YAML templates for the specified Istio resource type.
	object	A common YAML template for the specified Istio resource type.
ChineseName	string	The Chinese name of the YAML template.	HTTP基础路由
EnglishName	string	The English name of the YAML template.	HTTP basic routing
Yaml	string	The content of the YAML template.	apiVersion: networking.istio.io/v1beta1\nkind: VirtualService\nmetadata:\n name: reviews-route # Name for this VirtualService.\nspec:\n hosts:\n - reviews.prod.svc.cluster.local # Service that this VirtualSerivce belongs to. \n http:\n - name: \"reviews-route\" # Name for the route.\n route:\n - destination: # Uniquely identifies the instances of a service to which all traffic should be forwarded to.\n host: reviews.prod.svc.cluster.local # The name of a service from the service registry or ServiceEntry.\n port:\n number: 8080"

Examples

Success response

JSON format

{
  "RequestId": "74E97AE2-2900-55C1-A069-C3C1EA*****",
  "Templates": [
    {
      "ChineseName": "HTTP基础路由",
      "EnglishName": "HTTP basic routing",
      "Yaml": "apiVersion: networking.istio.io/v1beta1\\nkind: VirtualService\\nmetadata:\\n  name: reviews-route # Name for this VirtualService.\\nspec:\\n  hosts:\\n  - reviews.prod.svc.cluster.local # Service that this VirtualSerivce belongs to. \\n  http:\\n  - name: \\\"reviews-route\\\" # Name for the route.\\n    route:\\n    - destination: # Uniquely identifies the instances of a service to which all traffic should be forwarded to.\\n        host: reviews.prod.svc.cluster.local # The name of a service from the service registry or ServiceEntry.\\n        port:\\n          number: 8080\""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	ERR404	Not found

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.