# Alibaba Cloud API Gateway API

> Alibaba Cloud API Gateway API on Apizie: 220 endpoints (Unpublishes a specified API from a specified runtime environment, This feature provides instance-level access control capabilities for dedicated instances. Adds an IP address…, Adds a policy to an existing ACL, Adds a custom special policy to a specified throttling policy, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:aliyun-cloudapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-cloudapi`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/cloudapi
- Page: https://apizie.tech/api/cloud/aliyun-cloudapi
- OpenAPI: https://apizie.tech/api/cloud/aliyun-cloudapi/openapi.json

Alibaba Cloud OpenAPI for API Gateway (cloudapi, version 2016-07-14). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Unpublishes a specified API from a specified runtime environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/abolish-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The ID of the API group |
| ApiId | string | yes | The ID of the specified API |
| StageName | string | yes | The name of the runtime environment. Valid values: RELEASE TEST |

### This feature provides instance-level access control capabilities for dedicated instances. Adds an IP address…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/add-access-control-list-entry` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AclId | string | yes | The ID of the access control list (ACL) |
| AclEntrys | string | no | The ACL settings. entry: the entries that you want to add to the ACL. You can add CIDR blocks. Separate multiple CIDR blocks with commas… |

### Adds a policy to an existing ACL
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/add-ip-control-policy-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| IpControlId | string | yes | The ID of the ACL. The ID is unique |
| AppId | string | no | The restriction policy on app IDs for a specific policy. You can restrict app IDs only for whitelists. The IpControlType values of… |
| CidrIp | string | yes | The IP addresses or CIDR blocks involved in the policy. Separate multiple IP addresses or CIDR blocks with semicolons (;). You can specify… |

### Adds a custom special policy to a specified throttling policy
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/add-traffic-special-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| TrafficControlId | string | yes | The ID of the specified throttling policy |
| SpecialType | string | yes | The type of the special throttling policy. Valid values: APP USER |
| SpecialKey | string | yes | The ID of the app or Alibaba Cloud account. Specify this parameter based on the value of the SpecialType parameter. You can view your… |
| TrafficValue | integer | yes | The special throttling value |

### Associates internal domain name resolution with a dedicated instance
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/associate-instance-with-private-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| IntranetDomains | string | yes | The list of internal domain names to be associated with internal domain name resolution (JSON-encoded) |

### Attaches an API to a specified API product. If the specified API product does not exist, automatic creation…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/attach-api-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ApiProductId | string | yes | The ID of the API product |
| Apis | string | yes | The list of APIs (JSON-encoded) |

### Attach plugin to API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/attach-group-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| PluginId | string | yes | The ID of the plug-in to be bound |
| GroupId | string | yes | The ID of the API group |
| StageName | string | yes | The environment in which the API is requested. Valid values: RELEASE: the production environment PRE: the pre-release environment TEST:… |

### Binds a plug-in to an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/attach-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| PluginId | string | yes | The ID of the plug-in to be bound |
| GroupId | string | no | The ID of the API group that contains the API to which the plug-in is to be bound |
| ApiIds | string | no | The number of the API to be operated. Separate multiple numbers with commas (,). A maximum of 100 numbers can be entered |
| StageName | string | yes | The name of the runtime environment. Valid values: RELEASE PRE: the pre-release environment TEST |
| ApiId | string | no | The number of the API to be bound |

### Unpublishes multiple published APIs at a time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/batch-abolish-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| Api | string | yes | The APIs that you want to operate (JSON-encoded) |

### Publishes multiple APIs at a time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/batch-deploy-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StageName | string | yes | The name of the runtime environment. Valid values: RELEASE TEST PRE: the pre-release environment |
| Description | string | yes | The description |
| Api | string | no | The APIs that you want to publish (JSON-encoded) |

### This feature provides instance-level access control capabilities for dedicated instances. Creates an Access…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-access-control-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AclName | string | yes | The name of the ACL. The name must be 1 to 30 characters in length, and can contain letters, digits, periods (.), hyphens (-), forward… |
| AddressIPVersion | string | no | The IP protocol version of the ACL. Valid values: IPv4 IPv6 |

### Creates an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the group |
| ApiName | string | yes | The name of the API. The name must be unique within the group. The name can contain letters, digits, underscores (_), and Chinese… |
| Visibility | string | yes | Specifies whether the API is public. Valid values: PUBLIC: public. If you select this value, the online environment definition of the API… |
| Description | string | no | The description of the API. The description can be up to 180 characters in length |
| AuthType | string | no | The security authentication type of the API. Valid values: APP: Only authorized applications can call the API. ANONYMOUS: Anonymous calls… |
| RequestConfig | string | yes | The configurations of API requests sent by consumers to API Gateway. For more information, see… |
| ServiceConfig | string | yes | The configurations of API requests sent by API Gateway to the backend service. For more information, see… |
| RequestParameters | string | no | The descriptions of the parameters in API requests sent by consumers to API Gateway. For more information, see… |
| SystemParameters | string | no | The system parameters sent by API Gateway to the backend service |
| ConstantParameters | string | no | The constant parameters sent by API Gateway to the backend service |
| ServiceParameters | string | no | The descriptions of the parameters in API requests sent by API Gateway to the backend service. For more information, see… |
| ServiceParametersMap | string | no | The mappings between the parameters in requests sent by consumers to API Gateway and the parameters in requests sent by API Gateway to the… |
| ResultType | string | no | The format of the response returned by the backend service. Valid values: JSON, TEXT, BINARY, XML, and HTML. Default value: JSON |
| ResultSample | string | no | The sample success response returned by the backend service. This value is used only to generate documentation and does not affect the… |
| FailResultSample | string | no | The sample error response returned by the backend service. This value is used only to generate documentation and does not affect the… |
| ErrorCodeSamples | string | no | The sample error codes returned by the backend service. For more information, see https://help.aliyun.com/document_detail/44392.html |
| ResultDescriptions | string | no | The description of the API response |
| OpenIdConnectConfig | string | no | The status of the IP access control feature. Valid values: on: enabled. off: disabled |
| AllowSignatureMethod | string | no | The signature algorithm. This parameter is required when AuthType is set to APP. Valid values: HmacSHA256 HmacSHA1,HmacSHA256 Default… |
| WebSocketApiType | string | no | The type of the bidirectional communication API. Valid values: COMMON: common API. REGISTER: registration API. UNREGISTER: unregistration… |
| ResultBodyModel | string | no | The response body model of the API |
| ForceNonceCheck | string | no | If ForceNonceCheck is set to true, API Gateway forcibly checks the X-Ca-Nonce parameter in requests. This parameter is a unique identifier… |
| DisableInternet | string | no | If DisableInternet is set to true, the API can be called only over the internal network. If DisableInternet is set to false, the API can… |
| AppCodeAuthType | string | no | The AppCode authentication type. This parameter is valid when AuthType is set to APP. Valid values: DEFAULT: The default value, which… |
| BackendId | string | no | The ID of the backend service |
| BackendEnable | string | no | Specifies whether to enable the backend service |
| Tag | string | no | The tags of the object to which the rule applies. You can specify multiple tags (JSON-encoded) |

### Create an API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-api-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The group name. It must be unique and can contain only letters, digits, underscores, and Chinese characters. It must start with a letter… |
| BasePath | string | no | The root path for APIs in this group |
| Description | string | no | A description of the API group. It can be up to 180 characters long |
| InstanceId | string | no | The ID of the instance |
| Tag | string | no | The object tags to which the rule applies. You can specify multiple tags (JSON-encoded) |

### Adds a variable to an environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-api-stage-variable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group |
| StageId | string | yes | The ID of the runtime environment |
| VariableName | string | yes | The name of the variable to be added. This parameter is case-sensitive |
| SupportRoute | string | no | Specifies whether routing is supported |
| VariableValue | string | no | The value of the variable |
| StageRouteModel | string | no | The routing model of the environment |

### Creates an API Gateway application
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppName | string | yes | The name of the application. The name can contain Chinese characters, letters, digits, and underscores (_). It must start with a letter or… |
| Description | string | no | The description of the application. The description can be up to 180 characters in length |
| Tag | string | no | The tags of the object to which the rule applies. You can specify multiple tags (JSON-encoded) |
| AppKey | string | no | The AppKey of the application, which is used when calling APIs |
| AppSecret | string | no | The AppSecret of the application |
| AppCode | string | no | The AppCode of the application |
| Extend | string | no | The extended information |

### Adds an AppCode to an application
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-app-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | string | yes | The ID of the application |
| AppCode | string | no | The AppCode of the application |

### Adds an AppKey and an AppSecret to an application
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-app-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | string | yes | The ID of the application |
| AppKey | string | no | The AppKey of the application |
| AppSecret | string | no | The AppSecret of the application |

### Creates a backend service in API Gateway
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-backend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| BackendName | string | yes | The backend service name |
| BackendType | string | yes | The type of the backend service. Valid values: `HTTP`, `VPC`, `FC_EVENT`, `FC_EVENT_V3`, `FC_HTTP`, `FC_HTTP_V3`, `OSS`, and `MOCK` |
| Description | string | no | The description |
| CreateEventBridgeServiceLinkedRole | string | no | Specifies whether to create a service-linked role for EventBridge |
| CreateSlr | string | no | Specifies whether to create a service-linked role |
| Tag | string | no | The tags of the objects to which the rule applies. You can specify multiple tags (JSON-encoded) |

### Creates a backend service configuration for an environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-backend-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| BackendId | string | no | Backend ID |
| BackendType | string | no | Backend type |
| StageName | string | no | Specify the environment where you want to manage the API. RELEASE: Production PRE: Pre-release TEST: Test |
| BackendModelData | string | no | Backend model data |
| Description | string | no | Backend model description |

### Creates a custom dataset
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| DatasetName | string | yes | The name of the dataset |
| DatasetType | string | yes | The type of the dataset. Valid values: JWT_BLOCKING: JWT blacklist. IP_WHITELIST_CIDR: IP whitelist. PARAMETER_ACCESS: Parameter access… |
| Description | string | no | The Description |
| Tag | string | no | Specifies the object tags to which the rule applies. You can specify multiple tags (JSON-encoded) |

### Creates a data entry for a custom dataset
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-dataset-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID |
| Value | string | yes | The data value. Specify a value of the corresponding data type based on the dataset type |
| ExpiredTime | string | no | The expiration time of the data entry. The format is yyyy-MM-ddTHH:mm:ssZ (UTC time). If this parameter is left empty, the data entry… |
| Description | string | no | The description. The description cannot exceed 180 characters in length |

### Creates an API Gateway instance
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ChargeType | string | yes | The billing method |
| InstanceName | string | yes | The instance name |
| InstanceSpec | string | yes | The instance specifications |
| ZoneId | string | no | The zone ID. This parameter is required for traditional dedicated instances and optional for VPC-integrated dedicated instances |
| HttpsPolicy | string | no | The HTTPS policy |
| Duration | integer | no | The subscription duration of the instance. Valid values: If PricingCycle is set to Month, the value ranges from 1 to 9. If PricingCycle is… |
| PricingCycle | string | no | The billing cycle of the subscription instance. Valid values: year: year month: month This parameter is required when ChargeType is set to… |
| AutoPay | string | no | Specifies whether to enable automatic payment for renewals. Valid values: True: Automatic payment is enabled. Make sure that your account… |
| Token | string | yes | The client token that is used to ensure the idempotence of the request. Do not reuse the token. If the token string contains leading or… |
| Tag | string | no | The list of tags (JSON-encoded) |
| InstanceType | string | no | The type of the dedicated instance. Valid values: vpc_connect: VPC-integrated dedicated instance. normal: traditional dedicated instance.… |
| InstanceCidr | string | no | The CIDR block of the instance. This parameter is required when the dedicated instance type is VPC-integrated. Valid values:… |
| UserVpcId | string | no | The ID of the user VPC to be connected. This parameter is required when the dedicated instance type is VPC-integrated. This parameter is… |
| ZoneVSwitchSecurityGroup | string | no | The zone, vSwitch, and security group information required for network connectivity. This parameter is required when the dedicated… |

### Creates an IP access control policy in a region
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-ip-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| IpControlName | string | yes | The name of the IP access control policy. The name must be 4 to 50 characters in length and can contain uppercase and lowercase letters,… |
| IpControlType | string | yes | The type of the IP access control policy. Valid values: ALLOW: The IP access control policy is a whitelist. REFUSE: The IP access control… |
| Description | string | no | The description of the IP access control policy. The description can be up to 200 characters in length |
| IpControlPolicys | string | no | The array of IP control policies, which contains the information items of the policies (JSON-encoded) |

### Creates a Simple Log Service configuration for an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| SlsProject | string | yes | The name of the Log Service project |
| SlsLogStore | string | yes | slslogstore |
| LogType | string | no | The log type. Valid values: PROVIDER |
| CreateSlr | string | no | Specifies to create a service-linked role |

### Creates a model for an API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ModelName | string | yes | The name of the model. The name must be unique within the group |
| GroupId | string | yes | The ID of the API group to which the model belongs |
| Schema | string | yes | The definition of the model in JSON Schema |
| Description | string | no | The description of the model definition |
| Tag | string | no | The object tags that match the lifecycle rule. You can specify multiple tags (JSON-encoded) |

### Enables CloudMonitor alerts for a specified API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-monitor-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the group to query |
| RawMonitorGroupId | integer | no | The ID of the monitoring group |
| Auth | string | yes | The authentication status of the API. Valid values: ok: The authentication is successful. mismatch: The request is redirected.… |

### Creates an API Gateway plug-in
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| PluginName | string | yes | The name of the plug-in. The name must be 4 to 50 characters in length and can contain uppercase and lowercase letters, Chinese… |
| PluginType | string | yes | The type of the plug-in. Valid values: ipControl: IP access control trafficControl: throttling backendSignature: backend signature… |
| PluginData | string | yes | The plug-in definition statement. JSON and YAML formats are supported |
| Description | string | no | The description of the plug-in. The description can be up to 200 characters in length |
| Tag | string | no | The tags of the objects to which the rule applies. You can specify multiple tags (JSON-encoded) |

### Creates internal domain name resolution and adds DNS records
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-private-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| IntranetDomain | string | yes | The internal domain name |
| Type | string | yes | The type of internal domain name resolution. Valid values: VPC: Authorizes resolution for a VPC. Only traditional dedicated instances can… |
| Records | string | no | The list of DNS records. This parameter can be configured only when Type is set to A (JSON-encoded) |

### Creates a backend signature key
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-signature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| SignatureName | string | yes | The display name of the key. The name must be 4 to 50 characters in length and can contain Chinese characters, letters, digits, and… |
| SignatureKey | string | yes | The key value of the signature key. The value must be 6 to 20 characters in length and can contain letters, digits, and underscores. It… |
| SignatureSecret | string | yes | The secret value of the signature key. The value must be 6 to 30 characters in length and can contain letters, digits, underscores, and… |

### Creates an environment model
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-stage-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StageAlias | string | yes | The environment alias |
| StageName | string | yes | The environment name |
| Description | string | no | The environment description |

### Creates a custom throttling policy
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/create-traffic-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| TrafficControlName | string | yes | The name of the throttling policy. The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). It… |
| TrafficControlUnit | string | yes | The unit to be used in the throttling policy. Valid values: SECOND MINUTE HOUR DAY |
| ApiDefault | integer | yes | The default throttling value for each API |
| UserDefault | integer | no | The default throttling value for each user |
| AppDefault | integer | no | The default throttling value for each app |
| Description | string | no | The description of the throttling policy |

### This feature provides instance-level access control capabilities for dedicated instances. Deletes an access…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-access-control-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AclId | string | yes | The ID of the access control policy |

### Deletes all custom special policies of a specified throttling policy
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-all-traffic-special-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| TrafficControlId | string | yes | The ID of the throttling policy |

### Deletes a specified API definition
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The group ID |
| ApiId | string | yes | The API ID |

### Deletes an API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-api-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group. This ID is generated by the system and globally unique |
| Tag | string | no | The object tags that match the lifecycle rule. You can specify multiple tags (JSON-encoded) |

### Deletes an API product. Deleting an API product causes the association between APIs and the deleted API…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-api-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ApiProductId | string | yes | The ID of the API product |

### Deletes a specified variable in a specified environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-api-stage-variable` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group |
| StageId | string | yes | The ID of the environment |
| VariableName | string | yes | The name of the variable to be deleted. This parameter is case-sensitive |

### Deletes a specified app
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | yes | The ID of the application |
| Tag | string | no | The tags. Up to 20 tags are allowed (JSON-encoded) |

### Deletes the AppCode of an application
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-app-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | string | yes | The application ID |
| AppCode | string | yes | The application AppCode |

### Deletes the AppKey and AppSecret of an application
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-app-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | string | yes | The application ID |
| AppKey | string | yes | The AppKey of the application. The AppKey is used for calling an API |

### Deletes a backend service
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-backend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| BackendId | string | no | The ID of the backend service |

### Deletes the definition of a backend service in an environment. After the definition is deleted, the API that…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-backend-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| BackendModelId | string | yes | The ID of the backend model |
| BackendId | string | no | The ID of the backend service |
| StageName | string | no | The name of the runtime environment. Valid values: RELEASE PRE TEST |

### Deletes a custom dataset
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-dataset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset |

### Deletes a data entry from a custom dataset
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-dataset-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset |
| DatasetItemId | string | yes | The ID of the data entry |

### Unbinds a custom domain name from an API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group to which the domain name to be unbound is bound. This ID is generated by the system and globally unique |
| DomainName | string | yes | The custom domain name |

### Deletes the SSL certificate of a specified domain name. This operation is intended for API providers. If the…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-domain-certificate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group. This ID is generated by the system and globally unique |
| DomainName | string | yes | The custom domain name |
| CertificateId | string | yes | The ID of the SSL certificate that you want to delete. The ID is automatically generated by the system and globally unique |

### Deletes an API Gateway instance. You can use this operation only to delete pay-as-you-go instances. To…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| Tag | string | no | The object tags that apply to the rule. You can specify multiple tags (JSON-encoded) |

### Deletes an access control list (ACL)
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-ip-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| IpControlId | string | yes | The ID of the ACL. The ID is unique |

### Deletes a log configuration
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| LogType | string | no | The log type. Valid values: log and survey |

### Deletes a model
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ModelName | string | yes | The name of the model |
| GroupId | string | yes | The ID of the API group to which the model belongs |

### Deletes a CloudMonitor application group corresponding to an API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-monitor-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group. This ID is generated by the system and globally unique |
| RawMonitorGroupId | integer | no | The ID of the monitoring group |

### Deletes a plug-in
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| PluginId | string | yes | The ID of the plug-in to be deleted |
| Tag | string | no | The tag of objects that match the rule. You can specify multiple tags (JSON-encoded) |

### Deletes an internal domain name resolution
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-private-dns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| IntranetDomain | string | yes | The internal domain name |
| Type | string | yes | The internal domain name resolution type. Valid values: VPC: resolution for virtual private cloud (VPC) access authorizations. A… |
| Force | string | no | Specifies whether to force delete the resolution. true: force deletes the resolution if the resolution is associated with an instance.… |

### Deletes a backend signature key
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-signature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| SignatureId | string | yes | The ID of the key to be deleted |

### Deletes a stage model
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-stage-model` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StageModelId | string | yes | The ID of the stage configuration |

### Deletes a custom throttling policy and the special throttling rules in the policy
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-traffic-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| TrafficControlId | string | yes | The ID of the throttling policy |

### Deletes a custom special throttling policy
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/delete-traffic-special-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| TrafficControlId | string | yes | The ID of the throttling policy |
| SpecialType | string | yes | The type of the special throttling policy. Valid values: APP USER |
| SpecialKey | string | yes | The ID of the app or Alibaba Cloud account. You can view your account ID on the Account Management… |

### Publishes an API to a specified environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/deploy-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The ID of the API group |
| ApiId | string | yes | The ID of the API |
| StageName | string | yes | The name of the runtime environment. Valid values: RELEASE PRE: the pre-release environment TEST |
| Description | string | yes | The publishing remarks |

### Queries the progress of an API unpublishing task
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-abolish-api-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| OperationUid | string | yes | The ID of the unpublishing operation |

### This feature provides instance-level access control for dedicated instances. Queries an access control policy
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-access-control-list-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AclId | string | no | The ID of the access control policy |

### This feature provides instance-level access control for dedicated instances. Queries access control policies
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-access-control-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AclName | string | no | The name of the access control policy |
| PageSize | integer | no | The number of entries to return on each page |
| PageNumber | integer | no | The page number of the current page |
| AddressIPVersion | string | no | IP Version,You can set it to ipv4 or ipv6 |

### Queries the definition of a specified API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | ID of the group that contains the API |
| ApiId | string | yes | ID of the API |

### Queries the documentation of an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-doc` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The ID of the API group |
| StageName | string | no | The environment name. Valid values: RELEASE TEST If this parameter is not specified, the default value RELEASE is used |
| ApiId | string | yes | The ID of the API |

### Queries a specified API group, including its system-generated second-level domain name, custom domain names,…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group. This ID is generated by the system and is globally unique |
| Tag | string | no | The object tags. You can specify multiple tags (JSON-encoded) |

### Queries the VPC whitelist that is allowed to access an API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-group-vpc-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group |

### Queries existing API groups and their basic information
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The ID of the API group. This ID is generated by the system and globally unique |
| GroupName | string | no | The keyword that can be specified in the name of the API group |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 50. Default value: 10 |
| EnableTagAuth | string | no | Specifies whether to enable tag verification |
| InstanceId | string | no | The ID of the instance |
| Sort | string | no | The order. Valid values: asc and desc. Default value: desc. asc: The API groups are displayed in ascending order of modification time.… |
| Tag | string | no | The list of tags (JSON-encoded) |
| BasePath | string | no | The root path of the API |

### Queries the historical versions of a specified API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-histories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group |
| StageName | string | no | The name of the runtime environment. Valid values: RELEASE TEST |
| ApiId | string | no | The ID of the API |
| ApiName | string | no | The name of the API. The name is used for fuzzy match |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |

### Queries a specified historical version of a specified API definition
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The ID of the API group. This ID is generated by the system and globally unique |
| ApiId | string | yes | The ID of the API |
| StageName | string | yes | The name of the runtime environment. Valid values: RELEASE TEST: the test environment PRE: the pre-release environment |
| HistoryVersion | string | yes | Specifies the version number that you want to query |

### Queries the access control lists (ACLs) that are bound to all the APIs in an API group in a specified…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-ip-controls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StageName | string | yes | The runtime environment. Valid values: RELEASE TEST |
| GroupId | string | yes | The ID of the API group |
| ApiIds | string | no | The IDs of APIs. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |

### Queries the response time statistics of an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-latency-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ApiId | string | yes | The ID of the API |
| GroupId | string | no | The ID of the API group |
| StartTime | string | yes | The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | no | The environment. Valid values: RELEASE PRE: the pre-release environment TEST |

### Queries the Alibaba Cloud Marketplace attributes of an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-market-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group |
| ApiId | string | yes | The ID of the API |

### Queries the attached APIs of an API product
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-product-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ApiProductId | string | yes | The ID of the API product |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |

### Queries API products by application
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-products-by-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | yes | The application ID |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Default value: 10 |

### Queries the QPS statistics of an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-qps-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ApiId | string | yes | The ID of the API |
| GroupId | string | no | The ID of the API group |
| StartTime | string | yes | The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | no | The environment. Valid values: RELEASE PRE: the pre-release environment TEST |

### Queries the backend signature keys that are bound to the APIs of a specified API group in a specified…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-signatures` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StageName | string | yes | The runtime environment. Valid values: RELEASE TEST |
| GroupId | string | yes | The ID of the API group |
| ApiIds | string | no | The IDs of the APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |

### Queries the throttling policies bound to all members of an API group in a specified environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-traffic-controls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StageName | string | yes | The runtime environment of the API. Valid values: RELEASE TEST: the test environment |
| GroupId | string | yes | The ID of the API group that you want to query |
| ApiIds | string | no | The IDs of APIs that you want to query. Separate multiple API IDs with commas (,). A maximum of 100 API IDs can be entered |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |

### Queries the statistics on the traffic of an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-api-traffic-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ApiId | string | yes | The ID of the API |
| GroupId | string | no | The ID of the API group |
| StartTime | string | yes | The start time in UTC. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time in UTC. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | no | The environment. Valid values: RELEASE TEST: the test environment PRE: the pre-release environment |

### Queries a list of APIs that are being defined
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The API group ID |
| ApiId | string | no | The API ID |
| ApiName | string | no | The API name. The name is used for fuzzy match |
| CatalogId | string | no | The category ID |
| Visibility | string | no | Specifies whether the API is public. Valid values: PUBLIC: The API is public. If you publish the definition of a public API to the… |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| EnableTagAuth | string | no | Specifies whether to enable tag verification |
| Tag | string | no | The tags of objects that match the rule (JSON-encoded) |
| ApiPath | string | no | The request path of the API |
| ApiMethod | string | no | The HTTP method of the API request |
| UnDeployed | string | no | Specifies whether to filter unpublished APIs |
| StageName | string | no | The environment in which you want to perform this operation. Valid values: RELEASE: the production environment PRE: the staging… |

### Queries the APIs with which an application is associated
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apis-by-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | yes | The application ID |
| PageNumber | integer | no | The number of the current page |
| PageSize | integer | no | The number of entries per page |
| ApiUid | string | no | The API ID |
| ApiName | string | no | The name of the API. The name is used for fuzzy match |
| Path | string | no | The request path of the API |
| Method | string | no | The request HTTP method of the API |
| Description | string | no | The description of the API |

### Queries APIs in the draft or published state that are created by using a specified backend service
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apis-by-backend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| BackendId | string | yes | The ID of the backend service |
| StageName | string | no | The environment to which the API is published. Valid values: RELEASE PRE TEST If you do not specify this parameter, APIs in the draft… |
| PageSize | integer | no | The number of entries to return on each page |
| PageNumber | integer | no | The number of the current page |

### Queries the APIs that are bound to an access control list (ACL)
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apis-by-ip-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| IpControlId | string | yes | The ID of the ACL |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |

### Queries the APIs to which a specified backend signature key is bound
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apis-by-signature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| SignatureId | string | yes | The ID of the signature key |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |

### Queries the APIs to which a specified throttling policy is bound
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apis-by-traffic-control` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| TrafficControlId | string | yes | The ID of the throttling policy that you want to query |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |

### Queries the APIs that are associated with a virtual private cloud (VPC) access authorization in a region
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apis-by-vpc-access` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| VpcName | string | no | The name of the VPC access authorization |
| PageSize | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 10 |
| PageNumber | integer | no | The page number. Pages start from page 1. Default value: 1 |

### Queries APIs by application and returns the result by environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apis-with-stage-name-integrated-by-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | yes | The application ID |
| PageNumber | integer | no | The page number of the page to return |
| PageSize | integer | no | The number of entries per page |
| ApiUid | string | no | The API ID |
| ApiName | string | no | The API name |
| Path | string | no | The request path of the API |
| Method | string | no | The request HTTP method of the API |
| Description | string | no | The API description. The description can be up to 200 characters in length |

### This operation queries the list of Apps available for authorization and fetches App information for…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-app` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | no | The App ID. The system generates this globally unique ID |

### Query the list of applications and their basic information
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-app-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | no | The ID of the application |
| AppName | string | no | The name of the application |
| PageNumber | integer | no | Specify the page number to query. The default value is 1, and the starting value is 1 |
| PageSize | integer | no | Specify the number of rows per page for paged query. The maximum value is 100, and the default value is 10 |
| AppCode | string | no | The AppCode encoding of the application |
| AppKey | string | no | The application key, used when calling APIs |
| Sort | string | no | Sort order. The default value is desc. Options are asc and desc. asc: Sort by modification time in ascending order. desc: Sort by… |
| EnableTagAuth | string | no | Enable tag validation |
| Tag | string | no | Specify object tags that apply to the rule. You can set multiple tags (JSON-encoded) |
| Extend | string | no | Extension information |

### Queries the key-related information of an application
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-app-securities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | yes | The application ID |

### This key is used for authentication when an API call is made
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-app-security` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | yes | The ID of the app |
| Tag | string | no | The tag of objects that match the rule. You can specify multiple tags (JSON-encoded) |

### Queries the apps of a user. App information is returned only to the app owner
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | no | The ID of the app |
| AppOwner | integer | no | The Alibaba Cloud account of the app owner. For more information, see Account Management… |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |

### Queries authorized applications by API product
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-apps-by-api-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| ApiProductId | string | yes | The ID of the API product |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Maximum value: 100. Default value: 10 |
| AppName | string | no | The application name |

### Queries the authorized APIs of a specified APP
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-authorized-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| AppId | integer | yes | The application ID, which is generated by the system and globally unique |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |

### Queries the current apps
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-authorized-apps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The ID of the API group. This ID is generated by the system and globally unique |
| StageName | string | no | The environment. Valid values: RELEASE: the production environment PRE: the staging environment TEST: the test environment |
| ApiId | string | yes | The ID of the API. This ID is generated by the system and globally unique |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |
| AppId | integer | no | The ID of the app |
| AppName | string | no | The name of the app |
| AppOwnerId | integer | no | The Alibaba Cloud account of the app owner |

### Query backend service information and the backend addresses configured in each environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-backend-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| BackendId | string | no | Backend service ID |

### Queries backend services. You can filter backend services by backend service name and backend service type
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-backend-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| BackendName | string | no | The name of the backend service. You can use * to perform fuzzy queries |
| BackendType | string | no | The type of the backend service |
| PageNumber | integer | no | The number of the current page |
| PageSize | integer | no | The number of entries to return on each page |
| Tag | string | no | The list of the tag (JSON-encoded) |

### Queries the details of a single dataset
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-dataset-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The dataset ID |

### Queries a data entry in a custom dataset
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-dataset-item-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset |
| DatasetItemId | string | no | The ID of the data entry |
| Value | string | no | The value of the data entry |

### Queries the data entries of a custom dataset
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-dataset-item-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| DatasetId | string | yes | The ID of the dataset |
| DatasetItemIds | string | no | The ID of the data entry. You can enter multiple IDs. Separate them with commas (,) |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Default value: 10 |

### Retrieves the list of custom datasets
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-dataset-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| DatasetIds | string | no | Dataset IDs. You can specify multiple dataset IDs separated by commas (,) |
| DatasetName | string | no | Plugin dataset name |
| PageNumber | integer | no | The page number to query. Default is 1. Page numbering starts from 1 |
| PageSize | integer | no | Number of entries per page. Default is 10 |
| Tag | string | no | Object tags that the rule applies to. You can specify multiple tags (JSON-encoded) |

### Queries the progress of an asynchronous API publishing task
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-deploy-api-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| OperationUid | string | yes | The task ID |

### Queries the definition of an API that takes effect in an environment. The definition may differ from the…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-deployed-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The ID of the API group. This ID is generated by the system and globally unique |
| ApiId | string | yes | The ID of the API |
| StageName | string | yes | The name of the runtime environment. Valid values: RELEASE PRE: the pre-release environment TEST |

### Queries the APIs that have been published to a specified environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-deployed-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | no | The ID of the API group |
| StageName | string | no | The name of the runtime environment. Valid values: RELEASE TEST |
| ApiId | string | no | The ID of the API |
| ApiName | string | no | The name of the API. The name is used for fuzzy match |
| PageNumber | integer | no | The number of the page to return. Pages start from page 1. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page. Maximum value: 100. Default value: 10 |
| EnableTagAuth | string | no | Specifies whether to enable tag verification |
| Tag | string | no | The tags (JSON-encoded) |
| ApiPath | string | no | The request path of the API |
| ApiMethod | string | no | The HTTP method of the API request |

### Queries details about a bound custom domain name, including the automatically assigned second-level domain…
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group. This ID is generated by the system and globally unique |
| DomainName | string | yes | The custom domain name |

### Queries the average latency of an API group in an environment
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-group-latency` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time of the time range to query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time of the time range to query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | yes | The environment in which you want to perform the query. Valid values: RELEASE: the production environment PRE: the staging environment… |
| GroupId | string | yes | The ID of the API group |

### Queries the statistics on the number of requests directed to an API group within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-group-qps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | yes | The environment to which the API group is published. Valid values: RELEASE: the production environment PRE: the staging environment TEST:… |
| GroupId | string | yes | The API group ID |

### Queries the traffic of an API group
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-group-traffic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time for the query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time for the query. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | yes | The environment to which the APIs in the API group are published. Valid values: RELEASE: the production environment PRE: the staging… |
| GroupId | string | yes | The ID of the API group |

### Queries the historical versions of an API
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-history-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The ID of the API group |
| StageName | string | no | The name of the runtime environment. Valid values: RELEASE TEST |
| ApiId | string | no | The ID of the API |
| ApiName | string | no | The name of the API. The name is used for fuzzy match |
| PageSize | string | no | The number of entries to return on each page |
| PageNumber | string | no | The page number of the current page |

### Queries the result of an OAS API import task
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-import-oastask` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| OperationId | string | yes | The ID of the asynchronous API import task that was generated during the import operation. This ID is used to query the execution status… |

### Queries the information about a dedicated instance cluster
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-cluster-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| InstanceClusterName | string | no | The name of the dedicated instance cluster |

### Queries dedicated instance clusters
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-cluster-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| InstanceClusterName | string | no | The cluster name |
| InstanceClusterId | string | no | The cluster ID |
| PageSize | integer | no | The number of entries per page |
| PageNumber | integer | no | The page number of the page to return |

### Queries the number of lost connections to a dedicated instance within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-drop-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| InstanceId | string | yes | The ID of the dedicated instance |
| SbcName | string | yes | The statistical metric. Valid values: Maximum Minimum Average |

### Queries the number of dropped packets within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-drop-packet` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| InstanceId | string | yes | The ID of the instance |
| SbcName | string | yes | The statistical metric. Valid values: Maximum Minimum Average |

### Queries the distribution of HTTP status codes of requests to a dedicated instance within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-http-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | yes | The environment in which the API is requested. Valid values: RELEASE: the production environment PRE: the pre-release environment TEST:… |
| InstanceId | string | yes | The ID of the instance |

### Queries the average latency of a dedicated instance over a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-latency` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | yes | The environment in which the API is requested. Valid values: RELEASE: the production environment PRE: the pre-release environment TEST:… |
| InstanceId | string | yes | The ID of the instance |

### Queries the number of new connections to a dedicated instance within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-new-connections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| InstanceId | string | yes | The ID of the instance |
| SbcName | string | yes | The statistical metric. Valid values: Maximum Minimum Average |

### Queries the numbers of inbound and outbound packets of a dedicated instance within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-packets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| InstanceId | string | yes | The ID of the instance |
| SbcName | string | yes | The statistical metric. Valid values: Maximum Minimum Average |

### Queries the number of requests to a dedicated instance within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-qps` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | yes | The environment in which the API is requested. Valid values: RELEASE: the production environment PRE: the pre-release environment TEST:… |
| InstanceId | string | yes | The ID of the instance |

### Queries the number of concurrent connections to a dedicated instance within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-slb-connect` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| InstanceId | string | yes | The ID of the instance |
| SbcName | string | yes | The statistical metric. Valid values: Maximum Minimum Average |

### Queries the request traffic and response traffic of a dedicated instance within a period of time
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instance-traffic` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| StartTime | string | yes | The start time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| EndTime | string | yes | The end time. The time follows the ISO 8601 standard and UTC time is used. Format: YYYY-MM-DDThh:mm:ssZ |
| StageName | string | yes | The environment in which the API runs. Valid values: RELEASE: the production environment PRE: the pre-release environment TEST: the test… |
| InstanceId | string | yes | The ID of the instance |

### Describes the details of one or more shared or dedicated instances in a region
`POST https://apizie.tech/v1/cloud:aliyun-cloudapi/describe-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://apigateway.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID. If you do not specify this parameter, all instances are queried |
| Language | string | no | The language of the response. The descriptions of system policies are returned in this language. en: English. zh: Chinese. ja: Japanese |
| InstanceType | string | no | The InstanceType |
| EnableTagAuthorization | string | no | Indicates whether to enable tag-based authorization |
| Tag | string | no | The tags that are attached to the instance (JSON-encoded) |
| PageNumber | integer | no | The PageNumber |
| PageSize | integer | no | The PageSize |

…and 100 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:aliyun-cloudapi/abolish-api" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud API Gateway API?
Create a free Apizie key, then send POST https://apizie.tech/v1/cloud:aliyun-cloudapi/abolish-api with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud API Gateway API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud API Gateway itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud API Gateway API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-cloudapi.

### What is the status of the Alibaba Cloud API Gateway API?
Needs your own provider key (bring your own key)