# Alibaba Cloud Cloud Native API Gateway API

> Alibaba Cloud Cloud Native API Gateway API on Apizie: 226 endpoints (Creates a gateway quota throttling rule, Authorizes a security group for gateway access to services, Adds members to a consumer group in batches, Revokes API consumer authorization rules in batches, …) 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://zieapi.vercel.app/v1/cloud:aliyun-apig/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-apig`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/apig
- Page: https://zieapi.vercel.app/api/cloud/aliyun-apig
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-apig/openapi.json

Alibaba Cloud OpenAPI for Cloud Native API Gateway (apig, version 2024-03-27). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates a gateway quota throttling rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/add-gateway-quota-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The unique identifier of the gateway |
| conflictHash | string | no | The conflict snapshot hash, used to prevent concurrent dirty overwrites during confirmation. Obtain this value from the response of a… |
| consumerGroupIds | array | no | The list of consumer group IDs to bind to the rule. Specify this parameter when subjectType is set to consumer_group. This parameter… |
| consumerIds | array | no | The list of consumer IDs to bind to the rule. A maximum of 1,000 consumers can be specified in a single request |
| dryRun | string | no | Specifies whether to perform only a dry run without applying the configuration. A dry run checks whether conflicting rules exist on the… |
| overwrite | string | no | Specifies whether to allow overwriting on conflict. If overwriting is allowed, the conflicting subjects (consumers or consumer groups) are… |
| periodMultiplier | integer | no | The period multiplier, which specifies the number of periods after which the quota resets. This parameter is required for custom period… |
| periodType | string | yes | The period type. For calendar periods, the value can be day, week, or month. For custom periods, only day is supported |
| quotaDimension | string | yes | The quota dimension or throttling type. Valid values: token and credit |
| quotaLimit | integer | yes | The total available quota per period |
| ruleName | string | yes | The name of the rule |
| subjectType | string | no | The subject type of the rule. Valid values: consumer: API consumer. This is the default value. consumer_group: API consumer group |
| timezone | string | no | The time zone for the calendar period, in UTC+x format |
| windowAlignment | string | no | The reset period alignment type. Valid values: calendar: calendar period. The period starts from the beginning of a calendar day, week, or… |

### Authorizes a security group for gateway access to services
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/add-gateway-security-group-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The ID of the cloud-native API gateway |
| description | string | no | The description of the security group rule |
| portRanges | array | no | The port ranges |
| securityGroupId | string | no | The security group ID. This parameter is required. The specified security group must be different from the security group that is… |

### Adds members to a consumer group in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/batch-add-consumer-group-consumers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerGroupId | string | yes | The consumer group ID |
| consumerIds | array | no | The list of consumer IDs to add to the consumer group |

### Revokes API consumer authorization rules in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/batch-delete-consumer-authorization-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerAuthorizationRuleIds | string | no | The list of API consumer authorization rule IDs |

### Batch exports HTTP APIs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/batch-export-http-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| apiIds | array | yes | The list of API IDs to export |
| apiType | string | yes | The API type |
| extensionConfig | object | no | The export extension configuration. When this configuration is specified for a REST API, gatewayId is required. This configuration is… |
| format | string | no | The export format. Valid values: json and yaml. Default value: yaml |
| gatewayId | string | no | The gateway instance ID. This parameter is required when extensionConfig is specified for a REST API. This parameter is required for batch… |

### Imports HTTP APIs in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/batch-import-http-apis` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| allowUpdate | string | no | Specifies whether to overwrite existing APIs. If set to true, gatewayId is required |
| apiType | string | yes | The API type |
| dryRun | string | no | Enables the dry run feature, which validates the definition without performing the actual import |
| gatewayId | string | no | The gateway instance ID. For REST APIs, this parameter is required when withGatewayExtension is set to true or allowUpdate is set to true.… |
| resourceGroupId | string | no | The resource group ID |
| specContentBase64 | string | no | The standard Base64 encoding of the raw bytes of the OAS ZIP package. The decoded size cannot exceed 10 MiB. This parameter cannot be… |
| specFileUrl | string | no | The download URL of the OAS ZIP file. The URL must support unauthenticated downloads. OSS URLs and whitelisted backend domain names are… |
| specOssConfig | object | no | The OSS configuration for the OAS file in ZIP format. At least one of specFileUrl and specOssConfig must be specified |
| strategy | string | no | The conflict merge strategy during import. Default value: ExistFirst |
| withGatewayExtension | string | no | Specifies whether to import with gateway extension configurations. This parameter must be set to true for batch import of HTTP APIs |

### Removes consumer group members in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/batch-remove-consumer-group-consumers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerGroupId | string | yes | The consumer group ID |
| consumerIds | array | no | The list of consumer IDs to remove from the consumer group |

### Updates HTTP API operations in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/batch-update-http-api-operation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| authConfig | object | no | The authentication configuration. This parameter is required when enableAuth is set to true |
| enableAuth | string | no | Specifies whether to enable consumer authentication. If set to true, a valid authConfig must be provided. If set to false, authConfig is… |
| operationIds | array | no | The list of operation IDs to update in batches. This parameter cannot be empty |
| httpApiId | string | yes | The ID of the HTTP API |

### Moves a resource to a different resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Service | string | no | The cloud service identifier. Fixed as APIG. You generally do not need to specify this parameter |
| ResourceType | string | no | The resource type. This parameter is case-sensitive and must exactly match one of the valid values |
| ResourceId | string | no | The ID of the resource to be moved. The value must match the specified ResourceType |
| ResourceGroupId | string | no | The ID of the destination resource group. You can view the ID in the Resource Management console |

### Queries the activation status of the API management service
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/check-commodity-status` (byok)

### Creates an AI model card
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-ai-model-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| availablePaths | array | no | The list of API paths supported by the model. Each entry must include both path and type |
| credit | object | no | The credit billing information of the model. Currently, only the fixed type is supported, and the cost unit is Credits per million tokens.… |
| features | object | no | The model capability switches. Keys must be model capability names supported by API Gateway, and values must be Boolean values |
| gatewayId | string | yes | The AI gateway instance ID. The target instance must exist, belong to the current account, and be of the AI gateway type |
| meta | object | no | The token limits and input/output modality information of the model |
| modelName | string | yes | The model name. The model name must be unique within the same AI gateway instance and the same model provider. The value can be up to 256… |
| modelProvider | string | yes | The model provider identifier. The value must reference a model provider that already exists in the target AI gateway instance. The value… |

### Creates an AI model provider
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-ai-model-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| displayName | string | yes | The display name of the model provider |
| gatewayId | string | yes | The gateway instance ID |
| provider | string | yes | The identifier of the model provider |
| serviceIds | array | no | The list of service IDs to bind to the provider |
| clientToken | string | no | The client token that is used to ensure the idempotence of the request |

### Creates and attaches a policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-and-attach-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attachResourceIds | array | yes | The list of target resource IDs to attach |
| attachResourceType | string | yes | The type of the target resource to attach |
| className | string | yes | The policy type |
| config | string | yes | The policy configuration content in JSON string format |
| description | string | no | The policy description |
| environmentId | string | no | The environment ID |
| gatewayId | string | no | The gateway ID |
| name | string | no | The policy name. This parameter is required when className is set to IpAccessControl, JWTAuth, OIDCAuth, or ExternalZAuth, and the name… |

### Creates a HiMarket chat session with a specified conversation type and associated products, and returns the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-chat-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | The name of the chat session |
| products | array | no | The list of API products associated with the chat session |
| talkType | string | no | The conversation type of the session. Valid values: MODEL and AGENT |

### Creates an API consumer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-consumer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| akSkIdentityConfigs | array | no | The list of AccessKey ID/AccessKey Secret identity configurations |
| apikeyIdentityConfig | object | no | The API key-based authentication identity configuration |
| description | string | no | The description of the API consumer |
| enable | string | no | Specifies whether to enable the API consumer |
| gatewayType | string | no | The gateway type. Valid values: API: an API consumer of a cloud-native API gateway. AI: an API consumer of an AI gateway |
| jwtIdentityConfig | object | no | The JWT identity configuration |
| name | string | no | The name of the API consumer |
| clientToken | string | no | The idempotency token generated by the caller as a globally unique value. We recommend that you use a UUID. The value can be up to 64… |
| dryRun | string | no | Specifies whether to perform only a dry run. If set to true, the system performs the same parameter, permission, Identity and Access… |

### Creates a consumer authorization rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-consumer-authorization-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | yes | The consumer ID |
| authorizationResourceInfos | array | no | The list of resource authorization information |
| expireMode | string | no | The expiration mode. Valid values: LongTerm: long-term ShortTerm: short-term |
| expireTimestamp | integer | no | The expiration time |
| parentResourceType | string | no | The parent resource type |
| resourceType | string | no | The resource type |

### Creates consumer authorization rules
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-consumer-authorization-rules` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| authorizationRules | array | no | The consumer authentication rules |

### Creates a consumer group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerGroupId | string | no | The consumer group ID. This field is generated by the system and does not need to be specified during creation |
| description | string | no | The consumer group description |
| gatewayType | string | no | The gateway type. Valid values: API or AI |
| name | string | no | The consumer group name |

### Registers a HiMarket developer account and returns the ID of the new developer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-developer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| password | string | no | The password of the developer account. The length must be 6 to 32 characters |
| username | string | no | The logon username of the developer. The length must not exceed 64 characters |

### Creates a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| caCertIdentifier | string | no | The CA certificate identifier. This parameter is optional for Dedicated with HTTPS. This parameter is not allowed for Serverless and is… |
| certIdentifier | string | no | The certificate identifier. This parameter is required for Dedicated with HTTPS and must pass validation. This parameter is not allowed… |
| clientCACert | string | no | The client CA certificate. This parameter is conditionally required for Dedicated with HTTPS (required when MTLSEnabled is set to true).… |
| domainScope | string | no | The domain name scope. Valid values: Dedicated (dedicated gateway domain name), Serverless (Serverless gateway domain name). Default… |
| forceHttps | string | no | Specifies whether to enable forced HTTPS redirect when the protocol type is HTTPS. This parameter is required for Serverless and for… |
| gatewayType | string | no | The gateway type. If not specified, the default value is API |
| http2Option | string | no | The HTTP/2 setting. Valid values: GlobalConfig (follows the global configuration), Open (enabled), Close (disabled). Default value:… |
| mTLSEnabled | string | no | Specifies whether to enable mTLS mutual authentication. This parameter is optional for Dedicated with HTTPS. If set to true, ClientCACert… |
| name | string | yes | The domain name. The name must be 1 to 128 characters in length, such as abc.com |
| protocol | string | no | The protocol type used by the domain name. Valid values: HTTP, HTTPS. This parameter is required for the Dedicated scope and is not… |
| resourceGroupId | string | no | The https://help.aliyun.com/document_detail/151181.html |
| tlsCipherSuitesConfig | object | no | The TLS cipher suite configuration, including the configuration type, cipher suite names, and supported TLS versions. This configuration… |
| tlsMax | string | no | The maximum TLS protocol version. This parameter is optional for Dedicated with HTTPS. If not specified, the value is derived from TlsMin.… |
| tlsMin | string | no | The minimum TLS protocol version. This parameter is optional for Dedicated with HTTPS. If not specified, the default value is TLS 1.0.… |
| clientToken | string | no | The idempotency token, a globally unique value generated by the caller (UUID recommended). The value can be up to 64 characters in length.… |
| dryRun | string | no | Specifies whether to perform only a dry run. If set to true, all synchronous validations identical to those of an actual creation are… |

### Creates a cloud-native gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| chargeType | string | no | The billing method. This parameter is required for the Serverless edition and must be set to POSTPAY |
| gatewayEdition | string | no | The gateway instance edition. Valid values: Professional: standard instance. Serverless: Serverless instance. MultiTenantServerless:… |
| gatewayMode | string | no | The running mode for AI multi-tenant V2. Default value: ENTERPRISE. This parameter can be specified only when gatewayType is set to AI and… |
| gatewayType | string | no | The gateway type. This parameter must be explicitly set to AI for AI Serverless or multi-tenant editions |
| logConfig | object | no | The gateway log configuration |
| name | string | no | The gateway name. This parameter is required for all editions |
| networkAccessConfig | object | no | The network access configuration. This parameter is required. If this parameter is not specified, the service returns an… |
| resourceGroupId | string | no | The resource group ID |
| spec | string | no | The node specifications. This parameter is required for the Serverless edition |
| tag | array | no | The list of tags |
| vpcId | string | no | The virtual private cloud (VPC) ID. This parameter is required for all editions |
| zoneConfig | object | no | The zone configuration. This parameter is required for all editions |

### Creates an HTTP API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-http-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agentProtocols | array | no | The list of protocols supported by the agent. This parameter is required when type is set to Agent. You do not need to specify this… |
| aiProtocols | array | no | The list of AI API protocols. This parameter is required when type is set to LLM, and only one protocol can be specified. This parameter… |
| authConfig | object | no | The authentication configuration. This parameter is required when enableAuth is set to true |
| basePath | string | no | The base path of the API. The path must start with a forward slash (/), cannot exceed 256 bytes in length, and cannot contain spaces. This… |
| belongGatewayId | string | no | The ID of the gateway to which the API belongs |
| deployConfigs | array | no | The list of deployment configurations for the HTTP API. This parameter is required when type is set to LLM or Ai, and only one deployment… |
| description | string | no | The description of the API |
| dryRun | string | no | Specifies whether to perform a dry run without executing the operation |
| enableAuth | string | no | Specifies whether to enable authentication. This parameter is validated when type is set to LLM, Ai, or Agent. This parameter is not… |
| firstByteTimeout | integer | no | The timeout period for waiting for the first byte from the backend |
| ingressConfig | object | no | The HTTP Ingress API configuration. This parameter is required and cannot be nil when type is set to HttpIngress. You do not need to… |
| modelCategory | string | no | The AI model category. This parameter is optional when type is set to LLM or Ai. You do not need to specify this parameter for other… |
| name | string | yes | The name of the HTTP API, which is used to identify the API resource. Example: test-api |
| protocols | array | no | The list of API access protocols |
| removeBasePathOnForward | string | no | Specifies whether to remove the base path when forwarding requests |
| resourceGroupId | string | no | The resource group ID |
| strategy | string | no | The conflict merge strategy for import |
| type | string | yes | The type of the HTTP API. Valid values: Http: standard HTTP API. Rest: RESTful API. WebSocket: WebSocket API. HttpIngress: HTTP API… |
| versionConfig | object | no | The API versioning configuration |
| clientToken | string | no | The idempotency token, which is a globally unique value generated by the caller. We recommend that you use a UUID. The token cannot exceed… |

### Creates operations for an HTTP API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-http-api-operation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the HTTP API to which the operations belong |
| operations | array | no | The list of operation definitions |

### Creates a route for an HTTP API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-http-api-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the HTTP API to which the route belongs |
| backendConfig | object | no | The backend service configuration of the route |
| deployConfigs | array | no | The API deployment configuration |
| description | string | no | The route description |
| domainIds | array | no | The domain name IDs |
| environmentId | string | no | The environment ID |
| match | object | no | The route match rules |
| mcpRouteConfig | object | no | The MCP route configuration |
| name | string | no | The route name |
| policyConfigs | array | no | The policy type |

### Creates an API version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-http-api-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the HTTP API to which the route belongs |
| versionConfig | object | no | The API versioning configuration |

### Creates a Model Context Protocol (MCP) server
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-mcp-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| assembledSources | array | no | The list of assembly sources. This parameter is required when type is set to AssemblyMCP |
| backendConfig | object | no | The backend service configuration for the route. This parameter is required. You must specify the backend service configuration, including… |
| createFromType | string | no | The creation source type. Valid values: ApiGatewayHttpToMCP: gateway-managed HTTP-to-MCP conversion. ApiGatewayProxyMcpHosting:… |
| description | string | no | The description of the MCP server |
| domainIds | array | no | The domain name IDs |
| exposedUriPath | string | no | The exposed URI path. This parameter is required when protocol is set to SSE or StreamableHTTP and type is set to RealMCP |
| gatewayId | string | yes | The gateway ID |
| grayMcpServerConfigs | array | no | The canary release route configurations |
| match | object | no | The route match rule. When type is set to RealMCP, the match parameter is required and you must specify a route match rule |
| mcpServerConfig | object | no | The HTTP-to-MCP configuration |
| mcpStatisticsEnable | string | no | Specifies whether to enable MCP observability. Default value: false |
| name | string | yes | The MCP server name. The name must match the regular expression ^[a-z0-9]([-a-z0-9][a-z0-9])?(.[a-z0-9]([-a-z0-9][a-z0-9])?)*$ and cannot… |
| protocol | string | no | The protocol type. This parameter is required. You must explicitly specify the protocol type (HTTP/HTTPS/SSE/StreamableHTTP). If this… |
| type | string | yes | The type. Valid values: RealMCP: a standard MCP service |

### Creates a migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-migration-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| clusterId | string | no | The ID of the source ACK cluster. The value must be the same as the cluster specified in the IngressInfo of the API. Note: This parameter… |
| description | string | no | The description of the task. The description is stored only when the task is created |
| environmentId | string | no | The ID of the destination environment. The value must be the same as the Ingress import environment of the API. Note: This parameter is… |
| gatewayId | string | no | The ID of the destination gateway to which traffic is migrated |
| httpApiId | string | no | The HTTP API ID. The API must have been imported as an Ingress type (HttpIngress) API. Note: This parameter is actually required. If this… |
| ingressClass | string | no | The Ingress class. If specified, the value must be the same as the API import configuration. Otherwise, an ingress class conflict error is… |
| migrationType | string | no | The migration type. [_single.params.body.props.migrationType.enum.Nginx Ingress]Nginx Ingress migration |
| watchNamespace | string | no | The watched namespace. If specified, the value must be the same as the API import configuration. Otherwise, a watchNamespace conflict… |

### Mounts a plug-in
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-plugin-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attachResourceIds | array | no | The list of mount point IDs |
| attachResourceType | string | no | The resource type to which the plug-in is mounted. Valid values: GatewayRoute, Gateway, GatewayDomain, HttpApi, and Operation |
| enable | string | no | Specifies whether to enable the plug-in. Default value: false |
| environmentId | string | no | The environment ID |
| gatewayId | string | no | The gateway instance ID |
| pluginConfig | string | no | The Base64-encoded content of the original plug-in configuration |
| pluginId | string | no | The plug-in ID |

### Creates a custom plugin class
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-plugin-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| alias | string | no | The alias of the plugin class. This parameter is required. If this parameter is not specified, the service returns an… |
| description | string | yes | The description of the plugin |
| executePriority | integer | no | The execution priority of the plugin. This parameter is required when executeStage is specified. The default value 0 is invalid. We… |
| executeStage | string | yes | The execution stage of the plugin |
| name | string | yes | The name of the plugin class |
| supportedMinGatewayVersion | string | no | The minimum gateway version that the plugin is compatible with |
| version | string | yes | The version number of the plugin |
| versionDescription | string | yes | The description of the current version |
| wasmLanguage | string | yes | The development language of the WASM plugin. Valid values: TinyGo |
| wasmUrl | string | yes | The download URL of the WASM plugin binary file |

### Creates a WebIDE workspace for a plugin
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-plugin-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayType | string | no | The gateway type. If this parameter is not specified, the server uses API as the default value |
| organizationId | string | yes | The Codeup organization ID. This is the Yunxiao DevOps organization ID, which can be obtained by parsing the response of the… |
| repoName | string | yes | The repository name, which also serves as the English ID of the plugin. The backend does not validate the format. The frontend restricts… |
| workspaceName | string | no | The workspace name, which is the Chinese name of the plugin. This parameter is required. If you do not specify this parameter, the API… |

### Creates a policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| className | string | yes | The policy type. Valid values: RateLimit, ConcurrencyLimit, CircuitBreaker, HttpRewrite, HeaderModify, Cors, Authentication, FlowCopy,… |
| config | string | yes | The policy configuration |
| description | string | no | The description |
| name | string | yes | The policy name |

### Creates a policy attachment to a resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-policy-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| attachResourceId | string | yes | The ID of the resource to which the policy is attached |
| attachResourceType | string | yes | The type of the resource to which the policy is attached. Valid values: HttpApi, GatewayRoute, Operation, GatewayService,… |
| environmentId | string | yes | The environment ID |
| gatewayId | string | yes | The gateway instance ID |
| policyId | string | yes | The policy ID |

### Creates a HiMarket developer portal and returns the ID of the newly created portal
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| description | string | no | The description of the portal |
| name | string | no | The name of the portal |
| clientToken | string | no | The idempotency token. It is generated by the caller and guaranteed to be unique to prevent the portal from being repeatedly created due… |

### Creates an API product in the product catalog of the HiMarket portal and returns the ID of the new product…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| autoApprove | string | no | Specifies whether to automatically approve subscription requests for the product |
| categories | array | no | The list of categories to which the product belongs |
| description | string | no | The description of the API product |
| document | string | no | The content of the documentation for the API product |
| feature | object | no | The capability configuration of the product, which is currently used to describe the invocation capabilities of model-based products… |
| icon | object | no | The icon configuration of the API product |
| name | string | no | The name of the API product |
| type | string | no | The type of the API product. The set of valid values is not declared in the API definition. Refer to the types displayed in the console |
| clientToken | string | no | The idempotency token. It is generated by the caller and must be unique to prevent the same request from being repeatedly submitted and… |

### Creates a product category for an API product and returns the ID and name of the new category upon success
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-product-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| description | string | no | The description of the product category. Maximum length: 500 characters |
| icon | object | no | The icon of the product category, which consists of the icon type and icon information fields |
| name | string | no | The name of the product category. Maximum length: 100 characters |

### Associates an API configuration with a specified API product by submitting the gatewayId and apigRefConfig…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-product-ref` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| productId | string | yes | The ID of the API product with which you want to associate an API configuration. You can obtain this ID from the productId field in the… |
| apigRefConfig | object | no | The API configuration to associate with the API product |
| gatewayId | string | no | The ID of the gateway |

### Creates a risk check task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-risk-check-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The ID of the target gateway. The gateway must exist and be in the Running state. Otherwise, the ErrGatewayIsNotRunning error is returned |

### Generates a key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| description | string | no | The description of the key |
| gatewayType | string | no | The gateway type |
| kmsConfig | object | no | The KMS key configuration information |
| name | string | no | The key name. The name can contain letters, digits, and underscores (_) and can be up to 64 characters in length |
| secretData | string | no | The KMS credential value |
| secretSource | string | no | The key source |

### Creates services
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | no | The gateway ID |
| resourceGroupId | string | no | The resource group ID |
| serviceConfigs | array | no | The list of service configurations. At least one service configuration is required |
| sourceType | string | no | The service source. Valid values: MSE_NACOS: a service in MSE Nacos. K8S: a service in a Kubernetes cluster of Container Service. VIP: a… |
| clientToken | string | no | The client token |

### Creates a service version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-service-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | The service ID |
| labels | array | yes | The service labels |
| name | string | yes | The version name |

### Creates a source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/create-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | no | The gateway ID. Note: This parameter is required. If this parameter is not specified, the API returns a 400 InvalidParameter.IsEmpty error |
| k8sSourceConfig | object | no | The container service source configuration |
| nacosSourceConfig | object | no | The MSE Nacos source configuration |
| resourceGroupId | string | no | The resource group ID |
| type | string | no | The source type. Valid values: MSE_NACOS: MSE Nacos. K8S: container service |

### Deletes an AI model card
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-ai-model-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| modelCardId | string | yes | The ID of the model card to delete. This ID is returned by the model creation operation and is in a format that starts with mc- |

### Deletes an AI model provider
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-ai-model-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| modelProviderId | string | yes | The ID of the model provider to delete. This ID is returned by the model creation operation and is in a format that starts with mp- |

### Deletes a consumer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-consumer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | yes | The consumer ID |

### Deletes an API consumer authorization rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-consumer-authorization-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerAuthorizationRuleId | string | yes | The ID of the API consumer authorization rule used to filter the API list. The API list in the response contains only authorized APIs |
| consumerId | string | yes | The consumer ID |

### Deletes a consumer group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerGroupId | string | yes | The consumer group ID |

### Deletes a domain name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| domainId | string | yes | The domain name ID |

### Deletes a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The ID of the cloud-native API gateway |

### Deletes a quota throttling rule from a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-gateway-quota-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The gateway ID |
| ruleId | string | yes | The rule ID |

### Deletes a gateway security group rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-gateway-security-group-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The ID of the cloud-native API gateway |
| securityGroupRuleId | string | yes | The ID of the cloud-native API gateway security rule |
| cascadingDelete | string | no | Specifies whether security group rules is cascade deleted |

### Deletes a specified HTTP API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-http-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the HTTP API to delete |
| dryRun | string | no | Specifies whether to perform only a dry run. If set to true, all synchronous validations identical to an actual deletion are executed… |
| clientToken | string | no | The idempotence token. If you call this operation multiple times for the same HTTP API by using the same clientToken value and the same… |

### Deletes a specified API operation
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-http-api-operation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the HTTP API to which the API operation to be deleted belongs |
| operationId | string | yes | The operation ID |

### Deletes a route of an HTTP API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-http-api-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the HTTP API to which the route belongs |
| routeId | string | yes | The route ID |

### Deletes an MCP server
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-mcp-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| mcpServerId | string | yes | MCP Server ID |

### Deletes a data migration task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-migration-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | The ID of the data migration task |

### Deletes a plugin mount
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-plugin-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pluginAttachmentId | string | yes | The plugin mount ID |

### Deletes a custom plugin class
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-plugin-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pluginClassId | string | yes | The plugin class ID |

### Deletes a policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| policyId | string | yes | The policy ID |

### Deletes a policy attachment
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-policy-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| policyAttachmentId | string | yes | The policy attachment ID |

### Deletes a specified HiMarket developer portal by portal ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| portalId | string | yes | The ID of the portal to delete. You can obtain the portal ID from the portalId field in the CreatePortal response or from the portalId… |

### Deletes a specified API product by API product ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| productId | string | yes | The ID of the API product to delete. You can obtain this ID from the productId in the CreateProduct response or the productId of an item… |

### Deletes a specified product category by product category ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-product-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| categoryId | string | yes | The product category ID. Specifies the product category to delete. You can obtain this ID from the categoryId parameter in the response of… |

### Dissociates an API product from an API by API product ID. This association is established by…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-product-ref` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| productId | string | yes | The ID of the API product. Specifies the API product from which to dissociate the API. You can obtain this ID from the productId field of… |

### Deletes a key value
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| secretId | string | yes | The secret ID |

### Deletes a service
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | The service ID |

### Deletes a service version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-service-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | The service ID |
| name | string | yes | The version name |

### Deletes a service source
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/delete-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceId | string | yes | The source ID |

### Publishes an HTTP API. This includes REST APIs and routes within HTTP APIs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/deploy-http-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the HTTP API |
| httpApiConfig | object | no | The HTTP API deployment configuration |
| restApiConfig | object | no | The deployment configuration for a REST API. This parameter is required when the HTTP API to be published is a REST API. At least one of… |
| routeId | string | no | The route ID. This parameter is required when you publish a route of an HTTP API. Before deploying with routeId, make sure the target… |

### Publishes an MCP server
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/deploy-mcp-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| mcpServerId | string | yes | MCP Server ID |

### Queries the regions where the cloud-native API gateway is available for the current account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/describe-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| language | string | no | The language of the response. Valid values: zh, en |

### Detaches and deletes a policy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/detach-and-delete-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| policyId | string | yes | The policy ID |
| policyAttachmentId | string | no | The policy attachment ID |

### Exports a specified HTTP API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/export-http-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | HTTP API ID |
| extensionConfig | object | no | Specifies whether to export plug-in configurations |
| gatewayId | string | no | The gateway instance ID. This parameter is required when you export gateway extension information |
| operationIds | array | no | The IDs of specific operations to export when exporting a REST API |

### Queries the details of an AI model card
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-ai-model-card` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| modelCardId | string | yes | The ID of the model card to query. This ID is returned by the model creation operation and is in a format that starts with mc- |

### Queries the details of an AI model provider
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-ai-model-provider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| modelProviderId | string | yes | The ID of the model provider to query. This ID is returned by the model creation operation for model providers and is in a format that… |

### Queries the effective field collection configurations for an HTTP API across each URI of the request in a…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-api-path-field-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | no | The ID of the cloud-native API gateway |
| httpApiId | string | no | The ID of the HTTP API |

### Queries the field template corresponding to an API request path and returns the template name, applicable…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-api-path-field-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | no | The API request path, used to query the field template corresponding to the path |

### Queries a batch export task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-batch-export-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | The task ID |

### Queries a batch import task. The task ID is returned after a batch import task is created by calling…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-batch-import-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | The task ID. Call BatchImportHttpApis to create a batch import task first, and obtain the value of this parameter from the taskId field in… |

### Retrieves an API consumer
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-consumer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | yes | The API consumer ID |

### Retrieves a consumer authorization rule
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-consumer-authorization-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerAuthorizationRuleId | string | yes | The ID of the consumer authorization rule used to filter the API list. The API list in the response contains only authorized APIs |
| consumerId | string | yes | The consumer ID |

### Queries a consumer group
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-consumer-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerGroupId | string | yes | The consumer group ID |

### Retrieves the monitoring log dashboard
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-dashboard` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The unique ID of the gateway. Before calling this operation, make sure that the target gateway has enabled the Simple Log Service (SLS)… |
| pluginClassId | string | no | The plugin type ID |
| apiId | string | no | The unique ID of the API |
| routeId | string | no | The route ID |
| source | string | no | The source of the dashboard. Valid values: SLS: log dashboard. Note: This parameter is required. If this parameter is not specified, the… |
| name | string | no | The name of the dashboard. Valid values: LOG: access log. PLUGIN: plugin log. Note: This parameter is required. If this parameter is not… |
| filter | string | no | The filter configuration (JSON-encoded) |
| acceptLanguage | string | no | The language of the response. Valid values: zh: Chinese. en: English |
| upstreamCluster | string | no | The AI service identifier |
| pluginId | string | no | The plugin ID |

### Queries the account information of the currently logged-on developer and returns the developer ID, portal…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-developer` (byok)

### Queries a domain name
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| domainId | string | yes | The domain name ID |
| withStatistics | string | no | Specifies whether to return online resource information |

### Queries the basic information of a gateway, such as the associated VPC, vSwitch, and gateway endpoint
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-gateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The ID of the cloud-native API gateway. This parameter is required |

### Retrieves the elastic scaling rule of a gateway
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-gateway-elastic-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The gateway ID. The gateway must exist |

### Queries the details of a gateway quota throttling rule
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-gateway-quota-rule` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The gateway ID |
| ruleId | string | yes | The rule ID |
| withSubjects | string | no | Specifies whether to output the general subject list. This parameter takes effect for both consumer and consumer group rules |
| withConsumers | string | no | Specifies whether to output the consumer list |
| consumerPageNumber | string | no | The page number |
| consumerPageSize | string | no | The page size |

### Queries the usage details of a subject for a gateway quota throttling rule, including the used quota, total…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-gateway-quota-rule-subject-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The ID of the gateway |
| ruleId | string | yes | The ID of the rule |
| subjectId | string | yes | The ID of the subject, which is a consumer or a consumer group |
| pageNumber | integer | no | The page number of the detailed consumption (request) records for the consumer subject within the period |
| pageSize | integer | no | The number of entries per page for the detailed consumption (request) records of the consumer subject within the period. Maximum value: 10 |
| filterFailedRequests | string | no | Specifies whether to filter out zero values |
| startTime | integer | no | The start time for querying detailed consumption records. The time is a UNIX timestamp in seconds. If only this parameter is specified,… |
| endTime | integer | no | The end time for querying detailed consumption records. The time is a UNIX timestamp in seconds. If only this parameter is specified, the… |

### Queries the resource quotas and usage of a gateway
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-gateway-resource-quota-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The gateway ID |

### Queries the details of a single HiMarket consumer by consumer ID and returns the consumer ID, name,…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-hi-market-consumer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | yes | The consumer ID |

### Queries the credential information of a HiMarket consumer by consumer ID. The response includes API key and…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-hi-market-consumer-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| consumerId | string | yes | The consumer ID |

### Retrieves HTTP API information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-http-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the target HTTP API |
| expandPolicyConfigs | string | no | Specifies whether to expand independent policy configurations. If omitted or set to true, a full compatible view is returned. If set to… |

### Retrieves operation information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-http-api-operation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | The ID of the HTTP API to which the operation belongs |
| operationId | string | yes | The operation ID |

### Retrieves the route details of an HTTP API
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-http-api-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| httpApiId | string | yes | HTTP API ID |
| routeId | string | yes | The route ID |

### Retrieves an MCP server
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-mcp-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| mcpServerId | string | yes | MCP Server ID |

### Retrieves the namespaced services for a migration task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-migration-namespaced-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | The migration task ID. This parameter is a URL path parameter. Although the required field is set to false in the document metadata, you… |

### Retrieves a migration task
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-migration-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| taskId | string | yes | The migration task ID |

### Queries a plugin mount
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-plugin-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pluginAttachmentId | string | yes | The plugin mount ID |

### Retrieves a custom plug-in class
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-plugin-class` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pluginClassId | string | yes | The plug-in class ID |

### Queries the WebIDE workspace of a plugin
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-plugin-workspace` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| workspaceId | string | yes | The workspace ID. This parameter is included in the request path and must be provided when you invoke this operation. If this parameter is… |

### Retrieves a policy
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| policyId | string | yes | The policy ID |

### Queries the resource attachment of a policy
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-policy-attachment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| policyAttachmentId | string | yes | The policy attachment ID |

### Queries the details of a single HiMarket developer portal by portal ID and returns the portal name,…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-portal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| portalId | string | yes | The ID of the portal to query. You can obtain this ID from the portalId field in the CreatePortal response or from the portalId field of… |

### Queries the details of a single API product by API product ID, and returns information such as the name,…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-product` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| productId | string | yes | The API product ID, which is the primary ID of the API product resource and is used to specify the product to query |

### Queries the details of a product category by ID and returns the ID, name, description, and icon of the…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-product-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| categoryId | string | yes | The ID of the product category |

### Queries the API configurations associated with an API product by API product ID and returns the gateway ID…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-product-ref` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| productId | string | yes | The ID of the API product |

### Retrieves the resource overview information
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-resource-overview` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayType | string | no | The gateway type |

### Retrieves the notification configuration for a risk item
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-risk-notification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The gateway ID |
| riskCode | string | yes | The code of the risk item, such as the code for version risk or capacity risk |

### Retrieves a key
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| secretId | string | yes | The key ID |

### Retrieves the value of a secret
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-secret-value` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | yes | The secret name |

### Retrieves the details of a service
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-service` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| serviceId | string | yes | The unique ID of the service |

### Retrieves the details of a service source
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| sourceId | string | yes | The primary resource ID |

### Retrieves the Tracing Analysis configuration
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/get-trace-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The gateway instance ID |
| acceptLanguage | string | no | The language type. Valid values: zh: Chinese. en: English |

### Executes the callback step in the OIDC logon flow by submitting the code and state query parameters via a…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/handle-oidc-callback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| code | string | no | The code parameter carried in the OIDC callback request |
| state | string | no | The state parameter carried in the OIDC callback request |

### Imports an HTTP API. You can import an OpenAPI 2.0 or OpenAPI 3.0.x definition file as a REST API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/import-http-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| deployConfigs | array | no | The API deployment configurations |
| description | string | no | The description of the imported API. If this parameter is not specified, the description is extracted from the API definition file.… |
| dryRun | string | no | Specifies whether to enable dry run mode. If enabled, only validation is performed without actually importing the API |
| gatewayId | string | no | The gateway ID |
| mcpRouteId | string | no | The MCP route ID |
| name | string | no | The name of the imported API. If this parameter is not specified, the name is extracted from the API definition file. If an API with the… |
| resourceGroupId | string | no | The https://help.aliyun.com/document_detail/151181.html |
| specContentBase64 | string | no | The Base64-encoded API definition. Supports OAS 2.0 and OAS 3.0 specifications in YAML or JSON format. This parameter takes priority over… |
| specFileUrl | string | no | The download URL of the API definition file. The URL must be accessible over the Internet or be an internal network OSS download URL in… |
| specOssConfig | object | no | The OSS configuration |
| strategy | string | no | The update policy to use when the imported API has the same name and version management configuration as an existing API. Valid values:… |
| targetHttpApiId | string | no | If this parameter is specified, the import updates the specified API instead of creating a new one or searching for an existing API by… |
| versionConfig | object | no | The API version configuration. If version configuration is enabled, the import is treated as an update when the version number and API… |
| withGatewayExtension | string | no | Specifies whether to import gateway extension information |

### Initiates the Authorize step in the OIDC logon process based on the OIDC provider identifier. The response…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/initiate-oidc-auth` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| provider | string | no | The OIDC provider identifier |

### Installs a plug-in
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/install-plugin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayIds | array | no | The list of gateway IDs. This parameter is required. If this parameter is not specified, the service returns InvalidParameter.IsEmpty.… |
| pluginClassId | string | no | The plug-in type ID. This parameter is required. If this parameter is not specified, the service returns InvalidParameter.IsEmpty. This… |

### Calls an AI agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/invoke-aiagent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| agentName | string | yes | The agent name |
| bizParams | object | no | The business parameters. Each agent performs custom validation on these parameters, such as the SLS context passed for log diagnostics |
| history | array | no | The conversation history. Each element contains role (user/assistant) and content. The role and content fields in each element cannot be… |
| outputLanguage | string | no | The output language. When set to en, fallback error messages are displayed in English |
| prompt | string | no | The user input for the current turn. If left empty, a default prompt is used based on the scenario, such as "Start" |

### Queries a list of AI model cards
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/list-ai-model-cards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The ID of the AI gateway instance. The target instance must exist, belong to the current account, and be of the AI gateway type |
| keyword | string | no | The keyword for fuzzy match against the model provider identifier or model name. If this parameter is left empty, all model cards under… |
| pageNumber | integer | no | The page number. Default value: 1. The value must be greater than or equal to 1 |
| pageSize | integer | no | The number of entries per page. Default value: 10. Valid values: 1 to 500 |

### Queries the list of AI model providers
`GET https://zieapi.vercel.app/v1/cloud:aliyun-apig/list-ai-model-providers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| gatewayId | string | yes | The ID of the AI gateway instance. The target instance must exist, belong to the current account, and be of the AI gateway type |
| provider | string | no | The fuzzy match condition for the model provider identifier. If this parameter is left empty, all model providers under the current… |
| pageNumber | integer | no | The page number. Default value: 1. The value must be greater than or equal to 1 |
| pageSize | integer | no | The number of entries per page. Default value: 10. Valid values: 1 to 500 |

…and 106 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-apig/add-gateway-quota-rule" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Cloud Native API Gateway API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-apig/add-gateway-quota-rule with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Cloud Native 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 Cloud Native API Gateway itself also needs your own key from aliyuncs.com.

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

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