DescribeMetadata - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Retrieves the basic information about a Service Mesh (ASM) 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

servicemesh:DescribeMetadata

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The return value.
RequestId	string	The request ID.	F93DDAD7-6E04-5AC3-86F4-852708******
MetaData	object	The metadata of the ASM instance. This includes basic information about the ASM product.
VersionCrds	array<object>	The CustomResourceDefinition (CRD) information for each ASM version.
	object	The CRD information for the version.	{"1.5":[{"kind":"DestinationRule","api_group":"networking.istio.io","id":"2","api_version":"networking.istio.io/v1alpha3"}]}
Versions	array	A list of ASM versions.
	string	The version information.	v1.14.3.87-g96cf7305-aliyun
Regions	array	A list of regions where ASM is available.
	string	The region.	cn-hangzhou
CurrentVersion	string	The current version.	v1.14.3.87-g96cf7305-aliyun
VersionRegistry	array<object>	The Istio version that corresponds to the ASM version.
	object	The Istio version that corresponds to the ASM version.	{"v1.14.3.87-g96cf7305-aliyun": "1.14.3"}
ProEdition	object	The version information of ASM Commercial Edition.
Versions	array	A list of ASM versions.
	string	The version information.	v1.14.3.87-g96cf7305-aliyun
CurrentVersion	string	The current version.	v1.14.3.87-g96cf7305-aliyun
VersionRegistry	array<object>	The Istio version that corresponds to the ASM version.
	object	The Istio version that corresponds to the ASM version.	{"v1.14.3.87-g96cf7305-aliyun": "1.14.3"}
VersionCrds	array<object>	The CRD information for each ASM version.
	object	The CRD information for the version.	{"1.5":[{"kind":"DestinationRule","api_group":"networking.istio.io","id":"2","api_version":"networking.istio.io/v1alpha3"}]}
CompatibilityInfoList	array<object>	A list of ASM and Kubernetes (K8s) version compatibilities.
	object	The range of K8s versions that are compatible with the ASM version.	{ "k8s_version": { "MaxMajor": 1, "MaxMinor": 24, "MinMajor": 1, "MinMinor": 16 }, "asm_version": { "Major": 1, "Minor": 5 } }
PlaygroundScene	object	The data for ASM lab scenarios.
trafficManagement	array	The traffic management scenarios.
	string	The scenario ID.	ewmaLb
security	array	The security scenarios.
	string	The scenario ID.	none
observability	array	The observability scenarios.
	string	The scenario ID.	none
other	array	Other scenario categories.
	string	The scenario ID.	none

Examples

Success response

JSON format

{
  "RequestId": "F93DDAD7-6E04-5AC3-86F4-852708******",
  "MetaData": {
    "VersionCrds": [
      {
        "1.5": [
          {
            "kind": "DestinationRule",
            "api_group": "networking.istio.io",
            "id": "2",
            "api_version": "networking.istio.io/v1alpha3"
          }
        ]
      }
    ],
    "Versions": [
      "v1.14.3.87-g96cf7305-aliyun"
    ],
    "Regions": [
      "cn-hangzhou"
    ],
    "CurrentVersion": "v1.14.3.87-g96cf7305-aliyun",
    "VersionRegistry": [
      {
        "v1.14.3.87-g96cf7305-aliyun": "1.14.3"
      }
    ],
    "ProEdition": {
      "Versions": [
        "v1.14.3.87-g96cf7305-aliyun"
      ],
      "CurrentVersion": "v1.14.3.87-g96cf7305-aliyun",
      "VersionRegistry": [
        {
          "v1.14.3.87-g96cf7305-aliyun": "1.14.3"
        }
      ],
      "VersionCrds": [
        {
          "1.5": [
            {
              "kind": "DestinationRule",
              "api_group": "networking.istio.io",
              "id": "2",
              "api_version": "networking.istio.io/v1alpha3"
            }
          ]
        }
      ]
    },
    "CompatibilityInfoList": [
      {
        "k8s_version": {
          "MaxMajor": 1,
          "MaxMinor": 24,
          "MinMajor": 1,
          "MinMinor": 16
        },
        "asm_version": {
          "Major": 1,
          "Minor": 5
        }
      }
    ],
    "PlaygroundScene": {
      "trafficManagement": [
        "ewmaLb"
      ],
      "security": [
        "none"
      ],
      "observability": [
        "none"
      ],
      "other": [
        "none"
      ]
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.