All Products
Search
Document Center

Cloud Enterprise Network:DescribeRouteServicesInCen

Last Updated:Jan 26, 2024

Queries the configurations of cloud services, such as the cloud service status and the ID of the associated VPC.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cen:DescribeRouteServicesInCenREAD
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Valid values: 1 to 50.

10
CenIdstringYes

The ID of the Cloud Enterprise Network (CEN) instance.

cen-pfa6ugf3xl0qsd****
HoststringNo

The service address of the cloud service.

You can enter a domain name, an IP address, or a CIDR block.

100.118.28.0/24
HostRegionIdstringNo

The region ID of the cloud service.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

cn-hangzhou
AccessRegionIdstringNo

The ID of the region where the cloud service is accessed.

cn-hangzhou
HostVpcIdstringNo

The ID of the VPC associated with the cloud service.

vpc-bp1h8vbrbcgohcju5****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

196C99CA-6997-5951-9721-AE89720DF856
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries returned.

2
RouteServiceEntriesobject []

The information about the cloud services.

Statusstring

The status of the cloud service. Valid values:

  • Creating
  • Active
  • Deleting
Active
Hoststring

The service address of the cloud service.

100.118.28.0/24
Descriptionstring

The description of the cloud service.

descname
HostVpcIdstring

The ID of the VPC associated with the cloud service.

vpc-bp1h8vbrbcgohcju5****
CenIdstring

The ID of the CEN instance.

cen-pfa6ugf3xl0qsd****
AccessRegionIdstring

The ID of the region where the cloud service is accessed.

cn-hangzhou
HostRegionIdstring

The region ID of the cloud service.

cn-hangzhou
Cidrsarray

The service addresses of the cloud service.

string

The service address of the cloud service.

  • If Host is set to an IP address or a CIDR block, the value of Cidrs is an IP address or a CIDR block.
  • If Host is set to a domain name, the value of Cidrs is the IP address to which the domain name is resolved.
100.118.28.0/24

Examples

Sample success responses

JSONformat

{
  "PageSize": 10,
  "RequestId": "196C99CA-6997-5951-9721-AE89720DF856",
  "PageNumber": 1,
  "TotalCount": 2,
  "RouteServiceEntries": {
    "RouteServiceEntry": [
      {
        "Status": "Active",
        "Host": "100.118.28.0/24",
        "Description": "descname",
        "HostVpcId": "vpc-bp1h8vbrbcgohcju5****",
        "CenId": "cen-pfa6ugf3xl0qsd****",
        "AccessRegionId": "cn-hangzhou",
        "HostRegionId": "cn-hangzhou",
        "Cidrs": {
          "Cidr": [
            "100.118.28.0/24"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

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