Obtaining the Service List in a Mesh
Function
This API is used to obtain the service list in a mesh.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, the following identity policy-based permissions are required.
URI
GET /v3/meshes/{mesh_id}/namespaces/{namespace}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| mesh_id | Yes | String | Mesh ID |
| namespace | Yes | String | Namespace |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| items | Array of ServiceAggregation objects | Service list in a mesh |
| Parameter | Type | Description |
|---|---|---|
| service | Object | Service information. For details, see Service | Kubernetes. |
| clusters | Array of objects | Cluster information related to the service. For details, see CCE Cluster. |
| deployments | Array of objects | Workload information related to the service. For details, see Deployment | Kubernetes. |
| ASMStyled | ASMStyled object | Whether the ASM console is supported |
| entries | Array of ServiceAddress objects | Service entry information |
| release | Release object | Grayscale release task corresponding to a mesh service |
| Parameter | Type | Description |
|---|---|---|
| traffic_manage | String | Whether ASM console traffic management is supported. If the value is NotMatch, the capability is not supported. |
| security | String | Whether ASM console service security is supported. If the value is NotMatch, the capability is not supported. |
| gateway_route | String | Whether ASM console gateway routing is supported. If the value is NotMatch, the capability is not supported. |
| Parameter | Type | Description |
|---|---|---|
| host | String | Host of a mesh service |
| protocol | String | Protocol of a mesh service |
| port | String | Port of a mesh service |
| targetPort | String | Target port of a mesh service |
| accessType | String | Access type of a mesh service |
| prefix | String | Route prefix of a mesh service |
| sniHosts | Array of strings | SNI hosts of a mesh service |
| Parameter | Type | Description |
|---|---|---|
| kind | String | API type. Fixed value: Release |
| apiVersion | String | API version. Fixed value: asm/v2 |
| metadata | ReleaseMetadata object | Basic information about the grayscale release task of a mesh. Metadata is a collection of attributes. |
| spec | ReleaseSpec object | Attributes of the grayscale release task of a mesh |
| status | ReleaseStatus object | Status of the grayscale release task of a mesh |
| Parameter | Type | Description |
|---|---|---|
| meshID | String | ID of the mesh that a grayscale release task belongs to |
| name | String | Grayscale release task name Enter 4 to 64 characters. The name must start with a lowercase letter and not end with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed. |
| uid | String | ID of the grayscale release task, which is unique. The value is automatically generated after the task is created. A custom value will not take effect. |
| namespace | String | Namespace of the grayscale release task |
| Parameter | Type | Description |
|---|---|---|
| serviceName | String | Name of the service corresponding to the grayscale release task of a mesh |
| clusterID | String | ID of the cluster corresponding to the grayscale release task of a mesh |
| deploymentName | String | Name of the workload corresponding to the grayscale release task of a mesh |
| version | String | Mesh version corresponding to a grayscale release task |
| type | String | Type of the grayscale release task of a mesh |
| grayDeployments | Array of GrayWorkload objects | Grayscale workload template for the grayscale release task of a mesh |
| Parameter | Type | Description |
|---|---|---|
| clusterID | String | ID of the cluster where the grayscale workload resides |
| template | Object | Grayscale workload. For details, see Deployment | Kubernetes. |
| Parameter | Type | Description |
|---|---|---|
| phase | String | Phase of the grayscale release task of a mesh |
| startTime | String | Start time of the grayscale release task of a mesh |
| updateTime | String | Update time of the grayscale release task of a mesh |
| deployment | Object | Original workload in the grayscale release task of a mesh. For details, see Deployment | Kubernetes. |
| grayDeployments | Array of objects | Grayscale workload created in the grayscale release task of a mesh. For details, see Deployment | Kubernetes. |
Status code: 500
| Parameter | Type | Description |
|---|---|---|
| errorCode | String | Error code |
Example Requests
None
Example Responses
None
Status Codes
| Status Code | Description |
|---|---|
| 200 | The service list in the mesh is obtained. |
| 500 | Internal error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot