DescribeMetadata - Alibaba Cloud Service Mesh - Alibaba Cloud Documentation Center

Queries basic information about a Service Mesh (ASM) instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
servicemesh:DescribeMetadata	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example

The current API does not require request parameters

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F93DDAD7-6E04-5AC3-86F4-852708******
MetaData	object	The ASM metadata, including the basic information about ASM.
VersionCrds	array<object>	The custom resource definitions (CRDs) of all ASM versions.
VersionCrds	object	The CRD of a version.	{"1.5":[{"kind":"DestinationRule","api_group":"networking.istio.io","id":"2","api_version":"networking.istio.io/v1alpha3"}]}
Versions	array	The list of ASM versions.
Version	string	The information about a version.	v1.14.3.87-g96cf7305-aliyun
Regions	array	The regions where ASM instances can be created.
Region	string	A region.	cn-hangzhou
CurrentVersion	string	The current version.	v1.14.3.87-g96cf7305-aliyun
VersionRegistry	array<object>	The Istio versions corresponding to the ASM versions.
VersionRegistry	object	The Istio version corresponding to an ASM version.	{"v1.14.3.87-g96cf7305-aliyun": "1.14.3"}
ProEdition	object	The version information about ASM of a commercial edition.
Versions	array	The list of ASM versions.
Version	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 versions corresponding to the ASM versions.
VersionRegistry	object	The Istio version corresponding to an ASM version.	{"v1.14.3.87-g96cf7305-aliyun": "1.14.3"}
VersionCrds	array<object>	The CRDs of all ASM versions.
VersionCrds	object	The CRD of a version.	{"1.5":[{"kind":"DestinationRule","api_group":"networking.istio.io","id":"2","api_version":"networking.istio.io/v1alpha3"}]}
CompatibilityInfoList	array<object>	The Kubernetes versions compatible with ASM.
CompatibilityInfoList	object	The Kubernetes version compatible with ASM.	{ "k8s_version": { "MaxMajor": 1, "MaxMinor": 24, "MinMajor": 1, "MinMinor": 16 }, "asm_version": { "Major": 1, "Minor": 5 } }

Examples

Sample success responses

JSONformat

{
  "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": [
        ""
      ],
      "security": [
        ""
      ],
      "observability": [
        ""
      ],
      "other": [
        ""
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-18	The response structure of the API has changed	View Change Details
2024-05-11	The response structure of the API has changed	View Change Details